Skip to content

aws.keyspaces.get_table_auto_scaling_settings

Example SQL Queries

SELECT * FROM
aws.keyspaces.get_table_auto_scaling_settings
WHERE
"keyspace_name" = 'VALUE'
AND "table_name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
keyspace_name Required Input Column

The name of the keyspace.

VARCHAR
table_name Required Input Column

The name of the table.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

auto_scaling_specification

The auto scaling settings of the table.

STRUCT(
"write_capacity_auto_scaling" STRUCT(
"auto_scaling_disabled" BOOLEAN,
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"scaling_policy" STRUCT(
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)
),
"read_capacity_auto_scaling" STRUCT(
"auto_scaling_disabled" BOOLEAN,
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"scaling_policy" STRUCT(
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)
)
)
Show child fields
auto_scaling_specification.read_capacity_auto_scaling

The auto scaling settings for the table's read capacity.

Show child fields
auto_scaling_specification.read_capacity_auto_scaling.auto_scaling_disabled

This optional parameter enables auto scaling for the table if set to false.

auto_scaling_specification.read_capacity_auto_scaling.maximum_units

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

auto_scaling_specification.read_capacity_auto_scaling.minimum_units

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

auto_scaling_specification.read_capacity_auto_scaling.scaling_policy

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.

Show child fields
auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration

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.

Show child fields
auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.disable_scale_in

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.

auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_in_cooldown

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.

auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.target_value

Specifies the target value for the target tracking auto scaling policy.

Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

auto_scaling_specification.write_capacity_auto_scaling

The auto scaling settings for the table's write capacity.

Show child fields
auto_scaling_specification.write_capacity_auto_scaling.auto_scaling_disabled

This optional parameter enables auto scaling for the table if set to false.

auto_scaling_specification.write_capacity_auto_scaling.maximum_units

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

auto_scaling_specification.write_capacity_auto_scaling.minimum_units

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

auto_scaling_specification.write_capacity_auto_scaling.scaling_policy

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.

Show child fields
auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration

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.

Show child fields
auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.disable_scale_in

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.

auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_in_cooldown

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.

auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.target_value

Specifies the target value for the target tracking auto scaling policy.

Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

replica_specifications

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

STRUCT(
"region" VARCHAR,
"auto_scaling_specification" STRUCT(
"write_capacity_auto_scaling" STRUCT(
"auto_scaling_disabled" BOOLEAN,
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"scaling_policy" STRUCT(
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)
),
"read_capacity_auto_scaling" STRUCT(
"auto_scaling_disabled" BOOLEAN,
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"scaling_policy" STRUCT(
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)
)
)
)[]
Show child fields
replica_specifications[]
Show child fields
replica_specifications[].auto_scaling_specification

The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region.

Show child fields
replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling

The auto scaling settings for the table's read capacity.

Show child fields
replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.auto_scaling_disabled

This optional parameter enables auto scaling for the table if set to false.

replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.maximum_units

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

replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.minimum_units

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

replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.scaling_policy

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.

Show child fields
replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration

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.

Show child fields
replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.disable_scale_in

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.

replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_in_cooldown

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.

replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

replica_specifications[].auto_scaling_specification.read_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.target_value

Specifies the target value for the target tracking auto scaling policy.

Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling

The auto scaling settings for the table's write capacity.

Show child fields
replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.auto_scaling_disabled

This optional parameter enables auto scaling for the table if set to false.

replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.maximum_units

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

replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.minimum_units

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

replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.scaling_policy

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.

Show child fields
replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration

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.

Show child fields
replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.disable_scale_in

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.

replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_in_cooldown

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.

replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

replica_specifications[].auto_scaling_specification.write_capacity_auto_scaling.scaling_policy.target_tracking_scaling_policy_configuration.target_value

Specifies the target value for the target tracking auto scaling policy.

Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

replica_specifications[].region

The Amazon Web Services Region.

resource_arn

The Amazon Resource Name (ARN) of the table.

VARCHAR