describe_scheduled_actions(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_scheduled_actions(
ScheduledActionNames=[
'string',
],
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
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'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
MaxResults=123,
NextToken='string'
)
The names of the scheduled actions to describe.
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .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.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .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 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.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 a 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.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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.
dict
Response Syntax
{
'ScheduledActions': [
{
'ScheduledActionName': 'string',
'ScheduledActionARN': 'string',
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'Schedule': 'string',
'Timezone': 'string',
'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'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ScalableTargetAction': {
'MinCapacity': 123,
'MaxCapacity': 123
},
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ScheduledActions (list) --
Information about the scheduled actions.
(dict) --
Represents a scheduled action.
ScheduledActionName (string) --
The name of the scheduled action.
ScheduledActionARN (string) --
The Amazon Resource Name (ARN) of the scheduled action.
ServiceNamespace (string) --
The namespace of the Amazon Web Services service that provides the resource, or a custom-resource .
Schedule (string) --
The schedule for this action. The following formats are supported:
at(yyyy-mm-ddThh:mm:ss) "rate(valueunit) "cron(fields) "At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days .
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide .
Timezone (string) --
The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .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.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .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 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (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.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.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 a 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.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.StartTime (datetime) --
The date and time that the action is scheduled to begin, in UTC.
EndTime (datetime) --
The date and time that the action is scheduled to end, in UTC.
ScalableTargetAction (dict) --
The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
MinCapacity (integer) --
The minimum capacity.
When the scheduled action runs, the resource will have at least this much capacity, but it might have more depending on other settings, such as the target utilization level of a target tracking scaling policy.
MaxCapacity (integer) --
The maximum capacity.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference .
CreationTime (datetime) --
The date and time that the scheduled action was created.
NextToken (string) --
The token required to get the next set of results. This value is null if there are no more results to return.
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.InvalidNextTokenExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceException