Skip to content

/AWS1/CL_IOTSCHEDULINGCONFIG

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_starttime TYPE /AWS1/IOTSTRINGDATETIME /AWS1/IOTSTRINGDATETIME

The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can 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 the startTime is YYYY-MM-DD for the date and HH:MM for the time.

For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.

iv_endtime TYPE /AWS1/IOTSTRINGDATETIME /AWS1/IOTSTRINGDATETIME

The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must 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 between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.

For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.

iv_endbehavior TYPE /AWS1/IOTJOBENDBEHAVIOR /AWS1/IOTJOBENDBEHAVIOR

Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

it_maintenancewindows TYPE /AWS1/CL_IOTMAINTENANCEWINDOW=>TT_MAINTENANCEWINDOWS TT_MAINTENANCEWINDOWS

An optional configuration within the SchedulingConfig to 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.

Queryable Attributes

startTime

The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can 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 the startTime is YYYY-MM-DD for the date and HH:MM for the time.

For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

endTime

The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must 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 between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.

For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.

Accessible with the following methods

Method Description
GET_ENDTIME() Getter for ENDTIME, with configurable default
ASK_ENDTIME() Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME() Determine if ENDTIME has a value

endBehavior

Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

Accessible with the following methods

Method Description
GET_ENDBEHAVIOR() Getter for ENDBEHAVIOR, with configurable default
ASK_ENDBEHAVIOR() Getter for ENDBEHAVIOR w/ exceptions if field has no value
HAS_ENDBEHAVIOR() Determine if ENDBEHAVIOR has a value

maintenanceWindows

An optional configuration within the SchedulingConfig to 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.

Accessible with the following methods

Method Description
GET_MAINTENANCEWINDOWS() Getter for MAINTENANCEWINDOWS, with configurable default
ASK_MAINTENANCEWINDOWS() Getter for MAINTENANCEWINDOWS w/ exceptions if field has no
HAS_MAINTENANCEWINDOWS() Determine if MAINTENANCEWINDOWS has a value