Table of Contents
IoTJobsDataPlane.Client¶A low-level client representing AWS IoT Jobs Data Plane
AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.
To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.
AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job
import boto3
client = boto3.client('iot-jobs-data')
These are the available methods:
can_paginate()close()describe_job_execution()get_paginator()get_pending_job_executions()get_waiter()start_next_pending_job_execution()update_job_execution()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
describe_job_execution(**kwargs)¶Gets details of a job execution.
See also: AWS API Documentation
Request Syntax
response = client.describe_job_execution(
jobId='string',
thingName='string',
includeJobDocument=True|False,
executionNumber=123
)
[REQUIRED]
The unique identifier assigned to this job when it was created.
[REQUIRED]
The thing name associated with the device the job execution is running on.
dict
Response Syntax
{
'execution': {
'jobId': 'string',
'thingName': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
'statusDetails': {
'string': 'string'
},
'queuedAt': 123,
'startedAt': 123,
'lastUpdatedAt': 123,
'approximateSecondsBeforeTimedOut': 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.
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.
approximateSecondsBeforeTimedOut (integer) --
The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT .
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.
Exceptions
IoTJobsDataPlane.Client.exceptions.InvalidRequestExceptionIoTJobsDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTJobsDataPlane.Client.exceptions.ThrottlingExceptionIoTJobsDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTJobsDataPlane.Client.exceptions.CertificateValidationExceptionIoTJobsDataPlane.Client.exceptions.TerminalStateExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_pending_job_executions(**kwargs)¶Gets the list of all jobs for a thing that are not in a terminal status.
See also: AWS API Documentation
Request Syntax
response = client.get_pending_job_executions(
thingName='string'
)
[REQUIRED]
The name of the thing that is executing the job.
{
'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
A list of JobExecutionSummary objects with status IN_PROGRESS.
Contains a subset of information about a job execution.
The unique identifier you assigned to this job when it was created.
The time, in milliseconds since the epoch, when the job execution was enqueued.
The time, in milliseconds since the epoch, when the job execution started.
The time, in milliseconds since the epoch, when the job execution was last updated.
The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.
A number that identifies a particular job execution on a particular device.
A list of JobExecutionSummary objects with status QUEUED.
Contains a subset of information about a job execution.
The unique identifier you assigned to this job when it was created.
The time, in milliseconds since the epoch, when the job execution was enqueued.
The time, in milliseconds since the epoch, when the job execution started.
The time, in milliseconds since the epoch, when the job execution was last updated.
The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.
A number that identifies a particular job execution on a particular device.
Exceptions
IoTJobsDataPlane.Client.exceptions.InvalidRequestExceptionIoTJobsDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTJobsDataPlane.Client.exceptions.ThrottlingExceptionIoTJobsDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTJobsDataPlane.Client.exceptions.CertificateValidationExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
start_next_pending_job_execution(**kwargs)¶Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
See also: AWS API Documentation
Request Syntax
response = client.start_next_pending_job_execution(
thingName='string',
statusDetails={
'string': 'string'
},
stepTimeoutInMinutes=123
)
[REQUIRED]
The name of the thing associated with the device.
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
UpdateJobExecution , setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes ) the job execution status will be automatically set to TIMED_OUT . Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created ( CreateJob using field timeoutConfig ).dict
Response Syntax
{
'execution': {
'jobId': 'string',
'thingName': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
'statusDetails': {
'string': 'string'
},
'queuedAt': 123,
'startedAt': 123,
'lastUpdatedAt': 123,
'approximateSecondsBeforeTimedOut': 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.
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.
approximateSecondsBeforeTimedOut (integer) --
The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT .
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.
Exceptions
IoTJobsDataPlane.Client.exceptions.InvalidRequestExceptionIoTJobsDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTJobsDataPlane.Client.exceptions.ThrottlingExceptionIoTJobsDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTJobsDataPlane.Client.exceptions.CertificateValidationExceptionupdate_job_execution(**kwargs)¶Updates the status of a job execution.
See also: AWS API Documentation
Request Syntax
response = client.update_job_execution(
jobId='string',
thingName='string',
status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
statusDetails={
'string': 'string'
},
stepTimeoutInMinutes=123,
expectedVersion=123,
includeJobExecutionState=True|False,
includeJobDocument=True|False,
executionNumber=123
)
[REQUIRED]
The unique identifier assigned to this job when it was created.
[REQUIRED]
The name of the thing associated with the device.
[REQUIRED]
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
UpdateJobExecution , setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT . Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created ( CreateJob using field timeoutConfig ).dict
Response Syntax
{
'executionState': {
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'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.
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.
Exceptions
IoTJobsDataPlane.Client.exceptions.InvalidRequestExceptionIoTJobsDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTJobsDataPlane.Client.exceptions.ThrottlingExceptionIoTJobsDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTJobsDataPlane.Client.exceptions.CertificateValidationExceptionIoTJobsDataPlane.Client.exceptions.InvalidStateTransitionExceptionThe available paginators are: