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. 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 .

client = session.create_client('keyspaces')

These are the available methods:

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.
close()

Closes underlying endpoint connections.

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 Creating keyspaces in the Amazon Keyspaces Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_keyspace(
    keyspaceName='string',
    tags=[
        {
            'key': 'string',
            'value': '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.

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

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 Creating tables 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'
        },
    ]
)
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:

    • ENABLED
    • DISABLED

    If it's not specified, the default is DISABLED .

    For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide .

    • status (string) -- [REQUIRED]

      The options are:

      • ENABLED
      • 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.

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

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

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

get_keyspace(**kwargs)

Returns the name and the Amazon Resource Name (ARN) of the specified table.

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'
}

Response Structure

  • (dict) --
    • keyspaceName (string) --

      The name of the keyspace.

    • resourceArn (string) --

      The ARN of the keyspace.

Exceptions

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
L{botocore.paginate.Paginator}
Returns
A paginator object.
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 , Select action permissions for the table and system tables are required to complete the operation.

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'
    }
}

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 of the specified table.

    • comment (dict) --

      The the description of the specified table.

      • message (string) --

        An optional description of the table.

Exceptions

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
list_keyspaces(**kwargs)

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'
        },
    ]
}

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).

Exceptions

list_tables(**kwargs)

Returns a list of tables for a specified 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

list_tags_for_resource(**kwargs)

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

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

restore_table(**kwargs)

Restores the specified 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, encryption, 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 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:

  • Automatic scaling policies (for tables that use provisioned capacity mode)
  • 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'
        },
    ]
)
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:

    • ENABLED
    • DISABLED

    If it's not specified, the default is DISABLED .

    For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide .

    • status (string) -- [REQUIRED]

      The options are:

      • ENABLED
      • 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.

Return type

dict

Returns

Response Syntax

{
    'restoredTableARN': 'string'
}

Response Structure

  • (dict) --

    • restoredTableARN (string) --

      The Amazon Resource Name (ARN) of the restored table.

Exceptions

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

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

update_table(**kwargs)

Adds new columns to the table or updates one of the table's settings, for example capacity mode, 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
)
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:

    • ENABLED
    • DISABLED

    If it's not specified, the default is DISABLED .

    For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide .

    • status (string) -- [REQUIRED]

      The options are:

      • ENABLED
      • 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 .

Return type

dict

Returns

Response Syntax

{
    'resourceArn': 'string'
}

Response Structure

  • (dict) --

    • resourceArn (string) --

      The Amazon Resource Name (ARN) of the modified table.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class Keyspaces.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Keyspaces.Client.exceptions.ConflictException

Amazon Keyspaces could not complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Amazon Keyspaces could not complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Keyspaces.Client.exceptions.InternalServerException

Amazon Keyspaces was unable to fully process this request because of an internal server error.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Amazon Keyspaces was unable to fully process this request because of an internal server error.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Keyspaces.Client.exceptions.ResourceNotFoundException

The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE .

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceArn': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE .

    • message (string) --

    • resourceArn (string) --

      The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Keyspaces.Client.exceptions.ServiceQuotaExceededException

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide .

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide .

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Keyspaces.Client.exceptions.ValidationException

The operation failed due to an invalid or malformed request.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation failed due to an invalid or malformed request.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

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'
        },
    ],
    '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).

    • NextToken (string) --

      A token to resume pagination.

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.

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.