Skip to content

stop_advanced_prompt_optimization_job async

stop_advanced_prompt_optimization_job(
    job_identifier: AdvancedPromptOptimizationJobIdentifier,
    *,
    config_overrides: Optional[AsyncBedrockClientConfig] = None,
) -> StopAdvancedPromptOptimizationJobResponse

Stops an advanced prompt optimization job that is in progress.

Parameters:

Raises:

Source code in docs_src/capo_bedrock/_services/async_bedrock.py
async def stop_advanced_prompt_optimization_job(
    self,
    job_identifier: "capo_bedrock.types.advanced_prompt_optimization_job_identifier.AdvancedPromptOptimizationJobIdentifier",
    *,
    config_overrides: Optional[AsyncBedrockClientConfig] = None,
) -> "capo_bedrock.types.stop_advanced_prompt_optimization_job_response.StopAdvancedPromptOptimizationJobResponse":
    """<p>Stops an advanced prompt optimization job that is in progress.</p>

    Args:
        job_identifier: <p>The ARN or ID of the advanced prompt optimization job to stop.</p>

    Raises:
        capo_bedrock.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock.errors.conflict_exception.ConflictException: <p>Error occurred because of a conflict while performing an operation.</p>
        capo_bedrock.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock.types.stop_advanced_prompt_optimization_job_request.StopAdvancedPromptOptimizationJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock.types.stop_advanced_prompt_optimization_job_response.StopAdvancedPromptOptimizationJobResponse"
    ]:
        import capo_bedrock._operations.amazon_bedrock_control_plane_service.stop_advanced_prompt_optimization_job

        (
            output,
            http_response,
        ) = await capo_bedrock._operations.amazon_bedrock_control_plane_service.stop_advanced_prompt_optimization_job.async_stop_advanced_prompt_optimization_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopAdvancedPromptOptimizationJob")
    )
    input_: capo_bedrock.types.stop_advanced_prompt_optimization_job_request.StopAdvancedPromptOptimizationJobRequest = {
        "job_identifier": job_identifier
    }

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