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

Class: Aws::ApplicationAutoScaling::Types::DescribeScalableTargetsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb

Overview

Note:

When making an API call, you may pass DescribeScalableTargetsRequest data as a hash:

{
  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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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.

Returns:

  • (Integer)


359
360
361
362
363
364
365
366
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 359

class DescribeScalableTargetsRequest < Struct.new(
  :service_namespace,
  :resource_ids,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


359
360
361
362
363
364
365
366
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 359

class DescribeScalableTargetsRequest < Struct.new(
  :service_namespace,
  :resource_ids,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#resource_idsArray<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.

Returns:

  • (Array<String>)


359
360
361
362
363
364
365
366
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 359

class DescribeScalableTargetsRequest < Struct.new(
  :service_namespace,
  :resource_ids,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#scalable_dimensionString

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.

Returns:

  • (String)


359
360
361
362
363
364
365
366
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 359

class DescribeScalableTargetsRequest < Struct.new(
  :service_namespace,
  :resource_ids,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#service_namespaceString

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

Returns:

  • (String)


359
360
361
362
363
364
365
366
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 359

class DescribeScalableTargetsRequest < Struct.new(
  :service_namespace,
  :resource_ids,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end