@aws-sdk/client-dynamodb 3.298.0 → 3.300.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 +87 -0
- package/dist-types/commands/BatchGetItemCommand.d.ts +84 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +84 -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 +113 -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 +85 -0
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +87 -0
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +11 -0
- package/dist-types/commands/GetItemCommand.d.ts +79 -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 +113 -0
- package/dist-types/commands/QueryCommand.d.ts +127 -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 +108 -0
- package/dist-types/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/commands/TransactGetItemsCommand.d.ts +81 -0
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +130 -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 +76 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +131 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +97 -0
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +62 -0
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +7 -0
- package/package.json +13 -13
|
@@ -38,6 +38,93 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
|
|
|
38
38
|
* import { DynamoDBClient, BatchExecuteStatementCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
39
39
|
* // const { DynamoDBClient, BatchExecuteStatementCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
40
40
|
* const client = new DynamoDBClient(config);
|
|
41
|
+
* const input = {
|
|
42
|
+
* Statements: [ // required
|
|
43
|
+
* {
|
|
44
|
+
* Statement: "STRING_VALUE", // required
|
|
45
|
+
* Parameters: [
|
|
46
|
+
* { // Union: only one key present
|
|
47
|
+
* S: "STRING_VALUE",
|
|
48
|
+
* N: "STRING_VALUE",
|
|
49
|
+
* B: "BLOB_VALUE",
|
|
50
|
+
* SS: [
|
|
51
|
+
* "STRING_VALUE",
|
|
52
|
+
* ],
|
|
53
|
+
* NS: [
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* BS: [
|
|
57
|
+
* "BLOB_VALUE",
|
|
58
|
+
* ],
|
|
59
|
+
* M: {
|
|
60
|
+
* "<keys>": { // Union: only one key present
|
|
61
|
+
* S: "STRING_VALUE",
|
|
62
|
+
* N: "STRING_VALUE",
|
|
63
|
+
* B: "BLOB_VALUE",
|
|
64
|
+
* SS: [
|
|
65
|
+
* "STRING_VALUE",
|
|
66
|
+
* ],
|
|
67
|
+
* NS: [
|
|
68
|
+
* "STRING_VALUE",
|
|
69
|
+
* ],
|
|
70
|
+
* BS: [
|
|
71
|
+
* "BLOB_VALUE",
|
|
72
|
+
* ],
|
|
73
|
+
* M: {
|
|
74
|
+
* "<keys>": { // Union: only one key present
|
|
75
|
+
* S: "<AttributeValue>",
|
|
76
|
+
* N: "<AttributeValue>",
|
|
77
|
+
* B: "<AttributeValue>",
|
|
78
|
+
* SS: "<AttributeValue>",
|
|
79
|
+
* NS: "<AttributeValue>",
|
|
80
|
+
* BS: "<AttributeValue>",
|
|
81
|
+
* M: "<AttributeValue>",
|
|
82
|
+
* L: [
|
|
83
|
+
* { // Union: only one key present
|
|
84
|
+
* S: "<AttributeValue>",
|
|
85
|
+
* N: "<AttributeValue>",
|
|
86
|
+
* B: "<AttributeValue>",
|
|
87
|
+
* SS: "<AttributeValue>",
|
|
88
|
+
* NS: "<AttributeValue>",
|
|
89
|
+
* BS: "<AttributeValue>",
|
|
90
|
+
* M: "<AttributeValue>",
|
|
91
|
+
* L: [
|
|
92
|
+
* { // Union: only one key present
|
|
93
|
+
* S: "<AttributeValue>",
|
|
94
|
+
* N: "<AttributeValue>",
|
|
95
|
+
* B: "<AttributeValue>",
|
|
96
|
+
* SS: "<AttributeValue>",
|
|
97
|
+
* NS: "<AttributeValue>",
|
|
98
|
+
* BS: "<AttributeValue>",
|
|
99
|
+
* M: "<AttributeValue>",
|
|
100
|
+
* L: "<AttributeValue>",
|
|
101
|
+
* NULL: true || false,
|
|
102
|
+
* BOOL: true || false,
|
|
103
|
+
* },
|
|
104
|
+
* ],
|
|
105
|
+
* NULL: true || false,
|
|
106
|
+
* BOOL: true || false,
|
|
107
|
+
* },
|
|
108
|
+
* ],
|
|
109
|
+
* NULL: "<AttributeValue>",
|
|
110
|
+
* BOOL: "<AttributeValue>",
|
|
111
|
+
* },
|
|
112
|
+
* },
|
|
113
|
+
* L: "<AttributeValue>",
|
|
114
|
+
* NULL: "<AttributeValue>",
|
|
115
|
+
* BOOL: "<AttributeValue>",
|
|
116
|
+
* },
|
|
117
|
+
* },
|
|
118
|
+
* L: "<AttributeValue>",
|
|
119
|
+
* NULL: "<AttributeValue>",
|
|
120
|
+
* BOOL: "<AttributeValue>",
|
|
121
|
+
* },
|
|
122
|
+
* ],
|
|
123
|
+
* ConsistentRead: true || false,
|
|
124
|
+
* },
|
|
125
|
+
* ],
|
|
126
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
127
|
+
* };
|
|
41
128
|
* const command = new BatchExecuteStatementCommand(input);
|
|
42
129
|
* const response = await client.send(command);
|
|
43
130
|
* ```
|
|
@@ -72,6 +72,90 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
72
72
|
* import { DynamoDBClient, BatchGetItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
73
73
|
* // const { DynamoDBClient, BatchGetItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
74
74
|
* const client = new DynamoDBClient(config);
|
|
75
|
+
* const input = {
|
|
76
|
+
* RequestItems: { // required
|
|
77
|
+
* "<keys>": {
|
|
78
|
+
* Keys: [ // required
|
|
79
|
+
* {
|
|
80
|
+
* "<keys>": { // Union: only one key present
|
|
81
|
+
* S: "STRING_VALUE",
|
|
82
|
+
* N: "STRING_VALUE",
|
|
83
|
+
* B: "BLOB_VALUE",
|
|
84
|
+
* SS: [
|
|
85
|
+
* "STRING_VALUE",
|
|
86
|
+
* ],
|
|
87
|
+
* NS: [
|
|
88
|
+
* "STRING_VALUE",
|
|
89
|
+
* ],
|
|
90
|
+
* BS: [
|
|
91
|
+
* "BLOB_VALUE",
|
|
92
|
+
* ],
|
|
93
|
+
* M: {
|
|
94
|
+
* "<keys>": { // Union: only one key present
|
|
95
|
+
* S: "STRING_VALUE",
|
|
96
|
+
* N: "STRING_VALUE",
|
|
97
|
+
* B: "BLOB_VALUE",
|
|
98
|
+
* SS: [
|
|
99
|
+
* "STRING_VALUE",
|
|
100
|
+
* ],
|
|
101
|
+
* NS: [
|
|
102
|
+
* "STRING_VALUE",
|
|
103
|
+
* ],
|
|
104
|
+
* BS: [
|
|
105
|
+
* "BLOB_VALUE",
|
|
106
|
+
* ],
|
|
107
|
+
* M: {
|
|
108
|
+
* "<keys>": "<AttributeValue>",
|
|
109
|
+
* },
|
|
110
|
+
* L: [
|
|
111
|
+
* { // Union: only one key present
|
|
112
|
+
* S: "<AttributeValue>",
|
|
113
|
+
* N: "<AttributeValue>",
|
|
114
|
+
* B: "<AttributeValue>",
|
|
115
|
+
* SS: "<AttributeValue>",
|
|
116
|
+
* NS: "<AttributeValue>",
|
|
117
|
+
* BS: "<AttributeValue>",
|
|
118
|
+
* M: "<AttributeValue>",
|
|
119
|
+
* L: [
|
|
120
|
+
* { // Union: only one key present
|
|
121
|
+
* S: "<AttributeValue>",
|
|
122
|
+
* N: "<AttributeValue>",
|
|
123
|
+
* B: "<AttributeValue>",
|
|
124
|
+
* SS: "<AttributeValue>",
|
|
125
|
+
* NS: "<AttributeValue>",
|
|
126
|
+
* BS: "<AttributeValue>",
|
|
127
|
+
* M: "<AttributeValue>",
|
|
128
|
+
* L: "<AttributeValue>",
|
|
129
|
+
* NULL: true || false,
|
|
130
|
+
* BOOL: true || false,
|
|
131
|
+
* },
|
|
132
|
+
* ],
|
|
133
|
+
* NULL: true || false,
|
|
134
|
+
* BOOL: true || false,
|
|
135
|
+
* },
|
|
136
|
+
* ],
|
|
137
|
+
* NULL: "<AttributeValue>",
|
|
138
|
+
* BOOL: "<AttributeValue>",
|
|
139
|
+
* },
|
|
140
|
+
* },
|
|
141
|
+
* L: "<AttributeValue>",
|
|
142
|
+
* NULL: "<AttributeValue>",
|
|
143
|
+
* BOOL: "<AttributeValue>",
|
|
144
|
+
* },
|
|
145
|
+
* },
|
|
146
|
+
* ],
|
|
147
|
+
* AttributesToGet: [
|
|
148
|
+
* "STRING_VALUE",
|
|
149
|
+
* ],
|
|
150
|
+
* ConsistentRead: true || false,
|
|
151
|
+
* ProjectionExpression: "STRING_VALUE",
|
|
152
|
+
* ExpressionAttributeNames: {
|
|
153
|
+
* "<keys>": "STRING_VALUE",
|
|
154
|
+
* },
|
|
155
|
+
* },
|
|
156
|
+
* },
|
|
157
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
158
|
+
* };
|
|
75
159
|
* const command = new BatchGetItemCommand(input);
|
|
76
160
|
* const response = await client.send(command);
|
|
77
161
|
* ```
|
|
@@ -107,6 +107,90 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
107
107
|
* import { DynamoDBClient, BatchWriteItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
108
108
|
* // const { DynamoDBClient, BatchWriteItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
109
109
|
* const client = new DynamoDBClient(config);
|
|
110
|
+
* const input = {
|
|
111
|
+
* RequestItems: { // required
|
|
112
|
+
* "<keys>": [
|
|
113
|
+
* {
|
|
114
|
+
* PutRequest: {
|
|
115
|
+
* Item: { // required
|
|
116
|
+
* "<keys>": { // Union: only one key present
|
|
117
|
+
* S: "STRING_VALUE",
|
|
118
|
+
* N: "STRING_VALUE",
|
|
119
|
+
* B: "BLOB_VALUE",
|
|
120
|
+
* SS: [
|
|
121
|
+
* "STRING_VALUE",
|
|
122
|
+
* ],
|
|
123
|
+
* NS: [
|
|
124
|
+
* "STRING_VALUE",
|
|
125
|
+
* ],
|
|
126
|
+
* BS: [
|
|
127
|
+
* "BLOB_VALUE",
|
|
128
|
+
* ],
|
|
129
|
+
* M: {
|
|
130
|
+
* "<keys>": { // Union: only one key present
|
|
131
|
+
* S: "STRING_VALUE",
|
|
132
|
+
* N: "STRING_VALUE",
|
|
133
|
+
* B: "BLOB_VALUE",
|
|
134
|
+
* SS: [
|
|
135
|
+
* "STRING_VALUE",
|
|
136
|
+
* ],
|
|
137
|
+
* NS: [
|
|
138
|
+
* "STRING_VALUE",
|
|
139
|
+
* ],
|
|
140
|
+
* BS: [
|
|
141
|
+
* "BLOB_VALUE",
|
|
142
|
+
* ],
|
|
143
|
+
* M: {
|
|
144
|
+
* "<keys>": "<AttributeValue>",
|
|
145
|
+
* },
|
|
146
|
+
* L: [
|
|
147
|
+
* { // Union: only one key present
|
|
148
|
+
* S: "<AttributeValue>",
|
|
149
|
+
* N: "<AttributeValue>",
|
|
150
|
+
* B: "<AttributeValue>",
|
|
151
|
+
* SS: "<AttributeValue>",
|
|
152
|
+
* NS: "<AttributeValue>",
|
|
153
|
+
* BS: "<AttributeValue>",
|
|
154
|
+
* M: "<AttributeValue>",
|
|
155
|
+
* L: [
|
|
156
|
+
* { // Union: only one key present
|
|
157
|
+
* S: "<AttributeValue>",
|
|
158
|
+
* N: "<AttributeValue>",
|
|
159
|
+
* B: "<AttributeValue>",
|
|
160
|
+
* SS: "<AttributeValue>",
|
|
161
|
+
* NS: "<AttributeValue>",
|
|
162
|
+
* BS: "<AttributeValue>",
|
|
163
|
+
* M: "<AttributeValue>",
|
|
164
|
+
* L: "<AttributeValue>",
|
|
165
|
+
* NULL: true || false,
|
|
166
|
+
* BOOL: true || false,
|
|
167
|
+
* },
|
|
168
|
+
* ],
|
|
169
|
+
* NULL: true || false,
|
|
170
|
+
* BOOL: true || false,
|
|
171
|
+
* },
|
|
172
|
+
* ],
|
|
173
|
+
* NULL: "<AttributeValue>",
|
|
174
|
+
* BOOL: "<AttributeValue>",
|
|
175
|
+
* },
|
|
176
|
+
* },
|
|
177
|
+
* L: "<AttributeValue>",
|
|
178
|
+
* NULL: "<AttributeValue>",
|
|
179
|
+
* BOOL: "<AttributeValue>",
|
|
180
|
+
* },
|
|
181
|
+
* },
|
|
182
|
+
* },
|
|
183
|
+
* DeleteRequest: {
|
|
184
|
+
* Key: { // required
|
|
185
|
+
* "<keys>": "<AttributeValue>",
|
|
186
|
+
* },
|
|
187
|
+
* },
|
|
188
|
+
* },
|
|
189
|
+
* ],
|
|
190
|
+
* },
|
|
191
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
192
|
+
* ReturnItemCollectionMetrics: "SIZE" || "NONE",
|
|
193
|
+
* };
|
|
110
194
|
* const command = new BatchWriteItemCommand(input);
|
|
111
195
|
* const response = await client.send(command);
|
|
112
196
|
* ```
|
|
@@ -55,6 +55,10 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
|
|
|
55
55
|
* import { DynamoDBClient, CreateBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
56
56
|
* // const { DynamoDBClient, CreateBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
57
57
|
* const client = new DynamoDBClient(config);
|
|
58
|
+
* const input = {
|
|
59
|
+
* TableName: "STRING_VALUE", // required
|
|
60
|
+
* BackupName: "STRING_VALUE", // required
|
|
61
|
+
* };
|
|
58
62
|
* const command = new CreateBackupCommand(input);
|
|
59
63
|
* const response = await client.send(command);
|
|
60
64
|
* ```
|
|
@@ -88,6 +88,14 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
88
88
|
* import { DynamoDBClient, CreateGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
89
89
|
* // const { DynamoDBClient, CreateGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
90
90
|
* const client = new DynamoDBClient(config);
|
|
91
|
+
* const input = {
|
|
92
|
+
* GlobalTableName: "STRING_VALUE", // required
|
|
93
|
+
* ReplicationGroup: [ // required
|
|
94
|
+
* {
|
|
95
|
+
* RegionName: "STRING_VALUE",
|
|
96
|
+
* },
|
|
97
|
+
* ],
|
|
98
|
+
* };
|
|
91
99
|
* const command = new CreateGlobalTableCommand(input);
|
|
92
100
|
* const response = await client.send(command);
|
|
93
101
|
* ```
|
|
@@ -38,6 +38,81 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
|
|
|
38
38
|
* import { DynamoDBClient, CreateTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
39
39
|
* // const { DynamoDBClient, CreateTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
40
40
|
* const client = new DynamoDBClient(config);
|
|
41
|
+
* const input = {
|
|
42
|
+
* AttributeDefinitions: [ // required
|
|
43
|
+
* {
|
|
44
|
+
* AttributeName: "STRING_VALUE", // required
|
|
45
|
+
* AttributeType: "S" || "N" || "B", // required
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* TableName: "STRING_VALUE", // required
|
|
49
|
+
* KeySchema: [ // required
|
|
50
|
+
* {
|
|
51
|
+
* AttributeName: "STRING_VALUE", // required
|
|
52
|
+
* KeyType: "HASH" || "RANGE", // required
|
|
53
|
+
* },
|
|
54
|
+
* ],
|
|
55
|
+
* LocalSecondaryIndexes: [
|
|
56
|
+
* {
|
|
57
|
+
* IndexName: "STRING_VALUE", // required
|
|
58
|
+
* KeySchema: [ // required
|
|
59
|
+
* {
|
|
60
|
+
* AttributeName: "STRING_VALUE", // required
|
|
61
|
+
* KeyType: "HASH" || "RANGE", // required
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* Projection: {
|
|
65
|
+
* ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
66
|
+
* NonKeyAttributes: [
|
|
67
|
+
* "STRING_VALUE",
|
|
68
|
+
* ],
|
|
69
|
+
* },
|
|
70
|
+
* },
|
|
71
|
+
* ],
|
|
72
|
+
* GlobalSecondaryIndexes: [
|
|
73
|
+
* {
|
|
74
|
+
* IndexName: "STRING_VALUE", // required
|
|
75
|
+
* KeySchema: [ // required
|
|
76
|
+
* {
|
|
77
|
+
* AttributeName: "STRING_VALUE", // required
|
|
78
|
+
* KeyType: "HASH" || "RANGE", // required
|
|
79
|
+
* },
|
|
80
|
+
* ],
|
|
81
|
+
* Projection: {
|
|
82
|
+
* ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
83
|
+
* NonKeyAttributes: [
|
|
84
|
+
* "STRING_VALUE",
|
|
85
|
+
* ],
|
|
86
|
+
* },
|
|
87
|
+
* ProvisionedThroughput: {
|
|
88
|
+
* ReadCapacityUnits: Number("long"), // required
|
|
89
|
+
* WriteCapacityUnits: Number("long"), // required
|
|
90
|
+
* },
|
|
91
|
+
* },
|
|
92
|
+
* ],
|
|
93
|
+
* BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
94
|
+
* ProvisionedThroughput: {
|
|
95
|
+
* ReadCapacityUnits: Number("long"), // required
|
|
96
|
+
* WriteCapacityUnits: Number("long"), // required
|
|
97
|
+
* },
|
|
98
|
+
* StreamSpecification: {
|
|
99
|
+
* StreamEnabled: true || false, // required
|
|
100
|
+
* StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
|
|
101
|
+
* },
|
|
102
|
+
* SSESpecification: {
|
|
103
|
+
* Enabled: true || false,
|
|
104
|
+
* SSEType: "AES256" || "KMS",
|
|
105
|
+
* KMSMasterKeyId: "STRING_VALUE",
|
|
106
|
+
* },
|
|
107
|
+
* Tags: [
|
|
108
|
+
* {
|
|
109
|
+
* Key: "STRING_VALUE", // required
|
|
110
|
+
* Value: "STRING_VALUE", // required
|
|
111
|
+
* },
|
|
112
|
+
* ],
|
|
113
|
+
* TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
114
|
+
* DeletionProtectionEnabled: true || false,
|
|
115
|
+
* };
|
|
41
116
|
* const command = new CreateTableCommand(input);
|
|
42
117
|
* const response = await client.send(command);
|
|
43
118
|
* ```
|
|
@@ -28,6 +28,9 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
|
|
|
28
28
|
* import { DynamoDBClient, DeleteBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
29
29
|
* // const { DynamoDBClient, DeleteBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
30
30
|
* const client = new DynamoDBClient(config);
|
|
31
|
+
* const input = {
|
|
32
|
+
* BackupArn: "STRING_VALUE", // required
|
|
33
|
+
* };
|
|
31
34
|
* const command = new DeleteBackupCommand(input);
|
|
32
35
|
* const response = await client.send(command);
|
|
33
36
|
* ```
|
|
@@ -36,6 +36,119 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
|
|
|
36
36
|
* import { DynamoDBClient, DeleteItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
37
37
|
* // const { DynamoDBClient, DeleteItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
38
38
|
* const client = new DynamoDBClient(config);
|
|
39
|
+
* const input = {
|
|
40
|
+
* TableName: "STRING_VALUE", // required
|
|
41
|
+
* Key: { // required
|
|
42
|
+
* "<keys>": { // Union: only one key present
|
|
43
|
+
* S: "STRING_VALUE",
|
|
44
|
+
* N: "STRING_VALUE",
|
|
45
|
+
* B: "BLOB_VALUE",
|
|
46
|
+
* SS: [
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* NS: [
|
|
50
|
+
* "STRING_VALUE",
|
|
51
|
+
* ],
|
|
52
|
+
* BS: [
|
|
53
|
+
* "BLOB_VALUE",
|
|
54
|
+
* ],
|
|
55
|
+
* M: {
|
|
56
|
+
* "<keys>": { // Union: only one key present
|
|
57
|
+
* S: "STRING_VALUE",
|
|
58
|
+
* N: "STRING_VALUE",
|
|
59
|
+
* B: "BLOB_VALUE",
|
|
60
|
+
* SS: [
|
|
61
|
+
* "STRING_VALUE",
|
|
62
|
+
* ],
|
|
63
|
+
* NS: [
|
|
64
|
+
* "STRING_VALUE",
|
|
65
|
+
* ],
|
|
66
|
+
* BS: [
|
|
67
|
+
* "BLOB_VALUE",
|
|
68
|
+
* ],
|
|
69
|
+
* M: {
|
|
70
|
+
* "<keys>": "<AttributeValue>",
|
|
71
|
+
* },
|
|
72
|
+
* L: [
|
|
73
|
+
* { // Union: only one key present
|
|
74
|
+
* S: "<AttributeValue>",
|
|
75
|
+
* N: "<AttributeValue>",
|
|
76
|
+
* B: "<AttributeValue>",
|
|
77
|
+
* SS: "<AttributeValue>",
|
|
78
|
+
* NS: "<AttributeValue>",
|
|
79
|
+
* BS: "<AttributeValue>",
|
|
80
|
+
* M: "<AttributeValue>",
|
|
81
|
+
* L: [
|
|
82
|
+
* { // Union: only one key present
|
|
83
|
+
* S: "<AttributeValue>",
|
|
84
|
+
* N: "<AttributeValue>",
|
|
85
|
+
* B: "<AttributeValue>",
|
|
86
|
+
* SS: "<AttributeValue>",
|
|
87
|
+
* NS: "<AttributeValue>",
|
|
88
|
+
* BS: "<AttributeValue>",
|
|
89
|
+
* M: "<AttributeValue>",
|
|
90
|
+
* L: "<AttributeValue>",
|
|
91
|
+
* NULL: true || false,
|
|
92
|
+
* BOOL: true || false,
|
|
93
|
+
* },
|
|
94
|
+
* ],
|
|
95
|
+
* NULL: true || false,
|
|
96
|
+
* BOOL: true || false,
|
|
97
|
+
* },
|
|
98
|
+
* ],
|
|
99
|
+
* NULL: "<AttributeValue>",
|
|
100
|
+
* BOOL: "<AttributeValue>",
|
|
101
|
+
* },
|
|
102
|
+
* },
|
|
103
|
+
* L: "<AttributeValue>",
|
|
104
|
+
* NULL: "<AttributeValue>",
|
|
105
|
+
* BOOL: "<AttributeValue>",
|
|
106
|
+
* },
|
|
107
|
+
* },
|
|
108
|
+
* Expected: {
|
|
109
|
+
* "<keys>": {
|
|
110
|
+
* Value: { // Union: only one key present
|
|
111
|
+
* S: "<AttributeValue>",
|
|
112
|
+
* N: "<AttributeValue>",
|
|
113
|
+
* B: "<AttributeValue>",
|
|
114
|
+
* SS: "<AttributeValue>",
|
|
115
|
+
* NS: "<AttributeValue>",
|
|
116
|
+
* BS: "<AttributeValue>",
|
|
117
|
+
* M: "<AttributeValue>",
|
|
118
|
+
* L: "<AttributeValue>",
|
|
119
|
+
* NULL: "<AttributeValue>",
|
|
120
|
+
* BOOL: "<AttributeValue>",
|
|
121
|
+
* },
|
|
122
|
+
* Exists: true || false,
|
|
123
|
+
* ComparisonOperator: "EQ" || "NE" || "IN" || "LE" || "LT" || "GE" || "GT" || "BETWEEN" || "NOT_NULL" || "NULL" || "CONTAINS" || "NOT_CONTAINS" || "BEGINS_WITH",
|
|
124
|
+
* AttributeValueList: [
|
|
125
|
+
* { // Union: only one key present
|
|
126
|
+
* S: "<AttributeValue>",
|
|
127
|
+
* N: "<AttributeValue>",
|
|
128
|
+
* B: "<AttributeValue>",
|
|
129
|
+
* SS: "<AttributeValue>",
|
|
130
|
+
* NS: "<AttributeValue>",
|
|
131
|
+
* BS: "<AttributeValue>",
|
|
132
|
+
* M: "<AttributeValue>",
|
|
133
|
+
* L: "<AttributeValue>",
|
|
134
|
+
* NULL: "<AttributeValue>",
|
|
135
|
+
* BOOL: "<AttributeValue>",
|
|
136
|
+
* },
|
|
137
|
+
* ],
|
|
138
|
+
* },
|
|
139
|
+
* },
|
|
140
|
+
* ConditionalOperator: "AND" || "OR",
|
|
141
|
+
* ReturnValues: "NONE" || "ALL_OLD" || "UPDATED_OLD" || "ALL_NEW" || "UPDATED_NEW",
|
|
142
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
143
|
+
* ReturnItemCollectionMetrics: "SIZE" || "NONE",
|
|
144
|
+
* ConditionExpression: "STRING_VALUE",
|
|
145
|
+
* ExpressionAttributeNames: {
|
|
146
|
+
* "<keys>": "STRING_VALUE",
|
|
147
|
+
* },
|
|
148
|
+
* ExpressionAttributeValues: {
|
|
149
|
+
* "<keys>": "<AttributeValue>",
|
|
150
|
+
* },
|
|
151
|
+
* };
|
|
39
152
|
* const command = new DeleteItemCommand(input);
|
|
40
153
|
* const response = await client.send(command);
|
|
41
154
|
* ```
|
|
@@ -48,6 +48,9 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
|
|
|
48
48
|
* import { DynamoDBClient, DeleteTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
49
49
|
* // const { DynamoDBClient, DeleteTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
50
50
|
* const client = new DynamoDBClient(config);
|
|
51
|
+
* const input = {
|
|
52
|
+
* TableName: "STRING_VALUE", // required
|
|
53
|
+
* };
|
|
51
54
|
* const command = new DeleteTableCommand(input);
|
|
52
55
|
* const response = await client.send(command);
|
|
53
56
|
* ```
|
|
@@ -28,6 +28,9 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met
|
|
|
28
28
|
* import { DynamoDBClient, DescribeBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
29
29
|
* // const { DynamoDBClient, DescribeBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
30
30
|
* const client = new DynamoDBClient(config);
|
|
31
|
+
* const input = {
|
|
32
|
+
* BackupArn: "STRING_VALUE", // required
|
|
33
|
+
* };
|
|
31
34
|
* const command = new DescribeBackupCommand(input);
|
|
32
35
|
* const response = await client.send(command);
|
|
33
36
|
* ```
|
|
@@ -37,6 +37,9 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo
|
|
|
37
37
|
* import { DynamoDBClient, DescribeContinuousBackupsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
38
38
|
* // const { DynamoDBClient, DescribeContinuousBackupsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
39
39
|
* const client = new DynamoDBClient(config);
|
|
40
|
+
* const input = {
|
|
41
|
+
* TableName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
40
43
|
* const command = new DescribeContinuousBackupsCommand(input);
|
|
41
44
|
* const response = await client.send(command);
|
|
42
45
|
* ```
|
|
@@ -27,6 +27,10 @@ export interface DescribeContributorInsightsCommandOutput extends DescribeContri
|
|
|
27
27
|
* import { DynamoDBClient, DescribeContributorInsightsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
28
28
|
* // const { DynamoDBClient, DescribeContributorInsightsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
29
29
|
* const client = new DynamoDBClient(config);
|
|
30
|
+
* const input = {
|
|
31
|
+
* TableName: "STRING_VALUE", // required
|
|
32
|
+
* IndexName: "STRING_VALUE",
|
|
33
|
+
* };
|
|
30
34
|
* const command = new DescribeContributorInsightsCommand(input);
|
|
31
35
|
* const response = await client.send(command);
|
|
32
36
|
* ```
|
|
@@ -28,6 +28,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
|
|
|
28
28
|
* import { DynamoDBClient, DescribeEndpointsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
29
29
|
* // const { DynamoDBClient, DescribeEndpointsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
30
30
|
* const client = new DynamoDBClient(config);
|
|
31
|
+
* const input = {};
|
|
31
32
|
* const command = new DescribeEndpointsCommand(input);
|
|
32
33
|
* const response = await client.send(command);
|
|
33
34
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface DescribeExportCommandOutput extends DescribeExportOutput, __Met
|
|
|
26
26
|
* import { DynamoDBClient, DescribeExportCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
27
27
|
* // const { DynamoDBClient, DescribeExportCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
28
28
|
* const client = new DynamoDBClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ExportArn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new DescribeExportCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -38,6 +38,9 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
|
|
|
38
38
|
* import { DynamoDBClient, DescribeGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
39
39
|
* // const { DynamoDBClient, DescribeGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
40
40
|
* const client = new DynamoDBClient(config);
|
|
41
|
+
* const input = {
|
|
42
|
+
* GlobalTableName: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
41
44
|
* const command = new DescribeGlobalTableCommand(input);
|
|
42
45
|
* const response = await client.send(command);
|
|
43
46
|
* ```
|
|
@@ -38,6 +38,9 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
|
|
|
38
38
|
* import { DynamoDBClient, DescribeGlobalTableSettingsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
39
39
|
* // const { DynamoDBClient, DescribeGlobalTableSettingsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
40
40
|
* const client = new DynamoDBClient(config);
|
|
41
|
+
* const input = {
|
|
42
|
+
* GlobalTableName: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
41
44
|
* const command = new DescribeGlobalTableSettingsCommand(input);
|
|
42
45
|
* const response = await client.send(command);
|
|
43
46
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface DescribeImportCommandOutput extends DescribeImportOutput, __Met
|
|
|
26
26
|
* import { DynamoDBClient, DescribeImportCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
27
27
|
* // const { DynamoDBClient, DescribeImportCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
28
28
|
* const client = new DynamoDBClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ImportArn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new DescribeImportCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface DescribeKinesisStreamingDestinationCommandOutput extends Descri
|
|
|
26
26
|
* import { DynamoDBClient, DescribeKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
27
27
|
* // const { DynamoDBClient, DescribeKinesisStreamingDestinationCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
28
28
|
* const client = new DynamoDBClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* TableName: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new DescribeKinesisStreamingDestinationCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -95,6 +95,7 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
|
|
|
95
95
|
* import { DynamoDBClient, DescribeLimitsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
96
96
|
* // const { DynamoDBClient, DescribeLimitsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
97
97
|
* const client = new DynamoDBClient(config);
|
|
98
|
+
* const input = {};
|
|
98
99
|
* const command = new DescribeLimitsCommand(input);
|
|
99
100
|
* const response = await client.send(command);
|
|
100
101
|
* ```
|
|
@@ -40,6 +40,9 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
|
|
|
40
40
|
* import { DynamoDBClient, DescribeTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
41
41
|
* // const { DynamoDBClient, DescribeTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
42
42
|
* const client = new DynamoDBClient(config);
|
|
43
|
+
* const input = {
|
|
44
|
+
* TableName: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
43
46
|
* const command = new DescribeTableCommand(input);
|
|
44
47
|
* const response = await client.send(command);
|
|
45
48
|
* ```
|
|
@@ -30,6 +30,9 @@ export interface DescribeTableReplicaAutoScalingCommandOutput extends DescribeTa
|
|
|
30
30
|
* import { DynamoDBClient, DescribeTableReplicaAutoScalingCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
31
31
|
* // const { DynamoDBClient, DescribeTableReplicaAutoScalingCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
32
32
|
* const client = new DynamoDBClient(config);
|
|
33
|
+
* const input = {
|
|
34
|
+
* TableName: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
33
36
|
* const command = new DescribeTableReplicaAutoScalingCommand(input);
|
|
34
37
|
* const response = await client.send(command);
|
|
35
38
|
* ```
|