JobSummary
The job summary.
Contents
- completedAt
-
The time, in seconds since the epoch, when the job completed.
Type: Timestamp
Required: No
- createdAt
-
The time, in seconds since the epoch, when the job was created.
Type: Timestamp
Required: No
- isConcurrent
-
Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.
Type: Boolean
Required: No
- jobArn
-
The job ARN.
Type: String
Required: No
- jobId
-
The unique identifier you assigned to this job when it was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: No
- lastUpdatedAt
-
The time, in seconds since the epoch, when the job was last updated.
Type: Timestamp
Required: No
- status
-
The job summary status.
Type: String
Valid Values:
IN_PROGRESS | CANCELED | COMPLETED | DELETION_IN_PROGRESS | SCHEDULEDRequired: No
- targetSelection
-
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
Note
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
Type: String
Valid Values:
CONTINUOUS | SNAPSHOTRequired: No
- thingGroupId
-
The ID of the thing group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9\-]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
