@aws-sdk/client-dynamodb 3.775.0 → 3.782.0

package/dist-types/commands/BatchExecuteStatementCommand.d.ts

@@ -210,6 +210,7 @@ declare const BatchExecuteStatementCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class BatchExecuteStatementCommand extends BatchExecuteStatementCommand_base {

package/dist-types/commands/BatchGetItemCommand.d.ts

@@ -271,71 +271,71 @@ declare const BatchGetItemCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To retrieve multiple items from a table
  * ```javascript
  * // This example reads multiple items from the Music table using a batch of three GetItem requests.  Only the AlbumTitle attribute is returned.
  * const input = {
- *   "RequestItems": {
- *     "Music": {
- *       "Keys": [
+ *   RequestItems: {
+ *     Music: {
+ *       Keys: [
  *         {
- *           "Artist": {
- *             "S": "No One You Know"
+ *           Artist: {
+ *             S: "No One You Know"
  *           },
- *           "SongTitle": {
- *             "S": "Call Me Today"
+ *           SongTitle: {
+ *             S: "Call Me Today"
  *           }
  *         },
  *         {
- *           "Artist": {
- *             "S": "Acme Band"
+ *           Artist: {
+ *             S: "Acme Band"
  *           },
- *           "SongTitle": {
- *             "S": "Happy Day"
+ *           SongTitle: {
+ *             S: "Happy Day"
  *           }
  *         },
  *         {
- *           "Artist": {
- *             "S": "No One You Know"
+ *           Artist: {
+ *             S: "No One You Know"
  *           },
- *           "SongTitle": {
- *             "S": "Scared of My Shadow"
+ *           SongTitle: {
+ *             S: "Scared of My Shadow"
  *           }
  *         }
  *       ],
- *       "ProjectionExpression": "AlbumTitle"
+ *       ProjectionExpression: "AlbumTitle"
  *     }
  *   }
  * };
  * const command = new BatchGetItemCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Responses": {
- *     "Music": [
+ *   Responses: {
+ *     Music: [
  *       {
- *         "AlbumTitle": {
- *           "S": "Somewhat Famous"
+ *         AlbumTitle: {
+ *           S: "Somewhat Famous"
  *         }
  *       },
  *       {
- *         "AlbumTitle": {
- *           "S": "Blue Sky Blues"
+ *         AlbumTitle: {
+ *           S: "Blue Sky Blues"
  *         }
  *       },
  *       {
- *         "AlbumTitle": {
- *           "S": "Louder Than Ever"
+ *         AlbumTitle: {
+ *           S: "Louder Than Ever"
  *         }
  *       }
  *     ]
  *   }
  * }
  * *\/
- * // example id: to-retrieve-multiple-items-from-a-table-1476118438992
  * ```
  *
+ * @public
  */
 export declare class BatchGetItemCommand extends BatchGetItemCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/BatchWriteItemCommand.d.ts

@@ -322,54 +322,54 @@ declare const BatchWriteItemCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To add multiple items to a table
  * ```javascript
  * // This example adds three new items to the Music table using a batch of three PutItem requests.
  * const input = {
- *   "RequestItems": {
- *     "Music": [
+ *   RequestItems: {
+ *     Music: [
  *       {
- *         "PutRequest": {
- *           "Item": {
- *             "AlbumTitle": {
- *               "S": "Somewhat Famous"
+ *         PutRequest: {
+ *           Item: {
+ *             AlbumTitle: {
+ *               S: "Somewhat Famous"
  *             },
- *             "Artist": {
- *               "S": "No One You Know"
+ *             Artist: {
+ *               S: "No One You Know"
  *             },
- *             "SongTitle": {
- *               "S": "Call Me Today"
+ *             SongTitle: {
+ *               S: "Call Me Today"
  *             }
  *           }
  *         }
  *       },
  *       {
- *         "PutRequest": {
- *           "Item": {
- *             "AlbumTitle": {
- *               "S": "Songs About Life"
+ *         PutRequest: {
+ *           Item: {
+ *             AlbumTitle: {
+ *               S: "Songs About Life"
  *             },
- *             "Artist": {
- *               "S": "Acme Band"
+ *             Artist: {
+ *               S: "Acme Band"
  *             },
- *             "SongTitle": {
- *               "S": "Happy Day"
+ *             SongTitle: {
+ *               S: "Happy Day"
  *             }
  *           }
  *         }
  *       },
  *       {
- *         "PutRequest": {
- *           "Item": {
- *             "AlbumTitle": {
- *               "S": "Blue Sky Blues"
+ *         PutRequest: {
+ *           Item: {
+ *             AlbumTitle: {
+ *               S: "Blue Sky Blues"
  *             },
- *             "Artist": {
- *               "S": "No One You Know"
+ *             Artist: {
+ *               S: "No One You Know"
  *             },
- *             "SongTitle": {
- *               "S": "Scared of My Shadow"
+ *             SongTitle: {
+ *               S: "Scared of My Shadow"
  *             }
  *           }
  *         }
@@ -378,10 +378,13 @@ declare const BatchWriteItemCommand_base: {
  *   }
  * };
  * const command = new BatchWriteItemCommand(input);
- * await client.send(command);
- * // example id: to-add-multiple-items-to-a-table-1476118519747
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class BatchWriteItemCommand extends BatchWriteItemCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/CreateBackupCommand.d.ts

@@ -128,6 +128,7 @@ declare const CreateBackupCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class CreateBackupCommand extends CreateBackupCommand_base {

package/dist-types/commands/CreateGlobalTableCommand.d.ts

@@ -187,6 +187,7 @@ declare const CreateGlobalTableCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class CreateGlobalTableCommand extends CreateGlobalTableCommand_base {

package/dist-types/commands/CreateTableCommand.d.ts

@@ -360,77 +360,8 @@ declare const CreateTableCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
- * @example To create a table
- * ```javascript
- * // This example creates a table named Music.
- * const input = {
- *   "AttributeDefinitions": [
- *     {
- *       "AttributeName": "Artist",
- *       "AttributeType": "S"
- *     },
- *     {
- *       "AttributeName": "SongTitle",
- *       "AttributeType": "S"
- *     }
- *   ],
- *   "KeySchema": [
- *     {
- *       "AttributeName": "Artist",
- *       "KeyType": "HASH"
- *     },
- *     {
- *       "AttributeName": "SongTitle",
- *       "KeyType": "RANGE"
- *     }
- *   ],
- *   "ProvisionedThroughput": {
- *     "ReadCapacityUnits": 5,
- *     "WriteCapacityUnits": 5
- *   },
- *   "TableName": "Music"
- * };
- * const command = new CreateTableCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "TableDescription": {
- *     "AttributeDefinitions": [
- *       {
- *         "AttributeName": "Artist",
- *         "AttributeType": "S"
- *       },
- *       {
- *         "AttributeName": "SongTitle",
- *         "AttributeType": "S"
- *       }
- *     ],
- *     "CreationDateTime": "1421866952.062",
- *     "ItemCount": 0,
- *     "KeySchema": [
- *       {
- *         "AttributeName": "Artist",
- *         "KeyType": "HASH"
- *       },
- *       {
- *         "AttributeName": "SongTitle",
- *         "KeyType": "RANGE"
- *       }
- *     ],
- *     "ProvisionedThroughput": {
- *       "ReadCapacityUnits": 5,
- *       "WriteCapacityUnits": 5
- *     },
- *     "TableName": "Music",
- *     "TableSizeBytes": 0,
- *     "TableStatus": "CREATING"
- *   }
- * }
- * *\/
- * // example id: to-create-a-table-1476116291743
- * ```
  *
+ * @public
  */
 export declare class CreateTableCommand extends CreateTableCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteBackupCommand.d.ts

@@ -175,6 +175,7 @@ declare const DeleteBackupCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteBackupCommand extends DeleteBackupCommand_base {

package/dist-types/commands/DeleteItemCommand.d.ts

@@ -242,34 +242,34 @@ declare const DeleteItemCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To delete an item
  * ```javascript
  * // This example deletes an item from the Music table.
  * const input = {
- *   "Key": {
- *     "Artist": {
- *       "S": "No One You Know"
+ *   Key: {
+ *     Artist: {
+ *       S: "No One You Know"
  *     },
- *     "SongTitle": {
- *       "S": "Scared of My Shadow"
+ *     SongTitle: {
+ *       S: "Scared of My Shadow"
  *     }
  *   },
- *   "TableName": "Music"
+ *   TableName: "Music"
  * };
  * const command = new DeleteItemCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ConsumedCapacity": {
- *     "CapacityUnits": 1,
- *     "TableName": "Music"
+ *   ConsumedCapacity: {
+ *     CapacityUnits: 1,
+ *     TableName: "Music"
  *   }
  * }
  * *\/
- * // example id: to-delete-an-item-1475884573758
  * ```
  *
+ * @public
  */
 export declare class DeleteItemCommand extends DeleteItemCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteResourcePolicyCommand.d.ts

@@ -120,6 +120,7 @@ declare const DeleteResourcePolicyCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteResourcePolicyCommand extends DeleteResourcePolicyCommand_base {

package/dist-types/commands/DeleteTableCommand.d.ts

@@ -285,33 +285,33 @@ declare const DeleteTableCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To delete a table
  * ```javascript
  * // This example deletes the Music table.
  * const input = {
- *   "TableName": "Music"
+ *   TableName: "Music"
  * };
  * const command = new DeleteTableCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TableDescription": {
- *     "ItemCount": 0,
- *     "ProvisionedThroughput": {
- *       "NumberOfDecreasesToday": 1,
- *       "ReadCapacityUnits": 5,
- *       "WriteCapacityUnits": 5
+ *   TableDescription: {
+ *     ItemCount: 0,
+ *     ProvisionedThroughput: {
+ *       NumberOfDecreasesToday: 1,
+ *       ReadCapacityUnits: 5,
+ *       WriteCapacityUnits: 5
  *     },
- *     "TableName": "Music",
- *     "TableSizeBytes": 0,
- *     "TableStatus": "DELETING"
+ *     TableName: "Music",
+ *     TableSizeBytes: 0,
+ *     TableStatus: "DELETING"
  *   }
  * }
  * *\/
- * // example id: to-delete-a-table-1475884368755
  * ```
  *
+ * @public
  */
 export declare class DeleteTableCommand extends DeleteTableCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeBackupCommand.d.ts

@@ -155,6 +155,7 @@ declare const DescribeBackupCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeBackupCommand extends DescribeBackupCommand_base {

package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts

@@ -82,6 +82,7 @@ declare const DescribeContinuousBackupsCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeContinuousBackupsCommand extends DescribeContinuousBackupsCommand_base {

package/dist-types/commands/DescribeContributorInsightsCommand.d.ts

@@ -73,6 +73,7 @@ declare const DescribeContributorInsightsCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeContributorInsightsCommand extends DescribeContributorInsightsCommand_base {

package/dist-types/commands/DescribeEndpointsCommand.d.ts

@@ -58,6 +58,7 @@ declare const DescribeEndpointsCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeEndpointsCommand extends DescribeEndpointsCommand_base {

package/dist-types/commands/DescribeExportCommand.d.ts

@@ -102,6 +102,7 @@ declare const DescribeExportCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeExportCommand extends DescribeExportCommand_base {

package/dist-types/commands/DescribeGlobalTableCommand.d.ts

@@ -112,6 +112,7 @@ declare const DescribeGlobalTableCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeGlobalTableCommand extends DescribeGlobalTableCommand_base {

package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts

@@ -158,6 +158,7 @@ declare const DescribeGlobalTableSettingsCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeGlobalTableSettingsCommand extends DescribeGlobalTableSettingsCommand_base {

package/dist-types/commands/DescribeImportCommand.d.ts

@@ -147,6 +147,7 @@ declare const DescribeImportCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeImportCommand extends DescribeImportCommand_base {

package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts

@@ -71,6 +71,7 @@ declare const DescribeKinesisStreamingDestinationCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeKinesisStreamingDestinationCommand extends DescribeKinesisStreamingDestinationCommand_base {

package/dist-types/commands/DescribeLimitsCommand.d.ts

@@ -129,24 +129,24 @@ declare const DescribeLimitsCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To determine capacity limits per table and account, in the current AWS region
  * ```javascript
  * // The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DescribeLimitsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "AccountMaxReadCapacityUnits": 20000,
- *   "AccountMaxWriteCapacityUnits": 20000,
- *   "TableMaxReadCapacityUnits": 10000,
- *   "TableMaxWriteCapacityUnits": 10000
+ *   AccountMaxReadCapacityUnits: 20000,
+ *   AccountMaxWriteCapacityUnits: 20000,
+ *   TableMaxReadCapacityUnits: 10000,
+ *   TableMaxWriteCapacityUnits: 10000
  * }
  * *\/
- * // example id: to-determine-capacity-limits-per-table-and-account-in-the-current-aws-region-1475884162064
  * ```
  *
+ * @public
  */
 export declare class DescribeLimitsCommand extends DescribeLimitsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeTableCommand.d.ts

@@ -245,54 +245,8 @@ declare const DescribeTableCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
- * @example To describe a table
- * ```javascript
- * // This example describes the Music table.
- * const input = {
- *   "TableName": "Music"
- * };
- * const command = new DescribeTableCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "Table": {
- *     "AttributeDefinitions": [
- *       {
- *         "AttributeName": "Artist",
- *         "AttributeType": "S"
- *       },
- *       {
- *         "AttributeName": "SongTitle",
- *         "AttributeType": "S"
- *       }
- *     ],
- *     "CreationDateTime": "1421866952.062",
- *     "ItemCount": 0,
- *     "KeySchema": [
- *       {
- *         "AttributeName": "Artist",
- *         "KeyType": "HASH"
- *       },
- *       {
- *         "AttributeName": "SongTitle",
- *         "KeyType": "RANGE"
- *       }
- *     ],
- *     "ProvisionedThroughput": {
- *       "NumberOfDecreasesToday": 1,
- *       "ReadCapacityUnits": 5,
- *       "WriteCapacityUnits": 5
- *     },
- *     "TableName": "Music",
- *     "TableSizeBytes": 0,
- *     "TableStatus": "ACTIVE"
- *   }
- * }
- * *\/
- * // example id: to-describe-a-table-1475884440502
- * ```
  *
+ * @public
  */
 export declare class DescribeTableCommand extends DescribeTableCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts

@@ -148,6 +148,7 @@ declare const DescribeTableReplicaAutoScalingCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeTableReplicaAutoScalingCommand extends DescribeTableReplicaAutoScalingCommand_base {

package/dist-types/commands/DescribeTimeToLiveCommand.d.ts

@@ -66,6 +66,7 @@ declare const DescribeTimeToLiveCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeTimeToLiveCommand extends DescribeTimeToLiveCommand_base {

package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts

@@ -104,6 +104,7 @@ declare const DisableKinesisStreamingDestinationCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class DisableKinesisStreamingDestinationCommand extends DisableKinesisStreamingDestinationCommand_base {

package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts

@@ -106,6 +106,7 @@ declare const EnableKinesisStreamingDestinationCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class EnableKinesisStreamingDestinationCommand extends EnableKinesisStreamingDestinationCommand_base {

package/dist-types/commands/ExecuteStatementCommand.d.ts

@@ -224,6 +224,7 @@ declare const ExecuteStatementCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class ExecuteStatementCommand extends ExecuteStatementCommand_base {

package/dist-types/commands/ExecuteTransactionCommand.d.ts

@@ -515,6 +515,7 @@ declare const ExecuteTransactionCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class ExecuteTransactionCommand extends ExecuteTransactionCommand_base {

package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts

@@ -129,6 +129,7 @@ declare const ExportTableToPointInTimeCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
+ *
  * @public
  */
 export declare class ExportTableToPointInTimeCommand extends ExportTableToPointInTimeCommand_base {