Skip to content
AWS for Query.Farm

aws.dynamodb.describe_backup

Example SQL Queries

SELECT * FROM
aws.dynamodb.describe_backup
WHERE
"backup_arn" = 'VALUE';

Description

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

Table Definition

Column NameColumn Data Type
backup_arn Required Input Column

The Amazon Resource Name (ARN) associated with the backup.

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
backup_description

Contains the description of the backup created for the table.

STRUCT(
    "backup_details" STRUCT(
        "backup_arn" VARCHAR,
        "backup_name" VARCHAR,
        "backup_size_bytes" BIGINT,
        "backup_status" VARCHAR,
        "backup_type" VARCHAR,
        "backup_creation_date_time" TIMESTAMP_S,
        "backup_expiry_date_time" TIMESTAMP_S
    ),
    "source_table_details" STRUCT(
        "table_name" VARCHAR,
        "table_id" VARCHAR,
        "table_arn" VARCHAR,
        "table_size_bytes" BIGINT,
        "key_schema" STRUCT(
            "attribute_name" VARCHAR,
            "key_type" VARCHAR
        )[],
        "table_creation_date_time" TIMESTAMP_S,
        "provisioned_throughput" STRUCT(
            "read_capacity_units" BIGINT,
            "write_capacity_units" BIGINT
        ),
        "on_demand_throughput" STRUCT(
            "max_read_request_units" BIGINT,
            "max_write_request_units" BIGINT
        ),
        "item_count" BIGINT,
        "billing_mode" VARCHAR
    ),
    "source_table_feature_details" STRUCT(
        "local_secondary_indexes" STRUCT(
            "index_name" VARCHAR,
            "key_schema" STRUCT(
                "attribute_name" VARCHAR,
                "key_type" VARCHAR
            )[],
            "projection" STRUCT(
                "projection_type" VARCHAR,
                "non_key_attributes" VARCHAR[]
            )
        )[],
        "global_secondary_indexes" STRUCT(
            "index_name" VARCHAR,
            "key_schema" STRUCT(
                "attribute_name" VARCHAR,
                "key_type" VARCHAR
            )[],
            "projection" STRUCT(
                "projection_type" VARCHAR,
                "non_key_attributes" VARCHAR[]
            ),
            "provisioned_throughput" STRUCT(
                "read_capacity_units" BIGINT,
                "write_capacity_units" BIGINT
            ),
            "on_demand_throughput" STRUCT(
                "max_read_request_units" BIGINT,
                "max_write_request_units" BIGINT
            )
        )[],
        "stream_description" STRUCT(
            "stream_enabled" BOOLEAN,
            "stream_view_type" VARCHAR
        ),
        "time_to_live_description" STRUCT(
            "time_to_live_status" VARCHAR,
            "attribute_name" VARCHAR
        ),
        "sse_description" STRUCT(
            "status" VARCHAR,
            "sse_type" VARCHAR,
            "kms_master_key_arn" VARCHAR,
            "inaccessible_encryption_date_time" TIMESTAMP_S
        )
    )
)
Show child fields
backup_description.backup_details

Contains the details of the backup created for the table.

Show child fields
backup_description.backup_details.backup_arn

ARN associated with the backup.

backup_description.backup_details.backup_creation_date_time

Time at which the backup was created. This is the request time of the backup.

backup_description.backup_details.backup_expiry_date_time

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

backup_description.backup_details.backup_name

Name of the requested backup.

backup_description.backup_details.backup_size_bytes

Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

backup_description.backup_details.backup_status

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

backup_description.backup_details.backup_type

BackupType:

  • USER - You create and manage these using the on-demand backup feature.

  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

  • AWS_BACKUP - On-demand backup created by you from Backup service.

backup_description.source_table_details

Contains the details of the table when the backup was created.

Show child fields
backup_description.source_table_details.billing_mode

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

backup_description.source_table_details.item_count

Number of items in the table. Note that this is an approximate value.

backup_description.source_table_details.key_schema[]
Show child fields
backup_description.source_table_details.key_schema[].attribute_name

The name of a key attribute.

backup_description.source_table_details.key_schema[].key_type

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

backup_description.source_table_details.on_demand_throughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Show child fields
backup_description.source_table_details.on_demand_throughput.max_read_request_units

Maximum number of read request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

backup_description.source_table_details.on_demand_throughput.max_write_request_units

Maximum number of write request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

backup_description.source_table_details.provisioned_throughput

Read IOPs and Write IOPS on the table when the backup was created.

Show child fields
backup_description.source_table_details.provisioned_throughput.read_capacity_units

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

backup_description.source_table_details.provisioned_throughput.write_capacity_units

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

backup_description.source_table_details.table_arn

ARN of the table for which backup was created.

backup_description.source_table_details.table_creation_date_time

Time when the source table was created.

backup_description.source_table_details.table_id

Unique identifier for the table for which the backup was created.

backup_description.source_table_details.table_name

The name of the table for which the backup was created.

backup_description.source_table_details.table_size_bytes

Size of the table in bytes. Note that this is an approximate value.

backup_description.source_table_feature_details

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

Show child fields
backup_description.source_table_feature_details.global_secondary_indexes[]
Show child fields
backup_description.source_table_feature_details.global_secondary_indexes[].index_name

The name of the global secondary index.

backup_description.source_table_feature_details.global_secondary_indexes[].key_schema[]
Show child fields
backup_description.source_table_feature_details.global_secondary_indexes[].key_schema[].attribute_name

The name of a key attribute.

backup_description.source_table_feature_details.global_secondary_indexes[].key_schema[].key_type

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

backup_description.source_table_feature_details.global_secondary_indexes[].on_demand_throughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Show child fields
backup_description.source_table_feature_details.global_secondary_indexes[].on_demand_throughput.max_read_request_units

Maximum number of read request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

backup_description.source_table_feature_details.global_secondary_indexes[].on_demand_throughput.max_write_request_units

Maximum number of write request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

backup_description.source_table_feature_details.global_secondary_indexes[].projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Show child fields
backup_description.source_table_feature_details.global_secondary_indexes[].projection.non_key_attributes[]
backup_description.source_table_feature_details.global_secondary_indexes[].projection.projection_type

The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.

  • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

  • ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

backup_description.source_table_feature_details.global_secondary_indexes[].provisioned_throughput

Represents the provisioned throughput settings for the specified global secondary index.

Show child fields
backup_description.source_table_feature_details.global_secondary_indexes[].provisioned_throughput.read_capacity_units

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

backup_description.source_table_feature_details.global_secondary_indexes[].provisioned_throughput.write_capacity_units

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

backup_description.source_table_feature_details.local_secondary_indexes[]
Show child fields
backup_description.source_table_feature_details.local_secondary_indexes[].index_name

Represents the name of the local secondary index.

backup_description.source_table_feature_details.local_secondary_indexes[].key_schema[]
Show child fields
backup_description.source_table_feature_details.local_secondary_indexes[].key_schema[].attribute_name

The name of a key attribute.

backup_description.source_table_feature_details.local_secondary_indexes[].key_schema[].key_type

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

backup_description.source_table_feature_details.local_secondary_indexes[].projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Show child fields
backup_description.source_table_feature_details.local_secondary_indexes[].projection.non_key_attributes[]
backup_description.source_table_feature_details.local_secondary_indexes[].projection.projection_type

The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.

  • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

  • ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

backup_description.source_table_feature_details.sse_description

The description of the server-side encryption status on the table when the backup was created.

Show child fields
backup_description.source_table_feature_details.sse_description.inaccessible_encryption_date_time

Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

backup_description.source_table_feature_details.sse_description.kms_master_key_arn

The KMS key ARN used for the KMS encryption.

backup_description.source_table_feature_details.sse_description.sse_type

Server-side encryption type. The only supported value is:

  • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

backup_description.source_table_feature_details.sse_description.status

Represents the current state of server-side encryption. The only supported values are:

  • ENABLED - Server-side encryption is enabled.

  • UPDATING - Server-side encryption is being updated.

backup_description.source_table_feature_details.stream_description

Stream settings on the table when the backup was created.

Show child fields
backup_description.source_table_feature_details.stream_description.stream_enabled

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

backup_description.source_table_feature_details.stream_description.stream_view_type

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

  • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

  • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

  • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

  • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

backup_description.source_table_feature_details.time_to_live_description

Time to Live settings on the table when the backup was created.

Show child fields
backup_description.source_table_feature_details.time_to_live_description.attribute_name

The name of the TTL attribute for items in the table.

backup_description.source_table_feature_details.time_to_live_description.time_to_live_status

The TTL status for the table.