Skip to content

describe_bot_alias

describe_bot_alias(
    bot_alias_id: BotAliasId,
    bot_id: Id,
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> DescribeBotAliasResponse

Get information about a specific bot alias.

Parameters:

  • bot_alias_id (BotAliasId) –

    The identifier of the bot alias to describe.

  • bot_id (Id) –

    The identifier of the bot associated with the bot alias to describe.

Raises:

Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py
def describe_bot_alias(
    self,
    bot_alias_id: "capo_lex_models_v2.types.bot_alias_id.BotAliasId",
    bot_id: "capo_lex_models_v2.types.id.Id",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> (
    "capo_lex_models_v2.types.describe_bot_alias_response.DescribeBotAliasResponse"
):
    """<p>Get information about a specific bot alias.</p>

    Args:
        bot_alias_id: <p>The identifier of the bot alias to describe.</p>
        bot_id: <p>The identifier of the bot associated with the bot alias to describe.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have reached a quota for your bot. </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.describe_bot_alias_request.DescribeBotAliasRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.describe_bot_alias_response.DescribeBotAliasResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.describe_bot_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBotAlias")
    )
    input_: capo_lex_models_v2.types.describe_bot_alias_request.DescribeBotAliasRequest = {
        "bot_alias_id": bot_alias_id,
        "bot_id": bot_id,
    }

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