Amazon Keyspaces

2023/03/14 - Amazon Keyspaces - 3 updated api methods

Changes  Adding support for client-side timestamps

CreateTable (updated) Link ¶
Changes (request) 
{'clientSideTimestamps': {'status': 'ENABLED'}}

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

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'
    }
)
type keyspaceName:

string

param keyspaceName:

[REQUIRED]

The name of the keyspace that the table is going to be created in.

type tableName:

string

param tableName:

[REQUIRED]

The name of the table.

type schemaDefinition:

dict

param schemaDefinition:

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

type comment:

dict

param comment:

This parameter allows to enter a description of the table.

  • message (string) -- [REQUIRED]

    An optional description of the table.

type capacitySpecification:

dict

param capacitySpecification:

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

type encryptionSpecification:

dict

param encryptionSpecification:

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.

type pointInTimeRecovery:

dict

param pointInTimeRecovery:

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

type ttl:

dict

param ttl:

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.

type defaultTimeToLive:

integer

param defaultTimeToLive:

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.

type tags:

list

param tags:

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.

type clientSideTimestamps:

dict

param clientSideTimestamps:

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.

rtype:

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

GetTable (updated) Link ¶
Changes (response) 
{'clientSideTimestamps': {'status': 'ENABLED'}}

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

client.get_table(
    keyspaceName='string',
    tableName='string'
)
type keyspaceName:

string

param keyspaceName:

[REQUIRED]

The name of the keyspace that the table is stored in.

type tableName:

string

param tableName:

[REQUIRED]

The name of the table.

rtype:

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

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.

UpdateTable (updated) Link ¶
Changes (request) 
{'clientSideTimestamps': {'status': 'ENABLED'}}

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

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'
    }
)
type keyspaceName:

string

param keyspaceName:

[REQUIRED]

The name of the keyspace the specified table is stored in.

type tableName:

string

param tableName:

[REQUIRED]

The name of the table.

type addColumns:

list

param addColumns:

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.

type capacitySpecification:

dict

param capacitySpecification:

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

type encryptionSpecification:

dict

param encryptionSpecification:

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.

type pointInTimeRecovery:

dict

param pointInTimeRecovery:

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

type ttl:

dict

param ttl:

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.

type defaultTimeToLive:

integer

param defaultTimeToLive:

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.

type clientSideTimestamps:

dict

param clientSideTimestamps:

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.

rtype:

dict

returns:

Response Syntax

{
    'resourceArn': 'string'
}

Response Structure

  • (dict) --

    • resourceArn (string) --

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