IoT / Client / get_job_document

get_job_document#

IoT.Client.get_job_document(**kwargs)#

Gets a job document.

Requires permission to access the GetJobDocument action.

See also: AWS API Documentation

Request Syntax

response = client.get_job_document(
    jobId='string',
    beforeSubstitution=True|False
)
Parameters:
  • jobId (string) –

    [REQUIRED]

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

  • beforeSubstitution (boolean) – A flag that provides a view of the job document before and after the substitution parameters have been resolved with their exact values.

Return type:

dict

Returns:

Response Syntax

{
    'document': 'string'
}

Response Structure

  • (dict) –

    • document (string) –

      The job document content.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.ServiceUnavailableException