Describe Scaling Plan Resources

autoscalingplans_describe_scaling_plan_resources

R Documentation

Describes the scalable resources in the specified scaling plan

Description

Describes the scalable resources in the specified scaling plan.

Usage

autoscalingplans_describe_scaling_plan_resources(ScalingPlanName,
  ScalingPlanVersion, MaxResults, NextToken)

Arguments

ScalingPlanName

[required] The name of the scaling plan.

ScalingPlanVersion

[required] The version number of the scaling plan. Currently, the only valid value is 1.

MaxResults

The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.

NextToken

The token for the next set of results.

Value

A list with the following syntax:

list(
  ScalingPlanResources = list(
    list(
      ScalingPlanName = "string",
      ScalingPlanVersion = 123,
      ServiceNamespace = "autoscaling"|"ecs"|"ec2"|"rds"|"dynamodb",
      ResourceId = "string",
      ScalableDimension = "autoscaling:autoScalingGroup:DesiredCapacity"|"ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"rds:cluster:ReadReplicaCount"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits",
      ScalingPolicies = list(
        list(
          PolicyName = "string",
          PolicyType = "TargetTrackingScaling",
          TargetTrackingConfiguration = list(
            PredefinedScalingMetricSpecification = list(
              PredefinedScalingMetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut",
              ResourceLabel = "string"
            ),
            CustomizedScalingMetricSpecification = list(
              MetricName = "string",
              Namespace = "string",
              Dimensions = list(
                list(
                  Name = "string",
                  Value = "string"
                )
              ),
              Statistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum",
              Unit = "string"
            ),
            TargetValue = 123.0,
            DisableScaleIn = TRUE|FALSE,
            ScaleOutCooldown = 123,
            ScaleInCooldown = 123,
            EstimatedInstanceWarmup = 123
          )
        )
      ),
      ScalingStatusCode = "Inactive"|"PartiallyActive"|"Active",
      ScalingStatusMessage = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_scaling_plan_resources(
  ScalingPlanName = "string",
  ScalingPlanVersion = 123,
  MaxResults = 123,
  NextToken = "string"
)