stop_bot_analyzer ¶

stop_bot_analyzer(
    bot_id: Id,
    bot_analyzer_request_id: UUID,
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> StopBotAnalyzerResponse

Cancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated.

Parameters:

bot_id (Id) –

The unique identifier of the bot.
bot_analyzer_request_id (UUID) –

The unique identifier of the analysis request to stop.

Raises:

InternalServerException –

The service encountered an unexpected condition. Try your request again.
ResourceNotFoundException –

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
ThrottlingException –

Your request rate is too high. Reduce the frequency of requests.
ValidationException –

One of the input parameters in your request isn't valid. Check the parameters and try your request again.
UnknownServiceError –

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

Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py

def stop_bot_analyzer(
    self,
    bot_id: "capo_lex_models_v2.types.id.Id",
    bot_analyzer_request_id: "capo_lex_models_v2.types.uuid.UUID",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> "capo_lex_models_v2.types.stop_bot_analyzer_response.StopBotAnalyzerResponse":
    """<p>Cancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated.</p>

    Args:
        bot_id: <p>The unique identifier of the bot.</p>
        bot_analyzer_request_id: <p>The unique identifier of the analysis request to stop.</p>

    Raises:
        capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
        capo_lex_models_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.</p>
        capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
        capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
        capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lex_models_v2.types.stop_bot_analyzer_request.StopBotAnalyzerRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.stop_bot_analyzer_response.StopBotAnalyzerResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.stop_bot_analyzer

        output, http_response = (
            capo_lex_models_v2._operations.lex_model_building_service_v2.stop_bot_analyzer.stop_bot_analyzer(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopBotAnalyzer")
    )
    input_: capo_lex_models_v2.types.stop_bot_analyzer_request.StopBotAnalyzerRequest = {
        "bot_id": bot_id,
        "bot_analyzer_request_id": bot_analyzer_request_id,
    }

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