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 Creating keyspaces 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

Result Syntax

[
    'resourceArn' => '<string>',
]

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.

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 Creating tables 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

Result Syntax

[
    'resourceArn' => '<string>',
]

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 or table 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

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 or table 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

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 or table 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

Result Syntax

[
    'keyspaceName' => '<string>',
    'replicationRegions' => ['<string>', ...],
    'replicationStrategy' => 'SINGLE_REGION|MULTI_REGION',
    'resourceArn' => '<string>',
]

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.

AccessDeniedException:

You don't have sufficient access permissions to perform this action.

ResourceNotFoundException:

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

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, Select action permissions for the table and system tables are required to complete the operation.

Parameter Syntax

$result = $client->getTable([
    'keyspaceName' => '<string>', // REQUIRED
    'tableName' => '<string>', // REQUIRED
]);

Parameter Details

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

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

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

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

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 or table 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([/* ... */]);

Returns a list of keyspaces.

Parameter Syntax

$result = $client->listKeyspaces([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'keyspaces' => [
        [
            'keyspaceName' => '<string>',
            'replicationRegions' => ['<string>', ...],
            'replicationStrategy' => 'SINGLE_REGION|MULTI_REGION',
            'resourceArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

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.

AccessDeniedException:

You don't have sufficient access permissions to perform this action.

ResourceNotFoundException:

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

ListTables

$result = $client->listTables([/* ... */]);
$promise = $client->listTablesAsync([/* ... */]);

Returns a list of tables for a specified keyspace.

Parameter Syntax

$result = $client->listTables([
    'keyspaceName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tables' => [
        [
            'keyspaceName' => '<string>',
            'resourceArn' => '<string>',
            'tableName' => '<string>',
        ],
        // ...
    ],
]

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.

AccessDeniedException:

You don't have sufficient access permissions to perform this action.

ResourceNotFoundException:

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

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

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.

AccessDeniedException:

You don't have sufficient access permissions to perform this action.

ResourceNotFoundException:

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

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

Result Syntax

[
    'restoredTableARN' => '<string>',
]

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 or table 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

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.

AccessDeniedException:

You don't have sufficient access permissions to perform this action.

ResourceNotFoundException:

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

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

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 or table 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

Result Syntax

[
    'resourceArn' => '<string>',
]

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 or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.