DescribeImportCommand

Suggest an Edit

Represents the properties of the import.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, DescribeImportCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DescribeImportCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DescribeImportInput
  ImportArn: "STRING_VALUE", // required
};
const command = new DescribeImportCommand(input);
const response = await client.send(command);
// { // DescribeImportOutput
//   ImportTableDescription: { // ImportTableDescription
//     ImportArn: "STRING_VALUE",
//     ImportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELLING" || "CANCELLED" || "FAILED",
//     TableArn: "STRING_VALUE",
//     TableId: "STRING_VALUE",
//     ClientToken: "STRING_VALUE",
//     S3BucketSource: { // S3BucketSource
//       S3BucketOwner: "STRING_VALUE",
//       S3Bucket: "STRING_VALUE", // required
//       S3KeyPrefix: "STRING_VALUE",
//     },
//     ErrorCount: Number("long"),
//     CloudWatchLogGroupArn: "STRING_VALUE",
//     InputFormat: "DYNAMODB_JSON" || "ION" || "CSV",
//     InputFormatOptions: { // InputFormatOptions
//       Csv: { // CsvOptions
//         Delimiter: "STRING_VALUE",
//         HeaderList: [ // CsvHeaderList
//           "STRING_VALUE",
//         ],
//       },
//     },
//     InputCompressionType: "GZIP" || "ZSTD" || "NONE",
//     TableCreationParameters: { // TableCreationParameters
//       TableName: "STRING_VALUE", // required
//       AttributeDefinitions: [ // AttributeDefinitions // required
//         { // AttributeDefinition
//           AttributeName: "STRING_VALUE", // required
//           AttributeType: "S" || "N" || "B", // required
//         },
//       ],
//       KeySchema: [ // KeySchema // required
//         { // KeySchemaElement
//           AttributeName: "STRING_VALUE", // required
//           KeyType: "HASH" || "RANGE", // required
//         },
//       ],
//       BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
//       ProvisionedThroughput: { // ProvisionedThroughput
//         ReadCapacityUnits: Number("long"), // required
//         WriteCapacityUnits: Number("long"), // required
//       },
//       OnDemandThroughput: { // OnDemandThroughput
//         MaxReadRequestUnits: Number("long"),
//         MaxWriteRequestUnits: Number("long"),
//       },
//       SSESpecification: { // SSESpecification
//         Enabled: true || false,
//         SSEType: "AES256" || "KMS",
//         KMSMasterKeyId: "STRING_VALUE",
//       },
//       GlobalSecondaryIndexes: [ // GlobalSecondaryIndexList
//         { // GlobalSecondaryIndex
//           IndexName: "STRING_VALUE", // required
//           KeySchema: [ // required
//             {
//               AttributeName: "STRING_VALUE", // required
//               KeyType: "HASH" || "RANGE", // required
//             },
//           ],
//           Projection: { // Projection
//             ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
//             NonKeyAttributes: [ // NonKeyAttributeNameList
//               "STRING_VALUE",
//             ],
//           },
//           ProvisionedThroughput: {
//             ReadCapacityUnits: Number("long"), // required
//             WriteCapacityUnits: Number("long"), // required
//           },
//           OnDemandThroughput: {
//             MaxReadRequestUnits: Number("long"),
//             MaxWriteRequestUnits: Number("long"),
//           },
//           WarmThroughput: { // WarmThroughput
//             ReadUnitsPerSecond: Number("long"),
//             WriteUnitsPerSecond: Number("long"),
//           },
//         },
//       ],
//     },
//     StartTime: new Date("TIMESTAMP"),
//     EndTime: new Date("TIMESTAMP"),
//     ProcessedSizeBytes: Number("long"),
//     ProcessedItemCount: Number("long"),
//     ImportedItemCount: Number("long"),
//     FailureCode: "STRING_VALUE",
//     FailureMessage: "STRING_VALUE",
//   },
// };

DescribeImportCommand Input

See DescribeImportCommandInput for more details

Parameter
Type
Description
ImportArn
Required
string | undefined

The Amazon Resource Name (ARN) associated with the table you're importing to.

DescribeImportCommand Output

See DescribeImportCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ImportTableDescription
Required
ImportTableDescription | undefined

Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.

Throws

Name
Fault
Details
ImportNotFoundException
client

The specified import was not found.

DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.