@aws-sdk/client-dynamodb 3.321.1 → 3.326.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 +86 -0
- package/dist-types/commands/BatchGetItemCommand.d.ts +98 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +102 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +14 -0
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +36 -0
- package/dist-types/commands/CreateTableCommand.d.ts +140 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +89 -0
- package/dist-types/commands/DeleteItemCommand.d.ts +83 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +140 -0
- package/dist-types/commands/DescribeBackupCommand.d.ts +89 -0
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +13 -0
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +11 -0
- package/dist-types/commands/DescribeExportCommand.d.ts +26 -0
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +36 -0
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +98 -0
- package/dist-types/commands/DescribeImportCommand.d.ts +82 -0
- package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +13 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +9 -0
- package/dist-types/commands/DescribeTableCommand.d.ts +140 -0
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +89 -0
- package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +9 -0
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +8 -0
- package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +8 -0
- package/dist-types/commands/ExecuteStatementCommand.d.ts +81 -0
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +81 -0
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +26 -0
- package/dist-types/commands/GetItemCommand.d.ts +75 -0
- package/dist-types/commands/ImportTableCommand.d.ts +82 -0
- package/dist-types/commands/ListBackupsCommand.d.ts +20 -0
- package/dist-types/commands/ListContributorInsightsCommand.d.ts +13 -0
- package/dist-types/commands/ListExportsCommand.d.ts +12 -0
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +16 -0
- package/dist-types/commands/ListImportsCommand.d.ts +22 -0
- package/dist-types/commands/ListTablesCommand.d.ts +9 -0
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +12 -0
- package/dist-types/commands/PutItemCommand.d.ts +83 -0
- package/dist-types/commands/QueryCommand.d.ts +82 -0
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +140 -0
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +140 -0
- package/dist-types/commands/ScanCommand.d.ts +82 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/TransactGetItemsCommand.d.ts +81 -0
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +86 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +13 -0
- package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +8 -0
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +36 -0
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +98 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +83 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +140 -0
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +89 -0
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +9 -0
- package/package.json +17 -17
|
@@ -31,6 +31,86 @@ export interface DescribeImportCommandOutput extends DescribeImportOutput, __Met
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeImportCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeImportOutput
|
|
35
|
+
* // ImportTableDescription: { // ImportTableDescription
|
|
36
|
+
* // ImportArn: "STRING_VALUE",
|
|
37
|
+
* // ImportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELLING" || "CANCELLED" || "FAILED",
|
|
38
|
+
* // TableArn: "STRING_VALUE",
|
|
39
|
+
* // TableId: "STRING_VALUE",
|
|
40
|
+
* // ClientToken: "STRING_VALUE",
|
|
41
|
+
* // S3BucketSource: { // S3BucketSource
|
|
42
|
+
* // S3BucketOwner: "STRING_VALUE",
|
|
43
|
+
* // S3Bucket: "STRING_VALUE", // required
|
|
44
|
+
* // S3KeyPrefix: "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // ErrorCount: Number("long"),
|
|
47
|
+
* // CloudWatchLogGroupArn: "STRING_VALUE",
|
|
48
|
+
* // InputFormat: "DYNAMODB_JSON" || "ION" || "CSV",
|
|
49
|
+
* // InputFormatOptions: { // InputFormatOptions
|
|
50
|
+
* // Csv: { // CsvOptions
|
|
51
|
+
* // Delimiter: "STRING_VALUE",
|
|
52
|
+
* // HeaderList: [ // CsvHeaderList
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // InputCompressionType: "GZIP" || "ZSTD" || "NONE",
|
|
58
|
+
* // TableCreationParameters: { // TableCreationParameters
|
|
59
|
+
* // TableName: "STRING_VALUE", // required
|
|
60
|
+
* // AttributeDefinitions: [ // AttributeDefinitions // required
|
|
61
|
+
* // { // AttributeDefinition
|
|
62
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
63
|
+
* // AttributeType: "S" || "N" || "B", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // KeySchema: [ // KeySchema // required
|
|
67
|
+
* // { // KeySchemaElement
|
|
68
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
69
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
73
|
+
* // ProvisionedThroughput: { // ProvisionedThroughput
|
|
74
|
+
* // ReadCapacityUnits: Number("long"), // required
|
|
75
|
+
* // WriteCapacityUnits: Number("long"), // required
|
|
76
|
+
* // },
|
|
77
|
+
* // SSESpecification: { // SSESpecification
|
|
78
|
+
* // Enabled: true || false,
|
|
79
|
+
* // SSEType: "AES256" || "KMS",
|
|
80
|
+
* // KMSMasterKeyId: "STRING_VALUE",
|
|
81
|
+
* // },
|
|
82
|
+
* // GlobalSecondaryIndexes: [ // GlobalSecondaryIndexList
|
|
83
|
+
* // { // GlobalSecondaryIndex
|
|
84
|
+
* // IndexName: "STRING_VALUE", // required
|
|
85
|
+
* // KeySchema: [ // required
|
|
86
|
+
* // {
|
|
87
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
88
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
91
|
+
* // Projection: { // Projection
|
|
92
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
93
|
+
* // NonKeyAttributes: [ // NonKeyAttributeNameList
|
|
94
|
+
* // "STRING_VALUE",
|
|
95
|
+
* // ],
|
|
96
|
+
* // },
|
|
97
|
+
* // ProvisionedThroughput: {
|
|
98
|
+
* // ReadCapacityUnits: Number("long"), // required
|
|
99
|
+
* // WriteCapacityUnits: Number("long"), // required
|
|
100
|
+
* // },
|
|
101
|
+
* // },
|
|
102
|
+
* // ],
|
|
103
|
+
* // },
|
|
104
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
105
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
106
|
+
* // ProcessedSizeBytes: Number("long"),
|
|
107
|
+
* // ProcessedItemCount: Number("long"),
|
|
108
|
+
* // ImportedItemCount: Number("long"),
|
|
109
|
+
* // FailureCode: "STRING_VALUE",
|
|
110
|
+
* // FailureMessage: "STRING_VALUE",
|
|
111
|
+
* // },
|
|
112
|
+
* // };
|
|
113
|
+
*
|
|
34
114
|
* ```
|
|
35
115
|
*
|
|
36
116
|
* @param DescribeImportCommandInput - {@link DescribeImportCommandInput}
|
|
@@ -44,6 +124,8 @@ export interface DescribeImportCommandOutput extends DescribeImportOutput, __Met
|
|
|
44
124
|
* The specified import was not found.
|
|
45
125
|
* </p>
|
|
46
126
|
*
|
|
127
|
+
* @throws {@link DynamoDBServiceException}
|
|
128
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
47
129
|
*
|
|
48
130
|
*/
|
|
49
131
|
export declare class DescribeImportCommand extends $Command<DescribeImportCommandInput, DescribeImportCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -31,6 +31,17 @@ export interface DescribeKinesisStreamingDestinationCommandOutput extends Descri
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeKinesisStreamingDestinationCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeKinesisStreamingDestinationOutput
|
|
35
|
+
* // TableName: "STRING_VALUE",
|
|
36
|
+
* // KinesisDataStreamDestinations: [ // KinesisDataStreamDestinations
|
|
37
|
+
* // { // KinesisDataStreamDestination
|
|
38
|
+
* // StreamArn: "STRING_VALUE",
|
|
39
|
+
* // DestinationStatus: "ENABLING" || "ACTIVE" || "DISABLING" || "DISABLED" || "ENABLE_FAILED",
|
|
40
|
+
* // DestinationStatusDescription: "STRING_VALUE",
|
|
41
|
+
* // },
|
|
42
|
+
* // ],
|
|
43
|
+
* // };
|
|
44
|
+
*
|
|
34
45
|
* ```
|
|
35
46
|
*
|
|
36
47
|
* @param DescribeKinesisStreamingDestinationCommandInput - {@link DescribeKinesisStreamingDestinationCommandInput}
|
|
@@ -48,6 +59,8 @@ export interface DescribeKinesisStreamingDestinationCommandOutput extends Descri
|
|
|
48
59
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
49
60
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
50
61
|
*
|
|
62
|
+
* @throws {@link DynamoDBServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
51
64
|
*
|
|
52
65
|
*/
|
|
53
66
|
export declare class DescribeKinesisStreamingDestinationCommand extends $Command<DescribeKinesisStreamingDestinationCommandInput, DescribeKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -98,6 +98,13 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
|
|
|
98
98
|
* const input = {};
|
|
99
99
|
* const command = new DescribeLimitsCommand(input);
|
|
100
100
|
* const response = await client.send(command);
|
|
101
|
+
* // { // DescribeLimitsOutput
|
|
102
|
+
* // AccountMaxReadCapacityUnits: Number("long"),
|
|
103
|
+
* // AccountMaxWriteCapacityUnits: Number("long"),
|
|
104
|
+
* // TableMaxReadCapacityUnits: Number("long"),
|
|
105
|
+
* // TableMaxWriteCapacityUnits: Number("long"),
|
|
106
|
+
* // };
|
|
107
|
+
*
|
|
101
108
|
* ```
|
|
102
109
|
*
|
|
103
110
|
* @param DescribeLimitsCommandInput - {@link DescribeLimitsCommandInput}
|
|
@@ -111,6 +118,8 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
|
|
|
111
118
|
*
|
|
112
119
|
* @throws {@link InvalidEndpointException} (client fault)
|
|
113
120
|
*
|
|
121
|
+
* @throws {@link DynamoDBServiceException}
|
|
122
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
114
123
|
*
|
|
115
124
|
* @example To determine capacity limits per table and account, in the current AWS region
|
|
116
125
|
* ```javascript
|
|
@@ -45,6 +45,144 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new DescribeTableCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // { // DescribeTableOutput
|
|
49
|
+
* // Table: { // TableDescription
|
|
50
|
+
* // AttributeDefinitions: [ // AttributeDefinitions
|
|
51
|
+
* // { // AttributeDefinition
|
|
52
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
53
|
+
* // AttributeType: "S" || "N" || "B", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // TableName: "STRING_VALUE",
|
|
57
|
+
* // KeySchema: [ // KeySchema
|
|
58
|
+
* // { // KeySchemaElement
|
|
59
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
60
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
|
|
64
|
+
* // CreationDateTime: new Date("TIMESTAMP"),
|
|
65
|
+
* // ProvisionedThroughput: { // ProvisionedThroughputDescription
|
|
66
|
+
* // LastIncreaseDateTime: new Date("TIMESTAMP"),
|
|
67
|
+
* // LastDecreaseDateTime: new Date("TIMESTAMP"),
|
|
68
|
+
* // NumberOfDecreasesToday: Number("long"),
|
|
69
|
+
* // ReadCapacityUnits: Number("long"),
|
|
70
|
+
* // WriteCapacityUnits: Number("long"),
|
|
71
|
+
* // },
|
|
72
|
+
* // TableSizeBytes: Number("long"),
|
|
73
|
+
* // ItemCount: Number("long"),
|
|
74
|
+
* // TableArn: "STRING_VALUE",
|
|
75
|
+
* // TableId: "STRING_VALUE",
|
|
76
|
+
* // BillingModeSummary: { // BillingModeSummary
|
|
77
|
+
* // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
78
|
+
* // LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
|
|
79
|
+
* // },
|
|
80
|
+
* // LocalSecondaryIndexes: [ // LocalSecondaryIndexDescriptionList
|
|
81
|
+
* // { // LocalSecondaryIndexDescription
|
|
82
|
+
* // IndexName: "STRING_VALUE",
|
|
83
|
+
* // KeySchema: [
|
|
84
|
+
* // {
|
|
85
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
86
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
87
|
+
* // },
|
|
88
|
+
* // ],
|
|
89
|
+
* // Projection: { // Projection
|
|
90
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
91
|
+
* // NonKeyAttributes: [ // NonKeyAttributeNameList
|
|
92
|
+
* // "STRING_VALUE",
|
|
93
|
+
* // ],
|
|
94
|
+
* // },
|
|
95
|
+
* // IndexSizeBytes: Number("long"),
|
|
96
|
+
* // ItemCount: Number("long"),
|
|
97
|
+
* // IndexArn: "STRING_VALUE",
|
|
98
|
+
* // },
|
|
99
|
+
* // ],
|
|
100
|
+
* // GlobalSecondaryIndexes: [ // GlobalSecondaryIndexDescriptionList
|
|
101
|
+
* // { // GlobalSecondaryIndexDescription
|
|
102
|
+
* // IndexName: "STRING_VALUE",
|
|
103
|
+
* // KeySchema: [
|
|
104
|
+
* // {
|
|
105
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
106
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
107
|
+
* // },
|
|
108
|
+
* // ],
|
|
109
|
+
* // Projection: {
|
|
110
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
111
|
+
* // NonKeyAttributes: [
|
|
112
|
+
* // "STRING_VALUE",
|
|
113
|
+
* // ],
|
|
114
|
+
* // },
|
|
115
|
+
* // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
|
|
116
|
+
* // Backfilling: true || false,
|
|
117
|
+
* // ProvisionedThroughput: {
|
|
118
|
+
* // LastIncreaseDateTime: new Date("TIMESTAMP"),
|
|
119
|
+
* // LastDecreaseDateTime: new Date("TIMESTAMP"),
|
|
120
|
+
* // NumberOfDecreasesToday: Number("long"),
|
|
121
|
+
* // ReadCapacityUnits: Number("long"),
|
|
122
|
+
* // WriteCapacityUnits: Number("long"),
|
|
123
|
+
* // },
|
|
124
|
+
* // IndexSizeBytes: Number("long"),
|
|
125
|
+
* // ItemCount: Number("long"),
|
|
126
|
+
* // IndexArn: "STRING_VALUE",
|
|
127
|
+
* // },
|
|
128
|
+
* // ],
|
|
129
|
+
* // StreamSpecification: { // StreamSpecification
|
|
130
|
+
* // StreamEnabled: true || false, // required
|
|
131
|
+
* // StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
|
|
132
|
+
* // },
|
|
133
|
+
* // LatestStreamLabel: "STRING_VALUE",
|
|
134
|
+
* // LatestStreamArn: "STRING_VALUE",
|
|
135
|
+
* // GlobalTableVersion: "STRING_VALUE",
|
|
136
|
+
* // Replicas: [ // ReplicaDescriptionList
|
|
137
|
+
* // { // ReplicaDescription
|
|
138
|
+
* // RegionName: "STRING_VALUE",
|
|
139
|
+
* // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
|
|
140
|
+
* // ReplicaStatusDescription: "STRING_VALUE",
|
|
141
|
+
* // ReplicaStatusPercentProgress: "STRING_VALUE",
|
|
142
|
+
* // KMSMasterKeyId: "STRING_VALUE",
|
|
143
|
+
* // ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
|
|
144
|
+
* // ReadCapacityUnits: Number("long"),
|
|
145
|
+
* // },
|
|
146
|
+
* // GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
|
|
147
|
+
* // { // ReplicaGlobalSecondaryIndexDescription
|
|
148
|
+
* // IndexName: "STRING_VALUE",
|
|
149
|
+
* // ProvisionedThroughputOverride: {
|
|
150
|
+
* // ReadCapacityUnits: Number("long"),
|
|
151
|
+
* // },
|
|
152
|
+
* // },
|
|
153
|
+
* // ],
|
|
154
|
+
* // ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
|
|
155
|
+
* // ReplicaTableClassSummary: { // TableClassSummary
|
|
156
|
+
* // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
157
|
+
* // LastUpdateDateTime: new Date("TIMESTAMP"),
|
|
158
|
+
* // },
|
|
159
|
+
* // },
|
|
160
|
+
* // ],
|
|
161
|
+
* // RestoreSummary: { // RestoreSummary
|
|
162
|
+
* // SourceBackupArn: "STRING_VALUE",
|
|
163
|
+
* // SourceTableArn: "STRING_VALUE",
|
|
164
|
+
* // RestoreDateTime: new Date("TIMESTAMP"), // required
|
|
165
|
+
* // RestoreInProgress: true || false, // required
|
|
166
|
+
* // },
|
|
167
|
+
* // SSEDescription: { // SSEDescription
|
|
168
|
+
* // Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
|
|
169
|
+
* // SSEType: "AES256" || "KMS",
|
|
170
|
+
* // KMSMasterKeyArn: "STRING_VALUE",
|
|
171
|
+
* // InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
|
|
172
|
+
* // },
|
|
173
|
+
* // ArchivalSummary: { // ArchivalSummary
|
|
174
|
+
* // ArchivalDateTime: new Date("TIMESTAMP"),
|
|
175
|
+
* // ArchivalReason: "STRING_VALUE",
|
|
176
|
+
* // ArchivalBackupArn: "STRING_VALUE",
|
|
177
|
+
* // },
|
|
178
|
+
* // TableClassSummary: {
|
|
179
|
+
* // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
180
|
+
* // LastUpdateDateTime: new Date("TIMESTAMP"),
|
|
181
|
+
* // },
|
|
182
|
+
* // DeletionProtectionEnabled: true || false,
|
|
183
|
+
* // },
|
|
184
|
+
* // };
|
|
185
|
+
*
|
|
48
186
|
* ```
|
|
49
187
|
*
|
|
50
188
|
* @param DescribeTableCommandInput - {@link DescribeTableCommandInput}
|
|
@@ -62,6 +200,8 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
|
|
|
62
200
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
63
201
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
64
202
|
*
|
|
203
|
+
* @throws {@link DynamoDBServiceException}
|
|
204
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
65
205
|
*
|
|
66
206
|
* @example To describe a table
|
|
67
207
|
* ```javascript
|
|
@@ -35,6 +35,93 @@ export interface DescribeTableReplicaAutoScalingCommandOutput extends DescribeTa
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DescribeTableReplicaAutoScalingCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // DescribeTableReplicaAutoScalingOutput
|
|
39
|
+
* // TableAutoScalingDescription: { // TableAutoScalingDescription
|
|
40
|
+
* // TableName: "STRING_VALUE",
|
|
41
|
+
* // TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
|
|
42
|
+
* // Replicas: [ // ReplicaAutoScalingDescriptionList
|
|
43
|
+
* // { // ReplicaAutoScalingDescription
|
|
44
|
+
* // RegionName: "STRING_VALUE",
|
|
45
|
+
* // GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexAutoScalingDescriptionList
|
|
46
|
+
* // { // ReplicaGlobalSecondaryIndexAutoScalingDescription
|
|
47
|
+
* // IndexName: "STRING_VALUE",
|
|
48
|
+
* // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
|
|
49
|
+
* // ProvisionedReadCapacityAutoScalingSettings: { // AutoScalingSettingsDescription
|
|
50
|
+
* // MinimumUnits: Number("long"),
|
|
51
|
+
* // MaximumUnits: Number("long"),
|
|
52
|
+
* // AutoScalingDisabled: true || false,
|
|
53
|
+
* // AutoScalingRoleArn: "STRING_VALUE",
|
|
54
|
+
* // ScalingPolicies: [ // AutoScalingPolicyDescriptionList
|
|
55
|
+
* // { // AutoScalingPolicyDescription
|
|
56
|
+
* // PolicyName: "STRING_VALUE",
|
|
57
|
+
* // TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationDescription
|
|
58
|
+
* // DisableScaleIn: true || false,
|
|
59
|
+
* // ScaleInCooldown: Number("int"),
|
|
60
|
+
* // ScaleOutCooldown: Number("int"),
|
|
61
|
+
* // TargetValue: Number("double"), // required
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // ProvisionedWriteCapacityAutoScalingSettings: {
|
|
67
|
+
* // MinimumUnits: Number("long"),
|
|
68
|
+
* // MaximumUnits: Number("long"),
|
|
69
|
+
* // AutoScalingDisabled: true || false,
|
|
70
|
+
* // AutoScalingRoleArn: "STRING_VALUE",
|
|
71
|
+
* // ScalingPolicies: [
|
|
72
|
+
* // {
|
|
73
|
+
* // PolicyName: "STRING_VALUE",
|
|
74
|
+
* // TargetTrackingScalingPolicyConfiguration: {
|
|
75
|
+
* // DisableScaleIn: true || false,
|
|
76
|
+
* // ScaleInCooldown: Number("int"),
|
|
77
|
+
* // ScaleOutCooldown: Number("int"),
|
|
78
|
+
* // TargetValue: Number("double"), // required
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // ReplicaProvisionedReadCapacityAutoScalingSettings: {
|
|
86
|
+
* // MinimumUnits: Number("long"),
|
|
87
|
+
* // MaximumUnits: Number("long"),
|
|
88
|
+
* // AutoScalingDisabled: true || false,
|
|
89
|
+
* // AutoScalingRoleArn: "STRING_VALUE",
|
|
90
|
+
* // ScalingPolicies: [
|
|
91
|
+
* // {
|
|
92
|
+
* // PolicyName: "STRING_VALUE",
|
|
93
|
+
* // TargetTrackingScalingPolicyConfiguration: {
|
|
94
|
+
* // DisableScaleIn: true || false,
|
|
95
|
+
* // ScaleInCooldown: Number("int"),
|
|
96
|
+
* // ScaleOutCooldown: Number("int"),
|
|
97
|
+
* // TargetValue: Number("double"), // required
|
|
98
|
+
* // },
|
|
99
|
+
* // },
|
|
100
|
+
* // ],
|
|
101
|
+
* // },
|
|
102
|
+
* // ReplicaProvisionedWriteCapacityAutoScalingSettings: {
|
|
103
|
+
* // MinimumUnits: Number("long"),
|
|
104
|
+
* // MaximumUnits: Number("long"),
|
|
105
|
+
* // AutoScalingDisabled: true || false,
|
|
106
|
+
* // AutoScalingRoleArn: "STRING_VALUE",
|
|
107
|
+
* // ScalingPolicies: [
|
|
108
|
+
* // {
|
|
109
|
+
* // PolicyName: "STRING_VALUE",
|
|
110
|
+
* // TargetTrackingScalingPolicyConfiguration: {
|
|
111
|
+
* // DisableScaleIn: true || false,
|
|
112
|
+
* // ScaleInCooldown: Number("int"),
|
|
113
|
+
* // ScaleOutCooldown: Number("int"),
|
|
114
|
+
* // TargetValue: Number("double"), // required
|
|
115
|
+
* // },
|
|
116
|
+
* // },
|
|
117
|
+
* // ],
|
|
118
|
+
* // },
|
|
119
|
+
* // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
|
|
120
|
+
* // },
|
|
121
|
+
* // ],
|
|
122
|
+
* // },
|
|
123
|
+
* // };
|
|
124
|
+
*
|
|
38
125
|
* ```
|
|
39
126
|
*
|
|
40
127
|
* @param DescribeTableReplicaAutoScalingCommandInput - {@link DescribeTableReplicaAutoScalingCommandInput}
|
|
@@ -50,6 +137,8 @@ export interface DescribeTableReplicaAutoScalingCommandOutput extends DescribeTa
|
|
|
50
137
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
51
138
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
52
139
|
*
|
|
140
|
+
* @throws {@link DynamoDBServiceException}
|
|
141
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
53
142
|
*
|
|
54
143
|
*/
|
|
55
144
|
export declare class DescribeTableReplicaAutoScalingCommand extends $Command<DescribeTableReplicaAutoScalingCommandInput, DescribeTableReplicaAutoScalingCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -31,6 +31,13 @@ export interface DescribeTimeToLiveCommandOutput extends DescribeTimeToLiveOutpu
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeTimeToLiveCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeTimeToLiveOutput
|
|
35
|
+
* // TimeToLiveDescription: { // TimeToLiveDescription
|
|
36
|
+
* // TimeToLiveStatus: "ENABLING" || "DISABLING" || "ENABLED" || "DISABLED",
|
|
37
|
+
* // AttributeName: "STRING_VALUE",
|
|
38
|
+
* // },
|
|
39
|
+
* // };
|
|
40
|
+
*
|
|
34
41
|
* ```
|
|
35
42
|
*
|
|
36
43
|
* @param DescribeTimeToLiveCommandInput - {@link DescribeTimeToLiveCommandInput}
|
|
@@ -48,6 +55,8 @@ export interface DescribeTimeToLiveCommandOutput extends DescribeTimeToLiveOutpu
|
|
|
48
55
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
49
56
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
50
57
|
*
|
|
58
|
+
* @throws {@link DynamoDBServiceException}
|
|
59
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
51
60
|
*
|
|
52
61
|
*/
|
|
53
62
|
export declare class DescribeTimeToLiveCommand extends $Command<DescribeTimeToLiveCommandInput, DescribeTimeToLiveCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -33,6 +33,12 @@ export interface DisableKinesisStreamingDestinationCommandOutput extends Kinesis
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DisableKinesisStreamingDestinationCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // KinesisStreamingDestinationOutput
|
|
37
|
+
* // TableName: "STRING_VALUE",
|
|
38
|
+
* // StreamArn: "STRING_VALUE",
|
|
39
|
+
* // DestinationStatus: "ENABLING" || "ACTIVE" || "DISABLING" || "DISABLED" || "ENABLE_FAILED",
|
|
40
|
+
* // };
|
|
41
|
+
*
|
|
36
42
|
* ```
|
|
37
43
|
*
|
|
38
44
|
* @param DisableKinesisStreamingDestinationCommandInput - {@link DisableKinesisStreamingDestinationCommandInput}
|
|
@@ -68,6 +74,8 @@ export interface DisableKinesisStreamingDestinationCommandOutput extends Kinesis
|
|
|
68
74
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
69
75
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
70
76
|
*
|
|
77
|
+
* @throws {@link DynamoDBServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
71
79
|
*
|
|
72
80
|
*/
|
|
73
81
|
export declare class DisableKinesisStreamingDestinationCommand extends $Command<DisableKinesisStreamingDestinationCommandInput, DisableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -35,6 +35,12 @@ export interface EnableKinesisStreamingDestinationCommandOutput extends KinesisS
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new EnableKinesisStreamingDestinationCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // KinesisStreamingDestinationOutput
|
|
39
|
+
* // TableName: "STRING_VALUE",
|
|
40
|
+
* // StreamArn: "STRING_VALUE",
|
|
41
|
+
* // DestinationStatus: "ENABLING" || "ACTIVE" || "DISABLING" || "DISABLED" || "ENABLE_FAILED",
|
|
42
|
+
* // };
|
|
43
|
+
*
|
|
38
44
|
* ```
|
|
39
45
|
*
|
|
40
46
|
* @param EnableKinesisStreamingDestinationCommandInput - {@link EnableKinesisStreamingDestinationCommandInput}
|
|
@@ -70,6 +76,8 @@ export interface EnableKinesisStreamingDestinationCommandOutput extends KinesisS
|
|
|
70
76
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
71
77
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
72
78
|
*
|
|
79
|
+
* @throws {@link DynamoDBServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
73
81
|
*
|
|
74
82
|
*/
|
|
75
83
|
export declare class EnableKinesisStreamingDestinationCommand extends $Command<EnableKinesisStreamingDestinationCommandInput, EnableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -92,6 +92,85 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
|
|
|
92
92
|
* };
|
|
93
93
|
* const command = new ExecuteStatementCommand(input);
|
|
94
94
|
* const response = await client.send(command);
|
|
95
|
+
* // { // ExecuteStatementOutput
|
|
96
|
+
* // Items: [ // ItemList
|
|
97
|
+
* // { // AttributeMap
|
|
98
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
99
|
+
* // S: "STRING_VALUE",
|
|
100
|
+
* // N: "STRING_VALUE",
|
|
101
|
+
* // B: "BLOB_VALUE",
|
|
102
|
+
* // SS: [ // StringSetAttributeValue
|
|
103
|
+
* // "STRING_VALUE",
|
|
104
|
+
* // ],
|
|
105
|
+
* // NS: [ // NumberSetAttributeValue
|
|
106
|
+
* // "STRING_VALUE",
|
|
107
|
+
* // ],
|
|
108
|
+
* // BS: [ // BinarySetAttributeValue
|
|
109
|
+
* // "BLOB_VALUE",
|
|
110
|
+
* // ],
|
|
111
|
+
* // M: { // MapAttributeValue
|
|
112
|
+
* // "<keys>": {// Union: only one key present
|
|
113
|
+
* // S: "STRING_VALUE",
|
|
114
|
+
* // N: "STRING_VALUE",
|
|
115
|
+
* // B: "BLOB_VALUE",
|
|
116
|
+
* // SS: [
|
|
117
|
+
* // "STRING_VALUE",
|
|
118
|
+
* // ],
|
|
119
|
+
* // NS: [
|
|
120
|
+
* // "STRING_VALUE",
|
|
121
|
+
* // ],
|
|
122
|
+
* // BS: [
|
|
123
|
+
* // "BLOB_VALUE",
|
|
124
|
+
* // ],
|
|
125
|
+
* // M: {
|
|
126
|
+
* // "<keys>": "<AttributeValue>",
|
|
127
|
+
* // },
|
|
128
|
+
* // L: [ // ListAttributeValue
|
|
129
|
+
* // "<AttributeValue>",
|
|
130
|
+
* // ],
|
|
131
|
+
* // NULL: true || false,
|
|
132
|
+
* // BOOL: true || false,
|
|
133
|
+
* // },
|
|
134
|
+
* // },
|
|
135
|
+
* // L: [
|
|
136
|
+
* // "<AttributeValue>",
|
|
137
|
+
* // ],
|
|
138
|
+
* // NULL: true || false,
|
|
139
|
+
* // BOOL: true || false,
|
|
140
|
+
* // },
|
|
141
|
+
* // },
|
|
142
|
+
* // ],
|
|
143
|
+
* // NextToken: "STRING_VALUE",
|
|
144
|
+
* // ConsumedCapacity: { // ConsumedCapacity
|
|
145
|
+
* // TableName: "STRING_VALUE",
|
|
146
|
+
* // CapacityUnits: Number("double"),
|
|
147
|
+
* // ReadCapacityUnits: Number("double"),
|
|
148
|
+
* // WriteCapacityUnits: Number("double"),
|
|
149
|
+
* // Table: { // Capacity
|
|
150
|
+
* // ReadCapacityUnits: Number("double"),
|
|
151
|
+
* // WriteCapacityUnits: Number("double"),
|
|
152
|
+
* // CapacityUnits: Number("double"),
|
|
153
|
+
* // },
|
|
154
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
155
|
+
* // "<keys>": {
|
|
156
|
+
* // ReadCapacityUnits: Number("double"),
|
|
157
|
+
* // WriteCapacityUnits: Number("double"),
|
|
158
|
+
* // CapacityUnits: Number("double"),
|
|
159
|
+
* // },
|
|
160
|
+
* // },
|
|
161
|
+
* // GlobalSecondaryIndexes: {
|
|
162
|
+
* // "<keys>": {
|
|
163
|
+
* // ReadCapacityUnits: Number("double"),
|
|
164
|
+
* // WriteCapacityUnits: Number("double"),
|
|
165
|
+
* // CapacityUnits: Number("double"),
|
|
166
|
+
* // },
|
|
167
|
+
* // },
|
|
168
|
+
* // },
|
|
169
|
+
* // LastEvaluatedKey: { // Key
|
|
170
|
+
* // "<keys>": "<AttributeValue>",
|
|
171
|
+
* // },
|
|
172
|
+
* // };
|
|
173
|
+
*
|
|
95
174
|
* ```
|
|
96
175
|
*
|
|
97
176
|
* @param ExecuteStatementCommandInput - {@link ExecuteStatementCommandInput}
|
|
@@ -133,6 +212,8 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
|
|
|
133
212
|
* <p>Operation was rejected because there is an ongoing transaction for the
|
|
134
213
|
* item.</p>
|
|
135
214
|
*
|
|
215
|
+
* @throws {@link DynamoDBServiceException}
|
|
216
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
136
217
|
*
|
|
137
218
|
*/
|
|
138
219
|
export declare class ExecuteStatementCommand extends $Command<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -89,6 +89,85 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu
|
|
|
89
89
|
* };
|
|
90
90
|
* const command = new ExecuteTransactionCommand(input);
|
|
91
91
|
* const response = await client.send(command);
|
|
92
|
+
* // { // ExecuteTransactionOutput
|
|
93
|
+
* // Responses: [ // ItemResponseList
|
|
94
|
+
* // { // ItemResponse
|
|
95
|
+
* // Item: { // AttributeMap
|
|
96
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
97
|
+
* // S: "STRING_VALUE",
|
|
98
|
+
* // N: "STRING_VALUE",
|
|
99
|
+
* // B: "BLOB_VALUE",
|
|
100
|
+
* // SS: [ // StringSetAttributeValue
|
|
101
|
+
* // "STRING_VALUE",
|
|
102
|
+
* // ],
|
|
103
|
+
* // NS: [ // NumberSetAttributeValue
|
|
104
|
+
* // "STRING_VALUE",
|
|
105
|
+
* // ],
|
|
106
|
+
* // BS: [ // BinarySetAttributeValue
|
|
107
|
+
* // "BLOB_VALUE",
|
|
108
|
+
* // ],
|
|
109
|
+
* // M: { // MapAttributeValue
|
|
110
|
+
* // "<keys>": {// Union: only one key present
|
|
111
|
+
* // S: "STRING_VALUE",
|
|
112
|
+
* // N: "STRING_VALUE",
|
|
113
|
+
* // B: "BLOB_VALUE",
|
|
114
|
+
* // SS: [
|
|
115
|
+
* // "STRING_VALUE",
|
|
116
|
+
* // ],
|
|
117
|
+
* // NS: [
|
|
118
|
+
* // "STRING_VALUE",
|
|
119
|
+
* // ],
|
|
120
|
+
* // BS: [
|
|
121
|
+
* // "BLOB_VALUE",
|
|
122
|
+
* // ],
|
|
123
|
+
* // M: {
|
|
124
|
+
* // "<keys>": "<AttributeValue>",
|
|
125
|
+
* // },
|
|
126
|
+
* // L: [ // ListAttributeValue
|
|
127
|
+
* // "<AttributeValue>",
|
|
128
|
+
* // ],
|
|
129
|
+
* // NULL: true || false,
|
|
130
|
+
* // BOOL: true || false,
|
|
131
|
+
* // },
|
|
132
|
+
* // },
|
|
133
|
+
* // L: [
|
|
134
|
+
* // "<AttributeValue>",
|
|
135
|
+
* // ],
|
|
136
|
+
* // NULL: true || false,
|
|
137
|
+
* // BOOL: true || false,
|
|
138
|
+
* // },
|
|
139
|
+
* // },
|
|
140
|
+
* // },
|
|
141
|
+
* // ],
|
|
142
|
+
* // ConsumedCapacity: [ // ConsumedCapacityMultiple
|
|
143
|
+
* // { // ConsumedCapacity
|
|
144
|
+
* // TableName: "STRING_VALUE",
|
|
145
|
+
* // CapacityUnits: Number("double"),
|
|
146
|
+
* // ReadCapacityUnits: Number("double"),
|
|
147
|
+
* // WriteCapacityUnits: Number("double"),
|
|
148
|
+
* // Table: { // Capacity
|
|
149
|
+
* // ReadCapacityUnits: Number("double"),
|
|
150
|
+
* // WriteCapacityUnits: Number("double"),
|
|
151
|
+
* // CapacityUnits: Number("double"),
|
|
152
|
+
* // },
|
|
153
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
154
|
+
* // "<keys>": {
|
|
155
|
+
* // ReadCapacityUnits: Number("double"),
|
|
156
|
+
* // WriteCapacityUnits: Number("double"),
|
|
157
|
+
* // CapacityUnits: Number("double"),
|
|
158
|
+
* // },
|
|
159
|
+
* // },
|
|
160
|
+
* // GlobalSecondaryIndexes: {
|
|
161
|
+
* // "<keys>": {
|
|
162
|
+
* // ReadCapacityUnits: Number("double"),
|
|
163
|
+
* // WriteCapacityUnits: Number("double"),
|
|
164
|
+
* // CapacityUnits: Number("double"),
|
|
165
|
+
* // },
|
|
166
|
+
* // },
|
|
167
|
+
* // },
|
|
168
|
+
* // ],
|
|
169
|
+
* // };
|
|
170
|
+
*
|
|
92
171
|
* ```
|
|
93
172
|
*
|
|
94
173
|
* @param ExecuteTransactionCommandInput - {@link ExecuteTransactionCommandInput}
|
|
@@ -417,6 +496,8 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu
|
|
|
417
496
|
* </li>
|
|
418
497
|
* </ul>
|
|
419
498
|
*
|
|
499
|
+
* @throws {@link DynamoDBServiceException}
|
|
500
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
420
501
|
*
|
|
421
502
|
*/
|
|
422
503
|
export declare class ExecuteTransactionCommand extends $Command<ExecuteTransactionCommandInput, ExecuteTransactionCommandOutput, DynamoDBClientResolvedConfig> {
|