GetTableAutoScalingSettings - Amazon Keyspaces (for Apache Cassandra)

GetTableAutoScalingSettings

Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the AWS 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.

Important

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

Request Syntax

{ "keyspaceName": "string", "tableName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

keyspaceName

The name of the keyspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

Required: Yes

tableName

The name of the table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

Required: Yes

Response Syntax

{ "autoScalingSpecification": { "readCapacityAutoScaling": { "autoScalingDisabled": boolean, "maximumUnits": number, "minimumUnits": number, "scalingPolicy": { "targetTrackingScalingPolicyConfiguration": { "disableScaleIn": boolean, "scaleInCooldown": number, "scaleOutCooldown": number, "targetValue": number } } }, "writeCapacityAutoScaling": { "autoScalingDisabled": boolean, "maximumUnits": number, "minimumUnits": number, "scalingPolicy": { "targetTrackingScalingPolicyConfiguration": { "disableScaleIn": boolean, "scaleInCooldown": number, "scaleOutCooldown": number, "targetValue": number } } } }, "keyspaceName": "string", "replicaSpecifications": [ { "autoScalingSpecification": { "readCapacityAutoScaling": { "autoScalingDisabled": boolean, "maximumUnits": number, "minimumUnits": number, "scalingPolicy": { "targetTrackingScalingPolicyConfiguration": { "disableScaleIn": boolean, "scaleInCooldown": number, "scaleOutCooldown": number, "targetValue": number } } }, "writeCapacityAutoScaling": { "autoScalingDisabled": boolean, "maximumUnits": number, "minimumUnits": number, "scalingPolicy": { "targetTrackingScalingPolicyConfiguration": { "disableScaleIn": boolean, "scaleInCooldown": number, "scaleOutCooldown": number, "targetValue": number } } } }, "region": "string" } ], "resourceArn": "string", "tableName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

autoScalingSpecification

The auto scaling settings of the table.

Type: AutoScalingSpecification object

keyspaceName

The name of the keyspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

replicaSpecifications

The AWS Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in.

Type: Array of ReplicaAutoScalingSpecification objects

Array Members: Minimum number of 0 items.

resourceArn

The Amazon Resource Name (ARN) of the table.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1000.

Pattern: arn:(aws[a-zA-Z0-9-]*):cassandra:.+.*

tableName

The name of the table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_]{0,47}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

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.

HTTP Status Code: 400

ServiceQuotaExceededException

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

HTTP Status Code: 400

ValidationException

The operation failed due to an invalid or malformed request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: