get_q_app async ¶

async def get_q_app(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    app_id: "capo_qapps.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
    app_version: Optional["capo_qapps.types.app_version.AppVersion"] = None,
) -> "capo_qapps.types.get_q_app_output.GetQAppOutput":
    """<p>Retrieves the full details of an Q App, including its definition specifying the cards and flow.</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 retrieve.</p>
        app_version: <p>The version of the Q App.</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:
        A basic application with 1 text input card and 1 output card

        >>> await client.get_q_app(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', app_id='3d110749-efc3-427c-87e8-15e966e5c168')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qapps.types.get_q_app_input.GetQAppInput]",
    ) -> AsyncOperationResponse["capo_qapps.types.get_q_app_output.GetQAppOutput"]:
        import capo_qapps._operations.q_apps_service.get_q_app

        (
            output,
            http_response,
        ) = await capo_qapps._operations.q_apps_service.get_q_app.async_get_q_app(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetQApp")
    )
    input_: capo_qapps.types.get_q_app_input.GetQAppInput = {
        "instance_id": instance_id,
        "app_id": app_id,
    }
    if app_version is not None:
        input_["app_version"] = app_version

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