Skip to content

JobSummary

Source code in docs_src/capo_endusermessaging/types/job_summary.py
class JobSummary(TypedDict, closed=True):
    job_id: "capo_endusermessaging.types.job_id.JobId"
    """<p>The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.</p>"""
    status: "capo_endusermessaging.types.job_status.JobStatus"
    """<p>The current lifecycle status of the job.</p>"""
    operation_type: "capo_endusermessaging.types.job_operation_type.JobOperationType"
    """<p>The type of mutating operation that created the job.</p>"""
    created_at: "datetime.datetime"
    """<p>The time when the resource was created, in Unix epoch time.</p>"""
    updated_at: "datetime.datetime"
    """<p>The time when the resource was last updated, in Unix epoch time.</p>"""
    brand_profile_id: NotRequired[
        "capo_endusermessaging.types.brand_profile_id_or_arn.BrandProfileIdOrArn"
    ]
    """<p>The brand profile that the job operates on. This value is absent for operations that create a brand profile.</p>"""
    error_code: NotRequired["capo_endusermessaging.types.job_error_code.JobErrorCode"]
    """<p>A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.</p>"""
    error_message: NotRequired[
        "capo_endusermessaging.types.job_error_message.JobErrorMessage"
    ]
    """<p>A human-readable description of why the job failed. This value is present only when the job status is FAILED.</p>"""
    resources: NotRequired[
        "capo_endusermessaging.types.job_resource_list.JobResourceList"
    ]
    """<p>The resources that were created or updated by the job.</p>"""

brand_profile_id instance-attribute

brand_profile_id: NotRequired[BrandProfileIdOrArn]

The brand profile that the job operates on. This value is absent for operations that create a brand profile.

created_at instance-attribute

created_at: datetime

The time when the resource was created, in Unix epoch time.

error_code instance-attribute

error_code: NotRequired[JobErrorCode]

A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

error_message instance-attribute

error_message: NotRequired[JobErrorMessage]

A human-readable description of why the job failed. This value is present only when the job status is FAILED.

job_id instance-attribute

job_id: JobId

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

operation_type instance-attribute

operation_type: JobOperationType

The type of mutating operation that created the job.

resources instance-attribute

resources: NotRequired[JobResourceList]

The resources that were created or updated by the job.

status instance-attribute

status: JobStatus

The current lifecycle status of the job.

updated_at instance-attribute

updated_at: datetime

The time when the resource was last updated, in Unix epoch time.