stop_ai_recommendation_job `async` ¶

stop_ai_recommendation_job(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    ai_recommendation_job_name: Optional[AIEntityName] = None,
) -> StopAIRecommendationJobResponse

Stops a running AI recommendation job.

Parameters:

ai_recommendation_job_name (Optional[AIEntityName], default: None ) –

The name of the AI recommendation job to stop.

Raises:

ResourceNotFound –

Resource being access is not found.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py

async def stop_ai_recommendation_job(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    ai_recommendation_job_name: Optional[
        "capo_sagemaker.types.ai_entity_name.AIEntityName"
    ] = None,
) -> "capo_sagemaker.types.stop_ai_recommendation_job_response.StopAIRecommendationJobResponse":
    """<p>Stops a running AI recommendation job.</p>

    Args:
        ai_recommendation_job_name: <p>The name of the AI recommendation job to stop.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.stop_ai_recommendation_job_request.StopAIRecommendationJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.stop_ai_recommendation_job_response.StopAIRecommendationJobResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.stop_ai_recommendation_job

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.stop_ai_recommendation_job.async_stop_ai_recommendation_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopAIRecommendationJob")
    )
    input_: capo_sagemaker.types.stop_ai_recommendation_job_request.StopAIRecommendationJobRequest = {}
    if ai_recommendation_job_name is not None:
        input_["ai_recommendation_job_name"] = ai_recommendation_job_name

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

stop_ai_recommendation_job async ¶

stop_ai_recommendation_job `async` ¶