Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.
Contents
- endBehavior
-
Specifies the end behavior for all job executions after a job reaches the selected
endTime. IfendTimeis not selected when creating the job, thenendBehaviordoes not apply.Type: String
Valid Values:
STOP_ROLLOUT | CANCEL | FORCE_CANCELRequired: No
- endTime
-
The time a job will stop rollout of the job document to all devices in the target group for a job. The
endTimemust take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration betweenstartTimeandendTimeis thirty minutes. The maximum duration betweenstartTimeandendTimeis two years. The date and time format for theendTimeis YYYY-MM-DD for the date and HH:MM for the time.For more information on the syntax for
endTimewhen using an API command or the AWS Command Line Interface, see Timestamp.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- maintenanceWindows
-
An optional configuration within the
SchedulingConfigto setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.Type: Array of MaintenanceWindow objects
Required: No
- startTime
-
The time a job will begin rollout of the job document to all devices in the target group for a job. The
startTimecan be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for thestartTimeis YYYY-MM-DD for the date and HH:MM for the time.For more information on the syntax for
startTimewhen using an API command or the AWS Command Line Interface, see Timestamp.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
