Skip to content

aws.bcm_data_exports.get_export

Example SQL Queries

SELECT * FROM
aws.bcm_data_exports.get_export
WHERE
"export_arn" = 'VALUE';

Description

Views the definition of an existing data export.

Table Definition

Column NameColumn Data Type
export_arn Required Input Column

The Amazon Resource Name (ARN) for this export.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

export

The data for this specific export.

STRUCT(
"data_query" STRUCT(
"query_statement" VARCHAR,
"table_configurations" MAP(VARCHAR, MAP(VARCHAR, VARCHAR))
),
"description" VARCHAR,
"destination_configurations" STRUCT(
"s3_destination" STRUCT(
"s3_bucket" VARCHAR,
"s3_output_configurations" STRUCT(
"compression" VARCHAR,
"format" VARCHAR,
"output_type" VARCHAR,
"overwrite" VARCHAR
),
"s3_prefix" VARCHAR,
"s3_region" VARCHAR
)
),
"export_arn" VARCHAR,
"name" VARCHAR,
"refresh_cadence" STRUCT(
"frequency" VARCHAR
)
)
Show child fields
export.data_query

The data query for this specific data export.

Show child fields
export.data_query.query_statement

The query statement.

export.data_query.table_configurations

The table configuration.

export.description

The description for this specific data export.

export.destination_configurations

The destination configuration for this specific data export.

Show child fields
export.destination_configurations.s3_destination

An object that describes the destination of the data exports file.

Show child fields
export.destination_configurations.s3_destination.s3_bucket

The name of the Amazon S3 bucket used as the destination of a data export file.

export.destination_configurations.s3_destination.s3_output_configurations

The output configuration for the data export.

Show child fields
export.destination_configurations.s3_destination.s3_output_configurations.compression

The compression type for the data export.

export.destination_configurations.s3_destination.s3_output_configurations.format

The file format for the data export.

export.destination_configurations.s3_destination.s3_output_configurations.output_type

The output type for the data export.

export.destination_configurations.s3_destination.s3_output_configurations.overwrite

The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.

export.destination_configurations.s3_destination.s3_prefix

The S3 path prefix you want prepended to the name of your data export.

export.destination_configurations.s3_destination.s3_region

The S3 bucket Region.

export.export_arn

The Amazon Resource Name (ARN) for this export.

export.name

The name of this specific data export.

export.refresh_cadence

The cadence for Amazon Web Services to update the export in your S3 bucket.

Show child fields
export.refresh_cadence.frequency

The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.

export_status

The status of this specific export.

STRUCT(
"created_at" TIMESTAMP_S,
"last_refreshed_at" TIMESTAMP_S,
"last_updated_at" TIMESTAMP_S,
"status_code" VARCHAR,
"status_reason" VARCHAR
)
Show child fields
export_status.created_at

The timestamp of when the export was created.

export_status.last_refreshed_at

The timestamp of when the export was last generated.

export_status.last_updated_at

The timestamp of when the export was updated.

export_status.status_code

The status code for the request.

export_status.status_reason

The description for the status code.