/AWS1/CL_IOTDESCRJOBTMPLRSP¶
DescribeJobTemplateResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_jobtemplatearn TYPE /AWS1/IOTJOBTEMPLATEARN /AWS1/IOTJOBTEMPLATEARN¶
The ARN of the job template.
iv_jobtemplateid TYPE /AWS1/IOTJOBTEMPLATEID /AWS1/IOTJOBTEMPLATEID¶
The unique identifier of the job template.
iv_description TYPE /AWS1/IOTJOBDESCRIPTION /AWS1/IOTJOBDESCRIPTION¶
A description of the job template.
iv_documentsource TYPE /AWS1/IOTJOBDOCUMENTSOURCE /AWS1/IOTJOBDOCUMENTSOURCE¶
An S3 link to the job document.
iv_document TYPE /AWS1/IOTJOBDOCUMENT /AWS1/IOTJOBDOCUMENT¶
The job document.
iv_createdat TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE¶
The time, in seconds since the epoch, when the job template was created.
io_presignedurlconfig TYPE REF TO /AWS1/CL_IOTPRESIGNEDURLCONFIG /AWS1/CL_IOTPRESIGNEDURLCONFIG¶
Configuration for pre-signed S3 URLs.
io_jobexecsrolloutconfig TYPE REF TO /AWS1/CL_IOTJOBEXECSRLOUTCFG /AWS1/CL_IOTJOBEXECSRLOUTCFG¶
Allows you to create a staged rollout of a job.
io_abortconfig TYPE REF TO /AWS1/CL_IOTABORTCONFIG /AWS1/CL_IOTABORTCONFIG¶
The criteria that determine when and how a job abort takes place.
io_timeoutconfig TYPE REF TO /AWS1/CL_IOTTIMEOUTCONFIG /AWS1/CL_IOTTIMEOUTCONFIG¶
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT.
io_jobexecutionsretryconfig TYPE REF TO /AWS1/CL_IOTJOBEXECSRETRYCFG /AWS1/CL_IOTJOBEXECSRETRYCFG¶
The configuration that determines how many retries are allowed for each failure type for a job.
it_maintenancewindows TYPE /AWS1/CL_IOTMAINTENANCEWINDOW=>TT_MAINTENANCEWINDOWS TT_MAINTENANCEWINDOWS¶
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
it_dstpackageversions TYPE /AWS1/CL_IOTDSTPACKAGEVRSS_W=>TT_DESTINATIONPACKAGEVERSIONS TT_DESTINATIONPACKAGEVERSIONS¶
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
Queryable Attributes¶
jobTemplateArn¶
The ARN of the job template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBTEMPLATEARN() |
Getter for JOBTEMPLATEARN, with configurable default |
ASK_JOBTEMPLATEARN() |
Getter for JOBTEMPLATEARN w/ exceptions if field has no valu |
HAS_JOBTEMPLATEARN() |
Determine if JOBTEMPLATEARN has a value |
jobTemplateId¶
The unique identifier of the job template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBTEMPLATEID() |
Getter for JOBTEMPLATEID, with configurable default |
ASK_JOBTEMPLATEID() |
Getter for JOBTEMPLATEID w/ exceptions if field has no value |
HAS_JOBTEMPLATEID() |
Determine if JOBTEMPLATEID has a value |
description¶
A description of the job template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
documentSource¶
An S3 link to the job document.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENTSOURCE() |
Getter for DOCUMENTSOURCE, with configurable default |
ASK_DOCUMENTSOURCE() |
Getter for DOCUMENTSOURCE w/ exceptions if field has no valu |
HAS_DOCUMENTSOURCE() |
Determine if DOCUMENTSOURCE has a value |
document¶
The job document.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENT() |
Getter for DOCUMENT, with configurable default |
ASK_DOCUMENT() |
Getter for DOCUMENT w/ exceptions if field has no value |
HAS_DOCUMENT() |
Determine if DOCUMENT has a value |
createdAt¶
The time, in seconds since the epoch, when the job template was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
presignedUrlConfig¶
Configuration for pre-signed S3 URLs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRESIGNEDURLCONFIG() |
Getter for PRESIGNEDURLCONFIG |
jobExecutionsRolloutConfig¶
Allows you to create a staged rollout of a job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBEXECSROLLOUTCONFIG() |
Getter for JOBEXECUTIONSROLLOUTCONFIG |
abortConfig¶
The criteria that determine when and how a job abort takes place.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ABORTCONFIG() |
Getter for ABORTCONFIG |
timeoutConfig¶
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIMEOUTCONFIG() |
Getter for TIMEOUTCONFIG |
jobExecutionsRetryConfig¶
The configuration that determines how many retries are allowed for each failure type for a job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBEXECUTIONSRETRYCONFIG() |
Getter for JOBEXECUTIONSRETRYCONFIG |
maintenanceWindows¶
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the 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 |
destinationPackageVersions¶
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DSTPACKAGEVERSIONS() |
Getter for DESTINATIONPACKAGEVERSIONS, with configurable def |
ASK_DSTPACKAGEVERSIONS() |
Getter for DESTINATIONPACKAGEVERSIONS w/ exceptions if field |
HAS_DSTPACKAGEVERSIONS() |
Determine if DESTINATIONPACKAGEVERSIONS has a value |