Skip to content

delete_q_app 

delete_q_app(
    instance_id: InstanceId,
    app_id: UUID,
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> None

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

Parameters:

  • instance_id (InstanceId) –

    The unique identifier of the Amazon Q Business application environment instance.

  • app_id (UUID) –

    The unique identifier of the Q App to delete.

Raises:

Examples:

Delete an Amazon Q App

>>> client.delete_q_app(app_id='393e77fb-0a30-4f47-ad30-75d71aeaed8a', instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f')
Source code in docs_src/capo_qapps/_services/q_apps.py 
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
def delete_q_app(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    app_id: "capo_qapps.types.uuid.UUID",
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> None:
    """<p>Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>
        app_id: <p>The unique identifier of the Q App to delete.</p>

    Raises:
        capo_qapps.errors.access_denied_exception.AccessDeniedException: <p>The client is not authorized to perform the requested operation.</p>
        capo_qapps.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred while processing the request.</p>
        capo_qapps.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_qapps.errors.throttling_exception.ThrottlingException: <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
        capo_qapps.errors.unauthorized_exception.UnauthorizedException: <p>The client is not authenticated or authorized to perform the requested operation.</p>
        capo_qapps.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by the service.</p>
        capo_qapps.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Delete an Amazon Q App

        >>> client.delete_q_app(app_id='393e77fb-0a30-4f47-ad30-75d71aeaed8a', instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f')
    """

    def _handler(
        req: "OperationRequest[capo_qapps.types.delete_q_app_input.DeleteQAppInput]",
    ) -> OperationResponse[None]:
        import capo_qapps._operations.q_apps_service.delete_q_app

        output, http_response = (
            capo_qapps._operations.q_apps_service.delete_q_app.delete_q_app(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteQApp")
    )
    input_: capo_qapps.types.delete_q_app_input.DeleteQAppInput = {
        "instance_id": instance_id,
        "app_id": app_id,
    }

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