Skip to content

update_job_priority

update_job_priority(
    account_id: AccountId,
    job_id: JobId,
    priority: JobPriority,
    *,
    config_overrides: Optional[S3ControlClientConfig] = None,
) -> UpdateJobPriorityResult

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Permissions

To use the UpdateJobPriority operation, you must have permission to perform the s3:UpdateJobPriority action.

Related actions include:

Parameters:

  • account_id (AccountId) –

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • job_id (JobId) –

    The ID for the job whose priority you want to update.

  • priority (JobPriority) –

    The priority you want to assign to this job.

Raises:

Source code in docs_src/capo_s3_control/_services/s3_control.py
def update_job_priority(
    self,
    account_id: "capo_s3_control.types.account_id.AccountId",
    job_id: "capo_s3_control.types.job_id.JobId",
    priority: "capo_s3_control.types.job_priority.JobPriority",
    *,
    config_overrides: Optional[S3ControlClientConfig] = None,
) -> "capo_s3_control.types.update_job_priority_result.UpdateJobPriorityResult":
    """<p>Updates an existing S3 Batch Operations job's priority. 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>To use the <code>UpdateJobPriority</code> operation, you must have permission to perform the <code>s3:UpdateJobPriority</code> action.</p> </dd> </dl> <p>Related actions include:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</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_DescribeJob.html">DescribeJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a> </p> </li> </ul>

    Args:
        account_id: <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
        job_id: <p>The ID for the job whose priority you want to update.</p>
        priority: <p>The priority you want to assign to this job.</p>

    Raises:
        capo_s3_control.errors.bad_request_exception.BadRequestException: <p></p>
        capo_s3_control.errors.internal_service_exception.InternalServiceException: <p></p>
        capo_s3_control.errors.not_found_exception.NotFoundException: <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.
    """

    def _handler(
        req: "OperationRequest[capo_s3_control.types.update_job_priority_request.UpdateJobPriorityRequest]",
    ) -> OperationResponse[
        "capo_s3_control.types.update_job_priority_result.UpdateJobPriorityResult"
    ]:
        import capo_s3_control._operations.awss3_control_service_v20180820.update_job_priority

        output, http_response = (
            capo_s3_control._operations.awss3_control_service_v20180820.update_job_priority.update_job_priority(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateJobPriority")
    )
    input_: capo_s3_control.types.update_job_priority_request.UpdateJobPriorityRequest = {
        "account_id": account_id,
        "job_id": job_id,
        "priority": priority,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output