2017/11/29 - AWS IoT Jobs Data Plane - 4 new api methods
Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
See also: AWS API Documentation
Request Syntax
client.start_next_pending_job_execution(
thingName='string',
statusDetails={
'string': 'string'
}
)
string
[REQUIRED]
The name of the thing associated with the device.
dict
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
(string) --
(string) --
dict
Response Syntax
{
'execution': {
'jobId': 'string',
'thingName': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
'statusDetails': {
'string': 'string'
},
'queuedAt': 123,
'startedAt': 123,
'lastUpdatedAt': 123,
'versionNumber': 123,
'executionNumber': 123,
'jobDocument': 'string'
}
}
Response Structure
(dict) --
execution (dict) --
A JobExecution object.
jobId (string) --
The unique identifier you assigned to this job when it was created.
thingName (string) --
The name of the thing that is executing the job.
status (string) --
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
statusDetails (dict) --
A collection of name/value pairs that describe the status of the job execution.
(string) --
(string) --
queuedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was enqueued.
startedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was started.
lastUpdatedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was last updated.
versionNumber (integer) --
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
executionNumber (integer) --
A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
jobDocument (string) --
The content of the job document.
Gets the list of all jobs for a thing that are not in a terminal status.
See also: AWS API Documentation
Request Syntax
client.get_pending_job_executions(
thingName='string'
)
string
[REQUIRED]
The name of the thing that is executing the job.
dict
Response Syntax
{
'inProgressJobs': [
{
'jobId': 'string',
'queuedAt': 123,
'startedAt': 123,
'lastUpdatedAt': 123,
'versionNumber': 123,
'executionNumber': 123
},
],
'queuedJobs': [
{
'jobId': 'string',
'queuedAt': 123,
'startedAt': 123,
'lastUpdatedAt': 123,
'versionNumber': 123,
'executionNumber': 123
},
]
}
Response Structure
(dict) --
inProgressJobs (list) --
A list of JobExecutionSummary objects with status IN_PROGRESS.
(dict) --
Contains a subset of information about a job execution.
jobId (string) --
The unique identifier you assigned to this job when it was created.
queuedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was enqueued.
startedAt (integer) --
The time, in milliseconds since the epoch, when the job execution started.
lastUpdatedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was last updated.
versionNumber (integer) --
The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.
executionNumber (integer) --
A number that identifies a particular job execution on a particular device.
queuedJobs (list) --
A list of JobExecutionSummary objects with status QUEUED.
(dict) --
Contains a subset of information about a job execution.
jobId (string) --
The unique identifier you assigned to this job when it was created.
queuedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was enqueued.
startedAt (integer) --
The time, in milliseconds since the epoch, when the job execution started.
lastUpdatedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was last updated.
versionNumber (integer) --
The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.
executionNumber (integer) --
A number that identifies a particular job execution on a particular device.
Updates the status of a job execution.
See also: AWS API Documentation
Request Syntax
client.update_job_execution(
jobId='string',
thingName='string',
status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
statusDetails={
'string': 'string'
},
expectedVersion=123,
includeJobExecutionState=True|False,
includeJobDocument=True|False,
executionNumber=123
)
string
[REQUIRED]
The unique identifier assigned to this job when it was created.
string
[REQUIRED]
The name of the thing associated with the device.
string
[REQUIRED]
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
dict
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
(string) --
(string) --
integer
Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
boolean
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
boolean
Optional. When set to true, the response contains the job document. The default is false.
integer
Optional. A number that identifies a particular job execution on a particular device.
dict
Response Syntax
{
'executionState': {
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
'statusDetails': {
'string': 'string'
},
'versionNumber': 123
},
'jobDocument': 'string'
}
Response Structure
(dict) --
executionState (dict) --
A JobExecutionState object.
status (string) --
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
statusDetails (dict) --
A collection of name/value pairs that describe the status of the job execution.
(string) --
(string) --
versionNumber (integer) --
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
jobDocument (string) --
The contents of the Job Documents.
Gets details of a job execution.
See also: AWS API Documentation
Request Syntax
client.describe_job_execution(
jobId='string',
thingName='string',
includeJobDocument=True|False,
executionNumber=123
)
string
[REQUIRED]
The unique identifier assigned to this job when it was created.
string
[REQUIRED]
The thing name associated with the device the job execution is running on.
boolean
Optional. When set to true, the response contains the job document. The default is false.
integer
Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.
dict
Response Syntax
{
'execution': {
'jobId': 'string',
'thingName': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
'statusDetails': {
'string': 'string'
},
'queuedAt': 123,
'startedAt': 123,
'lastUpdatedAt': 123,
'versionNumber': 123,
'executionNumber': 123,
'jobDocument': 'string'
}
}
Response Structure
(dict) --
execution (dict) --
Contains data about a job execution.
jobId (string) --
The unique identifier you assigned to this job when it was created.
thingName (string) --
The name of the thing that is executing the job.
status (string) --
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
statusDetails (dict) --
A collection of name/value pairs that describe the status of the job execution.
(string) --
(string) --
queuedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was enqueued.
startedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was started.
lastUpdatedAt (integer) --
The time, in milliseconds since the epoch, when the job execution was last updated.
versionNumber (integer) --
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
executionNumber (integer) --
A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
jobDocument (string) --
The content of the job document.