Skip to content

CreateJobRequest

Source code in docs_src/capo_s3_control/types/create_job_request.py
class CreateJobRequest(TypedDict, closed=True):
    account_id: "capo_s3_control.types.account_id.AccountId"
    """<p>The Amazon Web Services account ID that creates the job.</p>"""
    confirmation_required: NotRequired[
        "capo_s3_control.types.confirmation_required.ConfirmationRequired"
    ]
    """<p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p>"""
    operation: "capo_s3_control.types.job_operation.JobOperation"
    """<p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    report: "capo_s3_control.types.job_report.JobReport"
    """<p>Configuration parameters for the optional job-completion report.</p>"""
    client_request_token: (
        "capo_s3_control.types.non_empty_max_length64_string.NonEmptyMaxLength64String"
    )
    """<p>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</p>"""
    manifest: NotRequired["capo_s3_control.types.job_manifest.JobManifest"]
    """<p>Configuration parameters for the manifest.</p>"""
    description: NotRequired[
        "capo_s3_control.types.non_empty_max_length256_string.NonEmptyMaxLength256String"
    ]
    """<p>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</p>"""
    priority: "capo_s3_control.types.job_priority.JobPriority"
    """<p>The numerical priority for this job. Higher numbers indicate higher priority.</p>"""
    role_arn: "capo_s3_control.types.iam_role_arn.IAMRoleArn"
    """<p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</p>"""
    tags: NotRequired["capo_s3_control.types.s3_tag_set.S3TagSet"]
    """<p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter. </p>"""
    manifest_generator: NotRequired[
        "capo_s3_control.types.job_manifest_generator.JobManifestGenerator"
    ]
    """<p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p>"""

account_id instance-attribute

account_id: AccountId

The Amazon Web Services account ID that creates the job.

client_request_token instance-attribute

client_request_token: NonEmptyMaxLength64String

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

confirmation_required instance-attribute

confirmation_required: NotRequired[ConfirmationRequired]

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

description instance-attribute

description: NotRequired[NonEmptyMaxLength256String]

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

manifest instance-attribute

manifest: NotRequired[JobManifest]

Configuration parameters for the manifest.

manifest_generator instance-attribute

manifest_generator: NotRequired[JobManifestGenerator]

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

operation instance-attribute

operation: JobOperation

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

priority instance-attribute

priority: JobPriority

The numerical priority for this job. Higher numbers indicate higher priority.

report instance-attribute

report: JobReport

Configuration parameters for the optional job-completion report.

role_arn instance-attribute

role_arn: IAMRoleArn

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

tags instance-attribute

tags: NotRequired[S3TagSet]

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.