@aws-sdk/client-dynamodb 3.288.0 → 3.290.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +9 -0
- package/dist-types/commands/BatchGetItemCommand.d.ts +85 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +84 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +34 -0
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +26 -0
- package/dist-types/commands/CreateTableCommand.d.ts +94 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +26 -0
- package/dist-types/commands/DeleteItemCommand.d.ts +59 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +54 -0
- package/dist-types/commands/DescribeBackupCommand.d.ts +9 -0
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +8 -0
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeExportCommand.d.ts +20 -0
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +9 -0
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +9 -0
- package/dist-types/commands/DescribeImportCommand.d.ts +6 -0
- package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +10 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +23 -0
- package/dist-types/commands/DescribeTableCommand.d.ts +57 -0
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +8 -0
- package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +10 -0
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +28 -0
- package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +28 -0
- package/dist-types/commands/ExecuteStatementCommand.d.ts +34 -0
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +321 -0
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +31 -0
- package/dist-types/commands/GetItemCommand.d.ts +55 -0
- package/dist-types/commands/ImportTableCommand.d.ts +26 -0
- package/dist-types/commands/ListBackupsCommand.d.ts +6 -0
- package/dist-types/commands/ListContributorInsightsCommand.d.ts +8 -0
- package/dist-types/commands/ListExportsCommand.d.ts +17 -0
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +6 -0
- package/dist-types/commands/ListImportsCommand.d.ts +14 -0
- package/dist-types/commands/ListTablesCommand.d.ts +25 -0
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +10 -0
- package/dist-types/commands/PutItemCommand.d.ts +63 -0
- package/dist-types/commands/QueryCommand.d.ts +53 -0
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +33 -0
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +37 -0
- package/dist-types/commands/ScanCommand.d.ts +68 -0
- package/dist-types/commands/TagResourceCommand.d.ts +28 -0
- package/dist-types/commands/TransactGetItemsCommand.d.ts +254 -0
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +323 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +28 -0
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +13 -0
- package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +8 -0
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +19 -0
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +33 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +83 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +80 -0
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +26 -0
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +28 -0
- package/package.json +31 -31
|
@@ -36,6 +36,61 @@ export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {
|
|
|
36
36
|
* @see {@link GetItemCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link InternalServerError} (server fault)
|
|
40
|
+
* <p>An error occurred on the server side.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
45
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
46
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
47
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
48
|
+
* requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
51
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
52
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
53
|
+
* quota increase.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
56
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
57
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
58
|
+
*
|
|
59
|
+
*
|
|
60
|
+
* @example To read an item from a table
|
|
61
|
+
* ```javascript
|
|
62
|
+
* // 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.
|
|
63
|
+
* const input = {
|
|
64
|
+
* "Key": {
|
|
65
|
+
* "Artist": {
|
|
66
|
+
* "S": "Acme Band"
|
|
67
|
+
* },
|
|
68
|
+
* "SongTitle": {
|
|
69
|
+
* "S": "Happy Day"
|
|
70
|
+
* }
|
|
71
|
+
* },
|
|
72
|
+
* "TableName": "Music"
|
|
73
|
+
* };
|
|
74
|
+
* const command = new GetItemCommand(input);
|
|
75
|
+
* const response = await client.send(command);
|
|
76
|
+
* /* response ==
|
|
77
|
+
* {
|
|
78
|
+
* "Item": {
|
|
79
|
+
* "AlbumTitle": {
|
|
80
|
+
* "S": "Songs About Life"
|
|
81
|
+
* },
|
|
82
|
+
* "Artist": {
|
|
83
|
+
* "S": "Acme Band"
|
|
84
|
+
* },
|
|
85
|
+
* "SongTitle": {
|
|
86
|
+
* "S": "Happy Day"
|
|
87
|
+
* }
|
|
88
|
+
* }
|
|
89
|
+
* }
|
|
90
|
+
* *\/
|
|
91
|
+
* // example id: to-read-an-item-from-a-table-1475884258350
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
39
94
|
*/
|
|
40
95
|
export declare class GetItemCommand extends $Command<GetItemCommandInput, GetItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
41
96
|
readonly input: GetItemCommandInput;
|
|
@@ -29,6 +29,32 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
|
|
|
29
29
|
* @see {@link ImportTableCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ImportConflictException} (client fault)
|
|
33
|
+
* <p>
|
|
34
|
+
* There was a conflict when importing from the specified S3 source.
|
|
35
|
+
* This can occur when the current import conflicts with a previous import request
|
|
36
|
+
* that had the same client token.
|
|
37
|
+
* </p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
40
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
41
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
42
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
43
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
44
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
45
|
+
* <p>When you are creating a table with one or more secondary
|
|
46
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
47
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
48
|
+
* of concurrent operations.</p>
|
|
49
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
50
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
53
|
+
* <p>The operation conflicts with the resource's availability. For example, you
|
|
54
|
+
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
55
|
+
* <code>CREATING</code> state.</p>
|
|
56
|
+
*
|
|
57
|
+
*
|
|
32
58
|
*/
|
|
33
59
|
export declare class ImportTableCommand extends $Command<ImportTableCommandInput, ImportTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
34
60
|
readonly input: ImportTableCommandInput;
|
|
@@ -35,6 +35,12 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB
|
|
|
35
35
|
* @see {@link ListBackupsCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link InternalServerError} (server fault)
|
|
39
|
+
* <p>An error occurred on the server side.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
42
|
+
*
|
|
43
|
+
*
|
|
38
44
|
*/
|
|
39
45
|
export declare class ListBackupsCommand extends $Command<ListBackupsCommandInput, ListBackupsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
40
46
|
readonly input: ListBackupsCommandInput;
|
|
@@ -30,6 +30,14 @@ export interface ListContributorInsightsCommandOutput extends ListContributorIns
|
|
|
30
30
|
* @see {@link ListContributorInsightsCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link InternalServerError} (server fault)
|
|
34
|
+
* <p>An error occurred on the server side.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
37
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
38
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
39
|
+
*
|
|
40
|
+
*
|
|
33
41
|
*/
|
|
34
42
|
export declare class ListContributorInsightsCommand extends $Command<ListContributorInsightsCommandInput, ListContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
35
43
|
readonly input: ListContributorInsightsCommandInput;
|
|
@@ -29,6 +29,23 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
|
|
|
29
29
|
* @see {@link ListExportsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InternalServerError} (server fault)
|
|
33
|
+
* <p>An error occurred on the server side.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
36
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
37
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
38
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
39
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
40
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
41
|
+
* <p>When you are creating a table with one or more secondary
|
|
42
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
43
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
44
|
+
* of concurrent operations.</p>
|
|
45
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
46
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
32
49
|
*/
|
|
33
50
|
export declare class ListExportsCommand extends $Command<ListExportsCommandInput, ListExportsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
34
51
|
readonly input: ListExportsCommandInput;
|
|
@@ -41,6 +41,12 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
|
|
|
41
41
|
* @see {@link ListGlobalTablesCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link InternalServerError} (server fault)
|
|
45
|
+
* <p>An error occurred on the server side.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
48
|
+
*
|
|
49
|
+
*
|
|
44
50
|
*/
|
|
45
51
|
export declare class ListGlobalTablesCommand extends $Command<ListGlobalTablesCommandInput, ListGlobalTablesCommandOutput, DynamoDBClientResolvedConfig> {
|
|
46
52
|
readonly input: ListGlobalTablesCommandInput;
|
|
@@ -29,6 +29,20 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
|
|
|
29
29
|
* @see {@link ListImportsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
33
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
34
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
35
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
36
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
37
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
38
|
+
* <p>When you are creating a table with one or more secondary
|
|
39
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
40
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
41
|
+
* of concurrent operations.</p>
|
|
42
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
43
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
32
46
|
*/
|
|
33
47
|
export declare class ListImportsCommand extends $Command<ListImportsCommandInput, ListImportsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
34
48
|
readonly input: ListImportsCommandInput;
|
|
@@ -31,6 +31,31 @@ export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBea
|
|
|
31
31
|
* @see {@link ListTablesCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link InternalServerError} (server fault)
|
|
35
|
+
* <p>An error occurred on the server side.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
38
|
+
*
|
|
39
|
+
*
|
|
40
|
+
* @example To list tables
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // This example lists all of the tables associated with the current AWS account and endpoint.
|
|
43
|
+
* const input = {};
|
|
44
|
+
* const command = new ListTablesCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* /* response ==
|
|
47
|
+
* {
|
|
48
|
+
* "TableNames": [
|
|
49
|
+
* "Forum",
|
|
50
|
+
* "ProductCatalog",
|
|
51
|
+
* "Reply",
|
|
52
|
+
* "Thread"
|
|
53
|
+
* ]
|
|
54
|
+
* }
|
|
55
|
+
* *\/
|
|
56
|
+
* // example id: to-list-tables-1475884741238
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
34
59
|
*/
|
|
35
60
|
export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, DynamoDBClientResolvedConfig> {
|
|
36
61
|
readonly input: ListTablesCommandInput;
|
|
@@ -32,6 +32,16 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu
|
|
|
32
32
|
* @see {@link ListTagsOfResourceCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link InternalServerError} (server fault)
|
|
36
|
+
* <p>An error occurred on the server side.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
41
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
42
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
35
45
|
*/
|
|
36
46
|
export declare class ListTagsOfResourceCommand extends $Command<ListTagsOfResourceCommandInput, ListTagsOfResourceCommandOutput, DynamoDBClientResolvedConfig> {
|
|
37
47
|
readonly input: ListTagsOfResourceCommandInput;
|
|
@@ -50,6 +50,69 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
|
|
|
50
50
|
* @see {@link PutItemCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link ConditionalCheckFailedException} (client fault)
|
|
54
|
+
* <p>A condition specified in the operation could not be evaluated.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InternalServerError} (server fault)
|
|
57
|
+
* <p>An error occurred on the server side.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ItemCollectionSizeLimitExceededException} (client fault)
|
|
62
|
+
* <p>An item collection is too large. This exception is only returned for tables that
|
|
63
|
+
* have one or more local secondary indexes.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
66
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
67
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
68
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
69
|
+
* requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
72
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
73
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
74
|
+
* quota increase.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
78
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link TransactionConflictException} (client fault)
|
|
81
|
+
* <p>Operation was rejected because there is an ongoing transaction for the
|
|
82
|
+
* item.</p>
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* @example To add an item to a table
|
|
86
|
+
* ```javascript
|
|
87
|
+
* // This example adds a new item to the Music table.
|
|
88
|
+
* const input = {
|
|
89
|
+
* "Item": {
|
|
90
|
+
* "AlbumTitle": {
|
|
91
|
+
* "S": "Somewhat Famous"
|
|
92
|
+
* },
|
|
93
|
+
* "Artist": {
|
|
94
|
+
* "S": "No One You Know"
|
|
95
|
+
* },
|
|
96
|
+
* "SongTitle": {
|
|
97
|
+
* "S": "Call Me Today"
|
|
98
|
+
* }
|
|
99
|
+
* },
|
|
100
|
+
* "ReturnConsumedCapacity": "TOTAL",
|
|
101
|
+
* "TableName": "Music"
|
|
102
|
+
* };
|
|
103
|
+
* const command = new PutItemCommand(input);
|
|
104
|
+
* const response = await client.send(command);
|
|
105
|
+
* /* response ==
|
|
106
|
+
* {
|
|
107
|
+
* "ConsumedCapacity": {
|
|
108
|
+
* "CapacityUnits": 1,
|
|
109
|
+
* "TableName": "Music"
|
|
110
|
+
* }
|
|
111
|
+
* }
|
|
112
|
+
* *\/
|
|
113
|
+
* // example id: to-add-an-item-to-a-table-1476116191110
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
53
116
|
*/
|
|
54
117
|
export declare class PutItemCommand extends $Command<PutItemCommandInput, PutItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
55
118
|
readonly input: PutItemCommandInput;
|
|
@@ -79,6 +79,59 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
|
|
|
79
79
|
* @see {@link QueryCommandOutput} for command's `response` shape.
|
|
80
80
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
81
81
|
*
|
|
82
|
+
* @throws {@link InternalServerError} (server fault)
|
|
83
|
+
* <p>An error occurred on the server side.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
88
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
89
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
90
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
91
|
+
* requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
94
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
95
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
96
|
+
* quota increase.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
99
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
100
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @example To query an item
|
|
104
|
+
* ```javascript
|
|
105
|
+
* // 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".
|
|
106
|
+
* const input = {
|
|
107
|
+
* "ExpressionAttributeValues": {
|
|
108
|
+
* ":v1": {
|
|
109
|
+
* "S": "No One You Know"
|
|
110
|
+
* }
|
|
111
|
+
* },
|
|
112
|
+
* "KeyConditionExpression": "Artist = :v1",
|
|
113
|
+
* "ProjectionExpression": "SongTitle",
|
|
114
|
+
* "TableName": "Music"
|
|
115
|
+
* };
|
|
116
|
+
* const command = new QueryCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* /* response ==
|
|
119
|
+
* {
|
|
120
|
+
* "ConsumedCapacity": {},
|
|
121
|
+
* "Count": 2,
|
|
122
|
+
* "Items": [
|
|
123
|
+
* {
|
|
124
|
+
* "SongTitle": {
|
|
125
|
+
* "S": "Call Me Today"
|
|
126
|
+
* }
|
|
127
|
+
* }
|
|
128
|
+
* ],
|
|
129
|
+
* "ScannedCount": 2
|
|
130
|
+
* }
|
|
131
|
+
* *\/
|
|
132
|
+
* // example id: to-query-an-item-1475883874631
|
|
133
|
+
* ```
|
|
134
|
+
*
|
|
82
135
|
*/
|
|
83
136
|
export declare class QueryCommand extends $Command<QueryCommandInput, QueryCommandOutput, DynamoDBClientResolvedConfig> {
|
|
84
137
|
readonly input: QueryCommandInput;
|
|
@@ -53,6 +53,39 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac
|
|
|
53
53
|
* @see {@link RestoreTableFromBackupCommandOutput} for command's `response` shape.
|
|
54
54
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
55
55
|
*
|
|
56
|
+
* @throws {@link BackupInUseException} (client fault)
|
|
57
|
+
* <p>There is another ongoing conflicting backup control plane operation on the table.
|
|
58
|
+
* The backup is either being created, deleted or restored to a table.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link BackupNotFoundException} (client fault)
|
|
61
|
+
* <p>Backup not found for the given BackupARN. </p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerError} (server fault)
|
|
64
|
+
* <p>An error occurred on the server side.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
69
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
70
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
71
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
72
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
73
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
74
|
+
* <p>When you are creating a table with one or more secondary
|
|
75
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
76
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
77
|
+
* of concurrent operations.</p>
|
|
78
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
79
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link TableAlreadyExistsException} (client fault)
|
|
82
|
+
* <p>A target table with the specified name already exists. </p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link TableInUseException} (client fault)
|
|
85
|
+
* <p>A target table with the specified name is either being created or deleted.
|
|
86
|
+
* </p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
56
89
|
*/
|
|
57
90
|
export declare class RestoreTableFromBackupCommand extends $Command<RestoreTableFromBackupCommandInput, RestoreTableFromBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
58
91
|
readonly input: RestoreTableFromBackupCommandInput;
|
|
@@ -78,6 +78,43 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
|
|
|
78
78
|
* @see {@link RestoreTableToPointInTimeCommandOutput} for command's `response` shape.
|
|
79
79
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
80
80
|
*
|
|
81
|
+
* @throws {@link InternalServerError} (server fault)
|
|
82
|
+
* <p>An error occurred on the server side.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidRestoreTimeException} (client fault)
|
|
87
|
+
* <p>An invalid restore time was specified. RestoreDateTime must be between
|
|
88
|
+
* EarliestRestorableDateTime and LatestRestorableDateTime.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
91
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
92
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
93
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
94
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
95
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
96
|
+
* <p>When you are creating a table with one or more secondary
|
|
97
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
98
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
99
|
+
* of concurrent operations.</p>
|
|
100
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
101
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link PointInTimeRecoveryUnavailableException} (client fault)
|
|
104
|
+
* <p>Point in time recovery has not yet been enabled for this source table.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link TableAlreadyExistsException} (client fault)
|
|
107
|
+
* <p>A target table with the specified name already exists. </p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link TableInUseException} (client fault)
|
|
110
|
+
* <p>A target table with the specified name is either being created or deleted.
|
|
111
|
+
* </p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link TableNotFoundException} (client fault)
|
|
114
|
+
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
115
|
+
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
116
|
+
*
|
|
117
|
+
*
|
|
81
118
|
*/
|
|
82
119
|
export declare class RestoreTableToPointInTimeCommand extends $Command<RestoreTableToPointInTimeCommandInput, RestoreTableToPointInTimeCommandOutput, DynamoDBClientResolvedConfig> {
|
|
83
120
|
readonly input: RestoreTableToPointInTimeCommandInput;
|
|
@@ -54,6 +54,74 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
|
|
|
54
54
|
* @see {@link ScanCommandOutput} for command's `response` shape.
|
|
55
55
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
56
56
|
*
|
|
57
|
+
* @throws {@link InternalServerError} (server fault)
|
|
58
|
+
* <p>An error occurred on the server side.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
63
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
64
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
65
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
66
|
+
* requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
69
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
70
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
71
|
+
* quota increase.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
75
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @example To scan a table
|
|
79
|
+
* ```javascript
|
|
80
|
+
* // 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.
|
|
81
|
+
* const input = {
|
|
82
|
+
* "ExpressionAttributeNames": {
|
|
83
|
+
* "#AT": "AlbumTitle",
|
|
84
|
+
* "#ST": "SongTitle"
|
|
85
|
+
* },
|
|
86
|
+
* "ExpressionAttributeValues": {
|
|
87
|
+
* ":a": {
|
|
88
|
+
* "S": "No One You Know"
|
|
89
|
+
* }
|
|
90
|
+
* },
|
|
91
|
+
* "FilterExpression": "Artist = :a",
|
|
92
|
+
* "ProjectionExpression": "#ST, #AT",
|
|
93
|
+
* "TableName": "Music"
|
|
94
|
+
* };
|
|
95
|
+
* const command = new ScanCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response ==
|
|
98
|
+
* {
|
|
99
|
+
* "ConsumedCapacity": {},
|
|
100
|
+
* "Count": 2,
|
|
101
|
+
* "Items": [
|
|
102
|
+
* {
|
|
103
|
+
* "AlbumTitle": {
|
|
104
|
+
* "S": "Somewhat Famous"
|
|
105
|
+
* },
|
|
106
|
+
* "SongTitle": {
|
|
107
|
+
* "S": "Call Me Today"
|
|
108
|
+
* }
|
|
109
|
+
* },
|
|
110
|
+
* {
|
|
111
|
+
* "AlbumTitle": {
|
|
112
|
+
* "S": "Blue Sky Blues"
|
|
113
|
+
* },
|
|
114
|
+
* "SongTitle": {
|
|
115
|
+
* "S": "Scared of My Shadow"
|
|
116
|
+
* }
|
|
117
|
+
* }
|
|
118
|
+
* ],
|
|
119
|
+
* "ScannedCount": 3
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* // example id: to-scan-a-table-1475883652470
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
57
125
|
*/
|
|
58
126
|
export declare class ScanCommand extends $Command<ScanCommandInput, ScanCommandOutput, DynamoDBClientResolvedConfig> {
|
|
59
127
|
readonly input: ScanCommandInput;
|
|
@@ -34,6 +34,34 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
34
34
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link InternalServerError} (server fault)
|
|
38
|
+
* <p>An error occurred on the server side.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
43
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
44
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
45
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
46
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
47
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
48
|
+
* <p>When you are creating a table with one or more secondary
|
|
49
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
50
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
51
|
+
* of concurrent operations.</p>
|
|
52
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
53
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
56
|
+
* <p>The operation conflicts with the resource's availability. For example, you
|
|
57
|
+
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
58
|
+
* <code>CREATING</code> state.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
62
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
63
|
+
*
|
|
64
|
+
*
|
|
37
65
|
*/
|
|
38
66
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, DynamoDBClientResolvedConfig> {
|
|
39
67
|
readonly input: TagResourceCommandInput;
|