Post x amz targetanyscalefrontendservice.describescheduledactions

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1413106198.8 KB

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

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

For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide.

post/#X-Amz-Target=AnyScaleFrontendService.DescribeScheduledActions

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'AnyScaleFrontendService.DescribeScheduledActions' required

Request body

ScheduledActionNamesResourceIdMaxLen1600[]

The names of the scheduled actions to describe.

The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.

ResourceIdstring

The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. <ul> <li> ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>. </li> <li> Spot Fleet - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>. </li> <li> EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>. </li> <li> AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>. </li> <li> DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>. </li> <li> DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>. </li> <li> Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>. </li> <li> SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>. </li> <li> Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> 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 <a href="https://github.com/aws/aws-auto-scaling-custom-resource">GitHub repository</a>. </li> <li> Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>. </li> <li> Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE</code>. </li> <li> Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>. </li> <li> Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>. </li> <li> Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: <code>arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5</code>. </li> <li> Amazon ElastiCache replication group - The resource type is <code>replication-group</code> and the unique identifier is the replication group name. Example: <code>replication-group/mycluster</code>. </li> <li> Neptune cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:mycluster</code>. </li> </ul>

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. <ul> <li> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service. </li> <li> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group. </li> <li> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet. </li> <li> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet. </li> <li> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table. </li> <li> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table. </li> <li> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index. </li> <li> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index. </li> <li> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. </li> <li> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for a SageMaker model endpoint variant. </li> <li> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service. </li> <li> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint. </li> <li> <code>comprehend:entity-recognizer-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend entity recognizer endpoint. </li> <li> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function. </li> <li> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table. </li> <li> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table. </li> <li> <code>kafka:broker-storage:VolumeSize</code> - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. </li> <li> <code>elasticache:replication-group:NodeGroups</code> - The number of node groups for an Amazon ElastiCache replication group. </li> <li> <code>elasticache:replication-group:Replicas</code> - The number of replicas per node group for an Amazon ElastiCache replication group. </li> <li> <code>neptune:cluster:ReadReplicaCount</code> - The count of read replicas in an Amazon Neptune DB cluster. </li> </ul>

MaxResultsinteger

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 <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.

NextTokenstring

The token for the next set of results.

Response

Success

NextTokenstring

The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.

Example response

{
  "ScheduledActions": [
    {
      "CreationTime": 1561571888.361,
      "ResourceId": "table/my-table",
      "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
      "ScalableTargetAction": {
        "MaxCapacity": 20,
        "MinCapacity": 15
      },
      "Schedule": "at(2019-05-20T18:35:00)",
      "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action",
      "ScheduledActionName": "my-first-scheduled-action",
      "ServiceNamespace": "dynamodb"
    },
    {
      "CreationTime": 1561571946.021,
      "ResourceId": "table/my-table",
      "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
      "ScalableTargetAction": {
        "MaxCapacity": 10,
        "MinCapacity": 5
      },
      "Schedule": "at(2019-05-20T18:40:00)",
      "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action",
      "ScheduledActionName": "my-second-scheduled-action",
      "ServiceNamespace": "dynamodb"
    }
  ]
}