Skip to content

Commit 67542d3

Browse files
author
awstools
committed
docs(client-dynamodb): Doc-only update for DynamoDB. Added information about async behavior for TagResource and UntagResource APIs and updated the description of ResourceInUseException.
1 parent 550f0a4 commit 67542d3

16 files changed

+224
-48
lines changed

‎clients/client-dynamodb/src/commands/CreateTableCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -315,9 +315,19 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
315315
* this limit may result in request throttling.</p>
316316
*
317317
* @throws {@link ResourceInUseException} (client fault)
318-
* <p>The operation conflicts with the resource's availability. For example, you
319-
* attempted to recreate an existing table, or tried to delete a table currently in the
320-
* <code>CREATING</code> state.</p>
318+
* <p>The operation conflicts with the resource's availability. For example:</p>
319+
* <ul>
320+
* <li>
321+
* <p>You attempted to recreate an existing table.</p>
322+
* </li>
323+
* <li>
324+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
325+
* </li>
326+
* <li>
327+
* <p>You tried to update a resource that was already being updated.</p>
328+
* </li>
329+
* </ul>
330+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
321331
*
322332
* @throws {@link DynamoDBServiceException}
323333
* <p>Base exception class for all service exceptions from DynamoDB service.</p>

‎clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,19 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO
100100
* <p>If you specified an <code>ExpectedRevisionId</code>, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.</p>
101101
*
102102
* @throws {@link ResourceInUseException} (client fault)
103-
* <p>The operation conflicts with the resource's availability. For example, you
104-
* attempted to recreate an existing table, or tried to delete a table currently in the
105-
* <code>CREATING</code> state.</p>
103+
* <p>The operation conflicts with the resource's availability. For example:</p>
104+
* <ul>
105+
* <li>
106+
* <p>You attempted to recreate an existing table.</p>
107+
* </li>
108+
* <li>
109+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
110+
* </li>
111+
* <li>
112+
* <p>You tried to update a resource that was already being updated.</p>
113+
* </li>
114+
* </ul>
115+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
106116
*
107117
* @throws {@link ResourceNotFoundException} (client fault)
108118
* <p>The operation tried to access a nonexistent table or index. The resource might not

‎clients/client-dynamodb/src/commands/DeleteTableCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -244,9 +244,19 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
244244
* this limit may result in request throttling.</p>
245245
*
246246
* @throws {@link ResourceInUseException} (client fault)
247-
* <p>The operation conflicts with the resource's availability. For example, you
248-
* attempted to recreate an existing table, or tried to delete a table currently in the
249-
* <code>CREATING</code> state.</p>
247+
* <p>The operation conflicts with the resource's availability. For example:</p>
248+
* <ul>
249+
* <li>
250+
* <p>You attempted to recreate an existing table.</p>
251+
* </li>
252+
* <li>
253+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
254+
* </li>
255+
* <li>
256+
* <p>You tried to update a resource that was already being updated.</p>
257+
* </li>
258+
* </ul>
259+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
250260
*
251261
* @throws {@link ResourceNotFoundException} (client fault)
252262
* <p>The operation tried to access a nonexistent table or index. The resource might not

‎clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,19 @@ export interface DisableKinesisStreamingDestinationCommandOutput
8989
* this limit may result in request throttling.</p>
9090
*
9191
* @throws {@link ResourceInUseException} (client fault)
92-
* <p>The operation conflicts with the resource's availability. For example, you
93-
* attempted to recreate an existing table, or tried to delete a table currently in the
94-
* <code>CREATING</code> state.</p>
92+
* <p>The operation conflicts with the resource's availability. For example:</p>
93+
* <ul>
94+
* <li>
95+
* <p>You attempted to recreate an existing table.</p>
96+
* </li>
97+
* <li>
98+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
99+
* </li>
100+
* <li>
101+
* <p>You tried to update a resource that was already being updated.</p>
102+
* </li>
103+
* </ul>
104+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
95105
*
96106
* @throws {@link ResourceNotFoundException} (client fault)
97107
* <p>The operation tried to access a nonexistent table or index. The resource might not

‎clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,19 @@ export interface EnableKinesisStreamingDestinationCommandOutput
9191
* this limit may result in request throttling.</p>
9292
*
9393
* @throws {@link ResourceInUseException} (client fault)
94-
* <p>The operation conflicts with the resource's availability. For example, you
95-
* attempted to recreate an existing table, or tried to delete a table currently in the
96-
* <code>CREATING</code> state.</p>
94+
* <p>The operation conflicts with the resource's availability. For example:</p>
95+
* <ul>
96+
* <li>
97+
* <p>You attempted to recreate an existing table.</p>
98+
* </li>
99+
* <li>
100+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
101+
* </li>
102+
* <li>
103+
* <p>You tried to update a resource that was already being updated.</p>
104+
* </li>
105+
* </ul>
106+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
97107
*
98108
* @throws {@link ResourceNotFoundException} (client fault)
99109
* <p>The operation tried to access a nonexistent table or index. The resource might not

‎clients/client-dynamodb/src/commands/ImportTableCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,19 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
229229
* this limit may result in request throttling.</p>
230230
*
231231
* @throws {@link ResourceInUseException} (client fault)
232-
* <p>The operation conflicts with the resource's availability. For example, you
233-
* attempted to recreate an existing table, or tried to delete a table currently in the
234-
* <code>CREATING</code> state.</p>
232+
* <p>The operation conflicts with the resource's availability. For example:</p>
233+
* <ul>
234+
* <li>
235+
* <p>You attempted to recreate an existing table.</p>
236+
* </li>
237+
* <li>
238+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
239+
* </li>
240+
* <li>
241+
* <p>You tried to update a resource that was already being updated.</p>
242+
* </li>
243+
* </ul>
244+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
235245
*
236246
* @throws {@link DynamoDBServiceException}
237247
* <p>Base exception class for all service exceptions from DynamoDB service.</p>

‎clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,19 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput,
102102
* <p>If you specified an <code>ExpectedRevisionId</code>, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.</p>
103103
*
104104
* @throws {@link ResourceInUseException} (client fault)
105-
* <p>The operation conflicts with the resource's availability. For example, you
106-
* attempted to recreate an existing table, or tried to delete a table currently in the
107-
* <code>CREATING</code> state.</p>
105+
* <p>The operation conflicts with the resource's availability. For example:</p>
106+
* <ul>
107+
* <li>
108+
* <p>You attempted to recreate an existing table.</p>
109+
* </li>
110+
* <li>
111+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
112+
* </li>
113+
* <li>
114+
* <p>You tried to update a resource that was already being updated.</p>
115+
* </li>
116+
* </ul>
117+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
108118
*
109119
* @throws {@link ResourceNotFoundException} (client fault)
110120
* <p>The operation tried to access a nonexistent table or index. The resource might not

‎clients/client-dynamodb/src/commands/TagResourceCommand.ts‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
3232
* user-defined tags so that they appear on the Billing and Cost Management console for
3333
* cost allocation tracking. You can call TagResource up to five times per second, per
3434
* account. </p>
35+
* <ul>
36+
* <li>
37+
* <p>
38+
* <code>TagResource</code> is an asynchronous operation. If you issue a <a>ListTagsOfResource</a> request immediately after a <code>TagResource</code> request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because <code>ListTagsOfResource</code> uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the <code>ListTagsOfResource</code> request again.</p>
39+
* </li>
40+
* <li>
41+
* <p>The application or removal of tags using <code>TagResource</code> and <code>UntagResource</code> APIs is eventually consistent. <code>ListTagsOfResource</code> API will only reflect the changes after a few seconds.</p>
42+
* </li>
43+
* </ul>
3544
* <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
3645
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
3746
* @example
@@ -83,9 +92,19 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
8392
* this limit may result in request throttling.</p>
8493
*
8594
* @throws {@link ResourceInUseException} (client fault)
86-
* <p>The operation conflicts with the resource's availability. For example, you
87-
* attempted to recreate an existing table, or tried to delete a table currently in the
88-
* <code>CREATING</code> state.</p>
95+
* <p>The operation conflicts with the resource's availability. For example:</p>
96+
* <ul>
97+
* <li>
98+
* <p>You attempted to recreate an existing table.</p>
99+
* </li>
100+
* <li>
101+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
102+
* </li>
103+
* <li>
104+
* <p>You tried to update a resource that was already being updated.</p>
105+
* </li>
106+
* </ul>
107+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
89108
*
90109
* @throws {@link ResourceNotFoundException} (client fault)
91110
* <p>The operation tried to access a nonexistent table or index. The resource might not

‎clients/client-dynamodb/src/commands/UntagResourceCommand.ts‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {}
3030
/**
3131
* <p>Removes the association of tags from an Amazon DynamoDB resource. You can call
3232
* <code>UntagResource</code> up to five times per second, per account. </p>
33+
* <ul>
34+
* <li>
35+
* <p>
36+
* <code>UntagResource</code> is an asynchronous operation. If you issue a <a>ListTagsOfResource</a> request immediately after an <code>UntagResource</code> request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because <code>ListTagsOfResource</code> uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the <code>ListTagsOfResource</code> request again.</p>
37+
* </li>
38+
* <li>
39+
* <p>The application or removal of tags using <code>TagResource</code> and <code>UntagResource</code> APIs is eventually consistent. <code>ListTagsOfResource</code> API will only reflect the changes after a few seconds.</p>
40+
* </li>
41+
* </ul>
3342
* <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
3443
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
3544
* @example
@@ -78,9 +87,19 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {}
7887
* this limit may result in request throttling.</p>
7988
*
8089
* @throws {@link ResourceInUseException} (client fault)
81-
* <p>The operation conflicts with the resource's availability. For example, you
82-
* attempted to recreate an existing table, or tried to delete a table currently in the
83-
* <code>CREATING</code> state.</p>
90+
* <p>The operation conflicts with the resource's availability. For example:</p>
91+
* <ul>
92+
* <li>
93+
* <p>You attempted to recreate an existing table.</p>
94+
* </li>
95+
* <li>
96+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
97+
* </li>
98+
* <li>
99+
* <p>You tried to update a resource that was already being updated.</p>
100+
* </li>
101+
* </ul>
102+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
84103
*
85104
* @throws {@link ResourceNotFoundException} (client fault)
86105
* <p>The operation tried to access a nonexistent table or index. The resource might not

‎clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,19 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
246246
* <p>The specified replica is no longer part of the global table.</p>
247247
*
248248
* @throws {@link ResourceInUseException} (client fault)
249-
* <p>The operation conflicts with the resource's availability. For example, you
250-
* attempted to recreate an existing table, or tried to delete a table currently in the
251-
* <code>CREATING</code> state.</p>
249+
* <p>The operation conflicts with the resource's availability. For example:</p>
250+
* <ul>
251+
* <li>
252+
* <p>You attempted to recreate an existing table.</p>
253+
* </li>
254+
* <li>
255+
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
256+
* </li>
257+
* <li>
258+
* <p>You tried to update a resource that was already being updated.</p>
259+
* </li>
260+
* </ul>
261+
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
252262
*
253263
* @throws {@link DynamoDBServiceException}
254264
* <p>Base exception class for all service exceptions from DynamoDB service.</p>

0 commit comments

Comments
 (0)