@aws-sdk/client-dynamodb 3.299.0 → 3.301.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 +54 -0
- package/dist-types/commands/BatchGetItemCommand.d.ts +62 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +62 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +4 -0
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +8 -0
- package/dist-types/commands/CreateTableCommand.d.ts +75 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +3 -0
- package/dist-types/commands/DeleteItemCommand.d.ts +69 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +3 -0
- package/dist-types/commands/DescribeBackupCommand.d.ts +3 -0
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +4 -0
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeExportCommand.d.ts +3 -0
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +3 -0
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeImportCommand.d.ts +3 -0
- package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +3 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeTableCommand.d.ts +3 -0
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +3 -0
- package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +3 -0
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +4 -0
- package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +4 -0
- package/dist-types/commands/ExecuteStatementCommand.d.ts +52 -0
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +54 -0
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +11 -0
- package/dist-types/commands/GetItemCommand.d.ts +57 -0
- package/dist-types/commands/ImportTableCommand.d.ts +64 -0
- package/dist-types/commands/ListBackupsCommand.d.ts +8 -0
- package/dist-types/commands/ListContributorInsightsCommand.d.ts +5 -0
- package/dist-types/commands/ListExportsCommand.d.ts +5 -0
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +5 -0
- package/dist-types/commands/ListImportsCommand.d.ts +5 -0
- package/dist-types/commands/ListTablesCommand.d.ts +4 -0
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +4 -0
- package/dist-types/commands/PutItemCommand.d.ts +69 -0
- package/dist-types/commands/QueryCommand.d.ts +83 -0
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +52 -0
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +55 -0
- package/dist-types/commands/ScanCommand.d.ts +75 -0
- package/dist-types/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/commands/TransactGetItemsCommand.d.ts +59 -0
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +108 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +6 -0
- package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +5 -0
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +13 -0
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +70 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +76 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +97 -0
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +50 -0
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +7 -0
- package/package.json +9 -9
|
@@ -51,6 +51,81 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
|
|
|
51
51
|
* import { DynamoDBClient, ScanCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
52
52
|
* // const { DynamoDBClient, ScanCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
53
53
|
* const client = new DynamoDBClient(config);
|
|
54
|
+
* const input = { // ScanInput
|
|
55
|
+
* TableName: "STRING_VALUE", // required
|
|
56
|
+
* IndexName: "STRING_VALUE",
|
|
57
|
+
* AttributesToGet: [ // AttributeNameList
|
|
58
|
+
* "STRING_VALUE",
|
|
59
|
+
* ],
|
|
60
|
+
* Limit: Number("int"),
|
|
61
|
+
* Select: "ALL_ATTRIBUTES" || "ALL_PROJECTED_ATTRIBUTES" || "SPECIFIC_ATTRIBUTES" || "COUNT",
|
|
62
|
+
* ScanFilter: { // FilterConditionMap
|
|
63
|
+
* "<keys>": { // Condition
|
|
64
|
+
* AttributeValueList: [ // AttributeValueList
|
|
65
|
+
* { // AttributeValue Union: only one key present
|
|
66
|
+
* S: "STRING_VALUE",
|
|
67
|
+
* N: "STRING_VALUE",
|
|
68
|
+
* B: "BLOB_VALUE",
|
|
69
|
+
* SS: [ // StringSetAttributeValue
|
|
70
|
+
* "STRING_VALUE",
|
|
71
|
+
* ],
|
|
72
|
+
* NS: [ // NumberSetAttributeValue
|
|
73
|
+
* "STRING_VALUE",
|
|
74
|
+
* ],
|
|
75
|
+
* BS: [ // BinarySetAttributeValue
|
|
76
|
+
* "BLOB_VALUE",
|
|
77
|
+
* ],
|
|
78
|
+
* M: { // MapAttributeValue
|
|
79
|
+
* "<keys>": {// Union: only one key present
|
|
80
|
+
* S: "STRING_VALUE",
|
|
81
|
+
* N: "STRING_VALUE",
|
|
82
|
+
* B: "BLOB_VALUE",
|
|
83
|
+
* SS: [
|
|
84
|
+
* "STRING_VALUE",
|
|
85
|
+
* ],
|
|
86
|
+
* NS: [
|
|
87
|
+
* "STRING_VALUE",
|
|
88
|
+
* ],
|
|
89
|
+
* BS: [
|
|
90
|
+
* "BLOB_VALUE",
|
|
91
|
+
* ],
|
|
92
|
+
* M: {
|
|
93
|
+
* "<keys>": "<AttributeValue>",
|
|
94
|
+
* },
|
|
95
|
+
* L: [ // ListAttributeValue
|
|
96
|
+
* "<AttributeValue>",
|
|
97
|
+
* ],
|
|
98
|
+
* NULL: true || false,
|
|
99
|
+
* BOOL: true || false,
|
|
100
|
+
* },
|
|
101
|
+
* },
|
|
102
|
+
* L: [
|
|
103
|
+
* "<AttributeValue>",
|
|
104
|
+
* ],
|
|
105
|
+
* NULL: true || false,
|
|
106
|
+
* BOOL: true || false,
|
|
107
|
+
* },
|
|
108
|
+
* ],
|
|
109
|
+
* ComparisonOperator: "EQ" || "NE" || "IN" || "LE" || "LT" || "GE" || "GT" || "BETWEEN" || "NOT_NULL" || "NULL" || "CONTAINS" || "NOT_CONTAINS" || "BEGINS_WITH", // required
|
|
110
|
+
* },
|
|
111
|
+
* },
|
|
112
|
+
* ConditionalOperator: "AND" || "OR",
|
|
113
|
+
* ExclusiveStartKey: { // Key
|
|
114
|
+
* "<keys>": "<AttributeValue>",
|
|
115
|
+
* },
|
|
116
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
117
|
+
* TotalSegments: Number("int"),
|
|
118
|
+
* Segment: Number("int"),
|
|
119
|
+
* ProjectionExpression: "STRING_VALUE",
|
|
120
|
+
* FilterExpression: "STRING_VALUE",
|
|
121
|
+
* ExpressionAttributeNames: { // ExpressionAttributeNameMap
|
|
122
|
+
* "<keys>": "STRING_VALUE",
|
|
123
|
+
* },
|
|
124
|
+
* ExpressionAttributeValues: { // ExpressionAttributeValueMap
|
|
125
|
+
* "<keys>": "<AttributeValue>",
|
|
126
|
+
* },
|
|
127
|
+
* ConsistentRead: true || false,
|
|
128
|
+
* };
|
|
54
129
|
* const command = new ScanCommand(input);
|
|
55
130
|
* const response = await client.send(command);
|
|
56
131
|
* ```
|
|
@@ -31,6 +31,15 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
31
31
|
* import { DynamoDBClient, TagResourceCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
32
32
|
* // const { DynamoDBClient, TagResourceCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
33
33
|
* const client = new DynamoDBClient(config);
|
|
34
|
+
* const input = { // TagResourceInput
|
|
35
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
36
|
+
* Tags: [ // TagList // required
|
|
37
|
+
* { // Tag
|
|
38
|
+
* Key: "STRING_VALUE", // required
|
|
39
|
+
* Value: "STRING_VALUE", // required
|
|
40
|
+
* },
|
|
41
|
+
* ],
|
|
42
|
+
* };
|
|
34
43
|
* const command = new TagResourceCommand(input);
|
|
35
44
|
* const response = await client.send(command);
|
|
36
45
|
* ```
|
|
@@ -52,6 +52,65 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _
|
|
|
52
52
|
* import { DynamoDBClient, TransactGetItemsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
53
53
|
* // const { DynamoDBClient, TransactGetItemsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
54
54
|
* const client = new DynamoDBClient(config);
|
|
55
|
+
* const input = { // TransactGetItemsInput
|
|
56
|
+
* TransactItems: [ // TransactGetItemList // required
|
|
57
|
+
* { // TransactGetItem
|
|
58
|
+
* Get: { // Get
|
|
59
|
+
* Key: { // Key // required
|
|
60
|
+
* "<keys>": { // AttributeValue Union: only one key present
|
|
61
|
+
* S: "STRING_VALUE",
|
|
62
|
+
* N: "STRING_VALUE",
|
|
63
|
+
* B: "BLOB_VALUE",
|
|
64
|
+
* SS: [ // StringSetAttributeValue
|
|
65
|
+
* "STRING_VALUE",
|
|
66
|
+
* ],
|
|
67
|
+
* NS: [ // NumberSetAttributeValue
|
|
68
|
+
* "STRING_VALUE",
|
|
69
|
+
* ],
|
|
70
|
+
* BS: [ // BinarySetAttributeValue
|
|
71
|
+
* "BLOB_VALUE",
|
|
72
|
+
* ],
|
|
73
|
+
* M: { // MapAttributeValue
|
|
74
|
+
* "<keys>": {// Union: only one key present
|
|
75
|
+
* S: "STRING_VALUE",
|
|
76
|
+
* N: "STRING_VALUE",
|
|
77
|
+
* B: "BLOB_VALUE",
|
|
78
|
+
* SS: [
|
|
79
|
+
* "STRING_VALUE",
|
|
80
|
+
* ],
|
|
81
|
+
* NS: [
|
|
82
|
+
* "STRING_VALUE",
|
|
83
|
+
* ],
|
|
84
|
+
* BS: [
|
|
85
|
+
* "BLOB_VALUE",
|
|
86
|
+
* ],
|
|
87
|
+
* M: {
|
|
88
|
+
* "<keys>": "<AttributeValue>",
|
|
89
|
+
* },
|
|
90
|
+
* L: [ // ListAttributeValue
|
|
91
|
+
* "<AttributeValue>",
|
|
92
|
+
* ],
|
|
93
|
+
* NULL: true || false,
|
|
94
|
+
* BOOL: true || false,
|
|
95
|
+
* },
|
|
96
|
+
* },
|
|
97
|
+
* L: [
|
|
98
|
+
* "<AttributeValue>",
|
|
99
|
+
* ],
|
|
100
|
+
* NULL: true || false,
|
|
101
|
+
* BOOL: true || false,
|
|
102
|
+
* },
|
|
103
|
+
* },
|
|
104
|
+
* TableName: "STRING_VALUE", // required
|
|
105
|
+
* ProjectionExpression: "STRING_VALUE",
|
|
106
|
+
* ExpressionAttributeNames: { // ExpressionAttributeNameMap
|
|
107
|
+
* "<keys>": "STRING_VALUE",
|
|
108
|
+
* },
|
|
109
|
+
* },
|
|
110
|
+
* },
|
|
111
|
+
* ],
|
|
112
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
113
|
+
* };
|
|
55
114
|
* const command = new TransactGetItemsCommand(input);
|
|
56
115
|
* const response = await client.send(command);
|
|
57
116
|
* ```
|
|
@@ -98,6 +98,114 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
|
|
|
98
98
|
* import { DynamoDBClient, TransactWriteItemsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
99
99
|
* // const { DynamoDBClient, TransactWriteItemsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
100
100
|
* const client = new DynamoDBClient(config);
|
|
101
|
+
* const input = { // TransactWriteItemsInput
|
|
102
|
+
* TransactItems: [ // TransactWriteItemList // required
|
|
103
|
+
* { // TransactWriteItem
|
|
104
|
+
* ConditionCheck: { // ConditionCheck
|
|
105
|
+
* Key: { // Key // required
|
|
106
|
+
* "<keys>": { // AttributeValue Union: only one key present
|
|
107
|
+
* S: "STRING_VALUE",
|
|
108
|
+
* N: "STRING_VALUE",
|
|
109
|
+
* B: "BLOB_VALUE",
|
|
110
|
+
* SS: [ // StringSetAttributeValue
|
|
111
|
+
* "STRING_VALUE",
|
|
112
|
+
* ],
|
|
113
|
+
* NS: [ // NumberSetAttributeValue
|
|
114
|
+
* "STRING_VALUE",
|
|
115
|
+
* ],
|
|
116
|
+
* BS: [ // BinarySetAttributeValue
|
|
117
|
+
* "BLOB_VALUE",
|
|
118
|
+
* ],
|
|
119
|
+
* M: { // MapAttributeValue
|
|
120
|
+
* "<keys>": {// Union: only one key present
|
|
121
|
+
* S: "STRING_VALUE",
|
|
122
|
+
* N: "STRING_VALUE",
|
|
123
|
+
* B: "BLOB_VALUE",
|
|
124
|
+
* SS: [
|
|
125
|
+
* "STRING_VALUE",
|
|
126
|
+
* ],
|
|
127
|
+
* NS: [
|
|
128
|
+
* "STRING_VALUE",
|
|
129
|
+
* ],
|
|
130
|
+
* BS: [
|
|
131
|
+
* "BLOB_VALUE",
|
|
132
|
+
* ],
|
|
133
|
+
* M: {
|
|
134
|
+
* "<keys>": "<AttributeValue>",
|
|
135
|
+
* },
|
|
136
|
+
* L: [ // ListAttributeValue
|
|
137
|
+
* "<AttributeValue>",
|
|
138
|
+
* ],
|
|
139
|
+
* NULL: true || false,
|
|
140
|
+
* BOOL: true || false,
|
|
141
|
+
* },
|
|
142
|
+
* },
|
|
143
|
+
* L: [
|
|
144
|
+
* "<AttributeValue>",
|
|
145
|
+
* ],
|
|
146
|
+
* NULL: true || false,
|
|
147
|
+
* BOOL: true || false,
|
|
148
|
+
* },
|
|
149
|
+
* },
|
|
150
|
+
* TableName: "STRING_VALUE", // required
|
|
151
|
+
* ConditionExpression: "STRING_VALUE", // required
|
|
152
|
+
* ExpressionAttributeNames: { // ExpressionAttributeNameMap
|
|
153
|
+
* "<keys>": "STRING_VALUE",
|
|
154
|
+
* },
|
|
155
|
+
* ExpressionAttributeValues: { // ExpressionAttributeValueMap
|
|
156
|
+
* "<keys>": "<AttributeValue>",
|
|
157
|
+
* },
|
|
158
|
+
* ReturnValuesOnConditionCheckFailure: "ALL_OLD" || "NONE",
|
|
159
|
+
* },
|
|
160
|
+
* Put: { // Put
|
|
161
|
+
* Item: { // PutItemInputAttributeMap // required
|
|
162
|
+
* "<keys>": "<AttributeValue>",
|
|
163
|
+
* },
|
|
164
|
+
* TableName: "STRING_VALUE", // required
|
|
165
|
+
* ConditionExpression: "STRING_VALUE",
|
|
166
|
+
* ExpressionAttributeNames: {
|
|
167
|
+
* "<keys>": "STRING_VALUE",
|
|
168
|
+
* },
|
|
169
|
+
* ExpressionAttributeValues: {
|
|
170
|
+
* "<keys>": "<AttributeValue>",
|
|
171
|
+
* },
|
|
172
|
+
* ReturnValuesOnConditionCheckFailure: "ALL_OLD" || "NONE",
|
|
173
|
+
* },
|
|
174
|
+
* Delete: { // Delete
|
|
175
|
+
* Key: { // required
|
|
176
|
+
* "<keys>": "<AttributeValue>",
|
|
177
|
+
* },
|
|
178
|
+
* TableName: "STRING_VALUE", // required
|
|
179
|
+
* ConditionExpression: "STRING_VALUE",
|
|
180
|
+
* ExpressionAttributeNames: {
|
|
181
|
+
* "<keys>": "STRING_VALUE",
|
|
182
|
+
* },
|
|
183
|
+
* ExpressionAttributeValues: {
|
|
184
|
+
* "<keys>": "<AttributeValue>",
|
|
185
|
+
* },
|
|
186
|
+
* ReturnValuesOnConditionCheckFailure: "ALL_OLD" || "NONE",
|
|
187
|
+
* },
|
|
188
|
+
* Update: { // Update
|
|
189
|
+
* Key: { // required
|
|
190
|
+
* "<keys>": "<AttributeValue>",
|
|
191
|
+
* },
|
|
192
|
+
* UpdateExpression: "STRING_VALUE", // required
|
|
193
|
+
* TableName: "STRING_VALUE", // required
|
|
194
|
+
* ConditionExpression: "STRING_VALUE",
|
|
195
|
+
* ExpressionAttributeNames: {
|
|
196
|
+
* "<keys>": "STRING_VALUE",
|
|
197
|
+
* },
|
|
198
|
+
* ExpressionAttributeValues: {
|
|
199
|
+
* "<keys>": "<AttributeValue>",
|
|
200
|
+
* },
|
|
201
|
+
* ReturnValuesOnConditionCheckFailure: "ALL_OLD" || "NONE",
|
|
202
|
+
* },
|
|
203
|
+
* },
|
|
204
|
+
* ],
|
|
205
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
206
|
+
* ReturnItemCollectionMetrics: "SIZE" || "NONE",
|
|
207
|
+
* ClientRequestToken: "STRING_VALUE",
|
|
208
|
+
* };
|
|
101
209
|
* const command = new TransactWriteItemsCommand(input);
|
|
102
210
|
* const response = await client.send(command);
|
|
103
211
|
* ```
|
|
@@ -29,6 +29,12 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
* import { DynamoDBClient, UntagResourceCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
30
30
|
* // const { DynamoDBClient, UntagResourceCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
31
31
|
* const client = new DynamoDBClient(config);
|
|
32
|
+
* const input = { // UntagResourceInput
|
|
33
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
34
|
+
* TagKeys: [ // TagKeyList // required
|
|
35
|
+
* "STRING_VALUE",
|
|
36
|
+
* ],
|
|
37
|
+
* };
|
|
32
38
|
* const command = new UntagResourceCommand(input);
|
|
33
39
|
* const response = await client.send(command);
|
|
34
40
|
* ```
|
|
@@ -37,6 +37,12 @@ export interface UpdateContinuousBackupsCommandOutput extends UpdateContinuousBa
|
|
|
37
37
|
* import { DynamoDBClient, UpdateContinuousBackupsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
38
38
|
* // const { DynamoDBClient, UpdateContinuousBackupsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
39
39
|
* const client = new DynamoDBClient(config);
|
|
40
|
+
* const input = { // UpdateContinuousBackupsInput
|
|
41
|
+
* TableName: "STRING_VALUE", // required
|
|
42
|
+
* PointInTimeRecoverySpecification: { // PointInTimeRecoverySpecification
|
|
43
|
+
* PointInTimeRecoveryEnabled: true || false, // required
|
|
44
|
+
* },
|
|
45
|
+
* };
|
|
40
46
|
* const command = new UpdateContinuousBackupsCommand(input);
|
|
41
47
|
* const response = await client.send(command);
|
|
42
48
|
* ```
|
|
@@ -32,6 +32,11 @@ export interface UpdateContributorInsightsCommandOutput extends UpdateContributo
|
|
|
32
32
|
* import { DynamoDBClient, UpdateContributorInsightsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
33
33
|
* // const { DynamoDBClient, UpdateContributorInsightsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
34
34
|
* const client = new DynamoDBClient(config);
|
|
35
|
+
* const input = { // UpdateContributorInsightsInput
|
|
36
|
+
* TableName: "STRING_VALUE", // required
|
|
37
|
+
* IndexName: "STRING_VALUE",
|
|
38
|
+
* ContributorInsightsAction: "ENABLE" || "DISABLE", // required
|
|
39
|
+
* };
|
|
35
40
|
* const command = new UpdateContributorInsightsCommand(input);
|
|
36
41
|
* const response = await client.send(command);
|
|
37
42
|
* ```
|
|
@@ -68,6 +68,19 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
|
|
|
68
68
|
* import { DynamoDBClient, UpdateGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
69
69
|
* // const { DynamoDBClient, UpdateGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
70
70
|
* const client = new DynamoDBClient(config);
|
|
71
|
+
* const input = { // UpdateGlobalTableInput
|
|
72
|
+
* GlobalTableName: "STRING_VALUE", // required
|
|
73
|
+
* ReplicaUpdates: [ // ReplicaUpdateList // required
|
|
74
|
+
* { // ReplicaUpdate
|
|
75
|
+
* Create: { // CreateReplicaAction
|
|
76
|
+
* RegionName: "STRING_VALUE", // required
|
|
77
|
+
* },
|
|
78
|
+
* Delete: { // DeleteReplicaAction
|
|
79
|
+
* RegionName: "STRING_VALUE", // required
|
|
80
|
+
* },
|
|
81
|
+
* },
|
|
82
|
+
* ],
|
|
83
|
+
* };
|
|
71
84
|
* const command = new UpdateGlobalTableCommand(input);
|
|
72
85
|
* const response = await client.send(command);
|
|
73
86
|
* ```
|
|
@@ -38,6 +38,76 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
|
|
|
38
38
|
* import { DynamoDBClient, UpdateGlobalTableSettingsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
39
39
|
* // const { DynamoDBClient, UpdateGlobalTableSettingsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
40
40
|
* const client = new DynamoDBClient(config);
|
|
41
|
+
* const input = { // UpdateGlobalTableSettingsInput
|
|
42
|
+
* GlobalTableName: "STRING_VALUE", // required
|
|
43
|
+
* GlobalTableBillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
44
|
+
* GlobalTableProvisionedWriteCapacityUnits: Number("long"),
|
|
45
|
+
* GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate: { // AutoScalingSettingsUpdate
|
|
46
|
+
* MinimumUnits: Number("long"),
|
|
47
|
+
* MaximumUnits: Number("long"),
|
|
48
|
+
* AutoScalingDisabled: true || false,
|
|
49
|
+
* AutoScalingRoleArn: "STRING_VALUE",
|
|
50
|
+
* ScalingPolicyUpdate: { // AutoScalingPolicyUpdate
|
|
51
|
+
* PolicyName: "STRING_VALUE",
|
|
52
|
+
* TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
|
|
53
|
+
* DisableScaleIn: true || false,
|
|
54
|
+
* ScaleInCooldown: Number("int"),
|
|
55
|
+
* ScaleOutCooldown: Number("int"),
|
|
56
|
+
* TargetValue: Number("double"), // required
|
|
57
|
+
* },
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* GlobalTableGlobalSecondaryIndexSettingsUpdate: [ // GlobalTableGlobalSecondaryIndexSettingsUpdateList
|
|
61
|
+
* { // GlobalTableGlobalSecondaryIndexSettingsUpdate
|
|
62
|
+
* IndexName: "STRING_VALUE", // required
|
|
63
|
+
* ProvisionedWriteCapacityUnits: Number("long"),
|
|
64
|
+
* ProvisionedWriteCapacityAutoScalingSettingsUpdate: {
|
|
65
|
+
* MinimumUnits: Number("long"),
|
|
66
|
+
* MaximumUnits: Number("long"),
|
|
67
|
+
* AutoScalingDisabled: true || false,
|
|
68
|
+
* AutoScalingRoleArn: "STRING_VALUE",
|
|
69
|
+
* ScalingPolicyUpdate: {
|
|
70
|
+
* PolicyName: "STRING_VALUE",
|
|
71
|
+
* TargetTrackingScalingPolicyConfiguration: {
|
|
72
|
+
* DisableScaleIn: true || false,
|
|
73
|
+
* ScaleInCooldown: Number("int"),
|
|
74
|
+
* ScaleOutCooldown: Number("int"),
|
|
75
|
+
* TargetValue: Number("double"), // required
|
|
76
|
+
* },
|
|
77
|
+
* },
|
|
78
|
+
* },
|
|
79
|
+
* },
|
|
80
|
+
* ],
|
|
81
|
+
* ReplicaSettingsUpdate: [ // ReplicaSettingsUpdateList
|
|
82
|
+
* { // ReplicaSettingsUpdate
|
|
83
|
+
* RegionName: "STRING_VALUE", // required
|
|
84
|
+
* ReplicaProvisionedReadCapacityUnits: Number("long"),
|
|
85
|
+
* ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate: {
|
|
86
|
+
* MinimumUnits: Number("long"),
|
|
87
|
+
* MaximumUnits: Number("long"),
|
|
88
|
+
* AutoScalingDisabled: true || false,
|
|
89
|
+
* AutoScalingRoleArn: "STRING_VALUE",
|
|
90
|
+
* ScalingPolicyUpdate: {
|
|
91
|
+
* PolicyName: "STRING_VALUE",
|
|
92
|
+
* TargetTrackingScalingPolicyConfiguration: {
|
|
93
|
+
* DisableScaleIn: true || false,
|
|
94
|
+
* ScaleInCooldown: Number("int"),
|
|
95
|
+
* ScaleOutCooldown: Number("int"),
|
|
96
|
+
* TargetValue: Number("double"), // required
|
|
97
|
+
* },
|
|
98
|
+
* },
|
|
99
|
+
* },
|
|
100
|
+
* ReplicaGlobalSecondaryIndexSettingsUpdate: [ // ReplicaGlobalSecondaryIndexSettingsUpdateList
|
|
101
|
+
* { // ReplicaGlobalSecondaryIndexSettingsUpdate
|
|
102
|
+
* IndexName: "STRING_VALUE", // required
|
|
103
|
+
* ProvisionedReadCapacityUnits: Number("long"),
|
|
104
|
+
* ProvisionedReadCapacityAutoScalingSettingsUpdate: "<AutoScalingSettingsUpdate>",
|
|
105
|
+
* },
|
|
106
|
+
* ],
|
|
107
|
+
* ReplicaTableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
108
|
+
* },
|
|
109
|
+
* ],
|
|
110
|
+
* };
|
|
41
111
|
* const command = new UpdateGlobalTableSettingsCommand(input);
|
|
42
112
|
* const response = await client.send(command);
|
|
43
113
|
* ```
|
|
@@ -32,6 +32,82 @@ export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBea
|
|
|
32
32
|
* import { DynamoDBClient, UpdateItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
33
33
|
* // const { DynamoDBClient, UpdateItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
34
34
|
* const client = new DynamoDBClient(config);
|
|
35
|
+
* const input = { // UpdateItemInput
|
|
36
|
+
* TableName: "STRING_VALUE", // required
|
|
37
|
+
* Key: { // Key // required
|
|
38
|
+
* "<keys>": { // AttributeValue Union: only one key present
|
|
39
|
+
* S: "STRING_VALUE",
|
|
40
|
+
* N: "STRING_VALUE",
|
|
41
|
+
* B: "BLOB_VALUE",
|
|
42
|
+
* SS: [ // StringSetAttributeValue
|
|
43
|
+
* "STRING_VALUE",
|
|
44
|
+
* ],
|
|
45
|
+
* NS: [ // NumberSetAttributeValue
|
|
46
|
+
* "STRING_VALUE",
|
|
47
|
+
* ],
|
|
48
|
+
* BS: [ // BinarySetAttributeValue
|
|
49
|
+
* "BLOB_VALUE",
|
|
50
|
+
* ],
|
|
51
|
+
* M: { // MapAttributeValue
|
|
52
|
+
* "<keys>": {// Union: only one key present
|
|
53
|
+
* S: "STRING_VALUE",
|
|
54
|
+
* N: "STRING_VALUE",
|
|
55
|
+
* B: "BLOB_VALUE",
|
|
56
|
+
* SS: [
|
|
57
|
+
* "STRING_VALUE",
|
|
58
|
+
* ],
|
|
59
|
+
* NS: [
|
|
60
|
+
* "STRING_VALUE",
|
|
61
|
+
* ],
|
|
62
|
+
* BS: [
|
|
63
|
+
* "BLOB_VALUE",
|
|
64
|
+
* ],
|
|
65
|
+
* M: {
|
|
66
|
+
* "<keys>": "<AttributeValue>",
|
|
67
|
+
* },
|
|
68
|
+
* L: [ // ListAttributeValue
|
|
69
|
+
* "<AttributeValue>",
|
|
70
|
+
* ],
|
|
71
|
+
* NULL: true || false,
|
|
72
|
+
* BOOL: true || false,
|
|
73
|
+
* },
|
|
74
|
+
* },
|
|
75
|
+
* L: [
|
|
76
|
+
* "<AttributeValue>",
|
|
77
|
+
* ],
|
|
78
|
+
* NULL: true || false,
|
|
79
|
+
* BOOL: true || false,
|
|
80
|
+
* },
|
|
81
|
+
* },
|
|
82
|
+
* AttributeUpdates: { // AttributeUpdates
|
|
83
|
+
* "<keys>": { // AttributeValueUpdate
|
|
84
|
+
* Value: "<AttributeValue>",
|
|
85
|
+
* Action: "ADD" || "PUT" || "DELETE",
|
|
86
|
+
* },
|
|
87
|
+
* },
|
|
88
|
+
* Expected: { // ExpectedAttributeMap
|
|
89
|
+
* "<keys>": { // ExpectedAttributeValue
|
|
90
|
+
* Value: "<AttributeValue>",
|
|
91
|
+
* Exists: true || false,
|
|
92
|
+
* ComparisonOperator: "EQ" || "NE" || "IN" || "LE" || "LT" || "GE" || "GT" || "BETWEEN" || "NOT_NULL" || "NULL" || "CONTAINS" || "NOT_CONTAINS" || "BEGINS_WITH",
|
|
93
|
+
* AttributeValueList: [ // AttributeValueList
|
|
94
|
+
* "<AttributeValue>",
|
|
95
|
+
* ],
|
|
96
|
+
* },
|
|
97
|
+
* },
|
|
98
|
+
* ConditionalOperator: "AND" || "OR",
|
|
99
|
+
* ReturnValues: "NONE" || "ALL_OLD" || "UPDATED_OLD" || "ALL_NEW" || "UPDATED_NEW",
|
|
100
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
101
|
+
* ReturnItemCollectionMetrics: "SIZE" || "NONE",
|
|
102
|
+
* UpdateExpression: "STRING_VALUE",
|
|
103
|
+
* ConditionExpression: "STRING_VALUE",
|
|
104
|
+
* ExpressionAttributeNames: { // ExpressionAttributeNameMap
|
|
105
|
+
* "<keys>": "STRING_VALUE",
|
|
106
|
+
* },
|
|
107
|
+
* ExpressionAttributeValues: { // ExpressionAttributeValueMap
|
|
108
|
+
* "<keys>": "<AttributeValue>",
|
|
109
|
+
* },
|
|
110
|
+
* };
|
|
35
111
|
* const command = new UpdateItemCommand(input);
|
|
36
112
|
* const response = await client.send(command);
|
|
37
113
|
* ```
|
|
@@ -52,6 +52,103 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
|
|
|
52
52
|
* import { DynamoDBClient, UpdateTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
53
53
|
* // const { DynamoDBClient, UpdateTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
54
54
|
* const client = new DynamoDBClient(config);
|
|
55
|
+
* const input = { // UpdateTableInput
|
|
56
|
+
* AttributeDefinitions: [ // AttributeDefinitions
|
|
57
|
+
* { // AttributeDefinition
|
|
58
|
+
* AttributeName: "STRING_VALUE", // required
|
|
59
|
+
* AttributeType: "S" || "N" || "B", // required
|
|
60
|
+
* },
|
|
61
|
+
* ],
|
|
62
|
+
* TableName: "STRING_VALUE", // required
|
|
63
|
+
* BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
64
|
+
* ProvisionedThroughput: { // ProvisionedThroughput
|
|
65
|
+
* ReadCapacityUnits: Number("long"), // required
|
|
66
|
+
* WriteCapacityUnits: Number("long"), // required
|
|
67
|
+
* },
|
|
68
|
+
* GlobalSecondaryIndexUpdates: [ // GlobalSecondaryIndexUpdateList
|
|
69
|
+
* { // GlobalSecondaryIndexUpdate
|
|
70
|
+
* Update: { // UpdateGlobalSecondaryIndexAction
|
|
71
|
+
* IndexName: "STRING_VALUE", // required
|
|
72
|
+
* ProvisionedThroughput: {
|
|
73
|
+
* ReadCapacityUnits: Number("long"), // required
|
|
74
|
+
* WriteCapacityUnits: Number("long"), // required
|
|
75
|
+
* },
|
|
76
|
+
* },
|
|
77
|
+
* Create: { // CreateGlobalSecondaryIndexAction
|
|
78
|
+
* IndexName: "STRING_VALUE", // required
|
|
79
|
+
* KeySchema: [ // KeySchema // required
|
|
80
|
+
* { // KeySchemaElement
|
|
81
|
+
* AttributeName: "STRING_VALUE", // required
|
|
82
|
+
* KeyType: "HASH" || "RANGE", // required
|
|
83
|
+
* },
|
|
84
|
+
* ],
|
|
85
|
+
* Projection: { // Projection
|
|
86
|
+
* ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
87
|
+
* NonKeyAttributes: [ // NonKeyAttributeNameList
|
|
88
|
+
* "STRING_VALUE",
|
|
89
|
+
* ],
|
|
90
|
+
* },
|
|
91
|
+
* ProvisionedThroughput: {
|
|
92
|
+
* ReadCapacityUnits: Number("long"), // required
|
|
93
|
+
* WriteCapacityUnits: Number("long"), // required
|
|
94
|
+
* },
|
|
95
|
+
* },
|
|
96
|
+
* Delete: { // DeleteGlobalSecondaryIndexAction
|
|
97
|
+
* IndexName: "STRING_VALUE", // required
|
|
98
|
+
* },
|
|
99
|
+
* },
|
|
100
|
+
* ],
|
|
101
|
+
* StreamSpecification: { // StreamSpecification
|
|
102
|
+
* StreamEnabled: true || false, // required
|
|
103
|
+
* StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
|
|
104
|
+
* },
|
|
105
|
+
* SSESpecification: { // SSESpecification
|
|
106
|
+
* Enabled: true || false,
|
|
107
|
+
* SSEType: "AES256" || "KMS",
|
|
108
|
+
* KMSMasterKeyId: "STRING_VALUE",
|
|
109
|
+
* },
|
|
110
|
+
* ReplicaUpdates: [ // ReplicationGroupUpdateList
|
|
111
|
+
* { // ReplicationGroupUpdate
|
|
112
|
+
* Create: { // CreateReplicationGroupMemberAction
|
|
113
|
+
* RegionName: "STRING_VALUE", // required
|
|
114
|
+
* KMSMasterKeyId: "STRING_VALUE",
|
|
115
|
+
* ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
|
|
116
|
+
* ReadCapacityUnits: Number("long"),
|
|
117
|
+
* },
|
|
118
|
+
* GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexList
|
|
119
|
+
* { // ReplicaGlobalSecondaryIndex
|
|
120
|
+
* IndexName: "STRING_VALUE", // required
|
|
121
|
+
* ProvisionedThroughputOverride: {
|
|
122
|
+
* ReadCapacityUnits: Number("long"),
|
|
123
|
+
* },
|
|
124
|
+
* },
|
|
125
|
+
* ],
|
|
126
|
+
* TableClassOverride: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
127
|
+
* },
|
|
128
|
+
* Update: { // UpdateReplicationGroupMemberAction
|
|
129
|
+
* RegionName: "STRING_VALUE", // required
|
|
130
|
+
* KMSMasterKeyId: "STRING_VALUE",
|
|
131
|
+
* ProvisionedThroughputOverride: {
|
|
132
|
+
* ReadCapacityUnits: Number("long"),
|
|
133
|
+
* },
|
|
134
|
+
* GlobalSecondaryIndexes: [
|
|
135
|
+
* {
|
|
136
|
+
* IndexName: "STRING_VALUE", // required
|
|
137
|
+
* ProvisionedThroughputOverride: {
|
|
138
|
+
* ReadCapacityUnits: Number("long"),
|
|
139
|
+
* },
|
|
140
|
+
* },
|
|
141
|
+
* ],
|
|
142
|
+
* TableClassOverride: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
143
|
+
* },
|
|
144
|
+
* Delete: { // DeleteReplicationGroupMemberAction
|
|
145
|
+
* RegionName: "STRING_VALUE", // required
|
|
146
|
+
* },
|
|
147
|
+
* },
|
|
148
|
+
* ],
|
|
149
|
+
* TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
150
|
+
* DeletionProtectionEnabled: true || false,
|
|
151
|
+
* };
|
|
55
152
|
* const command = new UpdateTableCommand(input);
|
|
56
153
|
* const response = await client.send(command);
|
|
57
154
|
* ```
|
|
@@ -31,6 +31,56 @@ export interface UpdateTableReplicaAutoScalingCommandOutput extends UpdateTableR
|
|
|
31
31
|
* import { DynamoDBClient, UpdateTableReplicaAutoScalingCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
32
32
|
* // const { DynamoDBClient, UpdateTableReplicaAutoScalingCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
33
33
|
* const client = new DynamoDBClient(config);
|
|
34
|
+
* const input = { // UpdateTableReplicaAutoScalingInput
|
|
35
|
+
* GlobalSecondaryIndexUpdates: [ // GlobalSecondaryIndexAutoScalingUpdateList
|
|
36
|
+
* { // GlobalSecondaryIndexAutoScalingUpdate
|
|
37
|
+
* IndexName: "STRING_VALUE",
|
|
38
|
+
* ProvisionedWriteCapacityAutoScalingUpdate: { // AutoScalingSettingsUpdate
|
|
39
|
+
* MinimumUnits: Number("long"),
|
|
40
|
+
* MaximumUnits: Number("long"),
|
|
41
|
+
* AutoScalingDisabled: true || false,
|
|
42
|
+
* AutoScalingRoleArn: "STRING_VALUE",
|
|
43
|
+
* ScalingPolicyUpdate: { // AutoScalingPolicyUpdate
|
|
44
|
+
* PolicyName: "STRING_VALUE",
|
|
45
|
+
* TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
|
|
46
|
+
* DisableScaleIn: true || false,
|
|
47
|
+
* ScaleInCooldown: Number("int"),
|
|
48
|
+
* ScaleOutCooldown: Number("int"),
|
|
49
|
+
* TargetValue: Number("double"), // required
|
|
50
|
+
* },
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* ],
|
|
55
|
+
* TableName: "STRING_VALUE", // required
|
|
56
|
+
* ProvisionedWriteCapacityAutoScalingUpdate: {
|
|
57
|
+
* MinimumUnits: Number("long"),
|
|
58
|
+
* MaximumUnits: Number("long"),
|
|
59
|
+
* AutoScalingDisabled: true || false,
|
|
60
|
+
* AutoScalingRoleArn: "STRING_VALUE",
|
|
61
|
+
* ScalingPolicyUpdate: {
|
|
62
|
+
* PolicyName: "STRING_VALUE",
|
|
63
|
+
* TargetTrackingScalingPolicyConfiguration: {
|
|
64
|
+
* DisableScaleIn: true || false,
|
|
65
|
+
* ScaleInCooldown: Number("int"),
|
|
66
|
+
* ScaleOutCooldown: Number("int"),
|
|
67
|
+
* TargetValue: Number("double"), // required
|
|
68
|
+
* },
|
|
69
|
+
* },
|
|
70
|
+
* },
|
|
71
|
+
* ReplicaUpdates: [ // ReplicaAutoScalingUpdateList
|
|
72
|
+
* { // ReplicaAutoScalingUpdate
|
|
73
|
+
* RegionName: "STRING_VALUE", // required
|
|
74
|
+
* ReplicaGlobalSecondaryIndexUpdates: [ // ReplicaGlobalSecondaryIndexAutoScalingUpdateList
|
|
75
|
+
* { // ReplicaGlobalSecondaryIndexAutoScalingUpdate
|
|
76
|
+
* IndexName: "STRING_VALUE",
|
|
77
|
+
* ProvisionedReadCapacityAutoScalingUpdate: "<AutoScalingSettingsUpdate>",
|
|
78
|
+
* },
|
|
79
|
+
* ],
|
|
80
|
+
* ReplicaProvisionedReadCapacityAutoScalingUpdate: "<AutoScalingSettingsUpdate>",
|
|
81
|
+
* },
|
|
82
|
+
* ],
|
|
83
|
+
* };
|
|
34
84
|
* const command = new UpdateTableReplicaAutoScalingCommand(input);
|
|
35
85
|
* const response = await client.send(command);
|
|
36
86
|
* ```
|