AWS IoT Jobs Data Plane

2018/10/08 - AWS IoT Jobs Data Plane - 3 updated api methods

Changes  Update iot-jobs-data client to latest version

DescribeJobExecution (updated) Link ¶
Changes (response) 
{'execution': {'approximateSecondsBeforeTimedOut': 'long',
               'status': {'TIMED_OUT'}}}

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
)
type jobId:

string

param jobId:

[REQUIRED]

The unique identifier assigned to this job when it was created.

type thingName:

string

param thingName:

[REQUIRED]

The thing name associated with the device the job execution is running on.

type includeJobDocument:

boolean

param includeJobDocument:

Optional. When set to true, the response contains the job document. The default is false.

type executionNumber:

integer

param executionNumber:

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

rtype:

dict

returns:

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.

        • (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.

      • 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.

StartNextPendingJobExecution (updated) Link ¶
Changes (request, response)
Request 
{'stepTimeoutInMinutes': 'long'}
Response 
{'execution': {'approximateSecondsBeforeTimedOut': 'long',
               'status': {'TIMED_OUT'}}}

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'
    },
    stepTimeoutInMinutes=123
)
type thingName:

string

param thingName:

[REQUIRED]

The name of the thing associated with the device.

type statusDetails:

dict

param statusDetails:

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

  • (string) --

    • (string) --

type stepTimeoutInMinutes:

integer

param stepTimeoutInMinutes:

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling 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).

rtype:

dict

returns:

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.

        • (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.

      • 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.

UpdateJobExecution (updated) Link ¶
Changes (request, response)
Request 
{'status': {'TIMED_OUT'}, 'stepTimeoutInMinutes': 'long'}
Response 
{'executionState': {'status': {'TIMED_OUT'}}}

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'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
    statusDetails={
        'string': 'string'
    },
    stepTimeoutInMinutes=123,
    expectedVersion=123,
    includeJobExecutionState=True|False,
    includeJobDocument=True|False,
    executionNumber=123
)
type jobId:

string

param jobId:

[REQUIRED]

The unique identifier assigned to this job when it was created.

type thingName:

string

param thingName:

[REQUIRED]

The name of the thing associated with the device.

type status:

string

param status:

[REQUIRED]

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

type statusDetails:

dict

param statusDetails:

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

  • (string) --

    • (string) --

type stepTimeoutInMinutes:

integer

param stepTimeoutInMinutes:

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling 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).

type expectedVersion:

integer

param expectedVersion:

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.)

type includeJobExecutionState:

boolean

param includeJobExecutionState:

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

type includeJobDocument:

boolean

param includeJobDocument:

Optional. When set to true, the response contains the job document. The default is false.

type executionNumber:

integer

param executionNumber:

Optional. A number that identifies a particular job execution on a particular device.

rtype:

dict

returns:

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.

        • (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.