You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ApplicationAutoScaling::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



152
153
154
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 152

def initialize(*args)
  super
end

Instance Method Details

#delete_scaling_policy(params = {}) ⇒ Struct

Deletes the specified Application Auto Scaling scaling policy.

Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.

To create a scaling policy or update an existing one, see PutScalingPolicy.

Examples:

Example: To delete a scaling policy


# This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default
# cluster.

resp = client.delete_scaling_policy({
  policy_name: "web-app-cpu-lt-25", 
  resource_id: "service/default/web-app", 
  scalable_dimension: "ecs:service:DesiredCount", 
  service_namespace: "ecs", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_scaling_policy({
  policy_name: "ResourceIdMaxLen1600", # required
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb
  resource_id: "ResourceIdMaxLen1600", # required
  scalable_dimension: "ecs:service:DesiredCount", # required, accepts 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
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :policy_name (required, String)

    The name of the scaling policy.

  • :service_namespace (required, String)

    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

  • :resource_id (required, String)

    The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

    • 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 resource ID. Example: table/my-table.

    • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • :scalable_dimension (required, String)

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



264
265
266
267
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 264

def delete_scaling_policy(params = {}, options = {})
  req = build_request(:delete_scaling_policy, params)
  req.send_request(options)
end

#deregister_scalable_target(params = {}) ⇒ Struct

Deregisters a scalable target.

Deregistering a scalable target deletes the scaling policies that are associated with it.

To create a scalable target or update an existing one, see RegisterScalableTarget.

Examples:

Example: To deregister a scalable target


# This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default
# cluster.

resp = client.deregister_scalable_target({
  resource_id: "service/default/web-app", 
  scalable_dimension: "ecs:service:DesiredCount", 
  service_namespace: "ecs", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.deregister_scalable_target({
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb
  resource_id: "ResourceIdMaxLen1600", # required
  scalable_dimension: "ecs:service:DesiredCount", # required, accepts 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
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :service_namespace (required, String)

    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

  • :resource_id (required, String)

    The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

    • 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 resource ID. Example: table/my-table.

    • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • :scalable_dimension (required, String)

    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



370
371
372
373
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 370

def deregister_scalable_target(params = {}, options = {})
  req = build_request(:deregister_scalable_target, params)
  req.send_request(options)
end

#describe_scalable_targets(params = {}) ⇒ Types::DescribeScalableTargetsResponse

Provides descriptive information about the scalable targets in the specified namespace.

You can filter the results using the ResourceIds and ScalableDimension parameters.

To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

Examples:

Example: To describe scalable targets


# This example describes the scalable targets for the ecs service namespace.

resp = client.describe_scalable_targets({
  service_namespace: "ecs", 
})

resp.to_h outputs the following:
{
  scalable_targets: [
    {
      creation_time: Time.parse("2016-05-06T11:21:46.199Z"), 
      max_capacity: 10, 
      min_capacity: 1, 
      resource_id: "service/default/web-app", 
      role_arn: "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", 
      scalable_dimension: "ecs:service:DesiredCount", 
      service_namespace: "ecs", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_scalable_targets({
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb
  resource_ids: ["ResourceIdMaxLen1600"],
  scalable_dimension: "ecs:service:DesiredCount", # accepts 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
  max_results: 1,
  next_token: "XmlString",
})

Response structure


resp.scalable_targets #=> Array
resp.scalable_targets[0].service_namespace #=> String, one of "ecs", "elasticmapreduce", "ec2", "appstream", "dynamodb"
resp.scalable_targets[0].resource_id #=> String
resp.scalable_targets[0].scalable_dimension #=> String, one of "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"
resp.scalable_targets[0].min_capacity #=> Integer
resp.scalable_targets[0].max_capacity #=> Integer
resp.scalable_targets[0].role_arn #=> String
resp.scalable_targets[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :service_namespace (required, String)

    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

  • :resource_ids (Array<String>)

    The identifier of the resource associated with the scalable target. 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 resource ID. Example: table/my-table.

    • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • :scalable_dimension (String)

    The scalable dimension associated with the scalable target. 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.

  • :max_results (Integer)

    The maximum number of scalable target results. 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.

  • :next_token (String)

    The token for the next set of results.

Returns:

See Also:



518
519
520
521
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 518

def describe_scalable_targets(params = {}, options = {})
  req = build_request(:describe_scalable_targets, params)
  req.send_request(options)
end

#describe_scaling_activities(params = {}) ⇒ Types::DescribeScalingActivitiesResponse

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

You can filter the results using the ResourceId and ScalableDimension parameters.

Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.

Examples:

Example: To describe scaling activities for a scalable target


# This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default
# cluster.

resp = client.describe_scaling_activities({
  resource_id: "service/default/web-app", 
  scalable_dimension: "ecs:service:DesiredCount", 
  service_namespace: "ecs", 
})

resp.to_h outputs the following:
{
  scaling_activities: [
    {
      activity_id: "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", 
      cause: "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", 
      description: "Setting desired count to 1.", 
      end_time: Time.parse("2016-05-06T16:04:32.111Z"), 
      resource_id: "service/default/web-app", 
      scalable_dimension: "ecs:service:DesiredCount", 
      service_namespace: "ecs", 
      start_time: Time.parse("2016-05-06T16:03:58.171Z"), 
      status_code: "Successful", 
      status_message: "Successfully set desired count to 1. Change successfully fulfilled by ecs.", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_scaling_activities({
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb
  resource_id: "ResourceIdMaxLen1600",
  scalable_dimension: "ecs:service:DesiredCount", # accepts 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
  max_results: 1,
  next_token: "XmlString",
})

Response structure


resp.scaling_activities #=> Array
resp.scaling_activities[0].activity_id #=> String
resp.scaling_activities[0].service_namespace #=> String, one of "ecs", "elasticmapreduce", "ec2", "appstream", "dynamodb"
resp.scaling_activities[0].resource_id #=> String
resp.scaling_activities[0].scalable_dimension #=> String, one of "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"
resp.scaling_activities[0].description #=> String
resp.scaling_activities[0].cause #=> String
resp.scaling_activities[0].start_time #=> Time
resp.scaling_activities[0].end_time #=> Time
resp.scaling_activities[0].status_code #=> String, one of "Pending", "InProgress", "Successful", "Overridden", "Unfulfilled", "Failed"
resp.scaling_activities[0].status_message #=> String
resp.scaling_activities[0].details #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :service_namespace (required, String)

    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

  • :resource_id (String)

    The identifier of the resource associated with the scaling activity. 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 resource ID. Example: table/my-table.

    • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • :scalable_dimension (String)

    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.

  • :max_results (Integer)

    The maximum number of scalable target results. 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.

  • :next_token (String)

    The token for the next set of results.

Returns:

See Also:



676
677
678
679
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 676

def describe_scaling_activities(params = {}, options = {})
  req = build_request(:describe_scaling_activities, params)
  req.send_request(options)
end

#describe_scaling_policies(params = {}) ⇒ Types::DescribeScalingPoliciesResponse

Provides descriptive information about the scaling policies in the specified namespace.

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

To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

Examples:

Example: To describe scaling policies


# This example describes the scaling policies for the ecs service namespace.

resp = client.describe_scaling_policies({
  service_namespace: "ecs", 
})

resp.to_h outputs the following:
{
  next_token: "", 
  scaling_policies: [
    {
      alarms: [
        {
          alarm_arn: "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75", 
          alarm_name: "web-app-cpu-gt-75", 
        }, 
      ], 
      creation_time: Time.parse("2016-05-06T12:11:39.230Z"), 
      policy_arn: "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", 
      policy_name: "web-app-cpu-gt-75", 
      policy_type: "StepScaling", 
      resource_id: "service/default/web-app", 
      scalable_dimension: "ecs:service:DesiredCount", 
      service_namespace: "ecs", 
      step_scaling_policy_configuration: {
        adjustment_type: "PercentChangeInCapacity", 
        cooldown: 60, 
        step_adjustments: [
          {
            metric_interval_lower_bound: 0, 
            scaling_adjustment: 200, 
          }, 
        ], 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_scaling_policies({
  policy_names: ["ResourceIdMaxLen1600"],
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb
  resource_id: "ResourceIdMaxLen1600",
  scalable_dimension: "ecs:service:DesiredCount", # accepts 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
  max_results: 1,
  next_token: "XmlString",
})

Response structure


resp.scaling_policies #=> Array
resp.scaling_policies[0].policy_arn #=> String
resp.scaling_policies[0].policy_name #=> String
resp.scaling_policies[0].service_namespace #=> String, one of "ecs", "elasticmapreduce", "ec2", "appstream", "dynamodb"
resp.scaling_policies[0].resource_id #=> String
resp.scaling_policies[0].scalable_dimension #=> String, one of "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"
resp.scaling_policies[0].policy_type #=> String, one of "StepScaling", "TargetTrackingScaling"
resp.scaling_policies[0].step_scaling_policy_configuration.adjustment_type #=> String, one of "ChangeInCapacity", "PercentChangeInCapacity", "ExactCapacity"
resp.scaling_policies[0].step_scaling_policy_configuration.step_adjustments #=> Array
resp.scaling_policies[0].step_scaling_policy_configuration.step_adjustments[0].metric_interval_lower_bound #=> Float
resp.scaling_policies[0].step_scaling_policy_configuration.step_adjustments[0].metric_interval_upper_bound #=> Float
resp.scaling_policies[0].step_scaling_policy_configuration.step_adjustments[0].scaling_adjustment #=> Integer
resp.scaling_policies[0].step_scaling_policy_configuration.min_adjustment_magnitude #=> Integer
resp.scaling_policies[0].step_scaling_policy_configuration.cooldown #=> Integer
resp.scaling_policies[0].step_scaling_policy_configuration.metric_aggregation_type #=> String, one of "Average", "Minimum", "Maximum"
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.predefined_metric_specification.predefined_metric_type #=> String, one of "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization"
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.predefined_metric_specification.resource_label #=> String
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metric_name #=> String
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.namespace #=> String
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions #=> Array
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions[0].name #=> String
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions[0].value #=> String
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.unit #=> String
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
resp.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
resp.scaling_policies[0].alarms #=> Array
resp.scaling_policies[0].alarms[0].alarm_name #=> String
resp.scaling_policies[0].alarms[0].alarm_arn #=> String
resp.scaling_policies[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :policy_names (Array<String>)

    The names of the scaling policies to describe.

  • :service_namespace (required, String)

    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

  • :resource_id (String)

    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 resource ID. Example: table/my-table.

    • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • :scalable_dimension (String)

    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.

  • :max_results (Integer)

    The maximum number of scalable target results. 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.

  • :next_token (String)

    The token for the next set of results.

Returns:

See Also:



868
869
870
871
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 868

def describe_scaling_policies(params = {}, options = {})
  req = build_request(:describe_scaling_policies, params)
  req.send_request(options)
end

#put_scaling_policy(params = {}) ⇒ Types::PutScalingPolicyResponse

Creates or updates a policy for an Application Auto Scaling scalable target.

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using RegisterScalableTarget.

To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.

You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

Examples:

Example: To apply a scaling policy to an Amazon ECS service


# This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy
# increases the desired count of the service by 200%, with a cool down period of 60 seconds.

resp = client.put_scaling_policy({
  policy_name: "web-app-cpu-gt-75", 
  policy_type: "StepScaling", 
  resource_id: "service/default/web-app", 
  scalable_dimension: "ecs:service:DesiredCount", 
  service_namespace: "ecs", 
  step_scaling_policy_configuration: {
    adjustment_type: "PercentChangeInCapacity", 
    cooldown: 60, 
    step_adjustments: [
      {
        metric_interval_lower_bound: 0, 
        scaling_adjustment: 200, 
      }, 
    ], 
  }, 
})

resp.to_h outputs the following:
{
  policy_arn: "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", 
}

Example: To apply a scaling policy to an Amazon EC2 Spot fleet


# This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot
# fleet by 200%, with a cool down period of 180 seconds.",

resp = client.put_scaling_policy({
  policy_name: "fleet-cpu-gt-75", 
  policy_type: "StepScaling", 
  resource_id: "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", 
  scalable_dimension: "ec2:spot-fleet-request:TargetCapacity", 
  service_namespace: "ec2", 
  step_scaling_policy_configuration: {
    adjustment_type: "PercentChangeInCapacity", 
    cooldown: 180, 
    step_adjustments: [
      {
        metric_interval_lower_bound: 0, 
        scaling_adjustment: 200, 
      }, 
    ], 
  }, 
})

resp.to_h outputs the following:
{
  policy_arn: "arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75", 
}

Request syntax with placeholder values


resp = client.put_scaling_policy({
  policy_name: "PolicyName", # required
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb
  resource_id: "ResourceIdMaxLen1600", # required
  scalable_dimension: "ecs:service:DesiredCount", # required, accepts 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
  policy_type: "StepScaling", # accepts StepScaling, TargetTrackingScaling
  step_scaling_policy_configuration: {
    adjustment_type: "ChangeInCapacity", # accepts ChangeInCapacity, PercentChangeInCapacity, ExactCapacity
    step_adjustments: [
      {
        metric_interval_lower_bound: 1.0,
        metric_interval_upper_bound: 1.0,
        scaling_adjustment: 1, # required
      },
    ],
    min_adjustment_magnitude: 1,
    cooldown: 1,
    metric_aggregation_type: "Average", # accepts Average, Minimum, Maximum
  },
  target_tracking_scaling_policy_configuration: {
    target_value: 1.0, # required
    predefined_metric_specification: {
      predefined_metric_type: "DynamoDBReadCapacityUtilization", # required, accepts DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization
      resource_label: "ResourceLabel",
    },
    customized_metric_specification: {
      metric_name: "MetricName", # required
      namespace: "MetricNamespace", # required
      dimensions: [
        {
          name: "MetricDimensionName", # required
          value: "MetricDimensionValue", # required
        },
      ],
      statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
      unit: "MetricUnit",
    },
    scale_out_cooldown: 1,
    scale_in_cooldown: 1,
    disable_scale_in: false,
  },
})

Response structure


resp.policy_arn #=> String
resp.alarms #=> Array
resp.alarms[0].alarm_name #=> String
resp.alarms[0].alarm_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :policy_name (required, String)

    The name of the scaling policy.

  • :service_namespace (required, String)

    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

  • :resource_id (required, String)

    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

    • 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 resource ID. Example: table/my-table.

    • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • :scalable_dimension (required, String)

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

  • :policy_type (String)

    The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

    For DynamoDB, only TargetTrackingScaling is supported. For any other service, only StepScaling is supported.

  • :step_scaling_policy_configuration (Types::StepScalingPolicyConfiguration)

    A step scaling policy.

    This parameter is required if you are creating a policy and the policy type is StepScaling.

  • :target_tracking_scaling_policy_configuration (Types::TargetTrackingScalingPolicyConfiguration)

    A target tracking policy.

    This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.

Returns:

See Also:



1093
1094
1095
1096
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 1093

def put_scaling_policy(params = {}, options = {})
  req = build_request(:put_scaling_policy, params)
  req.send_request(options)
end

#register_scalable_target(params = {}) ⇒ Struct

Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.

After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

Examples:

Example: To register an ECS service as a scalable target


# This example registers a scalable target from an Amazon ECS service called web-app that is running on the default
# cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.

resp = client.register_scalable_target({
  max_capacity: 10, 
  min_capacity: 1, 
  resource_id: "service/default/web-app", 
  role_arn: "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", 
  scalable_dimension: "ecs:service:DesiredCount", 
  service_namespace: "ecs", 
})

Example: To register an EC2 Spot fleet as a scalable target


# This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum
# of 10.

resp = client.register_scalable_target({
  max_capacity: 10, 
  min_capacity: 1, 
  resource_id: "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", 
  role_arn: "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole", 
  scalable_dimension: "ec2:spot-fleet-request:TargetCapacity", 
  service_namespace: "ec2", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.register_scalable_target({
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb
  resource_id: "ResourceIdMaxLen1600", # required
  scalable_dimension: "ecs:service:DesiredCount", # required, accepts 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
  min_capacity: 1,
  max_capacity: 1,
  role_arn: "ResourceIdMaxLen1600",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :service_namespace (required, String)

    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

  • :resource_id (required, String)

    The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

    • 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 resource ID. Example: table/my-table.

    • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • :scalable_dimension (required, String)

    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

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

  • :min_capacity (Integer)

    The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.

  • :max_capacity (Integer)

    The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.

  • :role_arn (String)

    The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1238
1239
1240
1241
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/client.rb', line 1238

def register_scalable_target(params = {}, options = {})
  req = build_request(:register_scalable_target, params)
  req.send_request(options)
end