JobDescriptor ¶

class JobDescriptor(TypedDict, closed=True):
    job_id: NotRequired["capo_s3_control.types.job_id.JobId"]
    """<p>The ID for the specified job.</p>"""
    confirmation_required: NotRequired[
        "capo_s3_control.types.confirmation_required.ConfirmationRequired"
    ]
    """<p>Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.</p>"""
    description: NotRequired[
        "capo_s3_control.types.non_empty_max_length256_string.NonEmptyMaxLength256String"
    ]
    """<p>The description for this job, if one was provided in this job's <code>Create Job</code> request.</p>"""
    job_arn: NotRequired["capo_s3_control.types.job_arn.JobArn"]
    """<p>The Amazon Resource Name (ARN) for this job.</p>"""
    status: NotRequired["capo_s3_control.types.job_status.JobStatus"]
    """<p>The current status of the specified job.</p>"""
    manifest: NotRequired["capo_s3_control.types.job_manifest.JobManifest"]
    """<p>The configuration information for the specified job's manifest object.</p>"""
    operation: NotRequired["capo_s3_control.types.job_operation.JobOperation"]
    """<p>The operation that the specified job is configured to run on the objects listed in the manifest.</p>"""
    priority: "capo_s3_control.types.job_priority.JobPriority"
    """<p>The priority of the specified job.</p>"""
    progress_summary: NotRequired[
        "capo_s3_control.types.job_progress_summary.JobProgressSummary"
    ]
    """<p>Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.</p>"""
    status_update_reason: NotRequired[
        "capo_s3_control.types.job_status_update_reason.JobStatusUpdateReason"
    ]
    """<p>The reason for updating the job.</p>"""
    failure_reasons: NotRequired[
        "capo_s3_control.types.job_failure_list.JobFailureList"
    ]
    """<p>If the specified job failed, this field contains information describing the failure.</p>"""
    report: NotRequired["capo_s3_control.types.job_report.JobReport"]
    """<p>Contains the configuration information for the job-completion report if you requested one in the <code>Create Job</code> request.</p>"""
    creation_time: NotRequired[
        "capo_s3_control.types.job_creation_time.JobCreationTime"
    ]
    """<p>A timestamp indicating when this job was created.</p>"""
    termination_date: NotRequired[
        "capo_s3_control.types.job_termination_date.JobTerminationDate"
    ]
    """<p>A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.</p>"""
    role_arn: NotRequired["capo_s3_control.types.iam_role_arn.IAMRoleArn"]
    """<p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.</p>"""
    suspended_date: NotRequired["capo_s3_control.types.suspended_date.SuspendedDate"]
    """<p>The timestamp when this job was suspended, if it has been suspended.</p>"""
    suspended_cause: NotRequired["capo_s3_control.types.suspended_cause.SuspendedCause"]
    """<p>The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the <code>Suspended</code> state to await confirmation before running. After you confirm the job, it automatically exits the <code>Suspended</code> state.</p>"""
    manifest_generator: NotRequired[
        "capo_s3_control.types.job_manifest_generator.JobManifestGenerator"
    ]
    """<p>The manifest generator that was used to generate a job manifest for this job.</p>"""
    generated_manifest_descriptor: NotRequired[
        "capo_s3_control.types.s3_generated_manifest_descriptor.S3GeneratedManifestDescriptor"
    ]
    """<p>The attribute of the JobDescriptor containing details about the job's generated manifest.</p>"""