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.
", "operations": { "CreateKeyspace": "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.
", "CreateTable": "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.
", "DeleteKeyspace": "The DeleteKeyspace operation deletes a keyspace and all of its tables.
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.
Returns the name and the Amazon Resource Name (ARN) of the specified table.
", "GetTable": "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.
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.
", "ListKeyspaces": "Returns a list of keyspaces.
", "ListTables": "Returns a list of tables for a specified keyspace.
", "ListTagsForResource": "Returns a list of all tags associated with the specified Amazon Keyspaces resource.
", "RestoreTable": "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
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.
", "UntagResource": "Removes the association of tags from a Amazon Keyspaces resource.
", "UpdateTable": "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.
" }, "shapes": { "ARN": { "base": null, "refs": { "CreateKeyspaceResponse$resourceArn": "The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
", "CreateTableResponse$resourceArn": "The unique identifier of the table in the format of an Amazon Resource Name (ARN).
", "GetKeyspaceResponse$resourceArn": "Returns the ARN of the keyspace.
", "GetTableAutoScalingSettingsResponse$resourceArn": "The Amazon Resource Name (ARN) of the table.
", "GetTableResponse$resourceArn": "The Amazon Resource Name (ARN) of the specified table.
", "KeyspaceSummary$resourceArn": "The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
", "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
", "ResourceNotFoundException$resourceArn": "The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.
", "RestoreTableResponse$restoredTableARN": "The Amazon Resource Name (ARN) of the restored table.
", "TableSummary$resourceArn": "The unique identifier of the table in the format of an Amazon Resource Name (ARN).
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.
", "UntagResourceRequest$resourceArn": "The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
", "UpdateTableResponse$resourceArn": "The Amazon Resource Name (ARN) of the modified table.
" } }, "AccessDeniedException": { "base": "You don't have sufficient access permissions to perform this action.
", "refs": { } }, "AutoScalingPolicy": { "base": "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.
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.
The optional auto scaling settings for a table with provisioned throughput capacity.
To turn on auto scaling for a table in throughputMode:PROVISIONED, you must specify the following parameters.
Configure the minimum and maximum units for write and read capacity. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.
minimumUnits: 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: The maximum 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).
scalingPolicy: Amazon Keyspaces supports the target tracking scaling policy. The auto scaling target is the provisioned read and write capacity of the table.
targetTrackingScalingPolicyConfiguration: To define the target tracking policy, you must define the target value.
targetValue: The target utilization rate of the table. Amazon Keyspaces auto scaling 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. (Required)
disableScaleIn: A boolean that specifies if scale-in is disabled or enabled for the table. This parameter is disabled by default. To turn on scale-in, set the boolean value to FALSE. This means that capacity for a table can be automatically scaled down on your behalf. (Optional)
scaleInCooldown: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional)
scaleOutCooldown: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional)
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
", "refs": { "AutoScalingSpecification$writeCapacityAutoScaling": "The auto scaling settings for the table's write capacity.
", "AutoScalingSpecification$readCapacityAutoScaling": "The auto scaling settings for the table's read capacity.
", "ReplicaSpecification$readCapacityAutoScaling": "The read capacity auto scaling settings for the multi-Region table in the specified Amazon Web Services Region.
" } }, "AutoScalingSpecification": { "base": "The optional auto scaling settings for read and write capacity of a table in provisioned capacity mode.
", "refs": { "CreateTableRequest$autoScalingSpecification": "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.
", "GetTableAutoScalingSettingsResponse$autoScalingSpecification": "The auto scaling settings of the table.
", "ReplicaAutoScalingSpecification$autoScalingSpecification": "The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region.
", "RestoreTableRequest$autoScalingSpecification": "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.
", "UpdateTableRequest$autoScalingSpecification": "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.
" } }, "BooleanObject": { "base": null, "refs": { "AutoScalingSettings$autoScalingDisabled": "This optional parameter enables auto scaling for the table if set to false.
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.
" } }, "CapacitySpecification": { "base": "Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:
On-demand (default)
Provisioned
The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
", "refs": { "CreateTableRequest$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.
", "RestoreTableRequest$capacitySpecificationOverride": "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.
", "UpdateTableRequest$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.
" } }, "CapacitySpecificationSummary": { "base": "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.
", "refs": { "GetTableResponse$capacitySpecification": "The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST
throughputMode:PROVISIONED
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).
", "AutoScalingSettings$maximumUnits": "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).
", "CapacitySpecification$readCapacityUnits": "The throughput capacity specified for read operations defined in read capacity units (RCUs).
The throughput capacity specified for write operations defined in write capacity units (WCUs).
The throughput capacity specified for read operations defined in read capacity units (RCUs).
The throughput capacity specified for write operations defined in write capacity units (WCUs).
The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.
" } }, "ClientSideTimestamps": { "base": "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.
", "refs": { "CreateTableRequest$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.
", "GetTableResponse$clientSideTimestamps": "The client-side timestamps setting of the table.
", "UpdateTableRequest$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.
" } }, "ClientSideTimestampsStatus": { "base": null, "refs": { "ClientSideTimestamps$status": "Shows how to enable client-side timestamps settings for the specified table.
" } }, "ClusteringKey": { "base": "The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
", "refs": { "ClusteringKeyList$member": null } }, "ClusteringKeyList": { "base": null, "refs": { "SchemaDefinition$clusteringKeys": "The columns that are part of the clustering key of the table.
" } }, "ColumnDefinition": { "base": "The names and data types of regular columns.
", "refs": { "ColumnDefinitionList$member": null } }, "ColumnDefinitionList": { "base": null, "refs": { "SchemaDefinition$allColumns": "The regular columns of the table.
", "UpdateTableRequest$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.
An optional comment that describes the table.
", "refs": { "CreateTableRequest$comment": "This parameter allows to enter a description of the table.
", "GetTableResponse$comment": "The the description of the specified table.
" } }, "ConflictException": { "base": "Amazon Keyspaces couldn't 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.
", "refs": { } }, "CreateKeyspaceRequest": { "base": null, "refs": { } }, "CreateKeyspaceResponse": { "base": null, "refs": { } }, "CreateTableRequest": { "base": null, "refs": { } }, "CreateTableResponse": { "base": null, "refs": { } }, "DefaultTimeToLive": { "base": null, "refs": { "CreateTableRequest$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.
", "GetTableResponse$defaultTimeToLive": "The default Time to Live settings in seconds of the specified table.
", "UpdateTableRequest$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.
" } }, "DeleteKeyspaceRequest": { "base": null, "refs": { } }, "DeleteKeyspaceResponse": { "base": null, "refs": { } }, "DeleteTableRequest": { "base": null, "refs": { } }, "DeleteTableResponse": { "base": null, "refs": { } }, "DoubleObject": { "base": null, "refs": { "TargetTrackingScalingPolicyConfiguration$targetValue": "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.
Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):
Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).
Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).
For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer Guide.
For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.
", "refs": { "CreateTableRequest$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.
", "GetTableResponse$encryptionSpecification": "The encryption settings of the specified table.
", "RestoreTableRequest$encryptionSpecificationOverride": "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.
", "UpdateTableRequest$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.
" } }, "EncryptionType": { "base": null, "refs": { "EncryptionSpecification$type": "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.
" } }, "GenericString": { "base": null, "refs": { "ClusteringKey$name": "The name(s) of the clustering column(s).
", "ColumnDefinition$name": "The name of the column.
", "ColumnDefinition$type": "The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.
", "PartitionKey$name": "The name(s) of the partition key column(s).
", "StaticColumn$name": "The name of the static column.
" } }, "GetKeyspaceRequest": { "base": null, "refs": { } }, "GetKeyspaceResponse": { "base": null, "refs": { } }, "GetTableAutoScalingSettingsRequest": { "base": null, "refs": { } }, "GetTableAutoScalingSettingsResponse": { "base": null, "refs": { } }, "GetTableRequest": { "base": null, "refs": { } }, "GetTableResponse": { "base": null, "refs": { } }, "IntegerObject": { "base": null, "refs": { "TargetTrackingScalingPolicyConfiguration$scaleInCooldown": "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.
", "TargetTrackingScalingPolicyConfiguration$scaleOutCooldown": "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.
" } }, "InternalServerException": { "base": "Amazon Keyspaces was unable to fully process this request because of an internal server error.
", "refs": { } }, "KeyspaceName": { "base": null, "refs": { "CreateKeyspaceRequest$keyspaceName": "The name of the keyspace to be created.
", "CreateTableRequest$keyspaceName": "The name of the keyspace that the table is going to be created in.
", "DeleteKeyspaceRequest$keyspaceName": "The name of the keyspace to be deleted.
", "DeleteTableRequest$keyspaceName": "The name of the keyspace of the to be deleted table.
", "GetKeyspaceRequest$keyspaceName": "The name of the keyspace.
", "GetKeyspaceResponse$keyspaceName": "The name of the keyspace.
", "GetTableAutoScalingSettingsRequest$keyspaceName": "The name of the keyspace.
", "GetTableAutoScalingSettingsResponse$keyspaceName": "The name of the keyspace.
", "GetTableRequest$keyspaceName": "The name of the keyspace that the table is stored in.
", "GetTableResponse$keyspaceName": "The name of the keyspace that the specified table is stored in.
", "KeyspaceSummary$keyspaceName": "The name of the keyspace.
", "ListTablesRequest$keyspaceName": "The name of the keyspace.
", "RestoreTableRequest$sourceKeyspaceName": "The keyspace name of the source table.
", "RestoreTableRequest$targetKeyspaceName": "The name of the target keyspace.
", "TableSummary$keyspaceName": "The name of the keyspace that the table is stored in.
", "UpdateTableRequest$keyspaceName": "The name of the keyspace the specified table is stored in.
" } }, "KeyspaceSummary": { "base": "Represents the properties of a keyspace.
", "refs": { "KeyspaceSummaryList$member": null } }, "KeyspaceSummaryList": { "base": null, "refs": { "ListKeyspacesResponse$keyspaces": "A list of keyspaces.
" } }, "ListKeyspacesRequest": { "base": null, "refs": { } }, "ListKeyspacesResponse": { "base": null, "refs": { } }, "ListTablesRequest": { "base": null, "refs": { } }, "ListTablesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListKeyspacesRequest$maxResults": "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.
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.
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.
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
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.
", "refs": { "PartitionKeyList$member": null } }, "PartitionKeyList": { "base": null, "refs": { "SchemaDefinition$partitionKeys": "The columns that are part of the partition key of the table .
" } }, "PointInTimeRecovery": { "base": "Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
", "refs": { "CreateTableRequest$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.
", "RestoreTableRequest$pointInTimeRecoveryOverride": "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.
", "UpdateTableRequest$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.
" } }, "PointInTimeRecoveryStatus": { "base": null, "refs": { "PointInTimeRecovery$status": "The options are:
status=ENABLED
status=DISABLED
Shows if point-in-time recovery is enabled or disabled for the specified table.
" } }, "PointInTimeRecoverySummary": { "base": "The point-in-time recovery status of the specified table.
", "refs": { "GetTableResponse$pointInTimeRecovery": "The point-in-time recovery status of the specified table.
" } }, "RegionList": { "base": null, "refs": { "GetKeyspaceResponse$replicationRegions": " If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.
If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.
The regionList can contain up to six Amazon Web Services Regions where the keyspace is replicated in.
The auto scaling settings of a multi-Region table in the specified Amazon Web Services Region.
", "refs": { "ReplicaAutoScalingSpecificationList$member": null } }, "ReplicaAutoScalingSpecificationList": { "base": null, "refs": { "GetTableAutoScalingSettingsResponse$replicaSpecifications": "The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in.
" } }, "ReplicaSpecification": { "base": "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)
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)
The optional Region specific settings of a multi-Regional table.
", "UpdateTableRequest$replicaSpecifications": "The Region specific settings of a multi-Regional table.
" } }, "ReplicaSpecificationSummary": { "base": "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.
", "refs": { "ReplicaSpecificationSummaryList$member": null } }, "ReplicaSpecificationSummaryList": { "base": null, "refs": { "GetTableResponse$replicaSpecifications": "Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.
" } }, "ReplicationSpecification": { "base": "The replication specification of the keyspace includes:
regionList - up to six Amazon Web Services Regions where the keyspace is replicated in.
replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
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. The maximum number of supported replication Regions including the current Region is six.
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.
Describes the schema of the table.
", "refs": { "CreateTableRequest$schemaDefinition": "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.
The schema definition of the specified table.
" } }, "ServiceQuotaExceededException": { "base": "The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
", "refs": { } }, "SortOrder": { "base": null, "refs": { "ClusteringKey$orderBy": "Sets the ascendant (ASC) or descendant (DESC) order modifier.
The static columns of the table. Static columns store values that are shared by all rows in the same partition.
", "refs": { "StaticColumnList$member": null } }, "StaticColumnList": { "base": null, "refs": { "SchemaDefinition$staticColumns": "The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.
Description of the error.
", "Comment$message": "An optional description of the table.
", "ConflictException$message": "Description of the error.
", "InternalServerException$message": "Description of the error.
", "ResourceNotFoundException$message": "Description of the error.
", "ServiceQuotaExceededException$message": "Description of the error.
", "ValidationException$message": "Description of the error.
" } }, "TableName": { "base": null, "refs": { "CreateTableRequest$tableName": "The name of the table.
", "DeleteTableRequest$tableName": "The name of the table to be deleted.
", "GetTableAutoScalingSettingsRequest$tableName": "The name of the table.
", "GetTableAutoScalingSettingsResponse$tableName": "The name of the table.
", "GetTableRequest$tableName": "The name of the table.
", "GetTableResponse$tableName": "The name of the specified table.
", "RestoreTableRequest$sourceTableName": "The name of the source table.
", "RestoreTableRequest$targetTableName": "The name of the target table.
", "TableSummary$tableName": "The name of the table.
", "UpdateTableRequest$tableName": "The name of the table.
" } }, "TableStatus": { "base": null, "refs": { "GetTableResponse$status": "The current status of the specified table.
", "ReplicaSpecificationSummary$status": "The status of the multi-Region table in the specified Amazon Web Services Region.
" } }, "TableSummary": { "base": "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).
", "refs": { "TableSummaryList$member": null } }, "TableSummaryList": { "base": null, "refs": { "ListTablesResponse$tables": "A list of tables.
" } }, "Tag": { "base": "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.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "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.
" } }, "TagList": { "base": null, "refs": { "CreateKeyspaceRequest$tags": "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.
", "CreateTableRequest$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.
", "ListTagsForResourceResponse$tags": "A list of tags.
", "RestoreTableRequest$tagsOverride": "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.
", "TagResourceRequest$tags": "The tags to be assigned to the Amazon Keyspaces resource.
", "UntagResourceRequest$tags": "A list of existing tags to be removed from the Amazon Keyspaces resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$value": "The value of the tag. Tag values are case-sensitive and can be null.
" } }, "TargetTrackingScalingPolicyConfiguration": { "base": "The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.
", "refs": { "AutoScalingPolicy$targetTrackingScalingPolicyConfiguration": "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.
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.
", "CapacitySpecificationSummary$throughputMode": "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.
" } }, "TimeToLive": { "base": "Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.
For more information, see Enabling TTL on tables in the Amazon Keyspaces Developer Guide.
", "refs": { "CreateTableRequest$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.
", "GetTableResponse$ttl": "The custom Time to Live settings of the specified table.
", "UpdateTableRequest$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.
" } }, "TimeToLiveStatus": { "base": null, "refs": { "TimeToLive$status": "Shows how to enable custom Time to Live (TTL) settings for the specified table.
" } }, "Timestamp": { "base": null, "refs": { "CapacitySpecificationSummary$lastUpdateToPayPerRequestTimestamp": "The timestamp of the last operation that changed the provisioned throughput capacity of a table.
", "GetTableResponse$creationTimestamp": "The creation timestamp of the specified table.
", "PointInTimeRecoverySummary$earliestRestorableTimestamp": "Specifies the earliest possible restore point of the table in ISO 8601 format.
", "RestoreTableRequest$restoreTimestamp": "The restore timestamp in ISO 8601 format.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateTableRequest": { "base": null, "refs": { } }, "UpdateTableResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "The operation failed due to an invalid or malformed request.
", "refs": { } }, "kmsKeyARN": { "base": null, "refs": { "EncryptionSpecification$kmsKeyIdentifier": "The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.
The Amazon Web Services Region.
", "ReplicaSpecification$region": "The Amazon Web Services Region.
", "ReplicaSpecificationSummary$region": "The Amazon Web Services Region.
" } }, "rs": { "base": null, "refs": { "GetKeyspaceResponse$replicationStrategy": " Returns the replication strategy of the keyspace. The options are SINGLE_REGION or MULTI_REGION.
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.
The replicationStrategy of a keyspace, the required value is SINGLE_REGION or MULTI_REGION.