get_q_app_session `async` ¶

get_q_app_session(
    instance_id: InstanceId,
    session_id: UUID,
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
) -> GetQAppSessionOutput

Retrieves the current state and results for an active session of an Amazon Q App.

Parameters:

instance_id (InstanceId) –

The unique identifier of the Amazon Q Business application environment instance.
session_id (UUID) –

The unique identifier of the Q App session to retrieve.

Raises:

AccessDeniedException –

The client is not authorized to perform the requested operation.
InternalServerException –

An internal service error occurred while processing the request.
ResourceNotFoundException –

The requested resource could not be found.
ServiceQuotaExceededException –

The requested operation could not be completed because it would exceed the service's quota or limit.
ThrottlingException –

The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
UnauthorizedException –

The client is not authenticated or authorized to perform the requested operation.
ValidationException –

The input failed to satisfy the constraints specified by the service.
UnknownServiceError –

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

Examples:

Retrieves an existing session for an Amazon Q App

>>> await client.get_q_app_session(instance_id='288ae830-1df2-4871-b6c0-4314d74dadef', session_id='1fca878e-64c5-4dc4-b1d9-c93effed4e82')

Source code in docs_src/capo_qapps/_services/async_q_apps.py

async def get_q_app_session(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    session_id: "capo_qapps.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
) -> "capo_qapps.types.get_q_app_session_output.GetQAppSessionOutput":
    """<p>Retrieves the current state and results for an active session of an Amazon Q App.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>
        session_id: <p>The unique identifier of the Q App session to retrieve.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The requested operation could not be completed because it would exceed the service's quota or limit.</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:
        Retrieves an existing session for an Amazon Q App

        >>> await client.get_q_app_session(instance_id='288ae830-1df2-4871-b6c0-4314d74dadef', session_id='1fca878e-64c5-4dc4-b1d9-c93effed4e82')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qapps.types.get_q_app_session_input.GetQAppSessionInput]",
    ) -> AsyncOperationResponse[
        "capo_qapps.types.get_q_app_session_output.GetQAppSessionOutput"
    ]:
        import capo_qapps._operations.q_apps_service.get_q_app_session

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetQAppSession")
    )
    input_: capo_qapps.types.get_q_app_session_input.GetQAppSessionInput = {
        "instance_id": instance_id,
        "session_id": session_id,
    }

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

get_q_app_session async ¶

get_q_app_session `async` ¶