Skip to content

delete_web_experience async

delete_web_experience(
    application_id: ApplicationId,
    web_experience_id: WebExperienceId,
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
) -> DeleteWebExperienceResponse

Deletes an Amazon Q Business web experience.

Parameters:

  • application_id (ApplicationId) –

    The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.

  • web_experience_id (WebExperienceId) –

    The identifier of the Amazon Q Business web experience being deleted.

Raises:

  • AccessDeniedException –

    You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ConflictException –

    You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

  • InternalServerException –

    An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

  • ResourceNotFoundException –

    The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException –

    The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • UnknownServiceError –

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

Source code in docs_src/capo_qbusiness/_services/async_q_business.py
async def delete_web_experience(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    web_experience_id: "capo_qbusiness.types.web_experience_id.WebExperienceId",
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
) -> "capo_qbusiness.types.delete_web_experience_response.DeleteWebExperienceResponse":
    """<p>Deletes an Amazon Q Business web experience.</p>

    Args:
        application_id: <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.</p>
        web_experience_id: <p>The identifier of the Amazon Q Business web experience being deleted.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.conflict_exception.ConflictException: <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qbusiness.types.delete_web_experience_request.DeleteWebExperienceRequest]",
    ) -> AsyncOperationResponse[
        "capo_qbusiness.types.delete_web_experience_response.DeleteWebExperienceResponse"
    ]:
        import capo_qbusiness._operations.expert_q.delete_web_experience

        (
            output,
            http_response,
        ) = await capo_qbusiness._operations.expert_q.delete_web_experience.async_delete_web_experience(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWebExperience")
    )
    input_: capo_qbusiness.types.delete_web_experience_request.DeleteWebExperienceRequest = {
        "application_id": application_id,
        "web_experience_id": web_experience_id,
    }

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