Skip to content

Get Table Auto Scaling Settings

keyspaces_get_table_auto_scaling_settings R Documentation

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.

get_table_auto_scaling_settings can't be used as an action in an IAM policy.

To define permissions for get_table_auto_scaling_settings, you must allow the following two actions in the IAM policy statement's Action element:

  • application-autoscaling:DescribeScalableTargets

  • application-autoscaling:DescribeScalingPolicies

Usage

keyspaces_get_table_auto_scaling_settings(keyspaceName, tableName)

Arguments

keyspaceName

[required] The name of the keyspace.

tableName

[required] The name of the table.

Value

A list with the following syntax: 

list(
  keyspaceName = "string",
  tableName = "string",
  resourceArn = "string",
  autoScalingSpecification = list(
    writeCapacityAutoScaling = list(
      autoScalingDisabled = TRUE|FALSE,
      minimumUnits = 123,
      maximumUnits = 123,
      scalingPolicy = list(
        targetTrackingScalingPolicyConfiguration = list(
          disableScaleIn = TRUE|FALSE,
          scaleInCooldown = 123,
          scaleOutCooldown = 123,
          targetValue = 123.0
        )
      )
    ),
    readCapacityAutoScaling = list(
      autoScalingDisabled = TRUE|FALSE,
      minimumUnits = 123,
      maximumUnits = 123,
      scalingPolicy = list(
        targetTrackingScalingPolicyConfiguration = list(
          disableScaleIn = TRUE|FALSE,
          scaleInCooldown = 123,
          scaleOutCooldown = 123,
          targetValue = 123.0
        )
      )
    )
  ),
  replicaSpecifications = list(
    list(
      region = "string",
      autoScalingSpecification = list(
        writeCapacityAutoScaling = list(
          autoScalingDisabled = TRUE|FALSE,
          minimumUnits = 123,
          maximumUnits = 123,
          scalingPolicy = list(
            targetTrackingScalingPolicyConfiguration = list(
              disableScaleIn = TRUE|FALSE,
              scaleInCooldown = 123,
              scaleOutCooldown = 123,
              targetValue = 123.0
            )
          )
        ),
        readCapacityAutoScaling = list(
          autoScalingDisabled = TRUE|FALSE,
          minimumUnits = 123,
          maximumUnits = 123,
          scalingPolicy = list(
            targetTrackingScalingPolicyConfiguration = list(
              disableScaleIn = TRUE|FALSE,
              scaleInCooldown = 123,
              scaleOutCooldown = 123,
              targetValue = 123.0
            )
          )
        )
      )
    )
  )
)

Request syntax

svc$get_table_auto_scaling_settings(
  keyspaceName = "string",
  tableName = "string"
)