Keyspaces ********* Client ====== class Keyspaces.Client A low-level client representing Amazon Keyspaces Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software. In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail. For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the *Amazon Keyspaces Developer Guide*. To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the *Amazon Keyspaces Developer Guide*. For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the *General Reference*. import boto3 client = boto3.client('keyspaces') These are the available methods: * can_paginate * close * create_keyspace * create_table * create_type * delete_keyspace * delete_table * delete_type * get_keyspace * get_paginator * get_table * get_table_auto_scaling_settings * get_type * get_waiter * list_keyspaces * list_tables * list_tags_for_resource * list_types * restore_table * tag_resource * untag_resource * update_keyspace * update_table Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListKeyspaces * ListTables * ListTagsForResource * ListTypes Keyspaces / Paginator / ListTagsForResource ListTagsForResource ******************* class Keyspaces.Paginator.ListTagsForResource paginator = client.get_paginator('list_tags_for_resource') paginate(**kwargs) Creates an iterator that will paginate through responses from "Keyspaces.Client.list_tags_for_resource()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( resourceArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Keyspaces resource. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'tags': [ { 'key': 'string', 'value': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **tags** *(list) --* A list of tags. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User- assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* The value of the tag. Tag values are case-sensitive and can be null. * **NextToken** *(string) --* A token to resume pagination. Keyspaces / Paginator / ListKeyspaces ListKeyspaces ************* class Keyspaces.Paginator.ListKeyspaces paginator = client.get_paginator('list_keyspaces') paginate(**kwargs) Creates an iterator that will paginate through responses from "Keyspaces.Client.list_keyspaces()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'keyspaces': [ { 'keyspaceName': 'string', 'resourceArn': 'string', 'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION', 'replicationRegions': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **keyspaces** *(list) --* A list of keyspaces. * *(dict) --* Represents the properties of a keyspace. * **keyspaceName** *(string) --* The name of the keyspace. * **resourceArn** *(string) --* The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN). * **replicationStrategy** *(string) --* This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are "SINGLE_REGION" or "MULTI_REGION". * **replicationRegions** *(list) --* If the "replicationStrategy" of the keyspace is "MULTI_REGION", a list of replication Regions is returned. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. Keyspaces / Paginator / ListTypes ListTypes ********* class Keyspaces.Paginator.ListTypes paginator = client.get_paginator('list_types') paginate(**kwargs) Creates an iterator that will paginate through responses from "Keyspaces.Client.list_types()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( keyspaceName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace that contains the listed types. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'types': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **types** *(list) --* The list of types contained in the specified keyspace. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. Keyspaces / Paginator / ListTables ListTables ********** class Keyspaces.Paginator.ListTables paginator = client.get_paginator('list_tables') paginate(**kwargs) Creates an iterator that will paginate through responses from "Keyspaces.Client.list_tables()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( keyspaceName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'tables': [ { 'keyspaceName': 'string', 'tableName': 'string', 'resourceArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **tables** *(list) --* A list of tables. * *(dict) --* Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN). * **keyspaceName** *(string) --* The name of the keyspace that the table is stored in. * **tableName** *(string) --* The name of the table. * **resourceArn** *(string) --* The unique identifier of the table in the format of an Amazon Resource Name (ARN). * **NextToken** *(string) --* A token to resume pagination. Keyspaces / Client / create_type create_type *********** Keyspaces.Client.create_type(**kwargs) The "CreateType" operation creates a new user-defined type in the specified keyspace. To configure the required permissions, see Permissions to create a UDT in the *Amazon Keyspaces Developer Guide*. For more information, see User-defined types (UDTs) in the *Amazon Keyspaces Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_type( keyspaceName='string', typeName='string', fieldDefinitions=[ { 'name': 'string', 'type': 'string' }, ] ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace. * **typeName** (*string*) -- **[REQUIRED]** The name of the user-defined type. UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters. Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters. You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character. * **fieldDefinitions** (*list*) -- **[REQUIRED]** The field definitions, consisting of names and types, that define this type. * *(dict) --* A field definition consists out of a name and a type. * **name** *(string) --* **[REQUIRED]** The identifier. * **type** *(string) --* **[REQUIRED]** Any supported Cassandra data type, including collections and other user-defined types that are contained in the same keyspace. For more information, see Cassandra data type support in the *Amazon Keyspaces Developer Guide*. Return type: dict Returns: **Response Syntax** { 'keyspaceArn': 'string', 'typeName': 'string' } **Response Structure** * *(dict) --* * **keyspaceArn** *(string) --* The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN). * **typeName** *(string) --* The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for other operations, for example "GetType". **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / get_paginator get_paginator ************* Keyspaces.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Keyspaces / Client / get_keyspace get_keyspace ************ Keyspaces.Client.get_keyspace(**kwargs) Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an "UpdateKeyspace" operation. See also: AWS API Documentation **Request Syntax** response = client.get_keyspace( keyspaceName='string' ) Parameters: **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace. Return type: dict Returns: **Response Syntax** { 'keyspaceName': 'string', 'resourceArn': 'string', 'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION', 'replicationRegions': [ 'string', ], 'replicationGroupStatuses': [ { 'region': 'string', 'keyspaceStatus': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING', 'tablesReplicationProgress': 'string' }, ] } **Response Structure** * *(dict) --* * **keyspaceName** *(string) --* The name of the keyspace. * **resourceArn** *(string) --* Returns the ARN of the keyspace. * **replicationStrategy** *(string) --* Returns the replication strategy of the keyspace. The options are "SINGLE_REGION" or "MULTI_REGION". * **replicationRegions** *(list) --* If the "replicationStrategy" of the keyspace is "MULTI_REGION", a list of replication Regions is returned. * *(string) --* * **replicationGroupStatuses** *(list) --* A list of all Regions the keyspace is replicated in after the update keyspace operation and their status. * *(dict) --* This shows the summary status of the keyspace after a new Amazon Web Services Region was added. * **region** *(string) --* The name of the Region that was added to the keyspace. * **keyspaceStatus** *(string) --* The status of the keyspace. * **tablesReplicationProgress** *(string) --* This shows the replication progress of tables in the keyspace. The value is expressed as a percentage of the newly replicated tables with status "Active" compared to the total number of tables in the keyspace. **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / update_table update_table ************ Keyspaces.Client.update_table(**kwargs) Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation. See also: AWS API Documentation **Request Syntax** response = client.update_table( keyspaceName='string', tableName='string', addColumns=[ { 'name': 'string', 'type': 'string' }, ], capacitySpecification={ 'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED', 'readCapacityUnits': 123, 'writeCapacityUnits': 123 }, encryptionSpecification={ 'type': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY', 'kmsKeyIdentifier': 'string' }, pointInTimeRecovery={ 'status': 'ENABLED'|'DISABLED' }, ttl={ 'status': 'ENABLED' }, defaultTimeToLive=123, clientSideTimestamps={ 'status': 'ENABLED' }, autoScalingSpecification={ 'writeCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } }, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } }, replicaSpecifications=[ { 'region': 'string', 'readCapacityUnits': 123, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } }, ], cdcSpecification={ 'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING', 'viewType': 'NEW_IMAGE'|'OLD_IMAGE'|'KEYS_ONLY'|'NEW_AND_OLD_IMAGES', 'tags': [ { 'key': 'string', 'value': 'string' }, ], 'propagateTags': 'TABLE'|'NONE' } ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace the specified table is stored in. * **tableName** (*string*) -- **[REQUIRED]** The name of the table. * **addColumns** (*list*) -- For each column to be added to the specified table: * "name" - The name of the column. * "type" - An Amazon Keyspaces data type. For more information, see Data types in the *Amazon Keyspaces Developer Guide*. * *(dict) --* The names and data types of regular columns. * **name** *(string) --* **[REQUIRED]** The name of the column. * **type** *(string) --* **[REQUIRED]** The data type of the column. For a list of available data types, see Data types in the *Amazon Keyspaces Developer Guide*. * **capacitySpecification** (*dict*) -- Modifies the read/write throughput capacity mode for the table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **throughputMode** *(string) --* **[REQUIRED]** The read/write throughput capacity mode for a table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **readCapacityUnits** *(integer) --* The throughput capacity specified for "read" operations defined in "read capacity units" "(RCUs)". * **writeCapacityUnits** *(integer) --* The throughput capacity specified for "write" operations defined in "write capacity units" "(WCUs)". * **encryptionSpecification** (*dict*) -- Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key): * "type:AWS_OWNED_KMS_KEY" - This key is owned by Amazon Keyspaces. * "type:CUSTOMER_MANAGED_KMS_KEY" - This key is stored in your account and is created, owned, and managed by you. This option requires the "kms_key_identifier" of the KMS key in Amazon Resource Name (ARN) format as input. The default is "AWS_OWNED_KMS_KEY". For more information, see Encryption at rest in the *Amazon Keyspaces Developer Guide*. * **type** *(string) --* **[REQUIRED]** The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys): * "type:AWS_OWNED_KMS_KEY" - This key is owned by Amazon Keyspaces. * "type:CUSTOMER_MANAGED_KMS_KEY" - This key is stored in your account and is created, owned, and managed by you. This option requires the "kms_key_identifier" of the KMS key in Amazon Resource Name (ARN) format as input. The default is "type:AWS_OWNED_KMS_KEY". For more information, see Encryption at rest in the *Amazon Keyspaces Developer Guide*. * **kmsKeyIdentifier** *(string) --* The Amazon Resource Name (ARN) of the customer managed KMS key, for example "kms_key_identifier:ARN". * **pointInTimeRecovery** (*dict*) -- Modifies the "pointInTimeRecovery" settings of the table. The options are: * "status=ENABLED" * "status=DISABLED" If it's not specified, the default is "status=DISABLED". For more information, see Point-in-time recovery in the *Amazon Keyspaces Developer Guide*. * **status** *(string) --* **[REQUIRED]** The options are: * "status=ENABLED" * "status=DISABLED" * **ttl** (*dict*) -- Modifies Time to Live custom settings for the table. The options are: * "status:enabled" * "status:disabled" The default is "status:disabled". After "ttl" is enabled, you can't disable it for the table. For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the *Amazon Keyspaces Developer Guide*. * **status** *(string) --* **[REQUIRED]** Shows how to enable custom Time to Live (TTL) settings for the specified table. * **defaultTimeToLive** (*integer*) -- The default Time to Live setting in seconds for the table. For more information, see Setting the default TTL value for a table in the *Amazon Keyspaces Developer Guide*. * **clientSideTimestamps** (*dict*) -- Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option: * "status: "enabled"" Once client-side timestamps are enabled for a table, this setting cannot be disabled. * **status** *(string) --* **[REQUIRED]** Shows how to enable client-side timestamps settings for the specified table. * **autoScalingSpecification** (*dict*) -- The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. If auto scaling is already enabled for the table, you can use "UpdateTable" to update the minimum and maximum values or the auto scaling policy settings independently. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the *Amazon Keyspaces Developer Guide*. * **writeCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's write capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **readCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's read capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **replicaSpecifications** (*list*) -- The Region specific settings of a multi-Regional table. * *(dict) --* The Amazon Web Services Region specific settings of a multi- Region table. For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters. * "region": The Region where these settings are applied. (Required) * "readCapacityUnits": The provisioned read capacity units. (Optional) * "readCapacityAutoScaling": The read capacity auto scaling settings for the table. (Optional) * **region** *(string) --* **[REQUIRED]** The Amazon Web Services Region. * **readCapacityUnits** *(integer) --* The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region. * **readCapacityAutoScaling** *(dict) --* The read capacity auto scaling settings for the multi- Region table in the specified Amazon Web Services Region. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **cdcSpecification** (*dict*) -- The CDC stream settings of the table. * **status** *(string) --* **[REQUIRED]** The status of the CDC stream. You can enable or disable a stream for a table. * **viewType** *(string) --* The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection. The options are: * "NEW_AND_OLD_IMAGES" - both versions of the row, before and after the change. This is the default. * "NEW_IMAGE" - the version of the row after the change. * "OLD_IMAGE" - the version of the row before the change. * "KEYS_ONLY" - the partition and clustering keys of the row that was changed. * **tags** *(list) --* The tags (key-value pairs) that you want to apply to the stream. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* **[REQUIRED]** The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* **[REQUIRED]** The value of the tag. Tag values are case-sensitive and can be null. * **propagateTags** *(string) --* Specifies that the stream inherits the tags from the table. Return type: dict Returns: **Response Syntax** { 'resourceArn': 'string' } **Response Structure** * *(dict) --* * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the modified table. **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / can_paginate can_paginate ************ Keyspaces.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Keyspaces / Client / get_table_auto_scaling_settings get_table_auto_scaling_settings ******************************* Keyspaces.Client.get_table_auto_scaling_settings(**kwargs) Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the *Amazon Keyspaces Developer Guide*. Warning: "GetTableAutoScalingSettings" can't be used as an action in an IAM policy. To define permissions for "GetTableAutoScalingSettings", you must allow the following two actions in the IAM policy statement's "Action" element: * "application-autoscaling:DescribeScalableTargets" * "application-autoscaling:DescribeScalingPolicies" See also: AWS API Documentation **Request Syntax** response = client.get_table_auto_scaling_settings( keyspaceName='string', tableName='string' ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace. * **tableName** (*string*) -- **[REQUIRED]** The name of the table. Return type: dict Returns: **Response Syntax** { 'keyspaceName': 'string', 'tableName': 'string', 'resourceArn': 'string', 'autoScalingSpecification': { 'writeCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } }, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } }, 'replicaSpecifications': [ { 'region': 'string', 'autoScalingSpecification': { 'writeCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } }, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } } }, ] } **Response Structure** * *(dict) --* * **keyspaceName** *(string) --* The name of the keyspace. * **tableName** *(string) --* The name of the table. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the table. * **autoScalingSpecification** *(dict) --* The auto scaling settings of the table. * **writeCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's write capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **readCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's read capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **replicaSpecifications** *(list) --* The Amazon Web Services Region specific settings of a multi- Region table. Returns the settings for all Regions the table is replicated in. * *(dict) --* The auto scaling settings of a multi-Region table in the specified Amazon Web Services Region. * **region** *(string) --* The Amazon Web Services Region. * **autoScalingSpecification** *(dict) --* The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region. * **writeCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's write capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **readCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's read capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / delete_type delete_type *********** Keyspaces.Client.delete_type(**kwargs) The "DeleteType" operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT. To configure the required permissions, see Permissions to delete a UDT in the *Amazon Keyspaces Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_type( keyspaceName='string', typeName='string' ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace of the to be deleted type. * **typeName** (*string*) -- **[REQUIRED]** The name of the type to be deleted. Return type: dict Returns: **Response Syntax** { 'keyspaceArn': 'string', 'typeName': 'string' } **Response Structure** * *(dict) --* * **keyspaceArn** *(string) --* The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN). * **typeName** *(string) --* The name of the type that was deleted. **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / list_types list_types ********** Keyspaces.Client.list_types(**kwargs) The "ListTypes" operation returns a list of types for a specified keyspace. To read keyspace metadata using "ListTypes", the IAM principal needs "Select" action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the *Amazon Keyspaces Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_types( nextToken='string', maxResults=123, keyspaceName='string' ) Parameters: * **nextToken** (*string*) -- The pagination token. To resume pagination, provide the "NextToken" value as an argument of a subsequent API invocation. * **maxResults** (*integer*) -- The total number of types to return in the output. If the total number of types available is more than the value specified, a "NextToken" is provided in the output. To resume pagination, provide the "NextToken" value as an argument of a subsequent API invocation. * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace that contains the listed types. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'types': [ 'string', ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. To resume pagination, provide the "NextToken" value as an argument of a subsequent API invocation. * **types** *(list) --* The list of types contained in the specified keyspace. * *(string) --* **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / get_type get_type ******** Keyspaces.Client.get_type(**kwargs) The "GetType" operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables. To read keyspace metadata using "GetType", the IAM principal needs "Select" action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the *Amazon Keyspaces Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_type( keyspaceName='string', typeName='string' ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace that contains this type. * **typeName** (*string*) -- **[REQUIRED]** The formatted name of the type. For example, if the name of the type was created without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was created in double quotes, you must use double quotes to specify the type name. Return type: dict Returns: **Response Syntax** { 'keyspaceName': 'string', 'typeName': 'string', 'fieldDefinitions': [ { 'name': 'string', 'type': 'string' }, ], 'lastModifiedTimestamp': datetime(2015, 1, 1), 'status': 'ACTIVE'|'CREATING'|'DELETING'|'RESTORING', 'directReferringTables': [ 'string', ], 'directParentTypes': [ 'string', ], 'maxNestingDepth': 123, 'keyspaceArn': 'string' } **Response Structure** * *(dict) --* * **keyspaceName** *(string) --* The name of the keyspace that contains this type. * **typeName** *(string) --* The name of the type. * **fieldDefinitions** *(list) --* The names and types that define this type. * *(dict) --* A field definition consists out of a name and a type. * **name** *(string) --* The identifier. * **type** *(string) --* Any supported Cassandra data type, including collections and other user-defined types that are contained in the same keyspace. For more information, see Cassandra data type support in the *Amazon Keyspaces Developer Guide*. * **lastModifiedTimestamp** *(datetime) --* The timestamp that shows when this type was last modified. * **status** *(string) --* The status of this type. * **directReferringTables** *(list) --* The tables that use this type. * *(string) --* * **directParentTypes** *(list) --* The types that use this type. * *(string) --* * **maxNestingDepth** *(integer) --* The level of nesting implemented for this type. * **keyspaceArn** *(string) --* The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN). **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / get_table get_table ********* Keyspaces.Client.get_table(**kwargs) Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata. To read table metadata using "GetTable", the IAM principal needs "Select" action permissions for the table and the system keyspace. See also: AWS API Documentation **Request Syntax** response = client.get_table( keyspaceName='string', tableName='string' ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace that the table is stored in. * **tableName** (*string*) -- **[REQUIRED]** The name of the table. Return type: dict Returns: **Response Syntax** { 'keyspaceName': 'string', 'tableName': 'string', 'resourceArn': 'string', 'creationTimestamp': datetime(2015, 1, 1), 'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'DELETED'|'RESTORING'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS', 'schemaDefinition': { 'allColumns': [ { 'name': 'string', 'type': 'string' }, ], 'partitionKeys': [ { 'name': 'string' }, ], 'clusteringKeys': [ { 'name': 'string', 'orderBy': 'ASC'|'DESC' }, ], 'staticColumns': [ { 'name': 'string' }, ] }, 'capacitySpecification': { 'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED', 'readCapacityUnits': 123, 'writeCapacityUnits': 123, 'lastUpdateToPayPerRequestTimestamp': datetime(2015, 1, 1) }, 'encryptionSpecification': { 'type': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY', 'kmsKeyIdentifier': 'string' }, 'pointInTimeRecovery': { 'status': 'ENABLED'|'DISABLED', 'earliestRestorableTimestamp': datetime(2015, 1, 1) }, 'ttl': { 'status': 'ENABLED' }, 'defaultTimeToLive': 123, 'comment': { 'message': 'string' }, 'clientSideTimestamps': { 'status': 'ENABLED' }, 'replicaSpecifications': [ { 'region': 'string', 'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'DELETED'|'RESTORING'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS', 'capacitySpecification': { 'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED', 'readCapacityUnits': 123, 'writeCapacityUnits': 123, 'lastUpdateToPayPerRequestTimestamp': datetime(2015, 1, 1) } }, ], 'latestStreamArn': 'string', 'cdcSpecification': { 'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING', 'viewType': 'NEW_IMAGE'|'OLD_IMAGE'|'KEYS_ONLY'|'NEW_AND_OLD_IMAGES' } } **Response Structure** * *(dict) --* * **keyspaceName** *(string) --* The name of the keyspace that the specified table is stored in. * **tableName** *(string) --* The name of the specified table. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the specified table. * **creationTimestamp** *(datetime) --* The creation timestamp of the specified table. * **status** *(string) --* The current status of the specified table. * **schemaDefinition** *(dict) --* The schema definition of the specified table. * **allColumns** *(list) --* The regular columns of the table. * *(dict) --* The names and data types of regular columns. * **name** *(string) --* The name of the column. * **type** *(string) --* The data type of the column. For a list of available data types, see Data types in the *Amazon Keyspaces Developer Guide*. * **partitionKeys** *(list) --* The columns that are part of the partition key of the table . * *(dict) --* The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns. * **name** *(string) --* The name(s) of the partition key column(s). * **clusteringKeys** *(list) --* The columns that are part of the clustering key of the table. * *(dict) --* The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition. * **name** *(string) --* The name(s) of the clustering column(s). * **orderBy** *(string) --* Sets the ascendant ( "ASC") or descendant ( "DESC") order modifier. * **staticColumns** *(list) --* The columns that have been defined as "STATIC". Static columns store values that are shared by all rows in the same partition. * *(dict) --* The static columns of the table. Static columns store values that are shared by all rows in the same partition. * **name** *(string) --* The name of the static column. * **capacitySpecification** *(dict) --* The read/write throughput capacity mode for a table. The options are: * "throughputMode:PAY_PER_REQUEST" * "throughputMode:PROVISIONED" * **throughputMode** *(string) --* The read/write throughput capacity mode for a table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **readCapacityUnits** *(integer) --* The throughput capacity specified for "read" operations defined in "read capacity units" "(RCUs)". * **writeCapacityUnits** *(integer) --* The throughput capacity specified for "write" operations defined in "write capacity units" "(WCUs)". * **lastUpdateToPayPerRequestTimestamp** *(datetime) --* The timestamp of the last operation that changed the provisioned throughput capacity of a table. * **encryptionSpecification** *(dict) --* The encryption settings of the specified table. * **type** *(string) --* The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys): * "type:AWS_OWNED_KMS_KEY" - This key is owned by Amazon Keyspaces. * "type:CUSTOMER_MANAGED_KMS_KEY" - This key is stored in your account and is created, owned, and managed by you. This option requires the "kms_key_identifier" of the KMS key in Amazon Resource Name (ARN) format as input. The default is "type:AWS_OWNED_KMS_KEY". For more information, see Encryption at rest in the *Amazon Keyspaces Developer Guide*. * **kmsKeyIdentifier** *(string) --* The Amazon Resource Name (ARN) of the customer managed KMS key, for example "kms_key_identifier:ARN". * **pointInTimeRecovery** *(dict) --* The point-in-time recovery status of the specified table. * **status** *(string) --* Shows if point-in-time recovery is enabled or disabled for the specified table. * **earliestRestorableTimestamp** *(datetime) --* Specifies the earliest possible restore point of the table in ISO 8601 format. * **ttl** *(dict) --* The custom Time to Live settings of the specified table. * **status** *(string) --* Shows how to enable custom Time to Live (TTL) settings for the specified table. * **defaultTimeToLive** *(integer) --* The default Time to Live settings in seconds of the specified table. * **comment** *(dict) --* The the description of the specified table. * **message** *(string) --* An optional description of the table. * **clientSideTimestamps** *(dict) --* The client-side timestamps setting of the table. * **status** *(string) --* Shows how to enable client-side timestamps settings for the specified table. * **replicaSpecifications** *(list) --* Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in. * *(dict) --* The Region-specific settings of a multi-Region table in the specified Amazon Web Services Region. If the multi-Region table is using provisioned capacity and has optional auto scaling policies configured, note that the Region specific summary returns both read and write capacity settings. But only Region specific read capacity settings can be configured for a multi-Region table. In a multi-Region table, your write capacity units will be synced across all Amazon Web Services Regions to ensure that there is enough capacity to replicate write events across Regions. * **region** *(string) --* The Amazon Web Services Region. * **status** *(string) --* The status of the multi-Region table in the specified Amazon Web Services Region. * **capacitySpecification** *(dict) --* The read/write throughput capacity mode for a table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **throughputMode** *(string) --* The read/write throughput capacity mode for a table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **readCapacityUnits** *(integer) --* The throughput capacity specified for "read" operations defined in "read capacity units" "(RCUs)". * **writeCapacityUnits** *(integer) --* The throughput capacity specified for "write" operations defined in "write capacity units" "(WCUs)". * **lastUpdateToPayPerRequestTimestamp** *(datetime) --* The timestamp of the last operation that changed the provisioned throughput capacity of a table. * **latestStreamArn** *(string) --* The Amazon Resource Name (ARN) of the stream. * **cdcSpecification** *(dict) --* The CDC stream settings of the table. * **status** *(string) --* The status of the CDC stream. Specifies if the table has a CDC stream. * **viewType** *(string) --* The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. This setting can't be changed, after the stream has been created. The options are: * "NEW_AND_OLD_IMAGES" - both versions of the row, before and after the change. This is the default. * "NEW_IMAGE" - the version of the row after the change. * "OLD_IMAGE" - the version of the row before the change. * "KEYS_ONLY" - the partition and clustering keys of the row that was changed. **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / list_tags_for_resource list_tags_for_resource ********************** Keyspaces.Client.list_tags_for_resource(**kwargs) Returns a list of all tags associated with the specified Amazon Keyspaces resource. To read keyspace metadata using "ListTagsForResource", the IAM principal needs "Select" action permissions for the specified resource and the system keyspace. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string', nextToken='string', maxResults=123 ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Keyspaces resource. * **nextToken** (*string*) -- The pagination token. To resume pagination, provide the "NextToken" value as argument of a subsequent API invocation. * **maxResults** (*integer*) -- The total number of tags to return in the output. If the total number of tags available is more than the value specified, a "NextToken" is provided in the output. To resume pagination, provide the "NextToken" value as an argument of a subsequent API invocation. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'tags': [ { 'key': 'string', 'value': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previously truncated response. * **tags** *(list) --* A list of tags. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* The value of the tag. Tag values are case-sensitive and can be null. **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / untag_resource untag_resource ************** Keyspaces.Client.untag_resource(**kwargs) Removes the association of tags from a Amazon Keyspaces resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN). * **tags** (*list*) -- **[REQUIRED]** A list of existing tags to be removed from the Amazon Keyspaces resource. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* **[REQUIRED]** The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* **[REQUIRED]** The value of the tag. Tag values are case-sensitive and can be null. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / restore_table restore_table ************* Keyspaces.Client.restore_table(**kwargs) Restores the table to the specified point in time within the "earliest_restorable_timestamp" and the current time. For more information about restore points, see Time window for PITR continuous backups in the *Amazon Keyspaces Developer Guide*. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp "(day:hour:minute:second)" to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp. In addition to the table's schema, data, and TTL settings, "RestoreTable" restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted. You can also overwrite these settings during restore: * Read/write capacity mode * Provisioned throughput capacity units * Auto scaling settings * Point-in-time (PITR) settings * Tags For more information, see PITR restore settings in the *Amazon Keyspaces Developer Guide*. Note that the following settings are not restored, and you must configure them manually for the new table: * Identity and Access Management (IAM) policies * Amazon CloudWatch metrics and alarms See also: AWS API Documentation **Request Syntax** response = client.restore_table( sourceKeyspaceName='string', sourceTableName='string', targetKeyspaceName='string', targetTableName='string', restoreTimestamp=datetime(2015, 1, 1), capacitySpecificationOverride={ 'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED', 'readCapacityUnits': 123, 'writeCapacityUnits': 123 }, encryptionSpecificationOverride={ 'type': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY', 'kmsKeyIdentifier': 'string' }, pointInTimeRecoveryOverride={ 'status': 'ENABLED'|'DISABLED' }, tagsOverride=[ { 'key': 'string', 'value': 'string' }, ], autoScalingSpecification={ 'writeCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } }, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } }, replicaSpecifications=[ { 'region': 'string', 'readCapacityUnits': 123, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } }, ] ) Parameters: * **sourceKeyspaceName** (*string*) -- **[REQUIRED]** The keyspace name of the source table. * **sourceTableName** (*string*) -- **[REQUIRED]** The name of the source table. * **targetKeyspaceName** (*string*) -- **[REQUIRED]** The name of the target keyspace. * **targetTableName** (*string*) -- **[REQUIRED]** The name of the target table. * **restoreTimestamp** (*datetime*) -- The restore timestamp in ISO 8601 format. * **capacitySpecificationOverride** (*dict*) -- Specifies the read/write throughput capacity mode for the target table. The options are: * "throughputMode:PAY_PER_REQUEST" * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **throughputMode** *(string) --* **[REQUIRED]** The read/write throughput capacity mode for a table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **readCapacityUnits** *(integer) --* The throughput capacity specified for "read" operations defined in "read capacity units" "(RCUs)". * **writeCapacityUnits** *(integer) --* The throughput capacity specified for "write" operations defined in "write capacity units" "(WCUs)". * **encryptionSpecificationOverride** (*dict*) -- Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key): * "type:AWS_OWNED_KMS_KEY" - This key is owned by Amazon Keyspaces. * "type:CUSTOMER_MANAGED_KMS_KEY" - This key is stored in your account and is created, owned, and managed by you. This option requires the "kms_key_identifier" of the KMS key in Amazon Resource Name (ARN) format as input. The default is "type:AWS_OWNED_KMS_KEY". For more information, see Encryption at rest in the *Amazon Keyspaces Developer Guide*. * **type** *(string) --* **[REQUIRED]** The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys): * "type:AWS_OWNED_KMS_KEY" - This key is owned by Amazon Keyspaces. * "type:CUSTOMER_MANAGED_KMS_KEY" - This key is stored in your account and is created, owned, and managed by you. This option requires the "kms_key_identifier" of the KMS key in Amazon Resource Name (ARN) format as input. The default is "type:AWS_OWNED_KMS_KEY". For more information, see Encryption at rest in the *Amazon Keyspaces Developer Guide*. * **kmsKeyIdentifier** *(string) --* The Amazon Resource Name (ARN) of the customer managed KMS key, for example "kms_key_identifier:ARN". * **pointInTimeRecoveryOverride** (*dict*) -- Specifies the "pointInTimeRecovery" settings for the target table. The options are: * "status=ENABLED" * "status=DISABLED" If it's not specified, the default is "status=DISABLED". For more information, see Point-in-time recovery in the *Amazon Keyspaces Developer Guide*. * **status** *(string) --* **[REQUIRED]** The options are: * "status=ENABLED" * "status=DISABLED" * **tagsOverride** (*list*) -- A list of key-value pair tags to be attached to the restored table. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* **[REQUIRED]** The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* **[REQUIRED]** The value of the tag. Tag values are case-sensitive and can be null. * **autoScalingSpecification** (*dict*) -- The optional auto scaling settings for the restored table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the *Amazon Keyspaces Developer Guide*. * **writeCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's write capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **readCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's read capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **replicaSpecifications** (*list*) -- The optional Region specific settings of a multi-Regional table. * *(dict) --* The Amazon Web Services Region specific settings of a multi- Region table. For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters. * "region": The Region where these settings are applied. (Required) * "readCapacityUnits": The provisioned read capacity units. (Optional) * "readCapacityAutoScaling": The read capacity auto scaling settings for the table. (Optional) * **region** *(string) --* **[REQUIRED]** The Amazon Web Services Region. * **readCapacityUnits** *(integer) --* The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region. * **readCapacityAutoScaling** *(dict) --* The read capacity auto scaling settings for the multi- Region table in the specified Amazon Web Services Region. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. Return type: dict Returns: **Response Syntax** { 'restoredTableARN': 'string' } **Response Structure** * *(dict) --* * **restoredTableARN** *(string) --* The Amazon Resource Name (ARN) of the restored table. **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / get_waiter get_waiter ********** Keyspaces.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Keyspaces / Client / create_table create_table ************ Keyspaces.Client.create_table(**kwargs) The "CreateTable" operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique. "CreateTable" is an asynchronous operation. When the request is received, the status of the table is set to "CREATING". You can monitor the creation status of the new table by using the "GetTable" operation, which returns the current "status" of the table. You can start using a table when the status is "ACTIVE". For more information, see Create a table in the *Amazon Keyspaces Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_table( keyspaceName='string', tableName='string', schemaDefinition={ 'allColumns': [ { 'name': 'string', 'type': 'string' }, ], 'partitionKeys': [ { 'name': 'string' }, ], 'clusteringKeys': [ { 'name': 'string', 'orderBy': 'ASC'|'DESC' }, ], 'staticColumns': [ { 'name': 'string' }, ] }, comment={ 'message': 'string' }, capacitySpecification={ 'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED', 'readCapacityUnits': 123, 'writeCapacityUnits': 123 }, encryptionSpecification={ 'type': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY', 'kmsKeyIdentifier': 'string' }, pointInTimeRecovery={ 'status': 'ENABLED'|'DISABLED' }, ttl={ 'status': 'ENABLED' }, defaultTimeToLive=123, tags=[ { 'key': 'string', 'value': 'string' }, ], clientSideTimestamps={ 'status': 'ENABLED' }, autoScalingSpecification={ 'writeCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } }, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } }, replicaSpecifications=[ { 'region': 'string', 'readCapacityUnits': 123, 'readCapacityAutoScaling': { 'autoScalingDisabled': True|False, 'minimumUnits': 123, 'maximumUnits': 123, 'scalingPolicy': { 'targetTrackingScalingPolicyConfiguration': { 'disableScaleIn': True|False, 'scaleInCooldown': 123, 'scaleOutCooldown': 123, 'targetValue': 123.0 } } } }, ], cdcSpecification={ 'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING', 'viewType': 'NEW_IMAGE'|'OLD_IMAGE'|'KEYS_ONLY'|'NEW_AND_OLD_IMAGES', 'tags': [ { 'key': 'string', 'value': 'string' }, ], 'propagateTags': 'TABLE'|'NONE' } ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace that the table is going to be created in. * **tableName** (*string*) -- **[REQUIRED]** The name of the table. * **schemaDefinition** (*dict*) -- **[REQUIRED]** The "schemaDefinition" consists of the following parameters. For each column to be created: * "name" - The name of the column. * "type" - An Amazon Keyspaces data type. For more information, see Data types in the *Amazon Keyspaces Developer Guide*. The primary key of the table consists of the following columns: * "partitionKeys" - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data. * "name" - The name of each partition key column. * "clusteringKeys" - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition. * "name" - The name of the clustering column. * "orderBy" - Sets the ascendant ( "ASC") or descendant ( "DESC") order modifier. To define a column as static use "staticColumns" - Static columns store values that are shared by all rows in the same partition: * "name" - The name of the column. * "type" - An Amazon Keyspaces data type. * **allColumns** *(list) --* **[REQUIRED]** The regular columns of the table. * *(dict) --* The names and data types of regular columns. * **name** *(string) --* **[REQUIRED]** The name of the column. * **type** *(string) --* **[REQUIRED]** The data type of the column. For a list of available data types, see Data types in the *Amazon Keyspaces Developer Guide*. * **partitionKeys** *(list) --* **[REQUIRED]** The columns that are part of the partition key of the table . * *(dict) --* The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns. * **name** *(string) --* **[REQUIRED]** The name(s) of the partition key column(s). * **clusteringKeys** *(list) --* The columns that are part of the clustering key of the table. * *(dict) --* The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition. * **name** *(string) --* **[REQUIRED]** The name(s) of the clustering column(s). * **orderBy** *(string) --* **[REQUIRED]** Sets the ascendant ( "ASC") or descendant ( "DESC") order modifier. * **staticColumns** *(list) --* The columns that have been defined as "STATIC". Static columns store values that are shared by all rows in the same partition. * *(dict) --* The static columns of the table. Static columns store values that are shared by all rows in the same partition. * **name** *(string) --* **[REQUIRED]** The name of the static column. * **comment** (*dict*) -- This parameter allows to enter a description of the table. * **message** *(string) --* **[REQUIRED]** An optional description of the table. * **capacitySpecification** (*dict*) -- Specifies the read/write throughput capacity mode for the table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **throughputMode** *(string) --* **[REQUIRED]** The read/write throughput capacity mode for a table. The options are: * "throughputMode:PAY_PER_REQUEST" and * "throughputMode:PROVISIONED" - Provisioned capacity mode requires "readCapacityUnits" and "writeCapacityUnits" as input. The default is "throughput_mode:PAY_PER_REQUEST". For more information, see Read/write capacity modes in the *Amazon Keyspaces Developer Guide*. * **readCapacityUnits** *(integer) --* The throughput capacity specified for "read" operations defined in "read capacity units" "(RCUs)". * **writeCapacityUnits** *(integer) --* The throughput capacity specified for "write" operations defined in "write capacity units" "(WCUs)". * **encryptionSpecification** (*dict*) -- Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key): * "type:AWS_OWNED_KMS_KEY" - This key is owned by Amazon Keyspaces. * "type:CUSTOMER_MANAGED_KMS_KEY" - This key is stored in your account and is created, owned, and managed by you. This option requires the "kms_key_identifier" of the KMS key in Amazon Resource Name (ARN) format as input. The default is "type:AWS_OWNED_KMS_KEY". For more information, see Encryption at rest in the *Amazon Keyspaces Developer Guide*. * **type** *(string) --* **[REQUIRED]** The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys): * "type:AWS_OWNED_KMS_KEY" - This key is owned by Amazon Keyspaces. * "type:CUSTOMER_MANAGED_KMS_KEY" - This key is stored in your account and is created, owned, and managed by you. This option requires the "kms_key_identifier" of the KMS key in Amazon Resource Name (ARN) format as input. The default is "type:AWS_OWNED_KMS_KEY". For more information, see Encryption at rest in the *Amazon Keyspaces Developer Guide*. * **kmsKeyIdentifier** *(string) --* The Amazon Resource Name (ARN) of the customer managed KMS key, for example "kms_key_identifier:ARN". * **pointInTimeRecovery** (*dict*) -- Specifies if "pointInTimeRecovery" is enabled or disabled for the table. The options are: * "status=ENABLED" * "status=DISABLED" If it's not specified, the default is "status=DISABLED". For more information, see Point-in-time recovery in the *Amazon Keyspaces Developer Guide*. * **status** *(string) --* **[REQUIRED]** The options are: * "status=ENABLED" * "status=DISABLED" * **ttl** (*dict*) -- Enables Time to Live custom settings for the table. The options are: * "status:enabled" * "status:disabled" The default is "status:disabled". After "ttl" is enabled, you can't disable it for the table. For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the *Amazon Keyspaces Developer Guide*. * **status** *(string) --* **[REQUIRED]** Shows how to enable custom Time to Live (TTL) settings for the specified table. * **defaultTimeToLive** (*integer*) -- The default Time to Live setting in seconds for the table. For more information, see Setting the default TTL value for a table in the *Amazon Keyspaces Developer Guide*. * **tags** (*list*) -- A list of key-value pair tags to be attached to the resource. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* **[REQUIRED]** The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* **[REQUIRED]** The value of the tag. Tag values are case-sensitive and can be null. * **clientSideTimestamps** (*dict*) -- Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option: * "status: "enabled"" Once client-side timestamps are enabled for a table, this setting cannot be disabled. * **status** *(string) --* **[REQUIRED]** Shows how to enable client-side timestamps settings for the specified table. * **autoScalingSpecification** (*dict*) -- The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity automatically on your behalf. Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the *Amazon Keyspaces Developer Guide*. By default, auto scaling is disabled for a table. * **writeCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's write capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **readCapacityAutoScaling** *(dict) --* The auto scaling settings for the table's read capacity. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **replicaSpecifications** (*list*) -- The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region. For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so by configuring the following parameters. * "region": The Region where these settings are applied. (Required) * "readCapacityUnits": The provisioned read capacity units. (Optional) * "readCapacityAutoScaling": The read capacity auto scaling settings for the table. (Optional) * *(dict) --* The Amazon Web Services Region specific settings of a multi- Region table. For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters. * "region": The Region where these settings are applied. (Required) * "readCapacityUnits": The provisioned read capacity units. (Optional) * "readCapacityAutoScaling": The read capacity auto scaling settings for the table. (Optional) * **region** *(string) --* **[REQUIRED]** The Amazon Web Services Region. * **readCapacityUnits** *(integer) --* The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region. * **readCapacityAutoScaling** *(dict) --* The read capacity auto scaling settings for the multi- Region table in the specified Amazon Web Services Region. * **autoScalingDisabled** *(boolean) --* This optional parameter enables auto scaling for the table if set to "false". * **minimumUnits** *(integer) --* The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **maximumUnits** *(integer) --* Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default). * **scalingPolicy** *(dict) --* Amazon Keyspaces supports the "target tracking" auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90. * **targetTrackingScalingPolicyConfiguration** *(dict) --* Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A "double" between 20 and 90. * **disableScaleIn** *(boolean) --* Specifies if "scale-in" is enabled. When auto scaling automatically decreases capacity for a table, the table *scales in*. When scaling policies are set, they can't scale in the table lower than its minimum capacity. * **scaleInCooldown** *(integer) --* Specifies a "scale-in" cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **scaleOutCooldown** *(integer) --* Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. * **targetValue** *(float) --* **[REQUIRED]** Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define "targetValue" as a percentage. A "double" between 20 and 90. * **cdcSpecification** (*dict*) -- The CDC stream settings of the table. * **status** *(string) --* **[REQUIRED]** The status of the CDC stream. You can enable or disable a stream for a table. * **viewType** *(string) --* The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection. The options are: * "NEW_AND_OLD_IMAGES" - both versions of the row, before and after the change. This is the default. * "NEW_IMAGE" - the version of the row after the change. * "OLD_IMAGE" - the version of the row before the change. * "KEYS_ONLY" - the partition and clustering keys of the row that was changed. * **tags** *(list) --* The tags (key-value pairs) that you want to apply to the stream. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* **[REQUIRED]** The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* **[REQUIRED]** The value of the tag. Tag values are case-sensitive and can be null. * **propagateTags** *(string) --* Specifies that the stream inherits the tags from the table. Return type: dict Returns: **Response Syntax** { 'resourceArn': 'string' } **Response Structure** * *(dict) --* * **resourceArn** *(string) --* The unique identifier of the table in the format of an Amazon Resource Name (ARN). **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / delete_keyspace delete_keyspace *************** Keyspaces.Client.delete_keyspace(**kwargs) The "DeleteKeyspace" operation deletes a keyspace and all of its tables. See also: AWS API Documentation **Request Syntax** response = client.delete_keyspace( keyspaceName='string' ) Parameters: **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / delete_table delete_table ************ Keyspaces.Client.delete_table(**kwargs) The "DeleteTable" operation deletes a table and all of its data. After a "DeleteTable" request is received, the specified table is in the "DELETING" state until Amazon Keyspaces completes the deletion. If the table is in the "ACTIVE" state, you can delete it. If a table is either in the "CREATING" or "UPDATING" states, then Amazon Keyspaces returns a "ResourceInUseException". If the specified table does not exist, Amazon Keyspaces returns a "ResourceNotFoundException". If the table is already in the "DELETING" state, no error is returned. See also: AWS API Documentation **Request Syntax** response = client.delete_table( keyspaceName='string', tableName='string' ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace of the to be deleted table. * **tableName** (*string*) -- **[REQUIRED]** The name of the table to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / close close ***** Keyspaces.Client.close() Closes underlying endpoint connections. Keyspaces / Client / update_keyspace update_keyspace *************** Keyspaces.Client.update_keyspace(**kwargs) 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. 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: * "cassandra:Alter" * "cassandra:AlterMultiRegionResource" * "cassandra:Create" * "cassandra:CreateMultiRegionResource" * "cassandra:Select" * "cassandra:SelectMultiRegionResource" * "cassandra:Modify" * "cassandra:ModifyMultiRegionResource" 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. * "application-autoscaling:RegisterScalableTarget" * "application-autoscaling:DeregisterScalableTarget" * "application-autoscaling:DescribeScalableTargets" * "application-autoscaling:PutScalingPolicy" * "application-autoscaling:DescribeScalingPolicies" To use the "UpdateKeyspace" API, the IAM principal also needs permissions to create a service-linked role with the following elements: * "iam:CreateServiceLinkedRole" - The **action** the principal can perform. * "arn:aws:iam::*:role/aws-service-role/replication.cassandra.amaz onaws.com/AWSServiceRoleForKeyspacesReplication" - The **resource** that the action can be performed on. * "iam:AWSServiceName: replication.cassandra.amazonaws.com" - The only Amazon Web Services service that this role can be attached to is Amazon Keyspaces. 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*. See also: AWS API Documentation **Request Syntax** response = client.update_keyspace( keyspaceName='string', replicationSpecification={ 'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION', 'regionList': [ 'string', ] }, clientSideTimestamps={ 'status': 'ENABLED' } ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace. * **replicationSpecification** (*dict*) -- **[REQUIRED]** The replication specification of the keyspace includes: * "regionList" - the Amazon Web Services Regions where the keyspace is replicated in. * "replicationStrategy" - the required value is "SINGLE_REGION" or "MULTI_REGION". * **replicationStrategy** *(string) --* **[REQUIRED]** The "replicationStrategy" of a keyspace, the required value is "SINGLE_REGION" or "MULTI_REGION". * **regionList** *(list) --* The "regionList" contains the Amazon Web Services Regions where the keyspace is replicated in. * *(string) --* * **clientSideTimestamps** (*dict*) -- The client-side timestamp setting of the table. For more information, see How it works: Amazon Keyspaces client-side timestamps in the *Amazon Keyspaces Developer Guide*. * **status** *(string) --* **[REQUIRED]** Shows how to enable client-side timestamps settings for the specified table. Return type: dict Returns: **Response Syntax** { 'resourceArn': 'string' } **Response Structure** * *(dict) --* * **resourceArn** *(string) --* The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN). **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / list_tables list_tables *********** Keyspaces.Client.list_tables(**kwargs) The "ListTables" operation returns a list of tables for a specified keyspace. To read keyspace metadata using "ListTables", the IAM principal needs "Select" action permissions for the system keyspace. See also: AWS API Documentation **Request Syntax** response = client.list_tables( nextToken='string', maxResults=123, keyspaceName='string' ) Parameters: * **nextToken** (*string*) -- The pagination token. To resume pagination, provide the "NextToken" value as an argument of a subsequent API invocation. * **maxResults** (*integer*) -- The total number of tables to return in the output. If the total number of tables available is more than the value specified, a "NextToken" is provided in the output. To resume pagination, provide the "NextToken" value as an argument of a subsequent API invocation. * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'tables': [ { 'keyspaceName': 'string', 'tableName': 'string', 'resourceArn': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previously truncated response. * **tables** *(list) --* A list of tables. * *(dict) --* Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN). * **keyspaceName** *(string) --* The name of the keyspace that the table is stored in. * **tableName** *(string) --* The name of the table. * **resourceArn** *(string) --* The unique identifier of the table in the format of an Amazon Resource Name (ARN). **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / tag_resource tag_resource ************ Keyspaces.Client.tag_resource(**kwargs) Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the *Amazon Keyspaces Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags. * **tags** (*list*) -- **[REQUIRED]** The tags to be assigned to the Amazon Keyspaces resource. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* **[REQUIRED]** The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* **[REQUIRED]** The value of the tag. Tag values are case-sensitive and can be null. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException" Keyspaces / Client / create_keyspace create_keyspace *************** Keyspaces.Client.create_keyspace(**kwargs) The "CreateKeyspace" operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region. "CreateKeyspace" is an asynchronous operation. You can monitor the creation status of the new keyspace by using the "GetKeyspace" operation. For more information, see Create a keyspace in the *Amazon Keyspaces Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_keyspace( keyspaceName='string', tags=[ { 'key': 'string', 'value': 'string' }, ], replicationSpecification={ 'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION', 'regionList': [ 'string', ] } ) Parameters: * **keyspaceName** (*string*) -- **[REQUIRED]** The name of the keyspace to be created. * **tags** (*list*) -- A list of key-value pair tags to be attached to the keyspace. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * *(dict) --* Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the "aws:" prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix "user:" in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources in the *Amazon Keyspaces Developer Guide*. * **key** *(string) --* **[REQUIRED]** The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. * **value** *(string) --* **[REQUIRED]** The value of the tag. Tag values are case-sensitive and can be null. * **replicationSpecification** (*dict*) -- The replication specification of the keyspace includes: * "replicationStrategy" - the required value is "SINGLE_REGION" or "MULTI_REGION". * "regionList" - if the "replicationStrategy" is "MULTI_REGION", the "regionList" requires the current Region and at least one additional Amazon Web Services Region where the keyspace is going to be replicated in. * **replicationStrategy** *(string) --* **[REQUIRED]** The "replicationStrategy" of a keyspace, the required value is "SINGLE_REGION" or "MULTI_REGION". * **regionList** *(list) --* The "regionList" contains the Amazon Web Services Regions where the keyspace is replicated in. * *(string) --* Return type: dict Returns: **Response Syntax** { 'resourceArn': 'string' } **Response Structure** * *(dict) --* * **resourceArn** *(string) --* The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN). **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.ConflictException" * "Keyspaces.Client.exceptions.AccessDeniedException" Keyspaces / Client / list_keyspaces list_keyspaces ************** Keyspaces.Client.list_keyspaces(**kwargs) The "ListKeyspaces" operation returns a list of keyspaces. See also: AWS API Documentation **Request Syntax** response = client.list_keyspaces( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token. To resume pagination, provide the "NextToken" value as argument of a subsequent API invocation. * **maxResults** (*integer*) -- The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a "NextToken" is provided in the output. To resume pagination, provide the "NextToken" value as an argument of a subsequent API invocation. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'keyspaces': [ { 'keyspaceName': 'string', 'resourceArn': 'string', 'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION', 'replicationRegions': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previously truncated response. * **keyspaces** *(list) --* A list of keyspaces. * *(dict) --* Represents the properties of a keyspace. * **keyspaceName** *(string) --* The name of the keyspace. * **resourceArn** *(string) --* The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN). * **replicationStrategy** *(string) --* This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are "SINGLE_REGION" or "MULTI_REGION". * **replicationRegions** *(list) --* If the "replicationStrategy" of the keyspace is "MULTI_REGION", a list of replication Regions is returned. * *(string) --* **Exceptions** * "Keyspaces.Client.exceptions.ValidationException" * "Keyspaces.Client.exceptions.ServiceQuotaExceededException" * "Keyspaces.Client.exceptions.InternalServerException" * "Keyspaces.Client.exceptions.AccessDeniedException" * "Keyspaces.Client.exceptions.ResourceNotFoundException"