AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Application Auto Scaling PutScheduledAction API operation.

Syntax

Set-AASScheduledAction
-ResourceId <String>
-EndTime <DateTime>
-ScalableTargetAction_MaxCapacity <Int32>
-ScalableTargetAction_MinCapacity <Int32>
-ScalableDimension <ScalableDimension>
-Schedule <String>
-ScheduledActionName <String>
-ServiceNamespace <ServiceNamespace>
-StartTime <DateTime>
-Timezone <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonApplicationAutoScalingConfig>

Description

Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops. To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted. For more information, see Scheduled scaling in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.

Parameters

-ClientConfig <AmazonApplicationAutoScalingConfig>
Amazon.PowerShell.Cmdlets.AAS.AmazonApplicationAutoScalingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndTime <DateTime>
The date and time for the recurring schedule to end, in UTC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceId <String>
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  • Spot Fleet - 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.
  • 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.
  • Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
  • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  • Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  • Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/mycluster.
  • Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  • SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ScalableDimension <ScalableDimension>
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
  • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
  • sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalableTargetAction_MaxCapacity <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalableTargetAction_MinCapacity <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schedule <String>
The schedule for this action. The following formats are supported:
  • At expressions - "at(yyyy-mm-ddThh:mm:ss)"
  • Rate expressions - "rate(valueunit)"
  • Cron expressions - "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, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduledActionName <String>
The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationAutoScaling.Model.PutScheduledActionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceNamespace <ServiceNamespace>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTime <DateTime>
The date and time for this scheduled action to start, in UTC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Timezone <String>
Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is not provided, UTC is used by default.Valid values are the canonical names of the IANA time zones supported by Joda-Time (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.ApplicationAutoScaling.Model.PutScheduledActionResponse
This cmdlet does not generate any output.The service response (type Amazon.ApplicationAutoScaling.Model.PutScheduledActionResponse) be returned by specifying '-Select *'.

Examples

Example 1

Set-AASScheduledAction -ServiceNamespace AppStream -ResourceId fleet/MyFleet -Schedule "cron(0 0 8 ? * MON-FRI *)" -ScalableDimension appstream:fleet:DesiredCapacity -ScheduledActionName WeekDaysFleetScaling -ScalableTargetAction_MinCapacity 5 -ScalableTargetAction_MaxCapacity 10
This cmdlet creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z