Skip to content

disassociate_lex_bot

disassociate_lex_bot(
    instance_id: InstanceId,
    bot_name: BotName,
    lex_region: LexRegion,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> None

This API is in preview release for Connect Customer and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

Parameters:

  • instance_id (InstanceId) –

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • bot_name (BotName) –

    The name of the Amazon Lex bot. Maximum character limit of 50.

  • lex_region (LexRegion) –

    The Amazon Web Services Region in which the Amazon Lex bot has been created.

  • client_token (Optional[ClientToken], default: None ) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def disassociate_lex_bot(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    bot_name: "capo_connect.types.bot_name.BotName",
    lex_region: "capo_connect.types.lex_region.LexRegion",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    client_token: Optional["capo_connect.types.client_token.ClientToken"] = None,
) -> None:
    """<p>This API is in preview release for Connect Customer and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified Amazon Lex bot.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        bot_name: <p>The name of the Amazon Lex bot. Maximum character limit of 50.</p>
        lex_region: <p>The Amazon Web Services Region in which the Amazon Lex bot has been created.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.disassociate_lex_bot_request.DisassociateLexBotRequest]",
    ) -> OperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.disassociate_lex_bot

        output, http_response = (
            capo_connect._operations.amazon_connect_service.disassociate_lex_bot.disassociate_lex_bot(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisassociateLexBot")
    )
    input_: capo_connect.types.disassociate_lex_bot_request.DisassociateLexBotRequest = {
        "instance_id": instance_id,
        "bot_name": bot_name,
        "lex_region": lex_region,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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