Skip to content

GetJobResponse

Source code in docs_src/capo_location/types/get_job_response.py
class GetJobResponse(TypedDict, closed=True):
    action: "capo_location.types.job_action.JobAction"
    """<p>Action performed by the job.</p>"""
    action_options: NotRequired[
        "capo_location.types.job_action_options.JobActionOptions"
    ]
    """<p>Additional options for configuring job action parameters.</p>"""
    created_at: "capo_location.types.timestamp.Timestamp"
    """<p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>"""
    ended_at: NotRequired["capo_location.types.timestamp.Timestamp"]
    """<p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>"""
    error: NotRequired["capo_location.types.job_error.JobError"]
    """<p>Error information if the job failed.</p>"""
    execution_role_arn: "capo_location.types.iam_role_arn.IamRoleArn"
    """<p>IAM role used for permissions when running the job.</p>"""
    input_options: "capo_location.types.job_input_options.JobInputOptions"
    """<p>Input configuration.</p>"""
    job_arn: "capo_location.types.geo_arn.GeoArn"
    """<p>Amazon Resource Name (ARN) of the specified job.</p>"""
    job_id: "capo_location.types.job_id.JobId"
    """<p>Unique job identifier.</p>"""
    name: NotRequired["capo_location.types.resource_name.ResourceName"]
    """<p>Job name (if provided during creation).</p>"""
    output_options: "capo_location.types.job_output_options.JobOutputOptions"
    """<p>Output configuration.</p>"""
    status: "capo_location.types.job_status.JobStatus"
    """<p>Current job status.</p>"""
    updated_at: "capo_location.types.timestamp.Timestamp"
    """<p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>"""
    tags: NotRequired["capo_location.types.tag_map.TagMap"]
    """<p>Tags and corresponding values associated with the specified job.</p>"""

action instance-attribute

action: JobAction

Action performed by the job.

action_options instance-attribute

action_options: NotRequired[JobActionOptions]

Additional options for configuring job action parameters.

created_at instance-attribute

created_at: Timestamp

Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

ended_at instance-attribute

ended_at: NotRequired[Timestamp]

Job completion time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss. Only returned for jobs in a terminal status: Completed | Failed | Cancelled.

error instance-attribute

error: NotRequired[JobError]

Error information if the job failed.

execution_role_arn instance-attribute

execution_role_arn: IamRoleArn

IAM role used for permissions when running the job.

input_options instance-attribute

input_options: JobInputOptions

Input configuration.

job_arn instance-attribute

job_arn: GeoArn

Amazon Resource Name (ARN) of the specified job.

job_id instance-attribute

job_id: JobId

Unique job identifier.

name instance-attribute

name: NotRequired[ResourceName]

Job name (if provided during creation).

output_options instance-attribute

output_options: JobOutputOptions

Output configuration.

status instance-attribute

status: JobStatus

Current job status.

tags instance-attribute

tags: NotRequired[TagMap]

Tags and corresponding values associated with the specified job.

updated_at instance-attribute

updated_at: Timestamp

Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.