- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeExportCommand
Describes an existing table export.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DynamoDBClient, DescribeExportCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DescribeExportCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DescribeExportInput
ExportArn: "STRING_VALUE", // required
};
const command = new DescribeExportCommand(input);
const response = await client.send(command);
// { // DescribeExportOutput
// ExportDescription: { // ExportDescription
// ExportArn: "STRING_VALUE",
// ExportStatus: "IN_PROGRESS" || "COMPLETED" || "FAILED",
// StartTime: new Date("TIMESTAMP"),
// EndTime: new Date("TIMESTAMP"),
// ExportManifest: "STRING_VALUE",
// TableArn: "STRING_VALUE",
// TableId: "STRING_VALUE",
// ExportTime: new Date("TIMESTAMP"),
// ClientToken: "STRING_VALUE",
// S3Bucket: "STRING_VALUE",
// S3BucketOwner: "STRING_VALUE",
// S3Prefix: "STRING_VALUE",
// S3SseAlgorithm: "AES256" || "KMS",
// S3SseKmsKeyId: "STRING_VALUE",
// FailureCode: "STRING_VALUE",
// FailureMessage: "STRING_VALUE",
// ExportFormat: "DYNAMODB_JSON" || "ION",
// BilledSizeBytes: Number("long"),
// ItemCount: Number("long"),
// ExportType: "FULL_EXPORT" || "INCREMENTAL_EXPORT",
// IncrementalExportSpecification: { // IncrementalExportSpecification
// ExportFromTime: new Date("TIMESTAMP"),
// ExportToTime: new Date("TIMESTAMP"),
// ExportViewType: "NEW_IMAGE" || "NEW_AND_OLD_IMAGES",
// },
// },
// };
DescribeExportCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ExportArn Required | string | undefined | The Amazon Resource Name (ARN) associated with the export. |
DescribeExportCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ExportDescription | ExportDescription | undefined | Represents the properties of the export. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ExportNotFoundException | client | The specified export was not found. |
InternalServerError | server | An error occurred on the server side. |
LimitExceededException | client | There is no limit to the number of daily on-demand backups that can be taken. For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations. When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account. There is a soft account quota of 2,500 tables. GetRecords was called with a value of more than 1000 for the limit request parameter. More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling. |
DynamoDBServiceException | Base exception class for all service exceptions from DynamoDB service. |