Describes an existing table export.
See also: AWS API Documentation
describe-export --export-arn <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The Amazon Resource Name (ARN) associated with the export.
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
ExportDescription -> (structure)
Represents the properties of the export.
ExportArn -> (string)
The Amazon Resource Name (ARN) of the table export.
ExportStatus -> (string)
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
StartTime -> (timestamp)
The time at which the export task began.
EndTime -> (timestamp)
The time at which the export task completed.
ExportManifest -> (string)
The name of the manifest file for the export task.
TableArn -> (string)
The Amazon Resource Name (ARN) of the table that was exported.
TableId -> (string)
Unique ID of the table that was exported.
ExportTime -> (timestamp)
Point in time from which table data was exported.
ClientToken -> (string)
The client token that was provided for the export task. A client token makes calls to
ExportTableToPointInTimeInputidempotent, meaning that multiple identical calls have the same effect as one single call.
S3Bucket -> (string)
The name of the Amazon S3 bucket containing the export.
S3BucketOwner -> (string)
The ID of the Amazon Web Services account that owns the bucket containing the export.
S3Prefix -> (string)
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
S3SseAlgorithm -> (string)
Type of encryption used on the bucket where export data is stored. Valid values for
AES256- server-side encryption with Amazon S3 managed keys
KMS- server-side encryption with KMS managed keys
S3SseKmsKeyId -> (string)
The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
FailureCode -> (string)
Status code for the result of the failed export.
FailureMessage -> (string)
Export failure reason description.
ExportFormat -> (string)
The format of the exported data. Valid values for
BilledSizeBytes -> (long)
The billable size of the table export.
ItemCount -> (long)
The number of items exported.