IoTJobsDataPlane / Client / describe_job_execution

describe_job_execution

IoTJobsDataPlane.Client.describe_job_execution(**kwargs)

Gets details of a job execution.

Requires permission to access the DescribeJobExecution action.

See also: AWS API Documentation

Request Syntax

response = client.describe_job_execution(
    jobId='string',
    thingName='string',
    includeJobDocument=True|False,
    executionNumber=123
)

Parameters:

• jobId (string) –

  [REQUIRED]

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

• thingName (string) –

  [REQUIRED]

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

• includeJobDocument (boolean) – Optional. Unless set to false, the response contains the job document. The default is true.

• executionNumber (integer) – Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

Return type:

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”, “TIMED_OUT”, “REJECTED”, or “REMOVED”.

    • statusDetails (dict) –

      A collection of name/value pairs that describe the status of the job execution.

      The maximum length of the value in the name/value pair is 1,024 characters.

      • (string) –

        • (string) –

    • queuedAt (integer) –

      The time, in seconds since the epoch, when the job execution was enqueued.

    • startedAt (integer) –

      The time, in seconds since the epoch, when the job execution was started.

    • lastUpdatedAt (integer) –

      The time, in seconds 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. The actual job execution timeout can occur up to 60 seconds later than the estimated duration.

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

• IoTJobsDataPlane.Client.exceptions.ResourceNotFoundException

• IoTJobsDataPlane.Client.exceptions.ThrottlingException

• IoTJobsDataPlane.Client.exceptions.ServiceUnavailableException

• IoTJobsDataPlane.Client.exceptions.CertificateValidationException

• IoTJobsDataPlane.Client.exceptions.TerminalStateException