You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDB::Types::ExportDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents the properties of the exported table.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#billed_size_bytes ⇒ Integer

The billable size of the table export.

Returns:

  • (Integer) —

    The billable size of the table export.

#client_token ⇒ String

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.

Returns:

  • (String) —

    The client token that was provided for the export task.

#end_time ⇒ Time

The time at which the export task completed.

Returns:

  • (Time) —

    The time at which the export task completed.

#export_arn ⇒ String

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

Returns:

  • (String) —

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

#export_format ⇒ String

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

Possible values:

  • DYNAMODB_JSON
  • ION

Returns:

  • (String) —

    The format of the exported data.

#export_manifest ⇒ String

The name of the manifest file for the export task.

Returns:

  • (String) —

    The name of the manifest file for the export task.

#export_status ⇒ String

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

Possible values:

  • IN_PROGRESS
  • COMPLETED
  • FAILED

Returns:

  • (String) —

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

#export_time ⇒ Time

Point in time from which table data was exported.

Returns:

  • (Time) —

    Point in time from which table data was exported.

#failure_code ⇒ String

Status code for the result of the failed export.

Returns:

  • (String) —

    Status code for the result of the failed export.

#failure_message ⇒ String

Export failure reason description.

Returns:

  • (String) —

    Export failure reason description.

#item_count ⇒ Integer

The number of items exported.

Returns:

  • (Integer) —

    The number of items exported.

#s3_bucket ⇒ String

The name of the Amazon S3 bucket containing the export.

Returns:

  • (String) —

    The name of the Amazon S3 bucket containing the export.

#s3_bucket_owner ⇒ String

The ID of the AWS account that owns the bucket containing the export.

Returns:

  • (String) —

    The ID of the AWS account that owns the bucket containing the export.

#s3_prefix ⇒ String

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

Returns:

  • (String) —

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

#s3_sse_algorithm ⇒ String

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 AWS KMS managed keys

    Possible values:

    • AES256
    • KMS

Returns:

  • (String) —

    Type of encryption used on the bucket where export data is stored.

#s3_sse_kms_key_id ⇒ String

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

Returns:

  • (String) —

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

#start_time ⇒ Time

The time at which the export task began.

Returns:

  • (Time) —

    The time at which the export task began.

#table_arn ⇒ String

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

Returns:

  • (String) —

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

#table_id ⇒ String

Unique ID of the table that was exported.

Returns:

  • (String) —

    Unique ID of the table that was exported.