From 67542d35ff79a0cf1ff0989253cbda8d15382399 Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 9 Sep 2024 18:17:40 +0000 Subject: [PATCH] docs(client-dynamodb): Doc-only update for DynamoDB. Added information about async behavior for TagResource and UntagResource APIs and updated the description of ResourceInUseException. --- .../src/commands/CreateTableCommand.ts | 16 +++++++++--- .../commands/DeleteResourcePolicyCommand.ts | 16 +++++++++--- .../src/commands/DeleteTableCommand.ts | 16 +++++++++--- ...sableKinesisStreamingDestinationCommand.ts | 16 +++++++++--- ...nableKinesisStreamingDestinationCommand.ts | 16 +++++++++--- .../src/commands/ImportTableCommand.ts | 16 +++++++++--- .../src/commands/PutResourcePolicyCommand.ts | 16 +++++++++--- .../src/commands/TagResourceCommand.ts | 25 ++++++++++++++++--- .../src/commands/UntagResourceCommand.ts | 25 ++++++++++++++++--- .../UpdateGlobalTableSettingsCommand.ts | 16 +++++++++--- ...pdateKinesisStreamingDestinationCommand.ts | 16 +++++++++--- .../src/commands/UpdateTableCommand.ts | 16 +++++++++--- .../UpdateTableReplicaAutoScalingCommand.ts | 16 +++++++++--- .../src/commands/UpdateTimeToLiveCommand.ts | 16 +++++++++--- .../client-dynamodb/src/models/models_0.ts | 16 +++++++++--- codegen/sdk-codegen/aws-models/dynamodb.json | 14 ++++++++--- 16 files changed, 224 insertions(+), 48 deletions(-) diff --git a/clients/client-dynamodb/src/commands/CreateTableCommand.ts b/clients/client-dynamodb/src/commands/CreateTableCommand.ts index 2c6554a5da3b1..45b17d0651f9c 100644 --- a/clients/client-dynamodb/src/commands/CreateTableCommand.ts +++ b/clients/client-dynamodb/src/commands/CreateTableCommand.ts @@ -315,9 +315,19 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link DynamoDBServiceException} *

Base exception class for all service exceptions from DynamoDB service.

diff --git a/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts b/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts index 7eacb74462a07..c09a06ef69ecb 100644 --- a/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts @@ -100,9 +100,19 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO *

If you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/DeleteTableCommand.ts b/clients/client-dynamodb/src/commands/DeleteTableCommand.ts index 0766d492b52f4..bdf21d366ac09 100644 --- a/clients/client-dynamodb/src/commands/DeleteTableCommand.ts +++ b/clients/client-dynamodb/src/commands/DeleteTableCommand.ts @@ -244,9 +244,19 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts index 6a5a1cc74c070..6d9bc4f18908c 100644 --- a/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts +++ b/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts @@ -89,9 +89,19 @@ export interface DisableKinesisStreamingDestinationCommandOutput * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts index 0a7ce36b38995..2f017889d68f8 100644 --- a/clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts +++ b/clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts @@ -91,9 +91,19 @@ export interface EnableKinesisStreamingDestinationCommandOutput * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/ImportTableCommand.ts b/clients/client-dynamodb/src/commands/ImportTableCommand.ts index d16dd5194eba8..11163cb824d60 100644 --- a/clients/client-dynamodb/src/commands/ImportTableCommand.ts +++ b/clients/client-dynamodb/src/commands/ImportTableCommand.ts @@ -229,9 +229,19 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link DynamoDBServiceException} *

Base exception class for all service exceptions from DynamoDB service.

diff --git a/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts b/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts index ff94318ac117e..6264955d82249 100644 --- a/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts +++ b/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts @@ -102,9 +102,19 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput, *

If you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/TagResourceCommand.ts b/clients/client-dynamodb/src/commands/TagResourceCommand.ts index 692ca48b09785..eb575032030b7 100644 --- a/clients/client-dynamodb/src/commands/TagResourceCommand.ts +++ b/clients/client-dynamodb/src/commands/TagResourceCommand.ts @@ -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.

+ * *

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB * in the Amazon DynamoDB Developer Guide.

* @example @@ -83,9 +92,19 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/UntagResourceCommand.ts b/clients/client-dynamodb/src/commands/UntagResourceCommand.ts index 7c26482006ac0..508a85f6d6069 100644 --- a/clients/client-dynamodb/src/commands/UntagResourceCommand.ts +++ b/clients/client-dynamodb/src/commands/UntagResourceCommand.ts @@ -30,6 +30,15 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes the association of tags from an Amazon DynamoDB resource. You can call * UntagResource up to five times per second, per account.

+ * *

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB * in the Amazon DynamoDB Developer Guide.

* @example @@ -78,9 +87,19 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts b/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts index f02e895a0cc2a..4a1cec0b4498e 100644 --- a/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts @@ -246,9 +246,19 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl *

The specified replica is no longer part of the global table.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link DynamoDBServiceException} *

Base exception class for all service exceptions from DynamoDB service.

diff --git a/clients/client-dynamodb/src/commands/UpdateKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/src/commands/UpdateKinesisStreamingDestinationCommand.ts index d2e8872f1f55f..8bce4d9c422ca 100644 --- a/clients/client-dynamodb/src/commands/UpdateKinesisStreamingDestinationCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateKinesisStreamingDestinationCommand.ts @@ -88,9 +88,19 @@ export interface UpdateKinesisStreamingDestinationCommandOutput * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/UpdateTableCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableCommand.ts index 215223df079b9..a691c9fa7c696 100644 --- a/clients/client-dynamodb/src/commands/UpdateTableCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateTableCommand.ts @@ -365,9 +365,19 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts index 78834b2385df7..3bda254d99d78 100644 --- a/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts @@ -211,9 +211,19 @@ export interface UpdateTableReplicaAutoScalingCommandOutput * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/commands/UpdateTimeToLiveCommand.ts b/clients/client-dynamodb/src/commands/UpdateTimeToLiveCommand.ts index 811b2f0a9b6cc..41579b2385260 100644 --- a/clients/client-dynamodb/src/commands/UpdateTimeToLiveCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateTimeToLiveCommand.ts @@ -105,9 +105,19 @@ export interface UpdateTimeToLiveCommandOutput extends UpdateTimeToLiveOutput, _ * this limit may result in request throttling.

* * @throws {@link ResourceInUseException} (client fault) - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not diff --git a/clients/client-dynamodb/src/models/models_0.ts b/clients/client-dynamodb/src/models/models_0.ts index 18b880acbbc67..dd0952243e6f8 100644 --- a/clients/client-dynamodb/src/models/models_0.ts +++ b/clients/client-dynamodb/src/models/models_0.ts @@ -3519,9 +3519,19 @@ export interface CreateTableOutput { } /** - *

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 - * CREATING state.

+ *

The operation conflicts with the resource's availability. For example:

+ * + *

When appropriate, wait for the ongoing update to complete and attempt the request again.

* @public */ export class ResourceInUseException extends __BaseException { diff --git a/codegen/sdk-codegen/aws-models/dynamodb.json b/codegen/sdk-codegen/aws-models/dynamodb.json index 9d0ff5c609918..7b2af2bd4add6 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.json @@ -25,6 +25,14 @@ { "id": "Service", "namespace": "*" + }, + { + "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountIdEndpointMode", + "namespace": "*" + }, + { + "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountId", + "namespace": "*" } ] }, @@ -9611,7 +9619,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation conflicts with the resource's availability. For example, you\n attempted to recreate an existing table, or tried to delete a table currently in the\n CREATING state.

", + "smithy.api#documentation": "

The operation conflicts with the resource's availability. For example:

\n \n

When appropriate, wait for the ongoing update to complete and attempt the request again.

", "smithy.api#error": "client" } }, @@ -11131,7 +11139,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#TagResourceInput": { @@ -11564,7 +11572,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#UntagResourceInput": {