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 Amazon EventBridge Scheduler UpdateSchedule API operation.

Syntax

Update-SCHSchedule
-Name <String>
-ActionAfterCompletion <ActionAfterCompletion>
-Target_Arn <String>
-DeadLetterConfig_Arn <String>
-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>
-EcsParameters_CapacityProviderStrategy <CapacityProviderStrategyItem[]>
-Description <String>
-EventBridgeParameters_DetailType <String>
-EcsParameters_EnableECSManagedTag <Boolean>
-EcsParameters_EnableExecuteCommand <Boolean>
-EndDate <DateTime>
-EcsParameters_Group <String>
-GroupName <String>
-Target_Input <String>
-KmsKeyArn <String>
-EcsParameters_LaunchType <LaunchType>
-RetryPolicy_MaximumEventAgeInSecond <Int32>
-RetryPolicy_MaximumRetryAttempt <Int32>
-FlexibleTimeWindow_MaximumWindowInMinute <Int32>
-SqsParameters_MessageGroupId <String>
-FlexibleTimeWindow_Mode <FlexibleTimeWindowMode>
-KinesisParameters_PartitionKey <String>
-SageMakerPipelineParameters_PipelineParameterList <SageMakerPipelineParameter[]>
-EcsParameters_PlacementConstraint <PlacementConstraint[]>
-EcsParameters_PlacementStrategy <PlacementStrategy[]>
-EcsParameters_PlatformVersion <String>
-EcsParameters_PropagateTag <PropagateTags>
-EcsParameters_ReferenceId <String>
-Target_RoleArn <String>
-ScheduleExpression <String>
-ScheduleExpressionTimezone <String>
-AwsvpcConfiguration_SecurityGroup <String[]>
-EventBridgeParameters_Source <String>
-StartDate <DateTime>
-State <ScheduleState>
-AwsvpcConfiguration_Subnet <String[]>
-EcsParameters_Tag <Hashtable[]>
-EcsParameters_TaskCount <Int32>
-EcsParameters_TaskDefinitionArn <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSchedulerConfig>

Description

Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update. Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters for your UpdateSchedule call.

Parameters

-ActionAfterCompletion <ActionAfterCompletion>
Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_NetworkConfiguration_AwsvpcConfiguration_AssignPublicIp
-AwsvpcConfiguration_SecurityGroup <String[]>
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_NetworkConfiguration_AwsvpcConfiguration_SecurityGroups
-AwsvpcConfiguration_Subnet <String[]>
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_NetworkConfiguration_AwsvpcConfiguration_Subnets
-ClientConfig <AmazonSchedulerConfig>
Amazon.PowerShell.Cmdlets.SCH.AmazonSchedulerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeadLetterConfig_Arn <String>
The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_DeadLetterConfig_Arn
-Description <String>
The description you specify for the schedule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EcsParameters_CapacityProviderStrategy <CapacityProviderStrategyItem[]>
The capacity provider strategy to use for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_CapacityProviderStrategy
-EcsParameters_EnableECSManagedTag <Boolean>
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_EnableECSManagedTags
-EcsParameters_EnableExecuteCommand <Boolean>
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_EnableExecuteCommand
-EcsParameters_Group <String>
Specifies an ECS task group for the task. The maximum length is 255 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_Group
-EcsParameters_LaunchType <LaunchType>
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_LaunchType
-EcsParameters_PlacementConstraint <PlacementConstraint[]>
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_PlacementConstraints
-EcsParameters_PlacementStrategy <PlacementStrategy[]>
The task placement strategy for a task or service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_PlacementStrategy
-EcsParameters_PlatformVersion <String>
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_PlatformVersion
-EcsParameters_PropagateTag <PropagateTags>
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_PropagateTags
-EcsParameters_ReferenceId <String>
The reference ID to use for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_ReferenceId
-EcsParameters_Tag <Hashtable[]>
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see RunTask in the Amazon ECS API Reference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_Tags
-EcsParameters_TaskCount <Int32>
The number of tasks to create based on TaskDefinition. The default is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_TaskCount
-EcsParameters_TaskDefinitionArn <String>
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EcsParameters_TaskDefinitionArn
-EndDate <DateTime>
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventBridgeParameters_DetailType <String>
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EventBridgeParameters_DetailType
-EventBridgeParameters_Source <String>
The source of the event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_EventBridgeParameters_Source
-FlexibleTimeWindow_MaximumWindowInMinute <Int32>
The maximum time window during which a schedule can be invoked.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlexibleTimeWindow_MaximumWindowInMinutes
-FlexibleTimeWindow_Mode <FlexibleTimeWindowMode>
Determines whether the schedule is invoked within a flexible time window.
Required?True
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)
-GroupName <String>
The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KinesisParameters_PartitionKey <String>
Specifies the shard to which EventBridge Scheduler sends the event. For more information, see Amazon Kinesis Data Streams terminology and concepts in the Amazon Kinesis Streams Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_KinesisParameters_PartitionKey
-KmsKeyArn <String>
The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the schedule that you are updating.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RetryPolicy_MaximumEventAgeInSecond <Int32>
The maximum amount of time, in seconds, to continue to make retry attempts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_RetryPolicy_MaximumEventAgeInSeconds
-RetryPolicy_MaximumRetryAttempt <Int32>
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_RetryPolicy_MaximumRetryAttempts
-SageMakerPipelineParameters_PipelineParameterList <SageMakerPipelineParameter[]>
List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_SageMakerPipelineParameters_PipelineParameterList
-ScheduleExpression <String>
The expression that defines when the schedule runs. The following formats are supported.
  • at expression - at(yyyy-mm-ddThh:mm:ss)
  • rate expression - rate(value unit)
  • cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year). A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduleExpressionTimezone <String>
The timezone in which the scheduling expression is evaluated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ScheduleArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Scheduler.Model.UpdateScheduleResponse). Specifying the name of a property of type Amazon.Scheduler.Model.UpdateScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SqsParameters_MessageGroupId <String>
The FIFO message group ID to use as the target.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_SqsParameters_MessageGroupId
-StartDate <DateTime>
The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-State <ScheduleState>
Specifies whether the schedule is enabled or disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Target_Arn <String>
The Amazon Resource Name (ARN) of the target.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Target_Input <String>
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Target_RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
Required?True
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

System.String or Amazon.Scheduler.Model.UpdateScheduleResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Scheduler.Model.UpdateScheduleResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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