Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1435190156.6 KB

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

get/runtime.getQAppSession#instance-id&sessionId

Query parameters

sessionIdstring required

The unique identifier of the Q App session to retrieve.

Headers

instance-idstring required

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

Response

Success

sessionIdstring required

The unique identifier of the Q App session.

sessionArnstring required

The Amazon Resource Name (ARN) of the Q App session.

sessionNamestring

The name of the Q App session.

appVersioninteger

The version of the Q App used for the session.

latestPublishedAppVersioninteger

The latest published version of the Q App used for the session.

status'IN_PROGRESS' | 'WAITING' | 'COMPLETED' | 'ERROR' required

The current status of the Q App session.

cardStatusobject required

The current status for each card in the Q App session.

userIsHostboolean

Indicates whether the current user is the owner of the Q App data collection session.