Skip to content

Commit

Permalink
docs(client-dynamodb): Doc-only update for DynamoDB. Added informatio…
Browse files Browse the repository at this point in the history 
…n about async behavior for TagResource and UntagResource APIs and updated the description of ResourceInUseException.
  • Loading branch information
awstools committed Sep 9, 2024
1 parent 550f0a4 commit 67542d3
Show file tree
Hide file tree
Showing 16 changed files with 224 additions and 48 deletions.
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/CreateTableCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,19 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link DynamoDBServiceException}
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,19 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO
* <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>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/DeleteTableCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,19 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,19 @@ export interface DisableKinesisStreamingDestinationCommandOutput
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,19 @@ export interface EnableKinesisStreamingDestinationCommandOutput
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/ImportTableCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,19 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link DynamoDBServiceException}
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,19 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput,
* <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>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
25 changes: 22 additions & 3 deletions clients/client-dynamodb/src/commands/TagResourceCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
* user-defined tags so that they appear on the Billing and Cost Management console for
* cost allocation tracking. You can call TagResource up to five times per second, per
* account. </p>
* <ul>
* <li>
* <p>
* <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>
* </li>
* <li>
* <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>
* </li>
* </ul>
* <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>
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
* @example
Expand Down Expand Up @@ -83,9 +92,19 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
25 changes: 22 additions & 3 deletions clients/client-dynamodb/src/commands/UntagResourceCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {}
/**
* <p>Removes the association of tags from an Amazon DynamoDB resource. You can call
* <code>UntagResource</code> up to five times per second, per account. </p>
* <ul>
* <li>
* <p>
* <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>
* </li>
* <li>
* <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>
* </li>
* </ul>
* <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>
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
* @example
Expand Down Expand Up @@ -78,9 +87,19 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {}
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -246,9 +246,19 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
* <p>The specified replica is no longer part of the global table.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link DynamoDBServiceException}
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/UpdateKinesisStreamingDestinationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,19 @@ export interface UpdateKinesisStreamingDestinationCommandOutput
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/UpdateTableCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -365,9 +365,19 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,19 @@ export interface UpdateTableReplicaAutoScalingCommandOutput
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
16 changes: 13 additions & 3 deletions clients/client-dynamodb/src/commands/UpdateTimeToLiveCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,19 @@ export interface UpdateTimeToLiveCommandOutput extends UpdateTimeToLiveOutput, _
* this limit may result in request throttling.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The operation conflicts with the resource's availability. For example, you
* attempted to recreate an existing table, or tried to delete a table currently in the
* <code>CREATING</code> state.</p>
* <p>The operation conflicts with the resource's availability. For example:</p>
* <ul>
* <li>
* <p>You attempted to recreate an existing table.</p>
* </li>
* <li>
* <p>You tried to delete a table currently in the <code>CREATING</code> state.</p>
* </li>
* <li>
* <p>You tried to update a resource that was already being updated.</p>
* </li>
* </ul>
* <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The operation tried to access a nonexistent table or index. The resource might not
Expand Down
Loading

0 comments on commit 67542d3

Please sign in to comment.