@aws-sdk/client-dynamodb 3.40.0 → 3.41.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/CHANGELOG.md +11 -0
- package/README.md +18 -16
- package/dist-cjs/endpoints.js +8 -0
- package/dist-es/endpoints.js +8 -0
- package/dist-types/DynamoDB.d.ts +606 -567
- package/dist-types/DynamoDBClient.d.ts +16 -15
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +7 -4
- package/dist-types/commands/BatchGetItemCommand.d.ts +27 -26
- package/dist-types/commands/BatchWriteItemCommand.d.ts +51 -47
- package/dist-types/commands/CreateBackupCommand.d.ts +19 -19
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +32 -43
- package/dist-types/commands/CreateTableCommand.d.ts +14 -14
- package/dist-types/commands/DeleteBackupCommand.d.ts +3 -2
- package/dist-types/commands/DeleteItemCommand.d.ts +12 -7
- package/dist-types/commands/DeleteTableCommand.d.ts +18 -16
- package/dist-types/commands/DescribeBackupCommand.d.ts +3 -2
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +12 -11
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeExportCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +6 -5
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +5 -4
- package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeLimitsCommand.d.ts +51 -41
- package/dist-types/commands/DescribeTableCommand.d.ts +11 -8
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +5 -4
- package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +1 -1
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +1 -1
- package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +5 -5
- package/dist-types/commands/ExecuteStatementCommand.d.ts +3 -4
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +9 -4
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +1 -1
- package/dist-types/commands/GetItemCommand.d.ts +9 -8
- package/dist-types/commands/ListBackupsCommand.d.ts +7 -7
- package/dist-types/commands/ListContributorInsightsCommand.d.ts +3 -2
- package/dist-types/commands/ListExportsCommand.d.ts +1 -1
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +5 -4
- package/dist-types/commands/ListTablesCommand.d.ts +4 -4
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +5 -5
- package/dist-types/commands/PutItemCommand.d.ts +52 -45
- package/dist-types/commands/QueryCommand.d.ts +40 -44
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +19 -19
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +36 -41
- package/dist-types/commands/ScanCommand.d.ts +17 -16
- package/dist-types/commands/TagResourceCommand.d.ts +3 -4
- package/dist-types/commands/TransactGetItemsCommand.d.ts +12 -11
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +49 -47
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -4
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +10 -10
- package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +7 -2
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +12 -17
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateItemCommand.d.ts +8 -4
- package/dist-types/commands/UpdateTableCommand.d.ts +15 -13
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +5 -4
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +15 -15
- package/dist-types/models/models_0.d.ts +3413 -2779
- package/package.json +4 -4
|
@@ -8,22 +8,24 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>The <code>DeleteTable</code> operation deletes a table and all of its items. After a
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
11
|
+
* <code>DeleteTable</code> request, the specified table is in the
|
|
12
|
+
* <code>DELETING</code> state until DynamoDB completes the deletion. If the table is
|
|
13
|
+
* in the <code>ACTIVE</code> state, you can delete it. If a table is in
|
|
14
|
+
* <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a
|
|
15
|
+
* <code>ResourceInUseException</code>. If the specified table does not exist, DynamoDB
|
|
16
|
+
* returns a <code>ResourceNotFoundException</code>. If table is already in the
|
|
17
|
+
* <code>DELETING</code> state, no error is returned. </p>
|
|
18
|
+
* <note>
|
|
19
|
+
* <p>DynamoDB might continue to accept data read and write operations, such as
|
|
20
|
+
* <code>GetItem</code> and <code>PutItem</code>, on a table in the
|
|
21
|
+
* <code>DELETING</code> state until the table deletion is complete.</p>
|
|
22
|
+
* </note>
|
|
23
|
+
* <p>When you delete a table, any indexes on that table are also deleted.</p>
|
|
24
|
+
* <p>If you have DynamoDB Streams enabled on the table, then the corresponding stream on
|
|
25
|
+
* that table goes into the <code>DISABLED</code> state, and the stream is automatically
|
|
26
|
+
* deleted after 24 hours.</p>
|
|
25
27
|
*
|
|
26
|
-
*
|
|
28
|
+
* <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>
|
|
27
29
|
* @example
|
|
28
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
31
|
* ```javascript
|
|
@@ -36,7 +38,7 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
|
|
|
36
38
|
*
|
|
37
39
|
* @see {@link DeleteTableCommandInput} for command's `input` shape.
|
|
38
40
|
* @see {@link DeleteTableCommandOutput} for command's `response` shape.
|
|
39
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
41
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
40
42
|
*
|
|
41
43
|
*/
|
|
42
44
|
export declare class DeleteTableCommand extends $Command<DeleteTableCommandInput, DeleteTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,7 +8,8 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Describes an existing backup of a table.</p>
|
|
11
|
-
*
|
|
11
|
+
* <p>You can call <code>DescribeBackup</code> at a maximum rate of 10 times per
|
|
12
|
+
* second.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -21,7 +22,7 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met
|
|
|
21
22
|
*
|
|
22
23
|
* @see {@link DescribeBackupCommandInput} for command's `input` shape.
|
|
23
24
|
* @see {@link DescribeBackupCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
25
26
|
*
|
|
26
27
|
*/
|
|
27
28
|
export declare class DescribeBackupCommand extends $Command<DescribeBackupCommandInput, DescribeBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,17 +7,18 @@ export interface DescribeContinuousBackupsCommandInput extends DescribeContinuou
|
|
|
7
7
|
export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuousBackupsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Checks the status of continuous backups and point in time recovery on the specified
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Checks the status of continuous backups and point in time recovery on the specified
|
|
11
|
+
* table. Continuous backups are <code>ENABLED</code> on all tables at table creation. If
|
|
12
|
+
* point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to
|
|
13
|
+
* ENABLED.</p>
|
|
14
|
+
* <p> After continuous backups and point in time recovery are enabled, you can restore to
|
|
15
|
+
* any point in time within <code>EarliestRestorableDateTime</code> and
|
|
15
16
|
* <code>LatestRestorableDateTime</code>. </p>
|
|
16
|
-
*
|
|
17
|
-
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
17
|
+
* <p>
|
|
18
|
+
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
19
|
+
* You can restore your table to any point in time during the last 35 days. </p>
|
|
20
|
+
* <p>You can call <code>DescribeContinuousBackups</code> at a maximum rate of 10 times per
|
|
21
|
+
* second.</p>
|
|
21
22
|
* @example
|
|
22
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
24
|
* ```javascript
|
|
@@ -30,7 +31,7 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo
|
|
|
30
31
|
*
|
|
31
32
|
* @see {@link DescribeContinuousBackupsCommandInput} for command's `input` shape.
|
|
32
33
|
* @see {@link DescribeContinuousBackupsCommandOutput} for command's `response` shape.
|
|
33
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
34
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
34
35
|
*
|
|
35
36
|
*/
|
|
36
37
|
export declare class DescribeContinuousBackupsCommand extends $Command<DescribeContinuousBackupsCommandInput, DescribeContinuousBackupsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,7 +7,8 @@ export interface DescribeContributorInsightsCommandInput extends DescribeContrib
|
|
|
7
7
|
export interface DescribeContributorInsightsCommandOutput extends DescribeContributorInsightsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns information about contributor insights, for a given table or global secondary
|
|
10
|
+
* <p>Returns information about contributor insights, for a given table or global secondary
|
|
11
|
+
* index.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -20,7 +21,7 @@ export interface DescribeContributorInsightsCommandOutput extends DescribeContri
|
|
|
20
21
|
*
|
|
21
22
|
* @see {@link DescribeContributorInsightsCommandInput} for command's `input` shape.
|
|
22
23
|
* @see {@link DescribeContributorInsightsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
25
|
*
|
|
25
26
|
*/
|
|
26
27
|
export declare class DescribeContributorInsightsCommand extends $Command<DescribeContributorInsightsCommandInput, DescribeContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link DescribeEndpointsCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface DescribeExportCommandOutput extends DescribeExportOutput, __Met
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link DescribeExportCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link DescribeExportCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class DescribeExportCommand extends $Command<DescribeExportCommandInput, DescribeExportCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,10 +8,11 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns information about the specified global table.</p>
|
|
11
|
-
*
|
|
12
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
13
|
-
*
|
|
14
|
-
*
|
|
11
|
+
* <note>
|
|
12
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
13
|
+
* 2017.11.29</a> of global tables. If you are using global tables <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
14
|
+
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html">DescribeTable</a> instead.</p>
|
|
15
|
+
* </note>
|
|
15
16
|
* @example
|
|
16
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
18
|
* ```javascript
|
|
@@ -24,7 +25,7 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
|
|
|
24
25
|
*
|
|
25
26
|
* @see {@link DescribeGlobalTableCommandInput} for command's `input` shape.
|
|
26
27
|
* @see {@link DescribeGlobalTableCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
28
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
28
29
|
*
|
|
29
30
|
*/
|
|
30
31
|
export declare class DescribeGlobalTableCommand extends $Command<DescribeGlobalTableCommandInput, DescribeGlobalTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,9 +8,10 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Describes Region-specific settings for a global table.</p>
|
|
11
|
-
*
|
|
12
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
13
|
-
*
|
|
11
|
+
* <note>
|
|
12
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
13
|
+
* 2017.11.29</a> of global tables.</p>
|
|
14
|
+
* </note>
|
|
14
15
|
* @example
|
|
15
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
17
|
* ```javascript
|
|
@@ -23,7 +24,7 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
|
|
|
23
24
|
*
|
|
24
25
|
* @see {@link DescribeGlobalTableSettingsCommandInput} for command's `input` shape.
|
|
25
26
|
* @see {@link DescribeGlobalTableSettingsCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
27
28
|
*
|
|
28
29
|
*/
|
|
29
30
|
export declare class DescribeGlobalTableSettingsCommand extends $Command<DescribeGlobalTableSettingsCommandInput, DescribeGlobalTableSettingsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface DescribeKinesisStreamingDestinationCommandOutput extends Descri
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link DescribeKinesisStreamingDestinationCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link DescribeKinesisStreamingDestinationCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class DescribeKinesisStreamingDestinationCommand extends $Command<DescribeKinesisStreamingDestinationCommandInput, DescribeKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,70 +7,80 @@ export interface DescribeLimitsCommandInput extends DescribeLimitsInput {
|
|
|
7
7
|
export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the current provisioned-capacity quotas for your
|
|
11
|
-
* for the Region as a whole and for any one DynamoDB table that you create
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
10
|
+
* <p>Returns the current provisioned-capacity quotas for your Amazon Web Services account in
|
|
11
|
+
* a Region, both for the Region as a whole and for any one DynamoDB table that you create
|
|
12
|
+
* there.</p>
|
|
13
|
+
* <p>When you establish an Amazon Web Services account, the account has initial quotas on
|
|
14
|
+
* the maximum read capacity units and write capacity units that you can provision across
|
|
15
|
+
* all of your DynamoDB tables in a given Region. Also, there are per-table
|
|
16
|
+
* quotas that apply when you create a table there. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
17
|
+
* Account, and Table Quotas</a> page in the <i>Amazon DynamoDB
|
|
18
|
+
* Developer Guide</i>.</p>
|
|
18
19
|
*
|
|
19
|
-
*
|
|
20
|
-
* instantaneous. The <code>DescribeLimits</code> action lets you write
|
|
21
|
-
* capacity you are currently using to those quotas imposed by your
|
|
22
|
-
* have enough time to apply for an increase before you hit a
|
|
20
|
+
* <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support Center</a>, obtaining the
|
|
21
|
+
* increase is not instantaneous. The <code>DescribeLimits</code> action lets you write
|
|
22
|
+
* code to compare the capacity you are currently using to those quotas imposed by your
|
|
23
|
+
* account so that you have enough time to apply for an increase before you hit a
|
|
24
|
+
* quota.</p>
|
|
23
25
|
*
|
|
24
|
-
*
|
|
26
|
+
* <p>For example, you could use one of the Amazon Web Services SDKs to do the
|
|
27
|
+
* following:</p>
|
|
25
28
|
*
|
|
26
|
-
*
|
|
29
|
+
* <ol>
|
|
27
30
|
* <li>
|
|
28
|
-
*
|
|
29
|
-
* account quotas on provisioned capacity there.</p>
|
|
31
|
+
* <p>Call <code>DescribeLimits</code> for a particular Region to obtain your
|
|
32
|
+
* current account quotas on provisioned capacity there.</p>
|
|
30
33
|
* </li>
|
|
31
34
|
* <li>
|
|
32
|
-
*
|
|
33
|
-
* your tables in that Region, and one to hold the aggregate write capacity
|
|
34
|
-
* Zero them both.</p>
|
|
35
|
+
* <p>Create a variable to hold the aggregate read capacity units provisioned for
|
|
36
|
+
* all your tables in that Region, and one to hold the aggregate write capacity
|
|
37
|
+
* units. Zero them both.</p>
|
|
35
38
|
* </li>
|
|
36
39
|
* <li>
|
|
37
|
-
*
|
|
40
|
+
* <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB
|
|
41
|
+
* tables.</p>
|
|
38
42
|
* </li>
|
|
39
43
|
* <li>
|
|
40
|
-
*
|
|
41
|
-
*
|
|
44
|
+
* <p>For each table name listed by <code>ListTables</code>, do the
|
|
45
|
+
* following:</p>
|
|
46
|
+
* <ul>
|
|
42
47
|
* <li>
|
|
43
|
-
*
|
|
44
|
-
*
|
|
48
|
+
* <p>Call <code>DescribeTable</code> with the table name.</p>
|
|
49
|
+
* </li>
|
|
45
50
|
* <li>
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
51
|
+
* <p>Use the data returned by <code>DescribeTable</code> to add the read
|
|
52
|
+
* capacity units and write capacity units provisioned for the table itself
|
|
53
|
+
* to your variables.</p>
|
|
54
|
+
* </li>
|
|
49
55
|
* <li>
|
|
50
|
-
*
|
|
51
|
-
*
|
|
56
|
+
* <p>If the table has one or more global secondary indexes (GSIs), loop
|
|
57
|
+
* over these GSIs and add their provisioned capacity values to your
|
|
58
|
+
* variables as well.</p>
|
|
59
|
+
* </li>
|
|
52
60
|
* </ul>
|
|
53
61
|
* </li>
|
|
54
62
|
* <li>
|
|
55
|
-
*
|
|
56
|
-
*
|
|
63
|
+
* <p>Report the account quotas for that Region returned by
|
|
64
|
+
* <code>DescribeLimits</code>, along with the total current provisioned
|
|
65
|
+
* capacity levels you have calculated.</p>
|
|
57
66
|
* </li>
|
|
58
67
|
* </ol>
|
|
59
68
|
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
69
|
+
* <p>This will let you see whether you are getting close to your account-level
|
|
70
|
+
* quotas.</p>
|
|
71
|
+
* <p>The per-table quotas apply only when you are creating a new table. They restrict the
|
|
72
|
+
* sum of the provisioned capacity of the new table itself and all its global secondary
|
|
63
73
|
* indexes.</p>
|
|
64
|
-
*
|
|
74
|
+
* <p>For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned
|
|
65
75
|
* capacity extremely rapidly, but the only quota that applies is that the aggregate
|
|
66
76
|
* provisioned capacity over all your tables and GSIs cannot exceed either of the
|
|
67
77
|
* per-account quotas.</p>
|
|
68
|
-
*
|
|
78
|
+
* <note>
|
|
69
79
|
* <p>
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
80
|
+
* <code>DescribeLimits</code> should only be called periodically. You can expect
|
|
81
|
+
* throttling errors if you call it more than once in a minute.</p>
|
|
82
|
+
* </note>
|
|
83
|
+
* <p>The <code>DescribeLimits</code> Request element has no content.</p>
|
|
74
84
|
* @example
|
|
75
85
|
* Use a bare-bones client and the command you need to make an API call.
|
|
76
86
|
* ```javascript
|
|
@@ -83,7 +93,7 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
|
|
|
83
93
|
*
|
|
84
94
|
* @see {@link DescribeLimitsCommandInput} for command's `input` shape.
|
|
85
95
|
* @see {@link DescribeLimitsCommandOutput} for command's `response` shape.
|
|
86
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
96
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
87
97
|
*
|
|
88
98
|
*/
|
|
89
99
|
export declare class DescribeLimitsCommand extends $Command<DescribeLimitsCommandInput, DescribeLimitsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,13 +7,16 @@ export interface DescribeTableCommandInput extends DescribeTableInput {
|
|
|
7
7
|
export interface DescribeTableCommandOutput extends DescribeTableOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns information about the table, including the current status of the table, when
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
10
|
+
* <p>Returns information about the table, including the current status of the table, when
|
|
11
|
+
* it was created, the primary key schema, and any indexes on the table.</p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>If you issue a <code>DescribeTable</code> request immediately after a
|
|
14
|
+
* <code>CreateTable</code> request, DynamoDB might return a
|
|
15
|
+
* <code>ResourceNotFoundException</code>. This is because
|
|
16
|
+
* <code>DescribeTable</code> uses an eventually consistent query, and the metadata
|
|
17
|
+
* for your table might not be available at that moment. Wait for a few seconds, and
|
|
18
|
+
* then try the <code>DescribeTable</code> request again.</p>
|
|
19
|
+
* </note>
|
|
17
20
|
* @example
|
|
18
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
22
|
* ```javascript
|
|
@@ -26,7 +29,7 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
|
|
|
26
29
|
*
|
|
27
30
|
* @see {@link DescribeTableCommandInput} for command's `input` shape.
|
|
28
31
|
* @see {@link DescribeTableCommandOutput} for command's `response` shape.
|
|
29
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
32
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
30
33
|
*
|
|
31
34
|
*/
|
|
32
35
|
export declare class DescribeTableCommand extends $Command<DescribeTableCommandInput, DescribeTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,9 +8,10 @@ export interface DescribeTableReplicaAutoScalingCommandOutput extends DescribeTa
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Describes auto scaling settings across replicas of the global table at once.</p>
|
|
11
|
-
*
|
|
12
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
13
|
-
*
|
|
11
|
+
* <note>
|
|
12
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
13
|
+
* 2019.11.21</a> of global tables.</p>
|
|
14
|
+
* </note>
|
|
14
15
|
* @example
|
|
15
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
17
|
* ```javascript
|
|
@@ -23,7 +24,7 @@ export interface DescribeTableReplicaAutoScalingCommandOutput extends DescribeTa
|
|
|
23
24
|
*
|
|
24
25
|
* @see {@link DescribeTableReplicaAutoScalingCommandInput} for command's `input` shape.
|
|
25
26
|
* @see {@link DescribeTableReplicaAutoScalingCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
27
28
|
*
|
|
28
29
|
*/
|
|
29
30
|
export declare class DescribeTableReplicaAutoScalingCommand extends $Command<DescribeTableReplicaAutoScalingCommandInput, DescribeTableReplicaAutoScalingCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface DescribeTimeToLiveCommandOutput extends DescribeTimeToLiveOutpu
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link DescribeTimeToLiveCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link DescribeTimeToLiveCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class DescribeTimeToLiveCommand extends $Command<DescribeTimeToLiveCommandInput, DescribeTimeToLiveCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface DisableKinesisStreamingDestinationCommandOutput extends Kinesis
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link DisableKinesisStreamingDestinationCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link DisableKinesisStreamingDestinationCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class DisableKinesisStreamingDestinationCommand extends $Command<DisableKinesisStreamingDestinationCommandInput, DisableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,10 +7,10 @@ export interface EnableKinesisStreamingDestinationCommandInput extends KinesisSt
|
|
|
7
7
|
export interface EnableKinesisStreamingDestinationCommandOutput extends KinesisStreamingDestinationOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Starts table data replication to the specified Kinesis data stream at a timestamp
|
|
11
|
-
* during the enable workflow. If this operation doesn't return results immediately,
|
|
12
|
-
* DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream
|
|
13
|
-
* ACTIVE.</p>
|
|
10
|
+
* <p>Starts table data replication to the specified Kinesis data stream at a timestamp
|
|
11
|
+
* chosen during the enable workflow. If this operation doesn't return results immediately,
|
|
12
|
+
* use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream
|
|
13
|
+
* is ACTIVE.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface EnableKinesisStreamingDestinationCommandOutput extends KinesisS
|
|
|
23
23
|
*
|
|
24
24
|
* @see {@link EnableKinesisStreamingDestinationCommandInput} for command's `input` shape.
|
|
25
25
|
* @see {@link EnableKinesisStreamingDestinationCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
export declare class EnableKinesisStreamingDestinationCommand extends $Command<EnableKinesisStreamingDestinationCommandInput, EnableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,9 +7,8 @@ export interface ExecuteStatementCommandInput extends ExecuteStatementInput {
|
|
|
7
7
|
export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
* </p>
|
|
10
|
+
* <p>This operation allows you to perform reads and singleton writes on data stored in
|
|
11
|
+
* DynamoDB, using PartiQL.</p>
|
|
13
12
|
* @example
|
|
14
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
14
|
* ```javascript
|
|
@@ -22,7 +21,7 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
|
|
|
22
21
|
*
|
|
23
22
|
* @see {@link ExecuteStatementCommandInput} for command's `input` shape.
|
|
24
23
|
* @see {@link ExecuteStatementCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
26
25
|
*
|
|
27
26
|
*/
|
|
28
27
|
export declare class ExecuteStatementCommand extends $Command<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,9 +7,14 @@ export interface ExecuteTransactionCommandInput extends ExecuteTransactionInput
|
|
|
7
7
|
export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>This operation allows you to perform transactional reads or writes on data stored in
|
|
11
|
+
* DynamoDB, using PartiQL.</p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>The entire transaction must consist of either read statements or write statements,
|
|
14
|
+
* you cannot mix both in one transaction. The EXISTS function is an exception and can
|
|
15
|
+
* be used to check the condition of specific attributes of the item in a similar
|
|
16
|
+
* manner to <code>ConditionCheck</code> in the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems">TransactWriteItems</a> API.</p>
|
|
17
|
+
* </note>
|
|
13
18
|
* @example
|
|
14
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
20
|
* ```javascript
|
|
@@ -22,7 +27,7 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu
|
|
|
22
27
|
*
|
|
23
28
|
* @see {@link ExecuteTransactionCommandInput} for command's `input` shape.
|
|
24
29
|
* @see {@link ExecuteTransactionCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
30
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
26
31
|
*
|
|
27
32
|
*/
|
|
28
33
|
export declare class ExecuteTransactionCommand extends $Command<ExecuteTransactionCommandInput, ExecuteTransactionCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface ExportTableToPointInTimeCommandOutput extends ExportTableToPoin
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link ExportTableToPointInTimeCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link ExportTableToPointInTimeCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class ExportTableToPointInTimeCommand extends $Command<ExportTableToPointInTimeCommandInput, ExportTableToPointInTimeCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,13 +7,14 @@ export interface GetItemCommandInput extends GetItemInput {
|
|
|
7
7
|
export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The <code>GetItem</code> operation returns a set of attributes for the item with the
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
10
|
+
* <p>The <code>GetItem</code> operation returns a set of attributes for the item with the
|
|
11
|
+
* given primary key. If there is no matching item, <code>GetItem</code> does not return
|
|
12
|
+
* any data and there will be no <code>Item</code> element in the response.</p>
|
|
13
|
+
* <p>
|
|
14
|
+
* <code>GetItem</code> provides an eventually consistent read by default. If your
|
|
15
|
+
* application requires a strongly consistent read, set <code>ConsistentRead</code> to
|
|
16
|
+
* <code>true</code>. Although a strongly consistent read might take more time than an
|
|
17
|
+
* eventually consistent read, it always returns the last updated value.</p>
|
|
17
18
|
* @example
|
|
18
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
20
|
* ```javascript
|
|
@@ -26,7 +27,7 @@ export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {
|
|
|
26
27
|
*
|
|
27
28
|
* @see {@link GetItemCommandInput} for command's `input` shape.
|
|
28
29
|
* @see {@link GetItemCommandOutput} for command's `response` shape.
|
|
29
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
30
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
30
31
|
*
|
|
31
32
|
*/
|
|
32
33
|
export declare class GetItemCommand extends $Command<GetItemCommandInput, GetItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,13 +7,13 @@ export interface ListBackupsCommandInput extends ListBackupsInput {
|
|
|
7
7
|
export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>List backups associated with an
|
|
11
|
-
*
|
|
12
|
-
* with at most 1 MB worth of items in a page. You can also
|
|
13
|
-
* entries to be returned in a page
|
|
14
|
-
*
|
|
10
|
+
* <p>List backups associated with an Amazon Web Services account. To list backups for a
|
|
11
|
+
* given table, specify <code>TableName</code>. <code>ListBackups</code> returns a
|
|
12
|
+
* paginated list of results with at most 1 MB worth of items in a page. You can also
|
|
13
|
+
* specify a maximum number of entries to be returned in a page.</p>
|
|
14
|
+
* <p>In the request, start time is inclusive, but end time is exclusive. Note that these
|
|
15
15
|
* boundaries are for the time at which the original backup was requested.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>You can call <code>ListBackups</code> a maximum of five times per second.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -26,7 +26,7 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB
|
|
|
26
26
|
*
|
|
27
27
|
* @see {@link ListBackupsCommandInput} for command's `input` shape.
|
|
28
28
|
* @see {@link ListBackupsCommandOutput} for command's `response` shape.
|
|
29
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
29
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
30
30
|
*
|
|
31
31
|
*/
|
|
32
32
|
export declare class ListBackupsCommand extends $Command<ListBackupsCommandInput, ListBackupsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,7 +7,8 @@ export interface ListContributorInsightsCommandInput extends ListContributorInsi
|
|
|
7
7
|
export interface ListContributorInsightsCommandOutput extends ListContributorInsightsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of ContributorInsightsSummary for a table and all its global secondary
|
|
10
|
+
* <p>Returns a list of ContributorInsightsSummary for a table and all its global secondary
|
|
11
|
+
* indexes.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -20,7 +21,7 @@ export interface ListContributorInsightsCommandOutput extends ListContributorIns
|
|
|
20
21
|
*
|
|
21
22
|
* @see {@link ListContributorInsightsCommandInput} for command's `input` shape.
|
|
22
23
|
* @see {@link ListContributorInsightsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
25
|
*
|
|
25
26
|
*/
|
|
26
27
|
export declare class ListContributorInsightsCommand extends $Command<ListContributorInsightsCommandInput, ListContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link ListExportsCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link ListExportsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class ListExportsCommand extends $Command<ListExportsCommandInput, ListExportsCommandOutput, DynamoDBClientResolvedConfig> {
|