Amazon Keyspaces 2022-02-10
- Client: Aws\Keyspaces\KeyspacesClient
- Service ID: keyspaces
- Version: 2022-02-10
This page describes the parameters and results for the operations of the Amazon Keyspaces (2022-02-10), and shows how to use the Aws\Keyspaces\KeyspacesClient object to call the described operations. This documentation is specific to the 2022-02-10 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateKeyspace ( array $params = [] )
- The CreateKeyspace operation adds a new keyspace to your account.
- CreateTable ( array $params = [] )
- The CreateTable operation adds a new table to the specified keyspace.
- CreateType ( array $params = [] )
- The CreateType operation creates a new user-defined type in the specified keyspace.
- DeleteKeyspace ( array $params = [] )
- The DeleteKeyspace operation deletes a keyspace and all of its tables.
- DeleteTable ( array $params = [] )
- The DeleteTable operation deletes a table and all of its data.
- DeleteType ( array $params = [] )
- The DeleteType operation deletes a user-defined type (UDT).
- GetKeyspace ( array $params = [] )
- Returns the name and the Amazon Resource Name (ARN) of the specified table.
- GetTable ( array $params = [] )
- Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
- GetTableAutoScalingSettings ( array $params = [] )
- Returns auto scaling related settings of the specified table in JSON format.
- GetType ( array $params = [] )
- The GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.
- ListKeyspaces ( array $params = [] )
- The ListKeyspaces operation returns a list of keyspaces.
- ListTables ( array $params = [] )
- The ListTables operation returns a list of tables for a specified keyspace.
- ListTagsForResource ( array $params = [] )
- Returns a list of all tags associated with the specified Amazon Keyspaces resource.
- ListTypes ( array $params = [] )
- The ListTypes operation returns a list of types for a specified keyspace.
- RestoreTable ( array $params = [] )
- Restores the table to the specified point in time within the earliest_restorable_timestamp and the current time.
- TagResource ( array $params = [] )
- Associates a set of tags with a Amazon Keyspaces resource.
- UntagResource ( array $params = [] )
- Removes the association of tags from a Amazon Keyspaces resource.
- UpdateTable ( array $params = [] )
- 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.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateKeyspace
$result = $client->createKeyspace
([/* ... */]); $promise = $client->createKeyspaceAsync
([/* ... */]);
The CreateKeyspace
operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.
CreateKeyspace
is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace
operation.
For more information, see Create a keyspace in the Amazon Keyspaces Developer Guide.
Parameter Syntax
$result = $client->createKeyspace([ 'keyspaceName' => '<string>', // REQUIRED 'replicationSpecification' => [ 'regionList' => ['<string>', ...], 'replicationStrategy' => 'SINGLE_REGION|MULTI_REGION', // REQUIRED ], 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace to be created.
- replicationSpecification
-
- Type: ReplicationSpecification structure
The replication specification of the keyspace includes:
-
replicationStrategy
- the required value isSINGLE_REGION
orMULTI_REGION
. -
regionList
- if thereplicationStrategy
isMULTI_REGION
, theregionList
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.
- tags
-
- Type: Array of Tag structures
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.
Result Syntax
[ 'resourceArn' => '<string>', ]
Result Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
CreateTable
$result = $client->createTable
([/* ... */]); $promise = $client->createTableAsync
([/* ... */]);
The CreateTable
operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.
CreateTable
is an asynchronous operation. When the request is received, the status of the table is set to CREATING
. You can monitor the creation status of the new table by using the GetTable
operation, which returns the current status
of the table. You can start using a table when the status is ACTIVE
.
For more information, see Create a table in the Amazon Keyspaces Developer Guide.
Parameter Syntax
$result = $client->createTable([ 'autoScalingSpecification' => [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], 'writeCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], ], 'capacitySpecification' => [ 'readCapacityUnits' => <integer>, 'throughputMode' => 'PAY_PER_REQUEST|PROVISIONED', // REQUIRED 'writeCapacityUnits' => <integer>, ], 'clientSideTimestamps' => [ 'status' => 'ENABLED', // REQUIRED ], 'comment' => [ 'message' => '<string>', // REQUIRED ], 'defaultTimeToLive' => <integer>, 'encryptionSpecification' => [ 'kmsKeyIdentifier' => '<string>', 'type' => 'CUSTOMER_MANAGED_KMS_KEY|AWS_OWNED_KMS_KEY', // REQUIRED ], 'keyspaceName' => '<string>', // REQUIRED 'pointInTimeRecovery' => [ 'status' => 'ENABLED|DISABLED', // REQUIRED ], 'replicaSpecifications' => [ [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], 'readCapacityUnits' => <integer>, 'region' => '<string>', // REQUIRED ], // ... ], 'schemaDefinition' => [ // REQUIRED 'allColumns' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'type' => '<string>', // REQUIRED ], // ... ], 'clusteringKeys' => [ [ 'name' => '<string>', // REQUIRED 'orderBy' => 'ASC|DESC', // REQUIRED ], // ... ], 'partitionKeys' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED ], // ... ], 'staticColumns' => [ [ 'name' => '<string>', // REQUIRED ], // ... ], ], 'tableName' => '<string>', // REQUIRED 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'ttl' => [ 'status' => 'ENABLED', // REQUIRED ], ]);
Parameter Details
Members
- autoScalingSpecification
-
- Type: AutoScalingSpecification structure
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.
- capacitySpecification
-
- Type: CapacitySpecification structure
Specifies the read/write throughput capacity mode for the table. The options are:
-
throughputMode:PAY_PER_REQUEST
and -
throughputMode:PROVISIONED
- Provisioned capacity mode requiresreadCapacityUnits
andwriteCapacityUnits
as input.
The default is
throughput_mode:PAY_PER_REQUEST
.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- clientSideTimestamps
-
- Type: ClientSideTimestamps structure
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.
- comment
-
- Type: Comment structure
This parameter allows to enter a description of the table.
- defaultTimeToLive
-
- Type: int
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.
- encryptionSpecification
-
- Type: EncryptionSpecification structure
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 thekms_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.
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace that the table is going to be created in.
- pointInTimeRecovery
-
- Type: PointInTimeRecovery structure
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.
- replicaSpecifications
-
- Type: Array of ReplicaSpecification structures
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)
- schemaDefinition
-
- Required: Yes
- Type: SchemaDefinition structure
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.
- tableName
-
- Required: Yes
- Type: string
The name of the table.
- tags
-
- Type: Array of Tag structures
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.
- ttl
-
- Type: TimeToLive structure
Enables Time to Live custom settings for the table. The options are:
-
status:enabled
-
status:disabled
The default is
status:disabled
. Afterttl
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.
Result Syntax
[ 'resourceArn' => '<string>', ]
Result Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The unique identifier of the table in the format of an Amazon Resource Name (ARN).
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
CreateType
$result = $client->createType
([/* ... */]); $promise = $client->createTypeAsync
([/* ... */]);
The CreateType
operation creates a new user-defined type in the specified keyspace.
For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer Guide.
Parameter Syntax
$result = $client->createType([ 'fieldDefinitions' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'type' => '<string>', // REQUIRED ], // ... ], 'keyspaceName' => '<string>', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- fieldDefinitions
-
- Required: Yes
- Type: Array of FieldDefinition structures
The field definitions, consisting of names and types, that define this type.
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace.
- typeName
-
- Required: Yes
- Type: string
The name of the user-defined type.
UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters.
Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.
You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.
Result Syntax
[ 'keyspaceArn' => '<string>', 'typeName' => '<string>', ]
Result Details
Members
- keyspaceArn
-
- Required: Yes
- Type: string
The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN).
- typeName
-
- Required: Yes
- Type: string
The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for other operations, for example
GetType
.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
DeleteKeyspace
$result = $client->deleteKeyspace
([/* ... */]); $promise = $client->deleteKeyspaceAsync
([/* ... */]);
The DeleteKeyspace
operation deletes a keyspace and all of its tables.
Parameter Syntax
$result = $client->deleteKeyspace([ 'keyspaceName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace to be deleted.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
DeleteTable
$result = $client->deleteTable
([/* ... */]); $promise = $client->deleteTableAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteTable([ 'keyspaceName' => '<string>', // REQUIRED 'tableName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace of the to be deleted table.
- tableName
-
- Required: Yes
- Type: string
The name of the table to be deleted.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
DeleteType
$result = $client->deleteType
([/* ... */]); $promise = $client->deleteTypeAsync
([/* ... */]);
The DeleteType
operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT.
Parameter Syntax
$result = $client->deleteType([ 'keyspaceName' => '<string>', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace of the to be deleted type.
- typeName
-
- Required: Yes
- Type: string
The name of the type to be deleted.
Result Syntax
[ 'keyspaceArn' => '<string>', 'typeName' => '<string>', ]
Result Details
Members
- keyspaceArn
-
- Required: Yes
- Type: string
The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN).
- typeName
-
- Required: Yes
- Type: string
The name of the type that was deleted.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
GetKeyspace
$result = $client->getKeyspace
([/* ... */]); $promise = $client->getKeyspaceAsync
([/* ... */]);
Returns the name and the Amazon Resource Name (ARN) of the specified table.
Parameter Syntax
$result = $client->getKeyspace([ 'keyspaceName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace.
Result Syntax
[ 'keyspaceName' => '<string>', 'replicationRegions' => ['<string>', ...], 'replicationStrategy' => 'SINGLE_REGION|MULTI_REGION', 'resourceArn' => '<string>', ]
Result Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace.
- replicationRegions
-
- Type: Array of strings
If the
replicationStrategy
of the keyspace isMULTI_REGION
, a list of replication Regions is returned. - replicationStrategy
-
- Required: Yes
- Type: string
Returns the replication strategy of the keyspace. The options are
SINGLE_REGION
orMULTI_REGION
. - resourceArn
-
- Required: Yes
- Type: string
Returns the ARN of the keyspace.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
GetTable
$result = $client->getTable
([/* ... */]); $promise = $client->getTableAsync
([/* ... */]);
Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using GetTable
, the IAM principal needs Select
action permissions for the table and the system keyspace.
Parameter Syntax
$result = $client->getTable([ 'keyspaceName' => '<string>', // REQUIRED 'tableName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace that the table is stored in.
- tableName
-
- Required: Yes
- Type: string
The name of the table.
Result Syntax
[ 'capacitySpecification' => [ 'lastUpdateToPayPerRequestTimestamp' => <DateTime>, 'readCapacityUnits' => <integer>, 'throughputMode' => 'PAY_PER_REQUEST|PROVISIONED', 'writeCapacityUnits' => <integer>, ], 'clientSideTimestamps' => [ 'status' => 'ENABLED', ], 'comment' => [ 'message' => '<string>', ], 'creationTimestamp' => <DateTime>, 'defaultTimeToLive' => <integer>, 'encryptionSpecification' => [ 'kmsKeyIdentifier' => '<string>', 'type' => 'CUSTOMER_MANAGED_KMS_KEY|AWS_OWNED_KMS_KEY', ], 'keyspaceName' => '<string>', 'pointInTimeRecovery' => [ 'earliestRestorableTimestamp' => <DateTime>, 'status' => 'ENABLED|DISABLED', ], 'replicaSpecifications' => [ [ 'capacitySpecification' => [ 'lastUpdateToPayPerRequestTimestamp' => <DateTime>, 'readCapacityUnits' => <integer>, 'throughputMode' => 'PAY_PER_REQUEST|PROVISIONED', 'writeCapacityUnits' => <integer>, ], 'region' => '<string>', 'status' => 'ACTIVE|CREATING|UPDATING|DELETING|DELETED|RESTORING|INACCESSIBLE_ENCRYPTION_CREDENTIALS', ], // ... ], 'resourceArn' => '<string>', 'schemaDefinition' => [ 'allColumns' => [ [ 'name' => '<string>', 'type' => '<string>', ], // ... ], 'clusteringKeys' => [ [ 'name' => '<string>', 'orderBy' => 'ASC|DESC', ], // ... ], 'partitionKeys' => [ [ 'name' => '<string>', ], // ... ], 'staticColumns' => [ [ 'name' => '<string>', ], // ... ], ], 'status' => 'ACTIVE|CREATING|UPDATING|DELETING|DELETED|RESTORING|INACCESSIBLE_ENCRYPTION_CREDENTIALS', 'tableName' => '<string>', 'ttl' => [ 'status' => 'ENABLED', ], ]
Result Details
Members
- capacitySpecification
-
- Type: CapacitySpecificationSummary structure
The read/write throughput capacity mode for a table. The options are:
-
throughputMode:PAY_PER_REQUEST
-
throughputMode:PROVISIONED
- clientSideTimestamps
-
- Type: ClientSideTimestamps structure
The client-side timestamps setting of the table.
- comment
-
- Type: Comment structure
The the description of the specified table.
- creationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation timestamp of the specified table.
- defaultTimeToLive
-
- Type: int
The default Time to Live settings in seconds of the specified table.
- encryptionSpecification
-
- Type: EncryptionSpecification structure
The encryption settings of the specified table.
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace that the specified table is stored in.
- pointInTimeRecovery
-
- Type: PointInTimeRecoverySummary structure
The point-in-time recovery status of the specified table.
- replicaSpecifications
-
- Type: Array of ReplicaSpecificationSummary structures
Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the specified table.
- schemaDefinition
-
- Type: SchemaDefinition structure
The schema definition of the specified table.
- status
-
- Type: string
The current status of the specified table.
- tableName
-
- Required: Yes
- Type: string
The name of the specified table.
- ttl
-
- Type: TimeToLive structure
The custom Time to Live settings of the specified table.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
GetTableAutoScalingSettings
$result = $client->getTableAutoScalingSettings
([/* ... */]); $promise = $client->getTableAutoScalingSettingsAsync
([/* ... */]);
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.
GetTableAutoScalingSettings
can't be used as an action in an IAM policy.
To define permissions for GetTableAutoScalingSettings
, you must allow the following two actions in the IAM policy statement's Action
element:
-
application-autoscaling:DescribeScalableTargets
-
application-autoscaling:DescribeScalingPolicies
Parameter Syntax
$result = $client->getTableAutoScalingSettings([ 'keyspaceName' => '<string>', // REQUIRED 'tableName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace.
- tableName
-
- Required: Yes
- Type: string
The name of the table.
Result Syntax
[ 'autoScalingSpecification' => [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, ], ], ], 'writeCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, ], ], ], ], 'keyspaceName' => '<string>', 'replicaSpecifications' => [ [ 'autoScalingSpecification' => [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, ], ], ], 'writeCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, ], ], ], ], 'region' => '<string>', ], // ... ], 'resourceArn' => '<string>', 'tableName' => '<string>', ]
Result Details
Members
- autoScalingSpecification
-
- Type: AutoScalingSpecification structure
The auto scaling settings of the table.
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace.
- replicaSpecifications
-
- Type: Array of ReplicaAutoScalingSpecification structures
The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in.
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the table.
- tableName
-
- Required: Yes
- Type: string
The name of the table.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
GetType
$result = $client->getType
([/* ... */]); $promise = $client->getTypeAsync
([/* ... */]);
The GetType
operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.
To read keyspace metadata using GetType
, the IAM principal needs Select
action permissions for the system keyspace.
Parameter Syntax
$result = $client->getType([ 'keyspaceName' => '<string>', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace that contains this type.
- typeName
-
- Required: Yes
- Type: string
The formatted name of the type. For example, if the name of the type was created without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was created in double quotes, you must use double quotes to specify the type name.
Result Syntax
[ 'directParentTypes' => ['<string>', ...], 'directReferringTables' => ['<string>', ...], 'fieldDefinitions' => [ [ 'name' => '<string>', 'type' => '<string>', ], // ... ], 'keyspaceArn' => '<string>', 'keyspaceName' => '<string>', 'lastModifiedTimestamp' => <DateTime>, 'maxNestingDepth' => <integer>, 'status' => 'ACTIVE|CREATING|DELETING|RESTORING', 'typeName' => '<string>', ]
Result Details
Members
- directParentTypes
-
- Type: Array of strings
The types that use this type.
- directReferringTables
-
- Type: Array of strings
The tables that use this type.
- fieldDefinitions
-
- Type: Array of FieldDefinition structures
The names and types that define this type.
- keyspaceArn
-
- Required: Yes
- Type: string
The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN).
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace that contains this type.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that shows when this type was last modified.
- maxNestingDepth
-
- Type: int
The level of nesting implemented for this type.
- status
-
- Type: string
The status of this type.
- typeName
-
- Required: Yes
- Type: string
The name of the type.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
ListKeyspaces
$result = $client->listKeyspaces
([/* ... */]); $promise = $client->listKeyspacesAsync
([/* ... */]);
The ListKeyspaces
operation returns a list of keyspaces.
Parameter Syntax
$result = $client->listKeyspaces([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
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 theNextToken
value as an argument of a subsequent API invocation. - nextToken
-
- Type: string
The pagination token. To resume pagination, provide the
NextToken
value as argument of a subsequent API invocation.
Result Syntax
[ 'keyspaces' => [ [ 'keyspaceName' => '<string>', 'replicationRegions' => ['<string>', ...], 'replicationStrategy' => 'SINGLE_REGION|MULTI_REGION', 'resourceArn' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- keyspaces
-
- Required: Yes
- Type: Array of KeyspaceSummary structures
A list of keyspaces.
- nextToken
-
- Type: string
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
ListTables
$result = $client->listTables
([/* ... */]); $promise = $client->listTablesAsync
([/* ... */]);
The ListTables
operation returns a list of tables for a specified keyspace.
To read keyspace metadata using ListTables
, the IAM principal needs Select
action permissions for the system keyspace.
Parameter Syntax
$result = $client->listTables([ 'keyspaceName' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace.
- maxResults
-
- Type: int
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 theNextToken
value as an argument of a subsequent API invocation. - nextToken
-
- Type: string
The pagination token. To resume pagination, provide the
NextToken
value as an argument of a subsequent API invocation.
Result Syntax
[ 'nextToken' => '<string>', 'tables' => [ [ 'keyspaceName' => '<string>', 'resourceArn' => '<string>', 'tableName' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response. - tables
-
- Type: Array of TableSummary structures
A list of tables.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
To read keyspace metadata using ListTagsForResource
, the IAM principal needs Select
action permissions for the specified resource and the system keyspace.
Parameter Syntax
$result = $client->listTagsForResource([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
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 theNextToken
value as an argument of a subsequent API invocation. - nextToken
-
- Type: string
The pagination token. To resume pagination, provide the
NextToken
value as argument of a subsequent API invocation. - resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
Result Syntax
[ 'nextToken' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response. - tags
-
- Type: Array of Tag structures
A list of tags.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
ListTypes
$result = $client->listTypes
([/* ... */]); $promise = $client->listTypesAsync
([/* ... */]);
The ListTypes
operation returns a list of types for a specified keyspace.
To read keyspace metadata using ListTypes
, the IAM principal needs Select
action permissions for the system keyspace.
Parameter Syntax
$result = $client->listTypes([ 'keyspaceName' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace that contains the listed types.
- maxResults
-
- Type: int
The total number of types to return in the output. If the total number of types available is more than the value specified, a
NextToken
is provided in the output. To resume pagination, provide theNextToken
value as an argument of a subsequent API invocation. - nextToken
-
- Type: string
The pagination token. To resume pagination, provide the
NextToken
value as an argument of a subsequent API invocation.
Result Syntax
[ 'nextToken' => '<string>', 'types' => ['<string>', ...], ]
Result Details
Members
- nextToken
-
- Type: string
The pagination token. To resume pagination, provide the
NextToken
value as an argument of a subsequent API invocation. - types
-
- Required: Yes
- Type: Array of strings
The list of types contained in the specified keyspace.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
RestoreTable
$result = $client->restoreTable
([/* ... */]); $promise = $client->restoreTableAsync
([/* ... */]);
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
Parameter Syntax
$result = $client->restoreTable([ 'autoScalingSpecification' => [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], 'writeCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], ], 'capacitySpecificationOverride' => [ 'readCapacityUnits' => <integer>, 'throughputMode' => 'PAY_PER_REQUEST|PROVISIONED', // REQUIRED 'writeCapacityUnits' => <integer>, ], 'encryptionSpecificationOverride' => [ 'kmsKeyIdentifier' => '<string>', 'type' => 'CUSTOMER_MANAGED_KMS_KEY|AWS_OWNED_KMS_KEY', // REQUIRED ], 'pointInTimeRecoveryOverride' => [ 'status' => 'ENABLED|DISABLED', // REQUIRED ], 'replicaSpecifications' => [ [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], 'readCapacityUnits' => <integer>, 'region' => '<string>', // REQUIRED ], // ... ], 'restoreTimestamp' => <integer || string || DateTime>, 'sourceKeyspaceName' => '<string>', // REQUIRED 'sourceTableName' => '<string>', // REQUIRED 'tagsOverride' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'targetKeyspaceName' => '<string>', // REQUIRED 'targetTableName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- autoScalingSpecification
-
- Type: AutoScalingSpecification structure
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.
- capacitySpecificationOverride
-
- Type: CapacitySpecification structure
Specifies the read/write throughput capacity mode for the target table. The options are:
-
throughputMode:PAY_PER_REQUEST
-
throughputMode:PROVISIONED
- Provisioned capacity mode requiresreadCapacityUnits
andwriteCapacityUnits
as input.
The default is
throughput_mode:PAY_PER_REQUEST
.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- encryptionSpecificationOverride
-
- Type: EncryptionSpecification structure
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 thekms_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.
- pointInTimeRecoveryOverride
-
- Type: PointInTimeRecovery structure
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.
- replicaSpecifications
-
- Type: Array of ReplicaSpecification structures
The optional Region specific settings of a multi-Regional table.
- restoreTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The restore timestamp in ISO 8601 format.
- sourceKeyspaceName
-
- Required: Yes
- Type: string
The keyspace name of the source table.
- sourceTableName
-
- Required: Yes
- Type: string
The name of the source table.
- tagsOverride
-
- Type: Array of Tag structures
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.
- targetKeyspaceName
-
- Required: Yes
- Type: string
The name of the target keyspace.
- targetTableName
-
- Required: Yes
- Type: string
The name of the target table.
Result Syntax
[ 'restoredTableARN' => '<string>', ]
Result Details
Members
- restoredTableARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the restored table.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => [ // REQUIRED [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The tags to be assigned to the Amazon Keyspaces resource.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes the association of tags from a Amazon Keyspaces resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => [ // REQUIRED [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
- tags
-
- Required: Yes
- Type: Array of Tag structures
A list of existing tags to be removed from the Amazon Keyspaces resource.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
UpdateTable
$result = $client->updateTable
([/* ... */]); $promise = $client->updateTableAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateTable([ 'addColumns' => [ [ 'name' => '<string>', // REQUIRED 'type' => '<string>', // REQUIRED ], // ... ], 'autoScalingSpecification' => [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], 'writeCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], ], 'capacitySpecification' => [ 'readCapacityUnits' => <integer>, 'throughputMode' => 'PAY_PER_REQUEST|PROVISIONED', // REQUIRED 'writeCapacityUnits' => <integer>, ], 'clientSideTimestamps' => [ 'status' => 'ENABLED', // REQUIRED ], 'defaultTimeToLive' => <integer>, 'encryptionSpecification' => [ 'kmsKeyIdentifier' => '<string>', 'type' => 'CUSTOMER_MANAGED_KMS_KEY|AWS_OWNED_KMS_KEY', // REQUIRED ], 'keyspaceName' => '<string>', // REQUIRED 'pointInTimeRecovery' => [ 'status' => 'ENABLED|DISABLED', // REQUIRED ], 'replicaSpecifications' => [ [ 'readCapacityAutoScaling' => [ 'autoScalingDisabled' => true || false, 'maximumUnits' => <integer>, 'minimumUnits' => <integer>, 'scalingPolicy' => [ 'targetTrackingScalingPolicyConfiguration' => [ 'disableScaleIn' => true || false, 'scaleInCooldown' => <integer>, 'scaleOutCooldown' => <integer>, 'targetValue' => <float>, // REQUIRED ], ], ], 'readCapacityUnits' => <integer>, 'region' => '<string>', // REQUIRED ], // ... ], 'tableName' => '<string>', // REQUIRED 'ttl' => [ 'status' => 'ENABLED', // REQUIRED ], ]);
Parameter Details
Members
- addColumns
-
- Type: Array of ColumnDefinition structures
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.
- autoScalingSpecification
-
- Type: AutoScalingSpecification structure
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.
- capacitySpecification
-
- Type: CapacitySpecification structure
Modifies the read/write throughput capacity mode for the table. The options are:
-
throughputMode:PAY_PER_REQUEST
and -
throughputMode:PROVISIONED
- Provisioned capacity mode requiresreadCapacityUnits
andwriteCapacityUnits
as input.
The default is
throughput_mode:PAY_PER_REQUEST
.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- clientSideTimestamps
-
- Type: ClientSideTimestamps structure
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.
- defaultTimeToLive
-
- Type: int
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.
- encryptionSpecification
-
- Type: EncryptionSpecification structure
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 thekms_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.
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace the specified table is stored in.
- pointInTimeRecovery
-
- Type: PointInTimeRecovery structure
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.
- replicaSpecifications
-
- Type: Array of ReplicaSpecification structures
The Region specific settings of a multi-Regional table.
- tableName
-
- Required: Yes
- Type: string
The name of the table.
- ttl
-
- Type: TimeToLive structure
Modifies Time to Live custom settings for the table. The options are:
-
status:enabled
-
status:disabled
The default is
status:disabled
. Afterttl
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.
Result Syntax
[ 'resourceArn' => '<string>', ]
Result Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the modified table.
Errors
- ValidationException:
The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException:
Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException:
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.
- AccessDeniedException:
You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException:
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE
.
Shapes
AccessDeniedException
Description
You don't have sufficient access permissions to perform this action.
Members
- message
-
- Type: string
Description of the error.
AutoScalingPolicy
Description
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.
Members
- targetTrackingScalingPolicyConfiguration
-
- Type: TargetTrackingScalingPolicyConfiguration structure
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.
AutoScalingSettings
Description
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 capacity units. 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 thetarget tracking
scaling policy. The auto scaling target is the provisioned 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 definetargetValue
as a percentage. Adouble
between 20 and 90. (Required) -
disableScaleIn
: Aboolean
that specifies ifscale-in
is disabled or enabled for the table. This parameter is disabled by default. To turn onscale-in
, set theboolean
value toFALSE
. 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.
Members
- autoScalingDisabled
-
- Type: boolean
This optional parameter enables auto scaling for the table if set to
false
. - maximumUnits
-
- Type: long (int|float)
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).
- minimumUnits
-
- Type: long (int|float)
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).
- scalingPolicy
-
- Type: AutoScalingPolicy structure
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.
AutoScalingSpecification
Description
The optional auto scaling capacity settings for a table in provisioned capacity mode.
Members
- readCapacityAutoScaling
-
- Type: AutoScalingSettings structure
The auto scaling settings for the table's read capacity.
- writeCapacityAutoScaling
-
- Type: AutoScalingSettings structure
The auto scaling settings for the table's write capacity.
CapacitySpecification
Description
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.
Members
- readCapacityUnits
-
- Type: long (int|float)
The throughput capacity specified for
read
operations defined inread capacity units
(RCUs)
. - throughputMode
-
- Required: Yes
- Type: string
The read/write throughput capacity mode for a table. The options are:
-
throughputMode:PAY_PER_REQUEST
and -
throughputMode:PROVISIONED
- Provisioned capacity mode requiresreadCapacityUnits
andwriteCapacityUnits
as input.
The default is
throughput_mode:PAY_PER_REQUEST
.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- writeCapacityUnits
-
- Type: long (int|float)
The throughput capacity specified for
write
operations defined inwrite capacity units
(WCUs)
.
CapacitySpecificationSummary
Description
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.
Members
- lastUpdateToPayPerRequestTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last operation that changed the provisioned throughput capacity of a table.
- readCapacityUnits
-
- Type: long (int|float)
The throughput capacity specified for
read
operations defined inread capacity units
(RCUs)
. - throughputMode
-
- Required: Yes
- Type: string
The read/write throughput capacity mode for a table. The options are:
-
throughputMode:PAY_PER_REQUEST
and -
throughputMode:PROVISIONED
- Provisioned capacity mode requiresreadCapacityUnits
andwriteCapacityUnits
as input.
The default is
throughput_mode:PAY_PER_REQUEST
.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- writeCapacityUnits
-
- Type: long (int|float)
The throughput capacity specified for
write
operations defined inwrite capacity units
(WCUs)
.
ClientSideTimestamps
Description
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.
Members
- status
-
- Required: Yes
- Type: string
Shows how to enable client-side timestamps settings for the specified table.
ClusteringKey
Description
The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
Members
- name
-
- Required: Yes
- Type: string
The name(s) of the clustering column(s).
- orderBy
-
- Required: Yes
- Type: string
Sets the ascendant (
ASC
) or descendant (DESC
) order modifier.
ColumnDefinition
Description
The names and data types of regular columns.
Members
- name
-
- Required: Yes
- Type: string
The name of the column.
- type
-
- Required: Yes
- Type: string
The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.
Comment
Description
An optional comment that describes the table.
Members
- message
-
- Required: Yes
- Type: string
An optional description of the table.
ConflictException
Description
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.
Members
- message
-
- Type: string
Description of the error.
EncryptionSpecification
Description
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.
Members
- kmsKeyIdentifier
-
- Type: string
The Amazon Resource Name (ARN) of the customer managed KMS key, for example
kms_key_identifier:ARN
. - type
-
- Required: Yes
- 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 thekms_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.
FieldDefinition
Description
A field definition consists out of a name and a type.
Members
- name
-
- Required: Yes
- Type: string
The identifier.
- type
-
- Required: Yes
- Type: string
Any supported Cassandra data type, including collections and other user-defined types that are contained in the same keyspace.
For more information, see Cassandra data type support in the Amazon Keyspaces Developer Guide.
InternalServerException
Description
Amazon Keyspaces was unable to fully process this request because of an internal server error.
Members
- message
-
- Type: string
Description of the error.
KeyspaceSummary
Description
Represents the properties of a keyspace.
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace.
- replicationRegions
-
- Type: Array of strings
If the
replicationStrategy
of the keyspace isMULTI_REGION
, a list of replication Regions is returned. - replicationStrategy
-
- Required: Yes
- Type: string
This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are
SINGLE_REGION
orMULTI_REGION
. - resourceArn
-
- Required: Yes
- Type: string
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
PartitionKey
Description
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.
Members
- name
-
- Required: Yes
- Type: string
The name(s) of the partition key column(s).
PointInTimeRecovery
Description
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.
Members
- status
-
- Required: Yes
- Type: string
The options are:
-
status=ENABLED
-
status=DISABLED
PointInTimeRecoverySummary
Description
The point-in-time recovery status of the specified table.
Members
- earliestRestorableTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the earliest possible restore point of the table in ISO 8601 format.
- status
-
- Required: Yes
- Type: string
Shows if point-in-time recovery is enabled or disabled for the specified table.
ReplicaAutoScalingSpecification
Description
The auto scaling settings of a multi-Region table in the specified Amazon Web Services Region.
Members
- autoScalingSpecification
-
- Type: AutoScalingSpecification structure
The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region.
- region
-
- Type: string
The Amazon Web Services Region.
ReplicaSpecification
Description
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)
Members
- readCapacityAutoScaling
-
- Type: AutoScalingSettings structure
The read capacity auto scaling settings for the multi-Region table in the specified Amazon Web Services Region.
- readCapacityUnits
-
- Type: long (int|float)
The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.
- region
-
- Required: Yes
- Type: string
The Amazon Web Services Region.
ReplicaSpecificationSummary
Description
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.
Members
- capacitySpecification
-
- Type: CapacitySpecificationSummary structure
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.
- region
-
- Type: string
The Amazon Web Services Region.
- status
-
- Type: string
The status of the multi-Region table in the specified Amazon Web Services Region.
ReplicationSpecification
Description
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 isSINGLE_REGION
orMULTI_REGION
.
Members
- regionList
-
- Type: Array of strings
The
regionList
can contain up to six Amazon Web Services Regions where the keyspace is replicated in. - replicationStrategy
-
- Required: Yes
- Type: string
The
replicationStrategy
of a keyspace, the required value isSINGLE_REGION
orMULTI_REGION
.
ResourceNotFoundException
Description
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE
.
Members
- message
-
- Type: string
Description of the error.
- resourceArn
-
- Type: string
The unique identifier in the format of Amazon Resource Name (ARN) for the resource could't be found.
SchemaDefinition
Description
Describes the schema of the table.
Members
- allColumns
-
- Required: Yes
- Type: Array of ColumnDefinition structures
The regular columns of the table.
- clusteringKeys
-
- Type: Array of ClusteringKey structures
The columns that are part of the clustering key of the table.
- partitionKeys
-
- Required: Yes
- Type: Array of PartitionKey structures
The columns that are part of the partition key of the table .
- staticColumns
-
- Type: Array of StaticColumn structures
The columns that have been defined as
STATIC
. Static columns store values that are shared by all rows in the same partition.
ServiceQuotaExceededException
Description
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
Members
- message
-
- Type: string
Description of the error.
StaticColumn
Description
The static columns of the table. Static columns store values that are shared by all rows in the same partition.
Members
- name
-
- Required: Yes
- Type: string
The name of the static column.
TableSummary
Description
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).
Members
- keyspaceName
-
- Required: Yes
- Type: string
The name of the keyspace that the table is stored in.
- resourceArn
-
- Required: Yes
- Type: string
The unique identifier of the table in the format of an Amazon Resource Name (ARN).
- tableName
-
- Required: Yes
- Type: string
The name of the table.
Tag
Description
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.
Members
- key
-
- Required: Yes
- Type: 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
-
- Required: Yes
- Type: string
The value of the tag. Tag values are case-sensitive and can be null.
TargetTrackingScalingPolicyConfiguration
Description
The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.
Members
- disableScaleIn
-
- Type: boolean
Specifies if
scale-in
is enabled.When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.
- scaleInCooldown
-
- Type: int
Specifies a
scale-in
cool down period.A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
- scaleOutCooldown
-
- Type: int
Specifies a scale out cool down period.
A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
- targetValue
-
- Required: Yes
- Type: double
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. Adouble
between 20 and 90.
TimeToLive
Description
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.
Members
- status
-
- Required: Yes
- Type: string
Shows how to enable custom Time to Live (TTL) settings for the specified table.
ValidationException
Description
The operation failed due to an invalid or malformed request.
Members
- message
-
- Type: string
Description of the error.