Skip to content

cancel_batch_job_execution async 

cancel_batch_job_execution(
    application_id: Identifier,
    execution_id: Identifier,
    *,
    config_overrides: Optional[Asyncm2ClientConfig] = None,
    auth_secrets_manager_arn: Optional[AuthSecretsManagerArn] = None,
) -> CancelBatchJobExecutionResponse

Cancels the running of a specific batch job execution.

Parameters:

  • application_id (Identifier) –

    The unique identifier of the application.

  • execution_id (Identifier) –

    The unique identifier of the batch job execution.

  • auth_secrets_manager_arn (Optional[AuthSecretsManagerArn], default: None ) –

    The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation.

Raises:

Source code in docs_src/capo_m2/_services/async_m2.py 
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
async def cancel_batch_job_execution(
    self,
    application_id: "capo_m2.types.identifier.Identifier",
    execution_id: "capo_m2.types.identifier.Identifier",
    *,
    config_overrides: Optional[Asyncm2ClientConfig] = None,
    auth_secrets_manager_arn: Optional[
        "capo_m2.types.auth_secrets_manager_arn.AuthSecretsManagerArn"
    ] = None,
) -> "capo_m2.types.cancel_batch_job_execution_response.CancelBatchJobExecutionResponse":
    """<p>Cancels the running of a specific batch job execution.</p>

    Args:
        application_id: <p>The unique identifier of the application.</p>
        execution_id: <p>The unique identifier of the batch job execution.</p>
        auth_secrets_manager_arn: <p>The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation.</p>

    Raises:
        capo_m2.errors.access_denied_exception.AccessDeniedException: <p>The account or role doesn't have the right permissions to make the request.</p>
        capo_m2.errors.conflict_exception.ConflictException: <p>The parameters provided in the request conflict with existing resources.</p>
        capo_m2.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_m2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_m2.errors.throttling_exception.ThrottlingException: <p>The number of requests made exceeds the limit.</p>
        capo_m2.errors.validation_exception.ValidationException: <p>One or more parameters provided in the request is not valid.</p>
        capo_m2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_m2.types.cancel_batch_job_execution_request.CancelBatchJobExecutionRequest]",
    ) -> AsyncOperationResponse[
        "capo_m2.types.cancel_batch_job_execution_response.CancelBatchJobExecutionResponse"
    ]:
        import capo_m2._operations.aws_supernova_control_plane_service.cancel_batch_job_execution

        (
            output,
            http_response,
        ) = await capo_m2._operations.aws_supernova_control_plane_service.cancel_batch_job_execution.async_cancel_batch_job_execution(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelBatchJobExecution")
    )
    input_: capo_m2.types.cancel_batch_job_execution_request.CancelBatchJobExecutionRequest = {
        "application_id": application_id,
        "execution_id": execution_id,
    }
    if auth_secrets_manager_arn is not None:
        input_["auth_secrets_manager_arn"] = auth_secrets_manager_arn

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