@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.
Files changed (54) hide show
  1. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +86 -0
  2. package/dist-types/commands/BatchGetItemCommand.d.ts +98 -0
  3. package/dist-types/commands/BatchWriteItemCommand.d.ts +102 -0
  4. package/dist-types/commands/CreateBackupCommand.d.ts +14 -0
  5. package/dist-types/commands/CreateGlobalTableCommand.d.ts +36 -0
  6. package/dist-types/commands/CreateTableCommand.d.ts +140 -0
  7. package/dist-types/commands/DeleteBackupCommand.d.ts +89 -0
  8. package/dist-types/commands/DeleteItemCommand.d.ts +83 -0
  9. package/dist-types/commands/DeleteTableCommand.d.ts +140 -0
  10. package/dist-types/commands/DescribeBackupCommand.d.ts +89 -0
  11. package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +13 -0
  12. package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeEndpointsCommand.d.ts +11 -0
  14. package/dist-types/commands/DescribeExportCommand.d.ts +26 -0
  15. package/dist-types/commands/DescribeGlobalTableCommand.d.ts +36 -0
  16. package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +98 -0
  17. package/dist-types/commands/DescribeImportCommand.d.ts +82 -0
  18. package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +13 -0
  19. package/dist-types/commands/DescribeLimitsCommand.d.ts +9 -0
  20. package/dist-types/commands/DescribeTableCommand.d.ts +140 -0
  21. package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +89 -0
  22. package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +9 -0
  23. package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +8 -0
  24. package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +8 -0
  25. package/dist-types/commands/ExecuteStatementCommand.d.ts +81 -0
  26. package/dist-types/commands/ExecuteTransactionCommand.d.ts +81 -0
  27. package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +26 -0
  28. package/dist-types/commands/GetItemCommand.d.ts +75 -0
  29. package/dist-types/commands/ImportTableCommand.d.ts +82 -0
  30. package/dist-types/commands/ListBackupsCommand.d.ts +20 -0
  31. package/dist-types/commands/ListContributorInsightsCommand.d.ts +13 -0
  32. package/dist-types/commands/ListExportsCommand.d.ts +12 -0
  33. package/dist-types/commands/ListGlobalTablesCommand.d.ts +16 -0
  34. package/dist-types/commands/ListImportsCommand.d.ts +22 -0
  35. package/dist-types/commands/ListTablesCommand.d.ts +9 -0
  36. package/dist-types/commands/ListTagsOfResourceCommand.d.ts +12 -0
  37. package/dist-types/commands/PutItemCommand.d.ts +83 -0
  38. package/dist-types/commands/QueryCommand.d.ts +82 -0
  39. package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +140 -0
  40. package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +140 -0
  41. package/dist-types/commands/ScanCommand.d.ts +82 -0
  42. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  43. package/dist-types/commands/TransactGetItemsCommand.d.ts +81 -0
  44. package/dist-types/commands/TransactWriteItemsCommand.d.ts +86 -0
  45. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  46. package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +13 -0
  47. package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +8 -0
  48. package/dist-types/commands/UpdateGlobalTableCommand.d.ts +36 -0
  49. package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +98 -0
  50. package/dist-types/commands/UpdateItemCommand.d.ts +83 -0
  51. package/dist-types/commands/UpdateTableCommand.d.ts +140 -0
  52. package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +89 -0
  53. package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +9 -0
  54. package/package.json +17 -17
package/dist-types/commands/DeleteItemCommand.d.ts CHANGED
@@ -107,6 +107,87 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
107
107
  * };
108
108
  * const command = new DeleteItemCommand(input);
109
109
  * const response = await client.send(command);
110
+ * // { // DeleteItemOutput
111
+ * // Attributes: { // AttributeMap
112
+ * // "<keys>": { // AttributeValue Union: only one key present
113
+ * // S: "STRING_VALUE",
114
+ * // N: "STRING_VALUE",
115
+ * // B: "BLOB_VALUE",
116
+ * // SS: [ // StringSetAttributeValue
117
+ * // "STRING_VALUE",
118
+ * // ],
119
+ * // NS: [ // NumberSetAttributeValue
120
+ * // "STRING_VALUE",
121
+ * // ],
122
+ * // BS: [ // BinarySetAttributeValue
123
+ * // "BLOB_VALUE",
124
+ * // ],
125
+ * // M: { // MapAttributeValue
126
+ * // "<keys>": {// Union: only one key present
127
+ * // S: "STRING_VALUE",
128
+ * // N: "STRING_VALUE",
129
+ * // B: "BLOB_VALUE",
130
+ * // SS: [
131
+ * // "STRING_VALUE",
132
+ * // ],
133
+ * // NS: [
134
+ * // "STRING_VALUE",
135
+ * // ],
136
+ * // BS: [
137
+ * // "BLOB_VALUE",
138
+ * // ],
139
+ * // M: {
140
+ * // "<keys>": "<AttributeValue>",
141
+ * // },
142
+ * // L: [ // ListAttributeValue
143
+ * // "<AttributeValue>",
144
+ * // ],
145
+ * // NULL: true || false,
146
+ * // BOOL: true || false,
147
+ * // },
148
+ * // },
149
+ * // L: [
150
+ * // "<AttributeValue>",
151
+ * // ],
152
+ * // NULL: true || false,
153
+ * // BOOL: true || false,
154
+ * // },
155
+ * // },
156
+ * // ConsumedCapacity: { // ConsumedCapacity
157
+ * // TableName: "STRING_VALUE",
158
+ * // CapacityUnits: Number("double"),
159
+ * // ReadCapacityUnits: Number("double"),
160
+ * // WriteCapacityUnits: Number("double"),
161
+ * // Table: { // Capacity
162
+ * // ReadCapacityUnits: Number("double"),
163
+ * // WriteCapacityUnits: Number("double"),
164
+ * // CapacityUnits: Number("double"),
165
+ * // },
166
+ * // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
167
+ * // "<keys>": {
168
+ * // ReadCapacityUnits: Number("double"),
169
+ * // WriteCapacityUnits: Number("double"),
170
+ * // CapacityUnits: Number("double"),
171
+ * // },
172
+ * // },
173
+ * // GlobalSecondaryIndexes: {
174
+ * // "<keys>": {
175
+ * // ReadCapacityUnits: Number("double"),
176
+ * // WriteCapacityUnits: Number("double"),
177
+ * // CapacityUnits: Number("double"),
178
+ * // },
179
+ * // },
180
+ * // },
181
+ * // ItemCollectionMetrics: { // ItemCollectionMetrics
182
+ * // ItemCollectionKey: { // ItemCollectionKeyAttributeMap
183
+ * // "<keys>": "<AttributeValue>",
184
+ * // },
185
+ * // SizeEstimateRangeGB: [ // ItemCollectionSizeEstimateRange
186
+ * // Number("double"),
187
+ * // ],
188
+ * // },
189
+ * // };
190
+ *
110
191
  * ```
111
192
  *
112
193
  * @param DeleteItemCommandInput - {@link DeleteItemCommandInput}
@@ -146,6 +227,8 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
146
227
  * <p>Operation was rejected because there is an ongoing transaction for the
147
228
  * item.</p>
148
229
  *
230
+ * @throws {@link DynamoDBServiceException}
231
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
149
232
  *
150
233
  * @example To delete an item
151
234
  * ```javascript
package/dist-types/commands/DeleteTableCommand.d.ts CHANGED
@@ -53,6 +53,144 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
53
53
  * };
54
54
  * const command = new DeleteTableCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // DeleteTableOutput
57
+ * // TableDescription: { // TableDescription
58
+ * // AttributeDefinitions: [ // AttributeDefinitions
59
+ * // { // AttributeDefinition
60
+ * // AttributeName: "STRING_VALUE", // required
61
+ * // AttributeType: "S" || "N" || "B", // required
62
+ * // },
63
+ * // ],
64
+ * // TableName: "STRING_VALUE",
65
+ * // KeySchema: [ // KeySchema
66
+ * // { // KeySchemaElement
67
+ * // AttributeName: "STRING_VALUE", // required
68
+ * // KeyType: "HASH" || "RANGE", // required
69
+ * // },
70
+ * // ],
71
+ * // TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
72
+ * // CreationDateTime: new Date("TIMESTAMP"),
73
+ * // ProvisionedThroughput: { // ProvisionedThroughputDescription
74
+ * // LastIncreaseDateTime: new Date("TIMESTAMP"),
75
+ * // LastDecreaseDateTime: new Date("TIMESTAMP"),
76
+ * // NumberOfDecreasesToday: Number("long"),
77
+ * // ReadCapacityUnits: Number("long"),
78
+ * // WriteCapacityUnits: Number("long"),
79
+ * // },
80
+ * // TableSizeBytes: Number("long"),
81
+ * // ItemCount: Number("long"),
82
+ * // TableArn: "STRING_VALUE",
83
+ * // TableId: "STRING_VALUE",
84
+ * // BillingModeSummary: { // BillingModeSummary
85
+ * // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
86
+ * // LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
87
+ * // },
88
+ * // LocalSecondaryIndexes: [ // LocalSecondaryIndexDescriptionList
89
+ * // { // LocalSecondaryIndexDescription
90
+ * // IndexName: "STRING_VALUE",
91
+ * // KeySchema: [
92
+ * // {
93
+ * // AttributeName: "STRING_VALUE", // required
94
+ * // KeyType: "HASH" || "RANGE", // required
95
+ * // },
96
+ * // ],
97
+ * // Projection: { // Projection
98
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
99
+ * // NonKeyAttributes: [ // NonKeyAttributeNameList
100
+ * // "STRING_VALUE",
101
+ * // ],
102
+ * // },
103
+ * // IndexSizeBytes: Number("long"),
104
+ * // ItemCount: Number("long"),
105
+ * // IndexArn: "STRING_VALUE",
106
+ * // },
107
+ * // ],
108
+ * // GlobalSecondaryIndexes: [ // GlobalSecondaryIndexDescriptionList
109
+ * // { // GlobalSecondaryIndexDescription
110
+ * // IndexName: "STRING_VALUE",
111
+ * // KeySchema: [
112
+ * // {
113
+ * // AttributeName: "STRING_VALUE", // required
114
+ * // KeyType: "HASH" || "RANGE", // required
115
+ * // },
116
+ * // ],
117
+ * // Projection: {
118
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
119
+ * // NonKeyAttributes: [
120
+ * // "STRING_VALUE",
121
+ * // ],
122
+ * // },
123
+ * // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
124
+ * // Backfilling: true || false,
125
+ * // ProvisionedThroughput: {
126
+ * // LastIncreaseDateTime: new Date("TIMESTAMP"),
127
+ * // LastDecreaseDateTime: new Date("TIMESTAMP"),
128
+ * // NumberOfDecreasesToday: Number("long"),
129
+ * // ReadCapacityUnits: Number("long"),
130
+ * // WriteCapacityUnits: Number("long"),
131
+ * // },
132
+ * // IndexSizeBytes: Number("long"),
133
+ * // ItemCount: Number("long"),
134
+ * // IndexArn: "STRING_VALUE",
135
+ * // },
136
+ * // ],
137
+ * // StreamSpecification: { // StreamSpecification
138
+ * // StreamEnabled: true || false, // required
139
+ * // StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
140
+ * // },
141
+ * // LatestStreamLabel: "STRING_VALUE",
142
+ * // LatestStreamArn: "STRING_VALUE",
143
+ * // GlobalTableVersion: "STRING_VALUE",
144
+ * // Replicas: [ // ReplicaDescriptionList
145
+ * // { // ReplicaDescription
146
+ * // RegionName: "STRING_VALUE",
147
+ * // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
148
+ * // ReplicaStatusDescription: "STRING_VALUE",
149
+ * // ReplicaStatusPercentProgress: "STRING_VALUE",
150
+ * // KMSMasterKeyId: "STRING_VALUE",
151
+ * // ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
152
+ * // ReadCapacityUnits: Number("long"),
153
+ * // },
154
+ * // GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
155
+ * // { // ReplicaGlobalSecondaryIndexDescription
156
+ * // IndexName: "STRING_VALUE",
157
+ * // ProvisionedThroughputOverride: {
158
+ * // ReadCapacityUnits: Number("long"),
159
+ * // },
160
+ * // },
161
+ * // ],
162
+ * // ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
163
+ * // ReplicaTableClassSummary: { // TableClassSummary
164
+ * // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
165
+ * // LastUpdateDateTime: new Date("TIMESTAMP"),
166
+ * // },
167
+ * // },
168
+ * // ],
169
+ * // RestoreSummary: { // RestoreSummary
170
+ * // SourceBackupArn: "STRING_VALUE",
171
+ * // SourceTableArn: "STRING_VALUE",
172
+ * // RestoreDateTime: new Date("TIMESTAMP"), // required
173
+ * // RestoreInProgress: true || false, // required
174
+ * // },
175
+ * // SSEDescription: { // SSEDescription
176
+ * // Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
177
+ * // SSEType: "AES256" || "KMS",
178
+ * // KMSMasterKeyArn: "STRING_VALUE",
179
+ * // InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
180
+ * // },
181
+ * // ArchivalSummary: { // ArchivalSummary
182
+ * // ArchivalDateTime: new Date("TIMESTAMP"),
183
+ * // ArchivalReason: "STRING_VALUE",
184
+ * // ArchivalBackupArn: "STRING_VALUE",
185
+ * // },
186
+ * // TableClassSummary: {
187
+ * // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
188
+ * // LastUpdateDateTime: new Date("TIMESTAMP"),
189
+ * // },
190
+ * // DeletionProtectionEnabled: true || false,
191
+ * // },
192
+ * // };
193
+ *
56
194
  * ```
57
195
  *
58
196
  * @param DeleteTableCommandInput - {@link DeleteTableCommandInput}
@@ -88,6 +226,8 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
88
226
  * <p>The operation tried to access a nonexistent table or index. The resource might not
89
227
  * be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
90
228
  *
229
+ * @throws {@link DynamoDBServiceException}
230
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
91
231
  *
92
232
  * @example To delete a table
93
233
  * ```javascript
package/dist-types/commands/DescribeBackupCommand.d.ts CHANGED
@@ -33,6 +33,93 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met
33
33
  * };
34
34
  * const command = new DescribeBackupCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeBackupOutput
37
+ * // BackupDescription: { // BackupDescription
38
+ * // BackupDetails: { // BackupDetails
39
+ * // BackupArn: "STRING_VALUE", // required
40
+ * // BackupName: "STRING_VALUE", // required
41
+ * // BackupSizeBytes: Number("long"),
42
+ * // BackupStatus: "CREATING" || "DELETED" || "AVAILABLE", // required
43
+ * // BackupType: "USER" || "SYSTEM" || "AWS_BACKUP", // required
44
+ * // BackupCreationDateTime: new Date("TIMESTAMP"), // required
45
+ * // BackupExpiryDateTime: new Date("TIMESTAMP"),
46
+ * // },
47
+ * // SourceTableDetails: { // SourceTableDetails
48
+ * // TableName: "STRING_VALUE", // required
49
+ * // TableId: "STRING_VALUE", // required
50
+ * // TableArn: "STRING_VALUE",
51
+ * // TableSizeBytes: Number("long"),
52
+ * // KeySchema: [ // KeySchema // required
53
+ * // { // KeySchemaElement
54
+ * // AttributeName: "STRING_VALUE", // required
55
+ * // KeyType: "HASH" || "RANGE", // required
56
+ * // },
57
+ * // ],
58
+ * // TableCreationDateTime: new Date("TIMESTAMP"), // required
59
+ * // ProvisionedThroughput: { // ProvisionedThroughput
60
+ * // ReadCapacityUnits: Number("long"), // required
61
+ * // WriteCapacityUnits: Number("long"), // required
62
+ * // },
63
+ * // ItemCount: Number("long"),
64
+ * // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
65
+ * // },
66
+ * // SourceTableFeatureDetails: { // SourceTableFeatureDetails
67
+ * // LocalSecondaryIndexes: [ // LocalSecondaryIndexes
68
+ * // { // LocalSecondaryIndexInfo
69
+ * // IndexName: "STRING_VALUE",
70
+ * // KeySchema: [
71
+ * // {
72
+ * // AttributeName: "STRING_VALUE", // required
73
+ * // KeyType: "HASH" || "RANGE", // required
74
+ * // },
75
+ * // ],
76
+ * // Projection: { // Projection
77
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
78
+ * // NonKeyAttributes: [ // NonKeyAttributeNameList
79
+ * // "STRING_VALUE",
80
+ * // ],
81
+ * // },
82
+ * // },
83
+ * // ],
84
+ * // GlobalSecondaryIndexes: [ // GlobalSecondaryIndexes
85
+ * // { // GlobalSecondaryIndexInfo
86
+ * // IndexName: "STRING_VALUE",
87
+ * // KeySchema: [
88
+ * // {
89
+ * // AttributeName: "STRING_VALUE", // required
90
+ * // KeyType: "HASH" || "RANGE", // required
91
+ * // },
92
+ * // ],
93
+ * // Projection: {
94
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
95
+ * // NonKeyAttributes: [
96
+ * // "STRING_VALUE",
97
+ * // ],
98
+ * // },
99
+ * // ProvisionedThroughput: {
100
+ * // ReadCapacityUnits: Number("long"), // required
101
+ * // WriteCapacityUnits: Number("long"), // required
102
+ * // },
103
+ * // },
104
+ * // ],
105
+ * // StreamDescription: { // StreamSpecification
106
+ * // StreamEnabled: true || false, // required
107
+ * // StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
108
+ * // },
109
+ * // TimeToLiveDescription: { // TimeToLiveDescription
110
+ * // TimeToLiveStatus: "ENABLING" || "DISABLING" || "ENABLED" || "DISABLED",
111
+ * // AttributeName: "STRING_VALUE",
112
+ * // },
113
+ * // SSEDescription: { // SSEDescription
114
+ * // Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
115
+ * // SSEType: "AES256" || "KMS",
116
+ * // KMSMasterKeyArn: "STRING_VALUE",
117
+ * // InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
118
+ * // },
119
+ * // },
120
+ * // },
121
+ * // };
122
+ *
36
123
  * ```
37
124
  *
38
125
  * @param DescribeBackupCommandInput - {@link DescribeBackupCommandInput}
@@ -49,6 +136,8 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met
49
136
  *
50
137
  * @throws {@link InvalidEndpointException} (client fault)
51
138
  *
139
+ * @throws {@link DynamoDBServiceException}
140
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
52
141
  *
53
142
  */
54
143
  export declare class DescribeBackupCommand extends $Command<DescribeBackupCommandInput, DescribeBackupCommandOutput, DynamoDBClientResolvedConfig> {
package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts CHANGED
@@ -42,6 +42,17 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo
42
42
  * };
43
43
  * const command = new DescribeContinuousBackupsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // DescribeContinuousBackupsOutput
46
+ * // ContinuousBackupsDescription: { // ContinuousBackupsDescription
47
+ * // ContinuousBackupsStatus: "ENABLED" || "DISABLED", // required
48
+ * // PointInTimeRecoveryDescription: { // PointInTimeRecoveryDescription
49
+ * // PointInTimeRecoveryStatus: "ENABLED" || "DISABLED",
50
+ * // EarliestRestorableDateTime: new Date("TIMESTAMP"),
51
+ * // LatestRestorableDateTime: new Date("TIMESTAMP"),
52
+ * // },
53
+ * // },
54
+ * // };
55
+ *
45
56
  * ```
46
57
  *
47
58
  * @param DescribeContinuousBackupsCommandInput - {@link DescribeContinuousBackupsCommandInput}
@@ -59,6 +70,8 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo
59
70
  * <p>A source table with the name <code>TableName</code> does not currently exist within
60
71
  * the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
61
72
  *
73
+ * @throws {@link DynamoDBServiceException}
74
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
62
75
  *
63
76
  */
64
77
  export declare class DescribeContinuousBackupsCommand extends $Command<DescribeContinuousBackupsCommandInput, DescribeContinuousBackupsCommandOutput, DynamoDBClientResolvedConfig> {
package/dist-types/commands/DescribeContributorInsightsCommand.d.ts CHANGED
@@ -33,6 +33,20 @@ export interface DescribeContributorInsightsCommandOutput extends DescribeContri
33
33
  * };
34
34
  * const command = new DescribeContributorInsightsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeContributorInsightsOutput
37
+ * // TableName: "STRING_VALUE",
38
+ * // IndexName: "STRING_VALUE",
39
+ * // ContributorInsightsRuleList: [ // ContributorInsightsRuleList
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // ContributorInsightsStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "FAILED",
43
+ * // LastUpdateDateTime: new Date("TIMESTAMP"),
44
+ * // FailureException: { // FailureException
45
+ * // ExceptionName: "STRING_VALUE",
46
+ * // ExceptionDescription: "STRING_VALUE",
47
+ * // },
48
+ * // };
49
+ *
36
50
  * ```
37
51
  *
38
52
  * @param DescribeContributorInsightsCommandInput - {@link DescribeContributorInsightsCommandInput}
@@ -48,6 +62,8 @@ export interface DescribeContributorInsightsCommandOutput extends DescribeContri
48
62
  * <p>The operation tried to access a nonexistent table or index. The resource might not
49
63
  * be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
50
64
  *
65
+ * @throws {@link DynamoDBServiceException}
66
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
51
67
  *
52
68
  */
53
69
  export declare class DescribeContributorInsightsCommand extends $Command<DescribeContributorInsightsCommandInput, DescribeContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
package/dist-types/commands/DescribeEndpointsCommand.d.ts CHANGED
@@ -31,6 +31,15 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
31
31
  * const input = {};
32
32
  * const command = new DescribeEndpointsCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeEndpointsResponse
35
+ * // Endpoints: [ // Endpoints // required
36
+ * // { // Endpoint
37
+ * // Address: "STRING_VALUE", // required
38
+ * // CachePeriodInMinutes: Number("long"), // required
39
+ * // },
40
+ * // ],
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param DescribeEndpointsCommandInput - {@link DescribeEndpointsCommandInput}
@@ -39,6 +48,8 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
39
48
  * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
40
49
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
41
50
  *
51
+ * @throws {@link DynamoDBServiceException}
52
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
42
53
  *
43
54
  */
44
55
  export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, DynamoDBClientResolvedConfig> {
package/dist-types/commands/DescribeExportCommand.d.ts CHANGED
@@ -31,6 +31,30 @@ export interface DescribeExportCommandOutput extends DescribeExportOutput, __Met
31
31
  * };
32
32
  * const command = new DescribeExportCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeExportOutput
35
+ * // ExportDescription: { // ExportDescription
36
+ * // ExportArn: "STRING_VALUE",
37
+ * // ExportStatus: "IN_PROGRESS" || "COMPLETED" || "FAILED",
38
+ * // StartTime: new Date("TIMESTAMP"),
39
+ * // EndTime: new Date("TIMESTAMP"),
40
+ * // ExportManifest: "STRING_VALUE",
41
+ * // TableArn: "STRING_VALUE",
42
+ * // TableId: "STRING_VALUE",
43
+ * // ExportTime: new Date("TIMESTAMP"),
44
+ * // ClientToken: "STRING_VALUE",
45
+ * // S3Bucket: "STRING_VALUE",
46
+ * // S3BucketOwner: "STRING_VALUE",
47
+ * // S3Prefix: "STRING_VALUE",
48
+ * // S3SseAlgorithm: "AES256" || "KMS",
49
+ * // S3SseKmsKeyId: "STRING_VALUE",
50
+ * // FailureCode: "STRING_VALUE",
51
+ * // FailureMessage: "STRING_VALUE",
52
+ * // ExportFormat: "DYNAMODB_JSON" || "ION",
53
+ * // BilledSizeBytes: Number("long"),
54
+ * // ItemCount: Number("long"),
55
+ * // },
56
+ * // };
57
+ *
34
58
  * ```
35
59
  *
36
60
  * @param DescribeExportCommandInput - {@link DescribeExportCommandInput}
@@ -58,6 +82,8 @@ export interface DescribeExportCommandOutput extends DescribeExportOutput, __Met
58
82
  * <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
59
83
  * <p>There is a soft account quota of 2,500 tables.</p>
60
84
  *
85
+ * @throws {@link DynamoDBServiceException}
86
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
61
87
  *
62
88
  */
63
89
  export declare class DescribeExportCommand extends $Command<DescribeExportCommandInput, DescribeExportCommandOutput, DynamoDBClientResolvedConfig> {
package/dist-types/commands/DescribeGlobalTableCommand.d.ts CHANGED
@@ -43,6 +43,40 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
43
43
  * };
44
44
  * const command = new DescribeGlobalTableCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // DescribeGlobalTableOutput
47
+ * // GlobalTableDescription: { // GlobalTableDescription
48
+ * // ReplicationGroup: [ // ReplicaDescriptionList
49
+ * // { // ReplicaDescription
50
+ * // RegionName: "STRING_VALUE",
51
+ * // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
52
+ * // ReplicaStatusDescription: "STRING_VALUE",
53
+ * // ReplicaStatusPercentProgress: "STRING_VALUE",
54
+ * // KMSMasterKeyId: "STRING_VALUE",
55
+ * // ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
56
+ * // ReadCapacityUnits: Number("long"),
57
+ * // },
58
+ * // GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
59
+ * // { // ReplicaGlobalSecondaryIndexDescription
60
+ * // IndexName: "STRING_VALUE",
61
+ * // ProvisionedThroughputOverride: {
62
+ * // ReadCapacityUnits: Number("long"),
63
+ * // },
64
+ * // },
65
+ * // ],
66
+ * // ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
67
+ * // ReplicaTableClassSummary: { // TableClassSummary
68
+ * // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
69
+ * // LastUpdateDateTime: new Date("TIMESTAMP"),
70
+ * // },
71
+ * // },
72
+ * // ],
73
+ * // GlobalTableArn: "STRING_VALUE",
74
+ * // CreationDateTime: new Date("TIMESTAMP"),
75
+ * // GlobalTableStatus: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING",
76
+ * // GlobalTableName: "STRING_VALUE",
77
+ * // },
78
+ * // };
79
+ *
46
80
  * ```
47
81
  *
48
82
  * @param DescribeGlobalTableCommandInput - {@link DescribeGlobalTableCommandInput}
@@ -59,6 +93,8 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
59
93
  *
60
94
  * @throws {@link InvalidEndpointException} (client fault)
61
95
  *
96
+ * @throws {@link DynamoDBServiceException}
97
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
62
98
  *
63
99
  */
64
100
  export declare class DescribeGlobalTableCommand extends $Command<DescribeGlobalTableCommandInput, DescribeGlobalTableCommandOutput, DynamoDBClientResolvedConfig> {
package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts CHANGED
@@ -43,6 +43,102 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
43
43
  * };
44
44
  * const command = new DescribeGlobalTableSettingsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // DescribeGlobalTableSettingsOutput
47
+ * // GlobalTableName: "STRING_VALUE",
48
+ * // ReplicaSettings: [ // ReplicaSettingsDescriptionList
49
+ * // { // ReplicaSettingsDescription
50
+ * // RegionName: "STRING_VALUE", // required
51
+ * // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
52
+ * // ReplicaBillingModeSummary: { // BillingModeSummary
53
+ * // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
54
+ * // LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
55
+ * // },
56
+ * // ReplicaProvisionedReadCapacityUnits: Number("long"),
57
+ * // ReplicaProvisionedReadCapacityAutoScalingSettings: { // AutoScalingSettingsDescription
58
+ * // MinimumUnits: Number("long"),
59
+ * // MaximumUnits: Number("long"),
60
+ * // AutoScalingDisabled: true || false,
61
+ * // AutoScalingRoleArn: "STRING_VALUE",
62
+ * // ScalingPolicies: [ // AutoScalingPolicyDescriptionList
63
+ * // { // AutoScalingPolicyDescription
64
+ * // PolicyName: "STRING_VALUE",
65
+ * // TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationDescription
66
+ * // DisableScaleIn: true || false,
67
+ * // ScaleInCooldown: Number("int"),
68
+ * // ScaleOutCooldown: Number("int"),
69
+ * // TargetValue: Number("double"), // required
70
+ * // },
71
+ * // },
72
+ * // ],
73
+ * // },
74
+ * // ReplicaProvisionedWriteCapacityUnits: Number("long"),
75
+ * // ReplicaProvisionedWriteCapacityAutoScalingSettings: {
76
+ * // MinimumUnits: Number("long"),
77
+ * // MaximumUnits: Number("long"),
78
+ * // AutoScalingDisabled: true || false,
79
+ * // AutoScalingRoleArn: "STRING_VALUE",
80
+ * // ScalingPolicies: [
81
+ * // {
82
+ * // PolicyName: "STRING_VALUE",
83
+ * // TargetTrackingScalingPolicyConfiguration: {
84
+ * // DisableScaleIn: true || false,
85
+ * // ScaleInCooldown: Number("int"),
86
+ * // ScaleOutCooldown: Number("int"),
87
+ * // TargetValue: Number("double"), // required
88
+ * // },
89
+ * // },
90
+ * // ],
91
+ * // },
92
+ * // ReplicaGlobalSecondaryIndexSettings: [ // ReplicaGlobalSecondaryIndexSettingsDescriptionList
93
+ * // { // ReplicaGlobalSecondaryIndexSettingsDescription
94
+ * // IndexName: "STRING_VALUE", // required
95
+ * // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
96
+ * // ProvisionedReadCapacityUnits: Number("long"),
97
+ * // ProvisionedReadCapacityAutoScalingSettings: {
98
+ * // MinimumUnits: Number("long"),
99
+ * // MaximumUnits: Number("long"),
100
+ * // AutoScalingDisabled: true || false,
101
+ * // AutoScalingRoleArn: "STRING_VALUE",
102
+ * // ScalingPolicies: [
103
+ * // {
104
+ * // PolicyName: "STRING_VALUE",
105
+ * // TargetTrackingScalingPolicyConfiguration: {
106
+ * // DisableScaleIn: true || false,
107
+ * // ScaleInCooldown: Number("int"),
108
+ * // ScaleOutCooldown: Number("int"),
109
+ * // TargetValue: Number("double"), // required
110
+ * // },
111
+ * // },
112
+ * // ],
113
+ * // },
114
+ * // ProvisionedWriteCapacityUnits: Number("long"),
115
+ * // ProvisionedWriteCapacityAutoScalingSettings: {
116
+ * // MinimumUnits: Number("long"),
117
+ * // MaximumUnits: Number("long"),
118
+ * // AutoScalingDisabled: true || false,
119
+ * // AutoScalingRoleArn: "STRING_VALUE",
120
+ * // ScalingPolicies: [
121
+ * // {
122
+ * // PolicyName: "STRING_VALUE",
123
+ * // TargetTrackingScalingPolicyConfiguration: {
124
+ * // DisableScaleIn: true || false,
125
+ * // ScaleInCooldown: Number("int"),
126
+ * // ScaleOutCooldown: Number("int"),
127
+ * // TargetValue: Number("double"), // required
128
+ * // },
129
+ * // },
130
+ * // ],
131
+ * // },
132
+ * // },
133
+ * // ],
134
+ * // ReplicaTableClassSummary: { // TableClassSummary
135
+ * // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
136
+ * // LastUpdateDateTime: new Date("TIMESTAMP"),
137
+ * // },
138
+ * // },
139
+ * // ],
140
+ * // };
141
+ *
46
142
  * ```
47
143
  *
48
144
  * @param DescribeGlobalTableSettingsCommandInput - {@link DescribeGlobalTableSettingsCommandInput}
@@ -59,6 +155,8 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
59
155
  *
60
156
  * @throws {@link InvalidEndpointException} (client fault)
61
157
  *
158
+ * @throws {@link DynamoDBServiceException}
159
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
62
160
  *
63
161
  */
64
162
  export declare class DescribeGlobalTableSettingsCommand extends $Command<DescribeGlobalTableSettingsCommandInput, DescribeGlobalTableSettingsCommandOutput, DynamoDBClientResolvedConfig> {