applicationautoscaling_describe_scaling_policies: Describes the Application Auto Scaling scaling policies for...
In paws.management: 'Amazon Web Services' Management & Governance Services

Description Usage Arguments Value Request syntax Examples

View source: R/applicationautoscaling_operations.R

Describes the Application Auto Scaling scaling policies for the specified service namespace.

You can filter the results using ResourceId, ScalableDimension, and PolicyNames.

For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

1 2	applicationautoscaling_describe_scaling_policies(PolicyNames, ServiceNamespace, ResourceId, ScalableDimension, MaxResults, NextToken)

`PolicyNames`	The names of the scaling policies to describe.
`ServiceNamespace`	[required] The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use `custom-resource` instead.
`ResourceId`	The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/default/sample-webapp`. Spot Fleet request - The resource type is `spot-fleet-request` and the unique identifier is the Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`. EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID. Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`. AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name. Example: `fleet/sample-fleet`. DynamoDB table - The resource type is `table` and the unique identifier is the table name. Example: `table/my-table`. DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name. Example: `table/my-table/index/my-table-index`. Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:my-db-cluster`. Amazon SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`. Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`. Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST`. Example: `function:my-function:prod` or `function:my-function:1`. Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable`. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`.
`ScalableDimension`	The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. `ecs:service:DesiredCount` - The desired task count of an ECS service. `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet request. `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group. `appstream:fleet:DesiredCapacity` - The desired capacity of an AppStream 2.0 fleet. `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table. `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table. `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index. `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index. `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for an Amazon SageMaker model endpoint variant. `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service. `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint. `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function. `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table. `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table. `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
`MaxResults`	The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to `MaxResults` results at a time, along with a `NextToken` value. To get the next set of results, include the `NextToken` value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a `NextToken` value, if applicable.
`NextToken`	The token for the next set of results.

A list with the following syntax:

list(
  ScalingPolicies = list(
    list(
      PolicyARN = "string",
      PolicyName = "string",
      ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda"|"cassandra"|"kafka",
      ResourceId = "string",
      ScalableDimension = "ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"elasticmapreduce:instancegroup:InstanceCount"|"appstream:fleet:DesiredCapacity"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|"rds:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredInstanceCount"|"custom-resource:ResourceType:Property"|"comprehend:document-classifier-endpoint:DesiredInferenceUnits"|"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"|"lambda:function:ProvisionedConcurrency"|"cassandra:table:ReadCapacityUnits"|"cassandra:table:WriteCapacityUnits"|"kafka:broker-storage:VolumeSize",
      PolicyType = "StepScaling"|"TargetTrackingScaling",
      StepScalingPolicyConfiguration = list(
        AdjustmentType = "ChangeInCapacity"|"PercentChangeInCapacity"|"ExactCapacity",
        StepAdjustments = list(
          list(
            MetricIntervalLowerBound = 123.0,
            MetricIntervalUpperBound = 123.0,
            ScalingAdjustment = 123
          )
        ),
        MinAdjustmentMagnitude = 123,
        Cooldown = 123,
        MetricAggregationType = "Average"|"Minimum"|"Maximum"
      ),
      TargetTrackingScalingPolicyConfiguration = list(
        TargetValue = 123.0,
        PredefinedMetricSpecification = list(
          PredefinedMetricType = "DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|"SageMakerVariantInvocationsPerInstance"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"AppStreamAverageCapacityUtilization"|"ComprehendInferenceUtilization"|"LambdaProvisionedConcurrencyUtilization"|"CassandraReadCapacityUtilization"|"CassandraWriteCapacityUtilization"|"KafkaBrokerStorageUtilization",
          ResourceLabel = "string"
        ),
        CustomizedMetricSpecification = list(
          MetricName = "string",
          Namespace = "string",
          Dimensions = list(
            list(
              Name = "string",
              Value = "string"
            )
          ),
          Statistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum",
          Unit = "string"
        ),
        ScaleOutCooldown = 123,
        ScaleInCooldown = 123,
        DisableScaleIn = TRUE|FALSE
      ),
      Alarms = list(
        list(
          AlarmName = "string",
          AlarmARN = "string"
        )
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

svc$describe_scaling_policies(
  PolicyNames = list(
    "string"
  ),
  ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda"|"cassandra"|"kafka",
  ResourceId = "string",
  ScalableDimension = "ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"elasticmapreduce:instancegroup:InstanceCount"|"appstream:fleet:DesiredCapacity"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|"rds:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredInstanceCount"|"custom-resource:ResourceType:Property"|"comprehend:document-classifier-endpoint:DesiredInferenceUnits"|"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"|"lambda:function:ProvisionedConcurrency"|"cassandra:table:ReadCapacityUnits"|"cassandra:table:WriteCapacityUnits"|"kafka:broker-storage:VolumeSize",
  MaxResults = 123,
  NextToken = "string"
)

## Not run: 
# This example describes the scaling policies for the ECS service
# namespace.
svc$describe_scaling_policies(
  ServiceNamespace = "ecs"
)

## End(Not run)