Skip to content

stop_recommender async

stop_recommender(
    recommender_arn: Arn,
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
) -> StopRecommenderResponse

Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

Parameters:

  • recommender_arn (Arn) –

    The Amazon Resource Name (ARN) of the recommender to stop.

Raises:

Source code in docs_src/capo_personalize/_services/async_personalize.py
async def stop_recommender(
    self,
    recommender_arn: "capo_personalize.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
) -> "capo_personalize.types.stop_recommender_response.StopRecommenderResponse":
    """<p>Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.</p>

    Args:
        recommender_arn: <p>The Amazon Resource Name (ARN) of the recommender to stop.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource is in use.</p>
        capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize.types.stop_recommender_request.StopRecommenderRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.stop_recommender_response.StopRecommenderResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.stop_recommender

        (
            output,
            http_response,
        ) = await capo_personalize._operations.amazon_personalize.stop_recommender.async_stop_recommender(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopRecommender")
    )
    input_: capo_personalize.types.stop_recommender_request.StopRecommenderRequest = {
        "recommender_arn": recommender_arn
    }

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