Skip to content

ExportJobResponse

Source code in docs_src/capo_pinpoint/types/export_job_response.py
class ExportJobResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that's associated with the export job.</p>"""
    completed_pieces: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.</p>"""
    completion_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the export job was completed.</p>"""
    creation_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the export job was created.</p>"""
    definition: NotRequired["capo_pinpoint.types.export_job_resource.ExportJobResource"]
    """<p>The resource settings that apply to the export job.</p>"""
    failed_pieces: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.</p>"""
    failures: NotRequired["capo_pinpoint.types.list_of__string.ListOf__string"]
    """<p>An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.</p>"""
    id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the export job.</p>"""
    job_status: NotRequired["capo_pinpoint.types.job_status.JobStatus"]
    """<p>The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.</p>"""
    total_failures: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.</p>"""
    total_pieces: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.</p>"""
    total_processed: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The total number of endpoint definitions that were processed by the export job.</p>"""
    type: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The job type. This value is EXPORT for export jobs.</p>"""

application_id instance-attribute

application_id: NotRequired[__string]

The unique identifier for the application that's associated with the export job.

completed_pieces instance-attribute

completed_pieces: NotRequired[__integer]

The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

completion_date instance-attribute

completion_date: NotRequired[__string]

The date, in ISO 8601 format, when the export job was completed.

creation_date instance-attribute

creation_date: NotRequired[__string]

The date, in ISO 8601 format, when the export job was created.

definition instance-attribute

definition: NotRequired[ExportJobResource]

The resource settings that apply to the export job.

failed_pieces instance-attribute

failed_pieces: NotRequired[__integer]

The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

failures instance-attribute

failures: NotRequired[ListOf__string]

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

id instance-attribute

id: NotRequired[__string]

The unique identifier for the export job.

job_status instance-attribute

job_status: NotRequired[JobStatus]

The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

total_failures instance-attribute

total_failures: NotRequired[__integer]

The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

total_pieces instance-attribute

total_pieces: NotRequired[__integer]

The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

total_processed instance-attribute

total_processed: NotRequired[__integer]

The total number of endpoint definitions that were processed by the export job.

type instance-attribute

type: NotRequired[__string]

The job type. This value is EXPORT for export jobs.