ListQAppSessionData
Lists the collected data of a Q App data collection session.
Request Syntax
GET /runtime.listQAppSessionData?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 data collection session.
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
{
"nextToken": "string",
"sessionArn": "string",
"sessionData": [
{
"cardId": "string",
"submissionId": "string",
"timestamp": "string",
"user": {
"userId": "string"
},
"value": JSON value
}
],
"sessionId": "string"
}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.
- nextToken
-
The pagination token that indicates the next set of results to retrieve.
Type: String
- sessionArn
-
The Amazon Resource Name (ARN) of the Q App data collection session.
Type: String
- sessionData
-
The collected responses of a Q App session.
Type: Array of QAppSessionData objects
- sessionId
-
The unique identifier of the Q App data collection session.
Type: String
Pattern:
[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}
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.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource could not be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The requested operation could not be completed because it would exceed the service's quota or limit.
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.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
