create_job async ¶

async def create_job(
    self,
    account_id: "capo_s3_control.types.account_id.AccountId",
    operation: "capo_s3_control.types.job_operation.JobOperation",
    report: "capo_s3_control.types.job_report.JobReport",
    client_request_token: "capo_s3_control.types.non_empty_max_length64_string.NonEmptyMaxLength64String",
    priority: "capo_s3_control.types.job_priority.JobPriority",
    role_arn: "capo_s3_control.types.iam_role_arn.IAMRoleArn",
    *,
    config_overrides: Optional[AsyncS3ControlClientConfig] = None,
    confirmation_required: Optional[
        "capo_s3_control.types.confirmation_required.ConfirmationRequired"
    ] = None,
    manifest: Optional["capo_s3_control.types.job_manifest.JobManifest"] = None,
    description: Optional[
        "capo_s3_control.types.non_empty_max_length256_string.NonEmptyMaxLength256String"
    ] = None,
    tags: Optional["capo_s3_control.types.s3_tag_set.S3TagSet"] = None,
    manifest_generator: Optional[
        "capo_s3_control.types.job_manifest_generator.JobManifestGenerator"
    ] = None,
) -> "capo_s3_control.types.create_job_result.CreateJobResult":
    """<p>This operation creates an S3 Batch Operations job.</p> <p>You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>For information about permissions required to use the Batch Operations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops-iam-role-policies.html">Granting permissions for S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p> </dd> </dl> <p></p> <p>Related actions include:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html">UpdateJobPriority</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html">JobOperation</a> </p> </li> </ul>

    Args:
        account_id: <p>The Amazon Web Services account ID that creates the job.</p>
        confirmation_required: <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: <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: <p>Configuration parameters for the optional job-completion report.</p>
        client_request_token: <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: <p>Configuration parameters for the manifest.</p>
        description: <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: <p>The numerical priority for this job. Higher numbers indicate higher priority.</p>
        role_arn: <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: <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter. </p>
        manifest_generator: <p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p>

    Raises:
        capo_s3_control.errors.bad_request_exception.BadRequestException: <p></p>
        capo_s3_control.errors.idempotency_exception.IdempotencyException: <p></p>
        capo_s3_control.errors.internal_service_exception.InternalServiceException: <p></p>
        capo_s3_control.errors.too_many_requests_exception.TooManyRequestsException: <p></p>
        capo_s3_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_s3_control.types.create_job_request.CreateJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_s3_control.types.create_job_result.CreateJobResult"
    ]:
        import capo_s3_control._operations.awss3_control_service_v20180820.create_job

        (
            output,
            http_response,
        ) = await capo_s3_control._operations.awss3_control_service_v20180820.create_job.async_create_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateJob")
    )
    input_: capo_s3_control.types.create_job_request.CreateJobRequest = {
        "account_id": account_id,
        "operation": operation,
        "report": report,
        "client_request_token": client_request_token,
        "priority": priority,
        "role_arn": role_arn,
    }
    if confirmation_required is not None:
        input_["confirmation_required"] = confirmation_required
    if manifest is not None:
        input_["manifest"] = manifest
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags
    if manifest_generator is not None:
        input_["manifest_generator"] = manifest_generator

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output