Skip to content

DescribeJobExecutionRequest

Source code in docs_src/capo_iot_jobs_data_plane/types/describe_job_execution_request.py
class DescribeJobExecutionRequest(TypedDict, closed=True):
    job_id: "capo_iot_jobs_data_plane.types.describe_job_execution_job_id.DescribeJobExecutionJobId"
    """<p>The unique identifier assigned to this job when it was created.</p>"""
    thing_name: "capo_iot_jobs_data_plane.types.thing_name.ThingName"
    """<p>The thing name associated with the device the job execution is running on.</p>"""
    include_job_document: NotRequired[
        "capo_iot_jobs_data_plane.types.include_job_document.IncludeJobDocument"
    ]
    """<p>Optional. Unless set to false, the response contains the job document. The default is true.</p>"""
    execution_number: NotRequired[
        "capo_iot_jobs_data_plane.types.execution_number.ExecutionNumber"
    ]
    """<p>Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.</p>"""

execution_number instance-attribute

execution_number: NotRequired[ExecutionNumber]

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

include_job_document instance-attribute

include_job_document: NotRequired[IncludeJobDocument]

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

job_id instance-attribute

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

thing_name instance-attribute

thing_name: ThingName

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