IoT / Client / describe_job_execution

describe_job_execution

IoT.Client.describe_job_execution(**kwargs)

Describes 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',
    executionNumber=123
)

Parameters:

• jobId (string) –

  [REQUIRED]

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

• thingName (string) –

  [REQUIRED]

  The name of the thing on which the job execution is running.

• executionNumber (integer) – A string (consisting of the digits “0” through “9” which is used to specify a particular job execution on a particular device.

Return type:

dict

Returns:

Response Syntax

{
    'execution': {
        'jobId': 'string',
        'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
        'forceCanceled': True|False,
        'statusDetails': {
            'detailsMap': {
                'string': 'string'
            }
        },
        'thingArn': 'string',
        'queuedAt': datetime(2015, 1, 1),
        'startedAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'executionNumber': 123,
        'versionNumber': 123,
        'approximateSecondsBeforeTimedOut': 123
    }
}

Response Structure

• (dict) –

  • execution (dict) –

    Information about the job execution.

    • jobId (string) –

      The unique identifier you assigned to the job when it was created.

    • status (string) –

      The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

    • forceCanceled (boolean) –

      Will be true if the job execution was canceled with the optional force parameter set to true.

    • statusDetails (dict) –

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

      • detailsMap (dict) –

        The job execution status.

        • (string) –

          • (string) –

    • thingArn (string) –

      The ARN of the thing on which the job execution is running.

    • queuedAt (datetime) –

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

    • startedAt (datetime) –

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

    • lastUpdatedAt (datetime) –

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

    • executionNumber (integer) –

      A string (consisting of the digits “0” through “9”) which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

    • versionNumber (integer) –

      The version of the job execution. Job execution versions are incremented each time they are updated by a device.

    • approximateSecondsBeforeTimedOut (integer) –

      The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

Exceptions

• IoT.Client.exceptions.InvalidRequestException

• IoT.Client.exceptions.ResourceNotFoundException

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.ServiceUnavailableException