delete_bot_alias `async` ¶

delete_bot_alias(
    bot_alias_id: BotAliasId,
    bot_id: Id,
    *,
    config_overrides: Optional[AsyncLexModelsV2ClientConfig] = None,
    skip_resource_in_use_check: Optional[SkipResourceInUseCheck] = None,
) -> DeleteBotAliasResponse

Deletes the specified bot alias.

Parameters:

bot_alias_id (BotAliasId) –

The unique identifier of the bot alias to delete.
bot_id (Id) –

The unique identifier of the bot associated with the alias to delete.
skip_resource_in_use_check (Optional[SkipResourceInUseCheck], default: None ) –

By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is deleted and throws a ResourceInUseException exception if the alias is being used by another resource. Set this parameter to true to skip this check and remove the alias even if it is being used by another resource.

Raises:

ConflictException –

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
InternalServerException –

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

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
ServiceQuotaExceededException –

You have reached a quota for your bot.
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/async_lex_models_v2.py

async def delete_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[AsyncLexModelsV2ClientConfig] = None,
    skip_resource_in_use_check: Optional[
        "capo_lex_models_v2.types.skip_resource_in_use_check.SkipResourceInUseCheck"
    ] = None,
) -> "capo_lex_models_v2.types.delete_bot_alias_response.DeleteBotAliasResponse":
    """<p>Deletes the specified bot alias.</p>

    Args:
        bot_alias_id: <p>The unique identifier of the bot alias to delete.</p>
        bot_id: <p>The unique identifier of the bot associated with the alias to delete.</p>
        skip_resource_in_use_check: <p>By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is deleted and throws a <code>ResourceInUseException</code> exception if the alias is being used by another resource. Set this parameter to <code>true</code> to skip this check and remove the alias even if it is being used by another resource.</p>

    Raises:
        capo_lex_models_v2.errors.conflict_exception.ConflictException: <p>The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again. </p>
        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.precondition_failed_exception.PreconditionFailedException: <p>Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lex_models_v2.types.delete_bot_alias_request.DeleteBotAliasRequest]",
    ) -> AsyncOperationResponse[
        "capo_lex_models_v2.types.delete_bot_alias_response.DeleteBotAliasResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.delete_bot_alias

        (
            output,
            http_response,
        ) = await capo_lex_models_v2._operations.lex_model_building_service_v2.delete_bot_alias.async_delete_bot_alias(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteBotAlias")
    )
    input_: capo_lex_models_v2.types.delete_bot_alias_request.DeleteBotAliasRequest = {
        "bot_alias_id": bot_alias_id,
        "bot_id": bot_id,
    }
    if skip_resource_in_use_check is not None:
        input_["skip_resource_in_use_check"] = skip_resource_in_use_check

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

delete_bot_alias async ¶

delete_bot_alias `async` ¶