Skip to main content

Retrieve a DynamoDB table backup​

Returns a representation of the specified DynamoDB table backup.

Path Parameters
  • backup_id string required

    Performs the operation on the backup with the specified ID.

Responses

Success

Schema
  • _etag string

    The ETag value.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • restore-aws-dynamodb-records object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • restore-aws-dynamodb-table object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • account_native_id string

    The AWS-assigned ID of the account associated with this database at the time of backup.

  • aws_region string

    The AWS region associated with this environment.

  • billing_mode string

    The billing mode of the DynamoDB table. Possible values are PROVISIONED or PAY_PER_REQUEST. For POST /restores/aws/dynamodb, this is defaulted to the configuration of source table if both 'billing_mode' and 'provisioned_throughput' are empty or null.

  • expiration_timestamp string

    The timestamp of when this backup expires. Represented in RFC-3339 format.

  • global_secondary_indexes object[]

    Describes the global secondary indexes of the DynamoDB table. For POST /restores/aws/dynamodb, a subset of the source tables' global_secondary_indexes can be specified. The restored table will not have any global secondary indexes if this is specified empty or null.

  • index_name string

    The name of the global secondary index.

  • key_schema object[]

    The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types.

  • attribute_name string

    The name of a key attribute.

  • key_type string

    The role that this key attribute will assume. Possible values include: HASH - partition key and RANGE - sort key.

  • projection object

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

  • non_key_attributes string[]

    Represents the non-key attribute names which will be projected into the index. For POST /restores/aws/dynamodb, this must be empty if 'projection_type' is ALL or KEYS_ONLY, and non-empty if 'projection_type' is INCLUDE.

  • projection_type string

    The set of attributes that are projected into the index. Valid Values: ALL, KEYS_ONLY, INCLUDE.

  • provisioned_throughput object

    Represents the provisioned throughput settings for a DynamoDB table.

  • read_capacity_units int64

    The maximum number of strongly consistent reads consumed per second.

  • write_capacity_units int64

    The maximum number of writes consumed per second.

  • global_table_version string

    Describes the version of global tables in use, if the table is replicated across AWS Regions. If the table is not a global table, then this field has a value of null. Possible values are 2017.11.29 or 2019.11.21. For POST /restores/aws/dynamodb, the version is defaulted to 2019.11.21.

  • id string

    The Clumio-assigned ID of the backup.

  • item_count int64

    The number of items in DynamoDB table backup.

  • local_secondary_indexes object[]

    Describes the local secondary indexes of the DynamoDB table. For POST /restores/aws/dynamodb, a subset of the source tables' local_secondary_indexes can be specified. The restored table will not have any local secondary indexes if this is specified empty or null.

  • index_name string

    The name of the local secondary index

  • key_schema object[]

    The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types.

  • attribute_name string

    The name of a key attribute.

  • key_type string

    The role that this key attribute will assume. Possible values include: HASH - partition key and RANGE - sort key.

  • projection object

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

  • non_key_attributes string[]

    Represents the non-key attribute names which will be projected into the index. For POST /restores/aws/dynamodb, this must be empty if 'projection_type' is ALL or KEYS_ONLY, and non-empty if 'projection_type' is INCLUDE.

  • projection_type string

    The set of attributes that are projected into the index. Valid Values: ALL, KEYS_ONLY, INCLUDE.

  • pitr_status boolean

    Indicates whether DynamoDB Continuous Backup (PITR) is enabled (true) or disabled (false) on the table. For POST /restores/aws/dynamodb, this is defaulted to the value set in backup if null.

  • provisioned_throughput object

    Represents the provisioned throughput settings for a DynamoDB table.

  • read_capacity_units int64

    The maximum number of strongly consistent reads consumed per second.

  • write_capacity_units int64

    The maximum number of writes consumed per second.

  • replicas object[]

    Describes the replicas of the table, if the table is replicated across AWS Regions. Not applicable for POST /restores/aws/dynamodb currently, but will be used to specify the replication group information in a future release.

  • global_secondary_indexes object[]

    The replica-specific global secondary index settings.

  • index_name string

    The name of the global secondary index.

  • provisioned_throughput_override object

    Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.

  • read_capacity_units int64

    The maximum number of strongly consistent reads consumed per second.

  • kms_master_key_id string

    The AWS KMS key of the replica that will be used for AWS KMS encryption.

  • provisioned_throughput_override object

    Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.

  • read_capacity_units int64

    The maximum number of strongly consistent reads consumed per second.

  • region_name string

    The name of the Region.

  • size int64

    The size of the DynamoDB table backup in bytes.

  • sse_specification object

    Represents the server-side encryption settings for a table.

  • kms_key_type string

    The server-side encryption KMS key type. This field will only be populated for GET /datasources/aws/dynamodb-tables/{table_id} and GET /backups/aws/dynamodb-tables/{backup_id}. For POST /restores/aws/dynamodb, kms_master_key_id must be specified in case of CUSTOMER_MANAGED. Possible values include: DEFAULT, AWS_MANAGED, CUSTOMER_MANAGED.

  • kms_master_key_id string

    The AWS KMS customer master key (CMK) ARN that is used to encrypt the table. If this field is null, server-side encryption is the default encryption (AWS owned CMK). Otherwise, an AWS-managed or customer-managed CMK exists having these values. For POST /restores/aws/dynamodb, use key ID, Amazon Resource Name (ARN), alias name or alias ARN to specify a key to be used for encrypting the restored table. In case of default encryption (AWS owned CMK), specify this as null.

  • start_timestamp string

    The timestamp of when this backup started. Represented in RFC-3339 format.

  • stream_specification object

    Represents the DynamoDB Streams configuration for a table in DynamoDB. and the data type (S for string, N for number, B for binary).

  • enabled boolean

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

  • view_type string

    When an item in the table is modified, ViewType determines what information is written to the stream for this table. Valid values for ViewType 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.

  • table_class string

    The table class of the DynamoDB table. Possible values are STANDARD or STANDARD_INFREQUENT_ACCESS. For POST /restores/aws/dynamodb, this is defaulted to the STANDARD storage class if empty.

  • table_id string

    The Clumio-assigned ID of the DynamoDB table.

  • table_name string

    The name of the DynamoDB table.

  • tags object[]

    The AWS tags associated with the table at the time of backup.

  • key string

    The AWS-assigned tag key.

  • value string

    The AWS-assigned tag value.

  • type string

    The type of backup. Possible values include clumio_backup and aws_snapshot.

Loading...