Skip to content

Describe Table Replica Auto Scaling

dynamodb_describe_table_replica_auto_scaling R Documentation

Describes auto scaling settings across replicas of the global table at once

Description

Describes auto scaling settings across replicas of the global table at once.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

Usage

dynamodb_describe_table_replica_auto_scaling(TableName)

Arguments

TableName

[required] The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Value

A list with the following syntax:

list(
  TableAutoScalingDescription = list(
    TableName = "string",
    TableStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS"|"ARCHIVING"|"ARCHIVED",
    Replicas = list(
      list(
        RegionName = "string",
        GlobalSecondaryIndexes = list(
          list(
            IndexName = "string",
            IndexStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE",
            ProvisionedReadCapacityAutoScalingSettings = list(
              MinimumUnits = 123,
              MaximumUnits = 123,
              AutoScalingDisabled = TRUE|FALSE,
              AutoScalingRoleArn = "string",
              ScalingPolicies = list(
                list(
                  PolicyName = "string",
                  TargetTrackingScalingPolicyConfiguration = list(
                    DisableScaleIn = TRUE|FALSE,
                    ScaleInCooldown = 123,
                    ScaleOutCooldown = 123,
                    TargetValue = 123.0
                  )
                )
              )
            ),
            ProvisionedWriteCapacityAutoScalingSettings = list(
              MinimumUnits = 123,
              MaximumUnits = 123,
              AutoScalingDisabled = TRUE|FALSE,
              AutoScalingRoleArn = "string",
              ScalingPolicies = list(
                list(
                  PolicyName = "string",
                  TargetTrackingScalingPolicyConfiguration = list(
                    DisableScaleIn = TRUE|FALSE,
                    ScaleInCooldown = 123,
                    ScaleOutCooldown = 123,
                    TargetValue = 123.0
                  )
                )
              )
            )
          )
        ),
        ReplicaProvisionedReadCapacityAutoScalingSettings = list(
          MinimumUnits = 123,
          MaximumUnits = 123,
          AutoScalingDisabled = TRUE|FALSE,
          AutoScalingRoleArn = "string",
          ScalingPolicies = list(
            list(
              PolicyName = "string",
              TargetTrackingScalingPolicyConfiguration = list(
                DisableScaleIn = TRUE|FALSE,
                ScaleInCooldown = 123,
                ScaleOutCooldown = 123,
                TargetValue = 123.0
              )
            )
          )
        ),
        ReplicaProvisionedWriteCapacityAutoScalingSettings = list(
          MinimumUnits = 123,
          MaximumUnits = 123,
          AutoScalingDisabled = TRUE|FALSE,
          AutoScalingRoleArn = "string",
          ScalingPolicies = list(
            list(
              PolicyName = "string",
              TargetTrackingScalingPolicyConfiguration = list(
                DisableScaleIn = TRUE|FALSE,
                ScaleInCooldown = 123,
                ScaleOutCooldown = 123,
                TargetValue = 123.0
              )
            )
          )
        ),
        ReplicaStatus = "CREATING"|"CREATION_FAILED"|"UPDATING"|"DELETING"|"ACTIVE"|"REGION_DISABLED"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS"
      )
    )
  )
)

Request syntax

svc$describe_table_replica_auto_scaling(
  TableName = "string"
)