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

Class: Aws::ApplicationAutoScaling::Types::DescribeScheduledActionsRequest

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 DescribeScheduledActionsRequest data as a hash:

{
  scheduled_action_names: ["ResourceIdMaxLen1600"],
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb, rds, sagemaker, custom-resource
  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, rds:cluster:ReadReplicaCount, sagemaker:variant:DesiredInstanceCount, custom-resource:ResourceType:Property
  max_results: 1,
  next_token: "XmlString",
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of scheduled action 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)


1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1068

class DescribeScheduledActionsRequest < Struct.new(
  :scheduled_action_names,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1068

class DescribeScheduledActionsRequest < Struct.new(
  :scheduled_action_names,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#resource_idString

The identifier of the resource associated with the scheduled action. 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.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - 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.

Returns:

  • (String)


1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1068

class DescribeScheduledActionsRequest < Struct.new(
  :scheduled_action_names,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#scalable_dimensionString

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.

Returns:

  • (String)


1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1068

class DescribeScheduledActionsRequest < Struct.new(
  :scheduled_action_names,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#scheduled_action_namesArray<String>

The names of the scheduled actions to describe.

Returns:

  • (Array<String>)


1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1068

class DescribeScheduledActionsRequest < Struct.new(
  :scheduled_action_names,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end

#service_namespaceString

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

  • (String)


1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1068

class DescribeScheduledActionsRequest < Struct.new(
  :scheduled_action_names,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :max_results,
  :next_token)
  include Aws::Structure
end