Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetQAppSession

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

Request Syntax


GET /runtime.getQAppSession?sessionId=sessionId HTTP/1.1
instance-id: instanceId

URI Request Parameters

The request uses the following URI parameters.

instanceId

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

Required: Yes

sessionId

The unique identifier of the Q App session to retrieve.

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appVersion": number,
   "cardStatus": { 
      "string" : { 
         "currentState": "string",
         "currentValue": "string",
         "submissions": [ 
            { 
               "submissionId": "string",
               "timestamp": "string",
               "value": JSON value
            }
         ]
      }
   },
   "latestPublishedAppVersion": number,
   "sessionArn": "string",
   "sessionId": "string",
   "sessionName": "string",
   "status": "string",
   "userIsHost": boolean
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

appVersion

The version of the Q App used for the session.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

cardStatus

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

Type: String to CardStatus object map

Key Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

latestPublishedAppVersion

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

sessionArn

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

Type: String

sessionId

The unique identifier of the Q App session.

Type: String

sessionName

The name of the Q App session.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

status

The current status of the Q App session.

Type: String

Valid Values: IN_PROGRESS | WAITING | COMPLETED | ERROR

userIsHost

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

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The client is not authorized to perform the requested operation.

HTTP Status Code: 403

InternalServerException

An internal service error occurred while processing the request.

retryAfterSeconds: The number of seconds to wait before retrying the operation

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

resourceId: The unique identifier of the resource
resourceType: The type of the resource

HTTP Status Code: 404

ServiceQuotaExceededException

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

quotaCode: The code of the quota that was exceeded
resourceId: The unique identifier of the resource
resourceType: The type of the resource
serviceCode: The code for the service where the quota was exceeded

HTTP Status Code: 402

ThrottlingException

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

quotaCode: The code of the quota that was exceeded
retryAfterSeconds: The number of seconds to wait before retrying the operation
serviceCode: The code for the service where the quota was exceeded

HTTP Status Code: 429

UnauthorizedException

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

HTTP Status Code: 401

ValidationException

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

HTTP Status Code: 400