@aws-sdk/client-dynamodb 3.774.0 → 3.777.0

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 {

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

@@ -204,41 +204,41 @@ declare const GetItemCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To read an item from a table
  * ```javascript
  * // This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.
  * const input = {
- *   "Key": {
- *     "Artist": {
- *       "S": "Acme Band"
+ *   Key: {
+ *     Artist: {
+ *       S: "Acme Band"
  *     },
- *     "SongTitle": {
- *       "S": "Happy Day"
+ *     SongTitle: {
+ *       S: "Happy Day"
  *     }
  *   },
- *   "TableName": "Music"
+ *   TableName: "Music"
  * };
  * const command = new GetItemCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Item": {
- *     "AlbumTitle": {
- *       "S": "Songs About Life"
+ *   Item: {
+ *     AlbumTitle: {
+ *       S: "Songs About Life"
  *     },
- *     "Artist": {
- *       "S": "Acme Band"
+ *     Artist: {
+ *       S: "Acme Band"
  *     },
- *     "SongTitle": {
- *       "S": "Happy Day"
+ *     SongTitle: {
+ *       S: "Happy Day"
  *     }
  *   }
  * }
  * *\/
- * // example id: to-read-an-item-from-a-table-1475884258350
  * ```
  *
+ * @public
  */
 export declare class GetItemCommand extends GetItemCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -65,16 +65,16 @@ declare const ListTablesCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To list tables
  * ```javascript
  * // This example lists all of the tables associated with the current AWS account and endpoint.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new ListTablesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TableNames": [
+ *   TableNames: [
  *     "Forum",
  *     "ProductCatalog",
  *     "Reply",
@@ -82,9 +82,9 @@ declare const ListTablesCommand_base: {
  *   ]
  * }
  * *\/
- * // example id: to-list-tables-1475884741238
  * ```
  *
+ * @public
  */
 export declare class ListTablesCommand extends ListTablesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -252,38 +252,38 @@ declare const PutItemCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To add an item to a table
  * ```javascript
  * // This example adds a new item to the Music table.
  * const input = {
- *   "Item": {
- *     "AlbumTitle": {
- *       "S": "Somewhat Famous"
+ *   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"
  *     }
  *   },
- *   "ReturnConsumedCapacity": "TOTAL",
- *   "TableName": "Music"
+ *   ReturnConsumedCapacity: "TOTAL",
+ *   TableName: "Music"
  * };
  * const command = new PutItemCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ConsumedCapacity": {
- *     "CapacityUnits": 1,
- *     "TableName": "Music"
+ *   ConsumedCapacity: {
+ *     CapacityUnits: 1,
+ *     TableName: "Music"
  *   }
  * }
  * *\/
- * // example id: to-add-an-item-to-a-table-1476116191110
  * ```
  *
+ * @public
  */
 export declare class PutItemCommand extends PutItemCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -280,39 +280,39 @@ declare const QueryCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To query an item
  * ```javascript
  * // This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named "No One You Know".
  * const input = {
- *   "ExpressionAttributeValues": {
- *     ":v1": {
- *       "S": "No One You Know"
+ *   ExpressionAttributeValues: {
+ *     :v1: {
+ *       S: "No One You Know"
  *     }
  *   },
- *   "KeyConditionExpression": "Artist = :v1",
- *   "ProjectionExpression": "SongTitle",
- *   "TableName": "Music"
+ *   KeyConditionExpression: "Artist = :v1",
+ *   ProjectionExpression: "SongTitle",
+ *   TableName: "Music"
  * };
  * const command = new QueryCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ConsumedCapacity": {},
- *   "Count": 2,
- *   "Items": [
+ *   ConsumedCapacity:   { /* empty *\/ },
+ *   Count: 2,
+ *   Items: [
  *     {
- *       "SongTitle": {
- *         "S": "Call Me Today"
+ *       SongTitle: {
+ *         S: "Call Me Today"
  *       }
  *     }
  *   ],
- *   "ScannedCount": 2
+ *   ScannedCount: 2
  * }
  * *\/
- * // example id: to-query-an-item-1475883874631
  * ```
  *
+ * @public
  */
 export declare class QueryCommand extends QueryCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

@@ -264,54 +264,54 @@ declare const ScanCommand_base: {
  * @throws {@link DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>
  *
- * @public
+ *
  * @example To scan a table
  * ```javascript
  * // This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned.
  * const input = {
- *   "ExpressionAttributeNames": {
- *     "#AT": "AlbumTitle",
- *     "#ST": "SongTitle"
+ *   ExpressionAttributeNames: {
+ *     #AT: "AlbumTitle",
+ *     #ST: "SongTitle"
  *   },
- *   "ExpressionAttributeValues": {
- *     ":a": {
- *       "S": "No One You Know"
+ *   ExpressionAttributeValues: {
+ *     :a: {
+ *       S: "No One You Know"
  *     }
  *   },
- *   "FilterExpression": "Artist = :a",
- *   "ProjectionExpression": "#ST, #AT",
- *   "TableName": "Music"
+ *   FilterExpression: "Artist = :a",
+ *   ProjectionExpression: "#ST, #AT",
+ *   TableName: "Music"
  * };
  * const command = new ScanCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ConsumedCapacity": {},
- *   "Count": 2,
- *   "Items": [
+ *   ConsumedCapacity:   { /* empty *\/ },
+ *   Count: 2,
+ *   Items: [
  *     {
- *       "AlbumTitle": {
- *         "S": "Somewhat Famous"
+ *       AlbumTitle: {
+ *         S: "Somewhat Famous"
  *       },
- *       "SongTitle": {
- *         "S": "Call Me Today"
+ *       SongTitle: {
+ *         S: "Call Me Today"
  *       }
  *     },
  *     {
- *       "AlbumTitle": {
- *         "S": "Blue Sky Blues"
+ *       AlbumTitle: {
+ *         S: "Blue Sky Blues"
  *       },
- *       "SongTitle": {
- *         "S": "Scared of My Shadow"
+ *       SongTitle: {
+ *         S: "Scared of My Shadow"
  *       }
  *     }
  *   ],
- *   "ScannedCount": 3
+ *   ScannedCount: 3
  * }
  * *\/
- * // example id: to-scan-a-table-1475883652470
  * ```
  *
+ * @public
  */
 export declare class ScanCommand extends ScanCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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