@aws-sdk/client-dynamodb 3.288.0 → 3.289.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/BatchGetItemCommand.d.ts +64 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +59 -0
- package/dist-types/commands/CreateTableCommand.d.ts +70 -0
- package/dist-types/commands/DeleteItemCommand.d.ts +27 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +26 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +17 -0
- package/dist-types/commands/DescribeTableCommand.d.ts +47 -0
- package/dist-types/commands/GetItemCommand.d.ts +34 -0
- package/dist-types/commands/ListTablesCommand.d.ts +19 -0
- package/dist-types/commands/PutItemCommand.d.ts +31 -0
- package/dist-types/commands/QueryCommand.d.ts +32 -0
- package/dist-types/commands/ScanCommand.d.ts +47 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +51 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +52 -0
- package/package.json +31 -31
|
@@ -75,6 +75,70 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
75
75
|
* @see {@link BatchGetItemCommandOutput} for command's `response` shape.
|
|
76
76
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
77
77
|
*
|
|
78
|
+
* @example To retrieve multiple items from a table
|
|
79
|
+
* ```javascript
|
|
80
|
+
* // This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.
|
|
81
|
+
* const input = {
|
|
82
|
+
* "RequestItems": {
|
|
83
|
+
* "Music": {
|
|
84
|
+
* "Keys": [
|
|
85
|
+
* {
|
|
86
|
+
* "Artist": {
|
|
87
|
+
* "S": "No One You Know"
|
|
88
|
+
* },
|
|
89
|
+
* "SongTitle": {
|
|
90
|
+
* "S": "Call Me Today"
|
|
91
|
+
* }
|
|
92
|
+
* },
|
|
93
|
+
* {
|
|
94
|
+
* "Artist": {
|
|
95
|
+
* "S": "Acme Band"
|
|
96
|
+
* },
|
|
97
|
+
* "SongTitle": {
|
|
98
|
+
* "S": "Happy Day"
|
|
99
|
+
* }
|
|
100
|
+
* },
|
|
101
|
+
* {
|
|
102
|
+
* "Artist": {
|
|
103
|
+
* "S": "No One You Know"
|
|
104
|
+
* },
|
|
105
|
+
* "SongTitle": {
|
|
106
|
+
* "S": "Scared of My Shadow"
|
|
107
|
+
* }
|
|
108
|
+
* }
|
|
109
|
+
* ],
|
|
110
|
+
* "ProjectionExpression": "AlbumTitle"
|
|
111
|
+
* }
|
|
112
|
+
* }
|
|
113
|
+
* };
|
|
114
|
+
* const command = new BatchGetItemCommand(input);
|
|
115
|
+
* const response = await client.send(command);
|
|
116
|
+
* /* response ==
|
|
117
|
+
* {
|
|
118
|
+
* "Responses": {
|
|
119
|
+
* "Music": [
|
|
120
|
+
* {
|
|
121
|
+
* "AlbumTitle": {
|
|
122
|
+
* "S": "Somewhat Famous"
|
|
123
|
+
* }
|
|
124
|
+
* },
|
|
125
|
+
* {
|
|
126
|
+
* "AlbumTitle": {
|
|
127
|
+
* "S": "Blue Sky Blues"
|
|
128
|
+
* }
|
|
129
|
+
* },
|
|
130
|
+
* {
|
|
131
|
+
* "AlbumTitle": {
|
|
132
|
+
* "S": "Louder Than Ever"
|
|
133
|
+
* }
|
|
134
|
+
* }
|
|
135
|
+
* ]
|
|
136
|
+
* }
|
|
137
|
+
* }
|
|
138
|
+
* *\/
|
|
139
|
+
* // example id: to-retrieve-multiple-items-from-a-table-1476118438992
|
|
140
|
+
* ```
|
|
141
|
+
*
|
|
78
142
|
*/
|
|
79
143
|
export declare class BatchGetItemCommand extends $Command<BatchGetItemCommandInput, BatchGetItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
80
144
|
readonly input: BatchGetItemCommandInput;
|
|
@@ -110,6 +110,65 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
110
110
|
* @see {@link BatchWriteItemCommandOutput} for command's `response` shape.
|
|
111
111
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
112
112
|
*
|
|
113
|
+
* @example To add multiple items to a table
|
|
114
|
+
* ```javascript
|
|
115
|
+
* // This example adds three new items to the Music table using a batch of three PutItem requests.
|
|
116
|
+
* const input = {
|
|
117
|
+
* "RequestItems": {
|
|
118
|
+
* "Music": [
|
|
119
|
+
* {
|
|
120
|
+
* "PutRequest": {
|
|
121
|
+
* "Item": {
|
|
122
|
+
* "AlbumTitle": {
|
|
123
|
+
* "S": "Somewhat Famous"
|
|
124
|
+
* },
|
|
125
|
+
* "Artist": {
|
|
126
|
+
* "S": "No One You Know"
|
|
127
|
+
* },
|
|
128
|
+
* "SongTitle": {
|
|
129
|
+
* "S": "Call Me Today"
|
|
130
|
+
* }
|
|
131
|
+
* }
|
|
132
|
+
* }
|
|
133
|
+
* },
|
|
134
|
+
* {
|
|
135
|
+
* "PutRequest": {
|
|
136
|
+
* "Item": {
|
|
137
|
+
* "AlbumTitle": {
|
|
138
|
+
* "S": "Songs About Life"
|
|
139
|
+
* },
|
|
140
|
+
* "Artist": {
|
|
141
|
+
* "S": "Acme Band"
|
|
142
|
+
* },
|
|
143
|
+
* "SongTitle": {
|
|
144
|
+
* "S": "Happy Day"
|
|
145
|
+
* }
|
|
146
|
+
* }
|
|
147
|
+
* }
|
|
148
|
+
* },
|
|
149
|
+
* {
|
|
150
|
+
* "PutRequest": {
|
|
151
|
+
* "Item": {
|
|
152
|
+
* "AlbumTitle": {
|
|
153
|
+
* "S": "Blue Sky Blues"
|
|
154
|
+
* },
|
|
155
|
+
* "Artist": {
|
|
156
|
+
* "S": "No One You Know"
|
|
157
|
+
* },
|
|
158
|
+
* "SongTitle": {
|
|
159
|
+
* "S": "Scared of My Shadow"
|
|
160
|
+
* }
|
|
161
|
+
* }
|
|
162
|
+
* }
|
|
163
|
+
* }
|
|
164
|
+
* ]
|
|
165
|
+
* }
|
|
166
|
+
* };
|
|
167
|
+
* const command = new BatchWriteItemCommand(input);
|
|
168
|
+
* await client.send(command);
|
|
169
|
+
* // example id: to-add-multiple-items-to-a-table-1476118519747
|
|
170
|
+
* ```
|
|
171
|
+
*
|
|
113
172
|
*/
|
|
114
173
|
export declare class BatchWriteItemCommand extends $Command<BatchWriteItemCommandInput, BatchWriteItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
115
174
|
readonly input: BatchWriteItemCommandInput;
|
|
@@ -41,6 +41,76 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
|
|
|
41
41
|
* @see {@link CreateTableCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @example To create a table
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // This example creates a table named Music.
|
|
47
|
+
* const input = {
|
|
48
|
+
* "AttributeDefinitions": [
|
|
49
|
+
* {
|
|
50
|
+
* "AttributeName": "Artist",
|
|
51
|
+
* "AttributeType": "S"
|
|
52
|
+
* },
|
|
53
|
+
* {
|
|
54
|
+
* "AttributeName": "SongTitle",
|
|
55
|
+
* "AttributeType": "S"
|
|
56
|
+
* }
|
|
57
|
+
* ],
|
|
58
|
+
* "KeySchema": [
|
|
59
|
+
* {
|
|
60
|
+
* "AttributeName": "Artist",
|
|
61
|
+
* "KeyType": "HASH"
|
|
62
|
+
* },
|
|
63
|
+
* {
|
|
64
|
+
* "AttributeName": "SongTitle",
|
|
65
|
+
* "KeyType": "RANGE"
|
|
66
|
+
* }
|
|
67
|
+
* ],
|
|
68
|
+
* "ProvisionedThroughput": {
|
|
69
|
+
* "ReadCapacityUnits": 5,
|
|
70
|
+
* "WriteCapacityUnits": 5
|
|
71
|
+
* },
|
|
72
|
+
* "TableName": "Music"
|
|
73
|
+
* };
|
|
74
|
+
* const command = new CreateTableCommand(input);
|
|
75
|
+
* const response = await client.send(command);
|
|
76
|
+
* /* response ==
|
|
77
|
+
* {
|
|
78
|
+
* "TableDescription": {
|
|
79
|
+
* "AttributeDefinitions": [
|
|
80
|
+
* {
|
|
81
|
+
* "AttributeName": "Artist",
|
|
82
|
+
* "AttributeType": "S"
|
|
83
|
+
* },
|
|
84
|
+
* {
|
|
85
|
+
* "AttributeName": "SongTitle",
|
|
86
|
+
* "AttributeType": "S"
|
|
87
|
+
* }
|
|
88
|
+
* ],
|
|
89
|
+
* "CreationDateTime": "1421866952.062",
|
|
90
|
+
* "ItemCount": 0,
|
|
91
|
+
* "KeySchema": [
|
|
92
|
+
* {
|
|
93
|
+
* "AttributeName": "Artist",
|
|
94
|
+
* "KeyType": "HASH"
|
|
95
|
+
* },
|
|
96
|
+
* {
|
|
97
|
+
* "AttributeName": "SongTitle",
|
|
98
|
+
* "KeyType": "RANGE"
|
|
99
|
+
* }
|
|
100
|
+
* ],
|
|
101
|
+
* "ProvisionedThroughput": {
|
|
102
|
+
* "ReadCapacityUnits": 5,
|
|
103
|
+
* "WriteCapacityUnits": 5
|
|
104
|
+
* },
|
|
105
|
+
* "TableName": "Music",
|
|
106
|
+
* "TableSizeBytes": 0,
|
|
107
|
+
* "TableStatus": "CREATING"
|
|
108
|
+
* }
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* // example id: to-create-a-table-1476116291743
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
44
114
|
*/
|
|
45
115
|
export declare class CreateTableCommand extends $Command<CreateTableCommandInput, CreateTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
46
116
|
readonly input: CreateTableCommandInput;
|
|
@@ -39,6 +39,33 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
|
|
|
39
39
|
* @see {@link DeleteItemCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @example To delete an item
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // This example deletes an item from the Music table.
|
|
45
|
+
* const input = {
|
|
46
|
+
* "Key": {
|
|
47
|
+
* "Artist": {
|
|
48
|
+
* "S": "No One You Know"
|
|
49
|
+
* },
|
|
50
|
+
* "SongTitle": {
|
|
51
|
+
* "S": "Scared of My Shadow"
|
|
52
|
+
* }
|
|
53
|
+
* },
|
|
54
|
+
* "TableName": "Music"
|
|
55
|
+
* };
|
|
56
|
+
* const command = new DeleteItemCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* /* response ==
|
|
59
|
+
* {
|
|
60
|
+
* "ConsumedCapacity": {
|
|
61
|
+
* "CapacityUnits": 1,
|
|
62
|
+
* "TableName": "Music"
|
|
63
|
+
* }
|
|
64
|
+
* }
|
|
65
|
+
* *\/
|
|
66
|
+
* // example id: to-delete-an-item-1475884573758
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
42
69
|
*/
|
|
43
70
|
export declare class DeleteItemCommand extends $Command<DeleteItemCommandInput, DeleteItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
44
71
|
readonly input: DeleteItemCommandInput;
|
|
@@ -51,6 +51,32 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
|
|
|
51
51
|
* @see {@link DeleteTableCommandOutput} for command's `response` shape.
|
|
52
52
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
53
53
|
*
|
|
54
|
+
* @example To delete a table
|
|
55
|
+
* ```javascript
|
|
56
|
+
* // This example deletes the Music table.
|
|
57
|
+
* const input = {
|
|
58
|
+
* "TableName": "Music"
|
|
59
|
+
* };
|
|
60
|
+
* const command = new DeleteTableCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* /* response ==
|
|
63
|
+
* {
|
|
64
|
+
* "TableDescription": {
|
|
65
|
+
* "ItemCount": 0,
|
|
66
|
+
* "ProvisionedThroughput": {
|
|
67
|
+
* "NumberOfDecreasesToday": 1,
|
|
68
|
+
* "ReadCapacityUnits": 5,
|
|
69
|
+
* "WriteCapacityUnits": 5
|
|
70
|
+
* },
|
|
71
|
+
* "TableName": "Music",
|
|
72
|
+
* "TableSizeBytes": 0,
|
|
73
|
+
* "TableStatus": "DELETING"
|
|
74
|
+
* }
|
|
75
|
+
* }
|
|
76
|
+
* *\/
|
|
77
|
+
* // example id: to-delete-a-table-1475884368755
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
54
80
|
*/
|
|
55
81
|
export declare class DeleteTableCommand extends $Command<DeleteTableCommandInput, DeleteTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
56
82
|
readonly input: DeleteTableCommandInput;
|
|
@@ -98,6 +98,23 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
|
|
|
98
98
|
* @see {@link DescribeLimitsCommandOutput} for command's `response` shape.
|
|
99
99
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
100
100
|
*
|
|
101
|
+
* @example To determine capacity limits per table and account, in the current AWS region
|
|
102
|
+
* ```javascript
|
|
103
|
+
* // The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.
|
|
104
|
+
* const input = {};
|
|
105
|
+
* const command = new DescribeLimitsCommand(input);
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* /* response ==
|
|
108
|
+
* {
|
|
109
|
+
* "AccountMaxReadCapacityUnits": 20000,
|
|
110
|
+
* "AccountMaxWriteCapacityUnits": 20000,
|
|
111
|
+
* "TableMaxReadCapacityUnits": 10000,
|
|
112
|
+
* "TableMaxWriteCapacityUnits": 10000
|
|
113
|
+
* }
|
|
114
|
+
* *\/
|
|
115
|
+
* // example id: to-determine-capacity-limits-per-table-and-account-in-the-current-aws-region-1475884162064
|
|
116
|
+
* ```
|
|
117
|
+
*
|
|
101
118
|
*/
|
|
102
119
|
export declare class DescribeLimitsCommand extends $Command<DescribeLimitsCommandInput, DescribeLimitsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
103
120
|
readonly input: DescribeLimitsCommandInput;
|
|
@@ -43,6 +43,53 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
|
|
|
43
43
|
* @see {@link DescribeTableCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @example To describe a table
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // This example describes the Music table.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "TableName": "Music"
|
|
51
|
+
* };
|
|
52
|
+
* const command = new DescribeTableCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* /* response ==
|
|
55
|
+
* {
|
|
56
|
+
* "Table": {
|
|
57
|
+
* "AttributeDefinitions": [
|
|
58
|
+
* {
|
|
59
|
+
* "AttributeName": "Artist",
|
|
60
|
+
* "AttributeType": "S"
|
|
61
|
+
* },
|
|
62
|
+
* {
|
|
63
|
+
* "AttributeName": "SongTitle",
|
|
64
|
+
* "AttributeType": "S"
|
|
65
|
+
* }
|
|
66
|
+
* ],
|
|
67
|
+
* "CreationDateTime": "1421866952.062",
|
|
68
|
+
* "ItemCount": 0,
|
|
69
|
+
* "KeySchema": [
|
|
70
|
+
* {
|
|
71
|
+
* "AttributeName": "Artist",
|
|
72
|
+
* "KeyType": "HASH"
|
|
73
|
+
* },
|
|
74
|
+
* {
|
|
75
|
+
* "AttributeName": "SongTitle",
|
|
76
|
+
* "KeyType": "RANGE"
|
|
77
|
+
* }
|
|
78
|
+
* ],
|
|
79
|
+
* "ProvisionedThroughput": {
|
|
80
|
+
* "NumberOfDecreasesToday": 1,
|
|
81
|
+
* "ReadCapacityUnits": 5,
|
|
82
|
+
* "WriteCapacityUnits": 5
|
|
83
|
+
* },
|
|
84
|
+
* "TableName": "Music",
|
|
85
|
+
* "TableSizeBytes": 0,
|
|
86
|
+
* "TableStatus": "ACTIVE"
|
|
87
|
+
* }
|
|
88
|
+
* }
|
|
89
|
+
* *\/
|
|
90
|
+
* // example id: to-describe-a-table-1475884440502
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
46
93
|
*/
|
|
47
94
|
export declare class DescribeTableCommand extends $Command<DescribeTableCommandInput, DescribeTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
48
95
|
readonly input: DescribeTableCommandInput;
|
|
@@ -36,6 +36,40 @@ 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
|
+
* @example To read an item from a table
|
|
40
|
+
* ```javascript
|
|
41
|
+
* // 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.
|
|
42
|
+
* const input = {
|
|
43
|
+
* "Key": {
|
|
44
|
+
* "Artist": {
|
|
45
|
+
* "S": "Acme Band"
|
|
46
|
+
* },
|
|
47
|
+
* "SongTitle": {
|
|
48
|
+
* "S": "Happy Day"
|
|
49
|
+
* }
|
|
50
|
+
* },
|
|
51
|
+
* "TableName": "Music"
|
|
52
|
+
* };
|
|
53
|
+
* const command = new GetItemCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* /* response ==
|
|
56
|
+
* {
|
|
57
|
+
* "Item": {
|
|
58
|
+
* "AlbumTitle": {
|
|
59
|
+
* "S": "Songs About Life"
|
|
60
|
+
* },
|
|
61
|
+
* "Artist": {
|
|
62
|
+
* "S": "Acme Band"
|
|
63
|
+
* },
|
|
64
|
+
* "SongTitle": {
|
|
65
|
+
* "S": "Happy Day"
|
|
66
|
+
* }
|
|
67
|
+
* }
|
|
68
|
+
* }
|
|
69
|
+
* *\/
|
|
70
|
+
* // example id: to-read-an-item-from-a-table-1475884258350
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
39
73
|
*/
|
|
40
74
|
export declare class GetItemCommand extends $Command<GetItemCommandInput, GetItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
41
75
|
readonly input: GetItemCommandInput;
|
|
@@ -31,6 +31,25 @@ 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
|
+
* @example To list tables
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // This example lists all of the tables associated with the current AWS account and endpoint.
|
|
37
|
+
* const input = {};
|
|
38
|
+
* const command = new ListTablesCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "TableNames": [
|
|
43
|
+
* "Forum",
|
|
44
|
+
* "ProductCatalog",
|
|
45
|
+
* "Reply",
|
|
46
|
+
* "Thread"
|
|
47
|
+
* ]
|
|
48
|
+
* }
|
|
49
|
+
* *\/
|
|
50
|
+
* // example id: to-list-tables-1475884741238
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
34
53
|
*/
|
|
35
54
|
export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, DynamoDBClientResolvedConfig> {
|
|
36
55
|
readonly input: ListTablesCommandInput;
|
|
@@ -50,6 +50,37 @@ 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
|
+
* @example To add an item to a table
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // This example adds a new item to the Music table.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "Item": {
|
|
58
|
+
* "AlbumTitle": {
|
|
59
|
+
* "S": "Somewhat Famous"
|
|
60
|
+
* },
|
|
61
|
+
* "Artist": {
|
|
62
|
+
* "S": "No One You Know"
|
|
63
|
+
* },
|
|
64
|
+
* "SongTitle": {
|
|
65
|
+
* "S": "Call Me Today"
|
|
66
|
+
* }
|
|
67
|
+
* },
|
|
68
|
+
* "ReturnConsumedCapacity": "TOTAL",
|
|
69
|
+
* "TableName": "Music"
|
|
70
|
+
* };
|
|
71
|
+
* const command = new PutItemCommand(input);
|
|
72
|
+
* const response = await client.send(command);
|
|
73
|
+
* /* response ==
|
|
74
|
+
* {
|
|
75
|
+
* "ConsumedCapacity": {
|
|
76
|
+
* "CapacityUnits": 1,
|
|
77
|
+
* "TableName": "Music"
|
|
78
|
+
* }
|
|
79
|
+
* }
|
|
80
|
+
* *\/
|
|
81
|
+
* // example id: to-add-an-item-to-a-table-1476116191110
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
53
84
|
*/
|
|
54
85
|
export declare class PutItemCommand extends $Command<PutItemCommandInput, PutItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
55
86
|
readonly input: PutItemCommandInput;
|
|
@@ -79,6 +79,38 @@ 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
|
+
* @example To query an item
|
|
83
|
+
* ```javascript
|
|
84
|
+
* // 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".
|
|
85
|
+
* const input = {
|
|
86
|
+
* "ExpressionAttributeValues": {
|
|
87
|
+
* ":v1": {
|
|
88
|
+
* "S": "No One You Know"
|
|
89
|
+
* }
|
|
90
|
+
* },
|
|
91
|
+
* "KeyConditionExpression": "Artist = :v1",
|
|
92
|
+
* "ProjectionExpression": "SongTitle",
|
|
93
|
+
* "TableName": "Music"
|
|
94
|
+
* };
|
|
95
|
+
* const command = new QueryCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response ==
|
|
98
|
+
* {
|
|
99
|
+
* "ConsumedCapacity": {},
|
|
100
|
+
* "Count": 2,
|
|
101
|
+
* "Items": [
|
|
102
|
+
* {
|
|
103
|
+
* "SongTitle": {
|
|
104
|
+
* "S": "Call Me Today"
|
|
105
|
+
* }
|
|
106
|
+
* }
|
|
107
|
+
* ],
|
|
108
|
+
* "ScannedCount": 2
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* // example id: to-query-an-item-1475883874631
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
82
114
|
*/
|
|
83
115
|
export declare class QueryCommand extends $Command<QueryCommandInput, QueryCommandOutput, DynamoDBClientResolvedConfig> {
|
|
84
116
|
readonly input: QueryCommandInput;
|
|
@@ -54,6 +54,53 @@ 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
|
+
* @example To scan a table
|
|
58
|
+
* ```javascript
|
|
59
|
+
* // 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.
|
|
60
|
+
* const input = {
|
|
61
|
+
* "ExpressionAttributeNames": {
|
|
62
|
+
* "#AT": "AlbumTitle",
|
|
63
|
+
* "#ST": "SongTitle"
|
|
64
|
+
* },
|
|
65
|
+
* "ExpressionAttributeValues": {
|
|
66
|
+
* ":a": {
|
|
67
|
+
* "S": "No One You Know"
|
|
68
|
+
* }
|
|
69
|
+
* },
|
|
70
|
+
* "FilterExpression": "Artist = :a",
|
|
71
|
+
* "ProjectionExpression": "#ST, #AT",
|
|
72
|
+
* "TableName": "Music"
|
|
73
|
+
* };
|
|
74
|
+
* const command = new ScanCommand(input);
|
|
75
|
+
* const response = await client.send(command);
|
|
76
|
+
* /* response ==
|
|
77
|
+
* {
|
|
78
|
+
* "ConsumedCapacity": {},
|
|
79
|
+
* "Count": 2,
|
|
80
|
+
* "Items": [
|
|
81
|
+
* {
|
|
82
|
+
* "AlbumTitle": {
|
|
83
|
+
* "S": "Somewhat Famous"
|
|
84
|
+
* },
|
|
85
|
+
* "SongTitle": {
|
|
86
|
+
* "S": "Call Me Today"
|
|
87
|
+
* }
|
|
88
|
+
* },
|
|
89
|
+
* {
|
|
90
|
+
* "AlbumTitle": {
|
|
91
|
+
* "S": "Blue Sky Blues"
|
|
92
|
+
* },
|
|
93
|
+
* "SongTitle": {
|
|
94
|
+
* "S": "Scared of My Shadow"
|
|
95
|
+
* }
|
|
96
|
+
* }
|
|
97
|
+
* ],
|
|
98
|
+
* "ScannedCount": 3
|
|
99
|
+
* }
|
|
100
|
+
* *\/
|
|
101
|
+
* // example id: to-scan-a-table-1475883652470
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
57
104
|
*/
|
|
58
105
|
export declare class ScanCommand extends $Command<ScanCommandInput, ScanCommandOutput, DynamoDBClientResolvedConfig> {
|
|
59
106
|
readonly input: ScanCommandInput;
|
|
@@ -35,6 +35,57 @@ export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBea
|
|
|
35
35
|
* @see {@link UpdateItemCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @example To update an item in a table
|
|
39
|
+
* ```javascript
|
|
40
|
+
* // This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.
|
|
41
|
+
* const input = {
|
|
42
|
+
* "ExpressionAttributeNames": {
|
|
43
|
+
* "#AT": "AlbumTitle",
|
|
44
|
+
* "#Y": "Year"
|
|
45
|
+
* },
|
|
46
|
+
* "ExpressionAttributeValues": {
|
|
47
|
+
* ":t": {
|
|
48
|
+
* "S": "Louder Than Ever"
|
|
49
|
+
* },
|
|
50
|
+
* ":y": {
|
|
51
|
+
* "N": "2015"
|
|
52
|
+
* }
|
|
53
|
+
* },
|
|
54
|
+
* "Key": {
|
|
55
|
+
* "Artist": {
|
|
56
|
+
* "S": "Acme Band"
|
|
57
|
+
* },
|
|
58
|
+
* "SongTitle": {
|
|
59
|
+
* "S": "Happy Day"
|
|
60
|
+
* }
|
|
61
|
+
* },
|
|
62
|
+
* "ReturnValues": "ALL_NEW",
|
|
63
|
+
* "TableName": "Music",
|
|
64
|
+
* "UpdateExpression": "SET #Y = :y, #AT = :t"
|
|
65
|
+
* };
|
|
66
|
+
* const command = new UpdateItemCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "Attributes": {
|
|
71
|
+
* "AlbumTitle": {
|
|
72
|
+
* "S": "Louder Than Ever"
|
|
73
|
+
* },
|
|
74
|
+
* "Artist": {
|
|
75
|
+
* "S": "Acme Band"
|
|
76
|
+
* },
|
|
77
|
+
* "SongTitle": {
|
|
78
|
+
* "S": "Happy Day"
|
|
79
|
+
* },
|
|
80
|
+
* "Year": {
|
|
81
|
+
* "N": "2015"
|
|
82
|
+
* }
|
|
83
|
+
* }
|
|
84
|
+
* }
|
|
85
|
+
* *\/
|
|
86
|
+
* // example id: to-update-an-item-in-a-table-1476118250055
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
38
89
|
*/
|
|
39
90
|
export declare class UpdateItemCommand extends $Command<UpdateItemCommandInput, UpdateItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
40
91
|
readonly input: UpdateItemCommandInput;
|
|
@@ -55,6 +55,58 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
|
|
|
55
55
|
* @see {@link UpdateTableCommandOutput} for command's `response` shape.
|
|
56
56
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
57
57
|
*
|
|
58
|
+
* @example To modify a table's provisioned throughput
|
|
59
|
+
* ```javascript
|
|
60
|
+
* // This example increases the provisioned read and write capacity on the Music table.
|
|
61
|
+
* const input = {
|
|
62
|
+
* "ProvisionedThroughput": {
|
|
63
|
+
* "ReadCapacityUnits": 10,
|
|
64
|
+
* "WriteCapacityUnits": 10
|
|
65
|
+
* },
|
|
66
|
+
* "TableName": "MusicCollection"
|
|
67
|
+
* };
|
|
68
|
+
* const command = new UpdateTableCommand(input);
|
|
69
|
+
* const response = await client.send(command);
|
|
70
|
+
* /* response ==
|
|
71
|
+
* {
|
|
72
|
+
* "TableDescription": {
|
|
73
|
+
* "AttributeDefinitions": [
|
|
74
|
+
* {
|
|
75
|
+
* "AttributeName": "Artist",
|
|
76
|
+
* "AttributeType": "S"
|
|
77
|
+
* },
|
|
78
|
+
* {
|
|
79
|
+
* "AttributeName": "SongTitle",
|
|
80
|
+
* "AttributeType": "S"
|
|
81
|
+
* }
|
|
82
|
+
* ],
|
|
83
|
+
* "CreationDateTime": "1421866952.062",
|
|
84
|
+
* "ItemCount": 0,
|
|
85
|
+
* "KeySchema": [
|
|
86
|
+
* {
|
|
87
|
+
* "AttributeName": "Artist",
|
|
88
|
+
* "KeyType": "HASH"
|
|
89
|
+
* },
|
|
90
|
+
* {
|
|
91
|
+
* "AttributeName": "SongTitle",
|
|
92
|
+
* "KeyType": "RANGE"
|
|
93
|
+
* }
|
|
94
|
+
* ],
|
|
95
|
+
* "ProvisionedThroughput": {
|
|
96
|
+
* "LastIncreaseDateTime": "1421874759.194",
|
|
97
|
+
* "NumberOfDecreasesToday": 1,
|
|
98
|
+
* "ReadCapacityUnits": 1,
|
|
99
|
+
* "WriteCapacityUnits": 1
|
|
100
|
+
* },
|
|
101
|
+
* "TableName": "MusicCollection",
|
|
102
|
+
* "TableSizeBytes": 0,
|
|
103
|
+
* "TableStatus": "UPDATING"
|
|
104
|
+
* }
|
|
105
|
+
* }
|
|
106
|
+
* *\/
|
|
107
|
+
* // example id: to-modify-a-tables-provisioned-throughput-1476118076147
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
58
110
|
*/
|
|
59
111
|
export declare class UpdateTableCommand extends $Command<UpdateTableCommandInput, UpdateTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
60
112
|
readonly input: UpdateTableCommandInput;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-dynamodb",
|
|
3
3
|
"description": "AWS SDK for JavaScript Dynamodb Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.289.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,40 +20,40 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/config-resolver": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
27
|
-
"@aws-sdk/hash-node": "3.
|
|
28
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
29
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
30
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
-
"@aws-sdk/middleware-endpoint-discovery": "3.
|
|
32
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
33
|
-
"@aws-sdk/middleware-logger": "3.
|
|
34
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
35
|
-
"@aws-sdk/middleware-retry": "3.
|
|
36
|
-
"@aws-sdk/middleware-serde": "3.
|
|
37
|
-
"@aws-sdk/middleware-signing": "3.
|
|
38
|
-
"@aws-sdk/middleware-stack": "3.
|
|
39
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
40
|
-
"@aws-sdk/node-config-provider": "3.
|
|
41
|
-
"@aws-sdk/node-http-handler": "3.
|
|
42
|
-
"@aws-sdk/protocol-http": "3.
|
|
43
|
-
"@aws-sdk/smithy-client": "3.
|
|
44
|
-
"@aws-sdk/types": "3.
|
|
45
|
-
"@aws-sdk/url-parser": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.289.0",
|
|
24
|
+
"@aws-sdk/config-resolver": "3.289.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.289.0",
|
|
26
|
+
"@aws-sdk/fetch-http-handler": "3.289.0",
|
|
27
|
+
"@aws-sdk/hash-node": "3.289.0",
|
|
28
|
+
"@aws-sdk/invalid-dependency": "3.289.0",
|
|
29
|
+
"@aws-sdk/middleware-content-length": "3.289.0",
|
|
30
|
+
"@aws-sdk/middleware-endpoint": "3.289.0",
|
|
31
|
+
"@aws-sdk/middleware-endpoint-discovery": "3.289.0",
|
|
32
|
+
"@aws-sdk/middleware-host-header": "3.289.0",
|
|
33
|
+
"@aws-sdk/middleware-logger": "3.289.0",
|
|
34
|
+
"@aws-sdk/middleware-recursion-detection": "3.289.0",
|
|
35
|
+
"@aws-sdk/middleware-retry": "3.289.0",
|
|
36
|
+
"@aws-sdk/middleware-serde": "3.289.0",
|
|
37
|
+
"@aws-sdk/middleware-signing": "3.289.0",
|
|
38
|
+
"@aws-sdk/middleware-stack": "3.289.0",
|
|
39
|
+
"@aws-sdk/middleware-user-agent": "3.289.0",
|
|
40
|
+
"@aws-sdk/node-config-provider": "3.289.0",
|
|
41
|
+
"@aws-sdk/node-http-handler": "3.289.0",
|
|
42
|
+
"@aws-sdk/protocol-http": "3.289.0",
|
|
43
|
+
"@aws-sdk/smithy-client": "3.289.0",
|
|
44
|
+
"@aws-sdk/types": "3.289.0",
|
|
45
|
+
"@aws-sdk/url-parser": "3.289.0",
|
|
46
46
|
"@aws-sdk/util-base64": "3.208.0",
|
|
47
47
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
48
48
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
49
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
50
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
51
|
-
"@aws-sdk/util-endpoints": "3.
|
|
52
|
-
"@aws-sdk/util-retry": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
54
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
49
|
+
"@aws-sdk/util-defaults-mode-browser": "3.289.0",
|
|
50
|
+
"@aws-sdk/util-defaults-mode-node": "3.289.0",
|
|
51
|
+
"@aws-sdk/util-endpoints": "3.289.0",
|
|
52
|
+
"@aws-sdk/util-retry": "3.289.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-browser": "3.289.0",
|
|
54
|
+
"@aws-sdk/util-user-agent-node": "3.289.0",
|
|
55
55
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
56
|
-
"@aws-sdk/util-waiter": "3.
|
|
56
|
+
"@aws-sdk/util-waiter": "3.289.0",
|
|
57
57
|
"tslib": "^2.3.1",
|
|
58
58
|
"uuid": "^8.3.2"
|
|
59
59
|
},
|