Describes the Application Auto Scaling scheduled actions for the specified service namespace.
applicationautoscaling_describe_scheduled_actions(ScheduledActionNames,
ServiceNamespace, ResourceId, ScalableDimension, MaxResults, NextToken)
The names of the scheduled actions to describe.
[required] 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.
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 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
.
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
.
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.
lambda:function:ProvisionedConcurrency
- The provisioned
concurrency for a Lambda function.
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.
The token for the next set of results.
svc$describe_scheduled_actions( ScheduledActionNames = list( "string" ), ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda", 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"|"lambda:function:ProvisionedConcurrency", MaxResults = 123, NextToken = "string" )
You can filter the results using the ResourceId
, ScalableDimension
,
and ScheduledActionNames
parameters.
To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.