Skip to content
AWS for Query.Farm

aws.dynamodb.describe_export

Example SQL Queries

SELECT * FROM
aws.dynamodb.describe_export
WHERE
"export_arn" = 'VALUE';

Description

Describes an existing table export.

Table Definition

Column NameColumn Data Type
export_arn Required Input Column

The Amazon Resource Name (ARN) associated with the 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.

_aws_region Input Column

The AWS region to use.

VARCHAR
export_description

Represents the properties of the export.

STRUCT(
    "export_arn" VARCHAR,
    "export_status" VARCHAR,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "export_manifest" VARCHAR,
    "table_arn" VARCHAR,
    "table_id" VARCHAR,
    "export_time" TIMESTAMP_S,
    "client_token" VARCHAR,
    "s3_bucket" VARCHAR,
    "s3_bucket_owner" VARCHAR,
    "s3_prefix" VARCHAR,
    "s3_sse_algorithm" VARCHAR,
    "s3_sse_kms_key_id" VARCHAR,
    "failure_code" VARCHAR,
    "failure_message" VARCHAR,
    "export_format" VARCHAR,
    "billed_size_bytes" BIGINT,
    "item_count" BIGINT,
    "export_type" VARCHAR,
    "incremental_export_specification" STRUCT(
        "export_from_time" TIMESTAMP_S,
        "export_to_time" TIMESTAMP_S,
        "export_view_type" VARCHAR
    )
)
Show child fields
export_description.billed_size_bytes

The billable size of the table export.

export_description.client_token

The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

export_description.end_time

The time at which the export task completed.

export_description.export_arn

The Amazon Resource Name (ARN) of the table export.

export_description.export_format

The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

export_description.export_manifest

The name of the manifest file for the export task.

export_description.export_status

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

export_description.export_time

Point in time from which table data was exported.

export_description.export_type

The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.

export_description.failure_code

Status code for the result of the failed export.

export_description.failure_message

Export failure reason description.

export_description.incremental_export_specification

Optional object containing the parameters specific to an incremental export.

Show child fields
export_description.incremental_export_specification.export_from_time

Time in the past which provides the inclusive start range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state including and after this point in time.

export_description.incremental_export_specification.export_to_time

Time in the past which provides the exclusive end range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state just prior to this point in time. If this is not provided, the latest time with data available will be used.

export_description.incremental_export_specification.export_view_type

The view type that was chosen for the export. Valid values are NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is NEW_AND_OLD_IMAGES.

export_description.item_count

The number of items exported.

export_description.s3_bucket

The name of the Amazon S3 bucket containing the export.

export_description.s3_bucket_owner

The ID of the Amazon Web Services account that owns the bucket containing the export.

export_description.s3_prefix

The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.

export_description.s3_sse_algorithm

Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are:

  • AES256 - server-side encryption with Amazon S3 managed keys

  • KMS - server-side encryption with KMS managed keys

export_description.s3_sse_kms_key_id

The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).

export_description.start_time

The time at which the export task began.

export_description.table_arn

The Amazon Resource Name (ARN) of the table that was exported.

export_description.table_id

Unique ID of the table that was exported.