From a4233c3b964eece0f4a99cb14e650c45c10c7a40 Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 9 Dec 2024 19:38:04 +0000 Subject: [PATCH] docs(client-keyspaces): Amazon Keyspaces: adding the list of IAM actions required by the UpdateKeyspace API. --- .../src/commands/UpdateKeyspaceCommand.ts | 102 +++++++++++++++++- codegen/sdk-codegen/aws-models/keyspaces.json | 2 +- 2 files changed, 98 insertions(+), 6 deletions(-) diff --git a/clients/client-keyspaces/src/commands/UpdateKeyspaceCommand.ts b/clients/client-keyspaces/src/commands/UpdateKeyspaceCommand.ts index a66a12b8779e..fccf3c2d39bf 100644 --- a/clients/client-keyspaces/src/commands/UpdateKeyspaceCommand.ts +++ b/clients/client-keyspaces/src/commands/UpdateKeyspaceCommand.ts @@ -30,13 +30,105 @@ export interface UpdateKeyspaceCommandOutput extends UpdateKeyspaceResponse, __M /** *

* Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. - * The new replica Region is applied to all tables in the keyspace. For more information, see Add an Amazon Web Services Region to a keyspace in Amazon Keyspaces in the Amazon Keyspaces Developer - * Guide. - *

- *

To change a single-Region to a multi-Region keyspace, you have to enable client-side timestamps - * for all tables in the keyspace. For more information, see + * Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they + * must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled + * when invoking the API. For more information about client-side timestamps, see * Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer * Guide.

+ *

To add a Region to a keyspace using the UpdateKeyspace API, the IAM principal needs permissions for the following IAM actions:

+ * + *

If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, + * the following additional IAM actions need to be allowed.

+ * + *

To use the UpdateKeyspace API, the IAM principal also needs permissions to + * create a service-linked role with the following elements:

+ * + *

For more information, see Configure the IAM permissions + * required to add an Amazon Web Services Region to a keyspace + * in the Amazon Keyspaces Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/codegen/sdk-codegen/aws-models/keyspaces.json b/codegen/sdk-codegen/aws-models/keyspaces.json index 9ddc63cd7b1c..562607907961 100644 --- a/codegen/sdk-codegen/aws-models/keyspaces.json +++ b/codegen/sdk-codegen/aws-models/keyspaces.json @@ -3584,7 +3584,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace.\n The new replica Region is applied to all tables in the keyspace. For more information, see Add an Amazon Web Services Region to a keyspace in Amazon Keyspaces in the Amazon Keyspaces Developer\n Guide.\n

\n

To change a single-Region to a multi-Region keyspace, you have to enable client-side timestamps\n for all tables in the keyspace. For more information, see\n Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

\n Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace.\n Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they\n must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled\n when invoking the API. For more information about client-side timestamps, see\n Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer\n Guide.

\n

To add a Region to a keyspace using the UpdateKeyspace API, the IAM principal needs permissions for the following IAM actions:

\n \n

If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, \n the following additional IAM actions need to be allowed.

\n \n

To use the UpdateKeyspace API, the IAM principal also needs permissions to\n create a service-linked role with the following elements:

\n \n

For more information, see Configure the IAM permissions\n required to add an Amazon Web Services Region to a keyspace\n in the Amazon Keyspaces Developer Guide.

" } }, "com.amazonaws.keyspaces#UpdateKeyspaceRequest": {