AWS.Tools.Scheduler.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Scheduler</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SCH.AddSCHResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.AddSCHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.AddSCHResourceTagCmdlet.Tag"> <summary> <para> <para>The list of tags to associate with the schedule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.AddSCHResourceTagCmdlet.Select"> <summary> 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.Scheduler.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.AddSCHResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.AddSCHResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.GetSCHResourceTagCmdlet"> <summary> Lists the tags associated with the Scheduler resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the EventBridge Scheduler resource for which you want to view tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Scheduler.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Scheduler.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleCmdlet"> <summary> Retrieves the specified schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleCmdlet.GroupName"> <summary> <para> <para>The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleCmdlet.Name"> <summary> <para> <para>The name of the schedule to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Scheduler.Model.GetScheduleResponse). Specifying the name of a property of type Amazon.Scheduler.Model.GetScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupCmdlet"> <summary> Retrieves the specified schedule group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupCmdlet.Name"> <summary> <para> <para>The name of the schedule group to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Scheduler.Model.GetScheduleGroupResponse). Specifying the name of a property of type Amazon.Scheduler.Model.GetScheduleGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupListCmdlet"> <summary> Returns a paginated list of your schedule groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupListCmdlet.NamePrefix"> <summary> <para> <para>The name prefix that you can use to return a filtered list of your schedule groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupListCmdlet.MaxResult"> <summary> <para> <para>If specified, limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> which you can use in a subsequent operation to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupListCmdlet.NextToken"> <summary> <para> <para>The token returned by a previous call to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScheduleGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Scheduler.Model.ListScheduleGroupsResponse). Specifying the name of a property of type Amazon.Scheduler.Model.ListScheduleGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NamePrefix parameter. The -PassThru parameter is deprecated, use -Select '^NamePrefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet"> <summary> Returns a paginated list of your EventBridge Scheduler schedules. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet.GroupName"> <summary> <para> <para>If specified, only lists the schedules whose associated schedule group matches the given filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet.NamePrefix"> <summary> <para> <para>Schedule name prefix to return the filtered list of resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet.State"> <summary> <para> <para>If specified, only lists the schedules whose current state matches the given filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet.MaxResult"> <summary> <para> <para>If specified, limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> which you can use in a subsequent operation to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet.NextToken"> <summary> <para> <para>The token returned by a previous call to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schedules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Scheduler.Model.ListSchedulesResponse). Specifying the name of a property of type Amazon.Scheduler.Model.ListSchedulesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.GetSCHScheduleListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet"> <summary> Creates the specified schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.Target_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.DeadLetterConfig_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.AwsvpcConfiguration_AssignPublicIp"> <summary> <para> <para>Specifies whether the task's elastic network interface receives a public IP address. You can specify <code>ENABLED</code> only when <code>LaunchType</code> in <code>EcsParameters</code> is set to <code>FARGATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_CapacityProviderStrategy"> <summary> <para> <para>The capacity provider strategy to use for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.Description"> <summary> <para> <para>The description you specify for the schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EventBridgeParameters_DetailType"> <summary> <para> <para>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_EnableECSManagedTag"> <summary> <para> <para>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a> in the <i>Amazon ECS Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_EnableExecuteCommand"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EndDate"> <summary> <para> <para>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 <code>EndDate</code> you specify. EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_Group"> <summary> <para> <para>Specifies an ECS task group for the task. The maximum length is 255 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.GroupName"> <summary> <para> <para>The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.Target_Input"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_LaunchType"> <summary> <para> <para>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 <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html">AWS Fargate on Amazon ECS</a> in the <i>Amazon ECS Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.RetryPolicy_MaximumEventAgeInSecond"> <summary> <para> <para>The maximum amount of time, in seconds, to continue to make retry attempts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.RetryPolicy_MaximumRetryAttempt"> <summary> <para> <para>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 <code>MaximumEventAgeInSeconds</code> is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.FlexibleTimeWindow_MaximumWindowInMinute"> <summary> <para> <para>The maximum time window during which a schedule can be invoked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.SqsParameters_MessageGroupId"> <summary> <para> <para>The FIFO message group ID to use as the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.FlexibleTimeWindow_Mode"> <summary> <para> <para>Determines whether the schedule is invoked within a flexible time window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.Name"> <summary> <para> <para>The name of the schedule that you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.KinesisParameters_PartitionKey"> <summary> <para> <para>Specifies the shard to which EventBridge Scheduler sends the event. For more information, see <a href="https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html">Amazon Kinesis Data Streams terminology and concepts</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.SageMakerPipelineParameters_PipelineParameterList"> <summary> <para> <para>List of parameter names and values to use when executing the SageMaker Model Building Pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_PlacementConstraint"> <summary> <para> <para>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).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_PlacementStrategy"> <summary> <para> <para>The task placement strategy for a task or service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_PlatformVersion"> <summary> <para> <para>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <code>1.1.0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_PropagateTag"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html"><code>TagResource</code></a> API action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_ReferenceId"> <summary> <para> <para>The reference ID to use for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.Target_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.ScheduleExpression"> <summary> <para> <para> The expression that defines when the schedule runs. The following formats are supported. </para><ul><li><para><code>at</code> expression - <code>at(yyyy-mm-ddThh:mm:ss)</code></para></li><li><para><code>rate</code> expression - <code>rate(unit value)</code></para></li><li><para><code>cron</code> expression - <code>cron(fields)</code></para></li></ul><para> You can use <code>at</code> 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 <code>rate</code> and <code>cron</code> 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. </para><para> A <code>cron</code> expression consists of six fields separated by white spaces: <code>(minutes hours day_of_month month day_of_week year)</code>. </para><para> A <code>rate</code> expression consists of a <i>value</i> as a positive integer, and a <i>unit</i> with the following options: <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code></para><para> For more information and examples, see <a href="https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.ScheduleExpressionTimezone"> <summary> <para> <para>The timezone in which the scheduling expression is evaluated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.AwsvpcConfiguration_SecurityGroup"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EventBridgeParameters_Source"> <summary> <para> <para>The source of the event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.StartDate"> <summary> <para> <para>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 <code>StartDate</code> you specify. EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.State"> <summary> <para> <para>Specifies whether the schedule is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.AwsvpcConfiguration_Subnet"> <summary> <para> <para>Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_Tag"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html"><code>RunTask</code></a> in the <i>Amazon ECS API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_TaskCount"> <summary> <para> <para>The number of tasks to create based on <code>TaskDefinition</code>. The default is <code>1</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.EcsParameters_TaskDefinitionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.ClientToken"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.Select"> <summary> 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.CreateScheduleResponse). Specifying the name of a property of type Amazon.Scheduler.Model.CreateScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleGroupCmdlet"> <summary> Creates the specified schedule group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleGroupCmdlet.Name"> <summary> <para> <para>The name of the schedule group that you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleGroupCmdlet.Tag"> <summary> <para> <para>The list of tags to associate with the schedule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleGroupCmdlet.ClientToken"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScheduleGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Scheduler.Model.CreateScheduleGroupResponse). Specifying the name of a property of type Amazon.Scheduler.Model.CreateScheduleGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.NewSCHScheduleGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHResourceTagCmdlet"> <summary> Removes one or more tags from the specified EventBridge Scheduler schedule group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHResourceTagCmdlet.Select"> <summary> 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.Scheduler.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleCmdlet"> <summary> Deletes the specified schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleCmdlet.GroupName"> <summary> <para> <para>The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleCmdlet.Name"> <summary> <para> <para>The name of the schedule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleCmdlet.ClientToken"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleCmdlet.Select"> <summary> 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.Scheduler.Model.DeleteScheduleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleGroupCmdlet"> <summary> Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a <code>DELETING</code> state until all of its associated schedules are deleted. Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets until the schedule group and its associated schedules are deleted. <note><para> This operation is eventually consistent. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleGroupCmdlet.Name"> <summary> <para> <para>The name of the schedule group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleGroupCmdlet.ClientToken"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleGroupCmdlet.Select"> <summary> 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.Scheduler.Model.DeleteScheduleGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.RemoveSCHScheduleGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet"> <summary> Updates the specified schedule. When you call <code>UpdateSchedule</code>, 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. <para> Before calling this operation, we recommend that you call the <code>GetSchedule</code> API operation and make a note of all optional parameters for your <code>UpdateSchedule</code> call. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.Target_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.DeadLetterConfig_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.AwsvpcConfiguration_AssignPublicIp"> <summary> <para> <para>Specifies whether the task's elastic network interface receives a public IP address. You can specify <code>ENABLED</code> only when <code>LaunchType</code> in <code>EcsParameters</code> is set to <code>FARGATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_CapacityProviderStrategy"> <summary> <para> <para>The capacity provider strategy to use for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.Description"> <summary> <para> <para>The description you specify for the schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EventBridgeParameters_DetailType"> <summary> <para> <para>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_EnableECSManagedTag"> <summary> <para> <para>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a> in the <i>Amazon ECS Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_EnableExecuteCommand"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EndDate"> <summary> <para> <para>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 <code>EndDate</code> you specify. EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_Group"> <summary> <para> <para>Specifies an ECS task group for the task. The maximum length is 255 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.GroupName"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.Target_Input"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.KmsKeyArn"> <summary> <para> <para>The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_LaunchType"> <summary> <para> <para>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 <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html">AWS Fargate on Amazon ECS</a> in the <i>Amazon ECS Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.RetryPolicy_MaximumEventAgeInSecond"> <summary> <para> <para>The maximum amount of time, in seconds, to continue to make retry attempts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.RetryPolicy_MaximumRetryAttempt"> <summary> <para> <para>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 <code>MaximumEventAgeInSeconds</code> is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.FlexibleTimeWindow_MaximumWindowInMinute"> <summary> <para> <para>The maximum time window during which a schedule can be invoked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.SqsParameters_MessageGroupId"> <summary> <para> <para>The FIFO message group ID to use as the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.FlexibleTimeWindow_Mode"> <summary> <para> <para>Determines whether the schedule is invoked within a flexible time window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.Name"> <summary> <para> <para>The name of the schedule that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.KinesisParameters_PartitionKey"> <summary> <para> <para>Specifies the shard to which EventBridge Scheduler sends the event. For more information, see <a href="https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html">Amazon Kinesis Data Streams terminology and concepts</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.SageMakerPipelineParameters_PipelineParameterList"> <summary> <para> <para>List of parameter names and values to use when executing the SageMaker Model Building Pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_PlacementConstraint"> <summary> <para> <para>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).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_PlacementStrategy"> <summary> <para> <para>The task placement strategy for a task or service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_PlatformVersion"> <summary> <para> <para>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <code>1.1.0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_PropagateTag"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html"><code>TagResource</code></a> API action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_ReferenceId"> <summary> <para> <para>The reference ID to use for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.Target_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.ScheduleExpression"> <summary> <para> <para> The expression that defines when the schedule runs. The following formats are supported. </para><ul><li><para><code>at</code> expression - <code>at(yyyy-mm-ddThh:mm:ss)</code></para></li><li><para><code>rate</code> expression - <code>rate(unit value)</code></para></li><li><para><code>cron</code> expression - <code>cron(fields)</code></para></li></ul><para> You can use <code>at</code> 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 <code>rate</code> and <code>cron</code> 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. </para><para> A <code>cron</code> expression consists of six fields separated by white spaces: <code>(minutes hours day_of_month month day_of_week year)</code>. </para><para> A <code>rate</code> expression consists of a <i>value</i> as a positive integer, and a <i>unit</i> with the following options: <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code></para><para> For more information and examples, see <a href="https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.ScheduleExpressionTimezone"> <summary> <para> <para>The timezone in which the scheduling expression is evaluated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.AwsvpcConfiguration_SecurityGroup"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EventBridgeParameters_Source"> <summary> <para> <para>The source of the event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.StartDate"> <summary> <para> <para>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 <code>StartDate</code> you specify. EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.State"> <summary> <para> <para>Specifies whether the schedule is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.AwsvpcConfiguration_Subnet"> <summary> <para> <para>Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_Tag"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html"><code>RunTask</code></a> in the <i>Amazon ECS API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_TaskCount"> <summary> <para> <para>The number of tasks to create based on <code>TaskDefinition</code>. The default is <code>1</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.EcsParameters_TaskDefinitionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.ClientToken"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCH.UpdateSCHScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |