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

StartQAppSession

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

Note

Each Q App session will be condensed into a single conversation in the web experience.

Request Syntax


POST /runtime.startQAppSession HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "appId": "string",
   "appVersion": number,
   "initialValues": [ 
      { 
         "cardId": "string",
         "submissionMutation": { 
            "mutationType": "string",
            "submissionId": "string"
         },
         "value": "string"
      }
   ],
   "sessionId": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

instanceId

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

appId

The unique identifier of the Q App to start a session for.

Type: String

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

Required: Yes

appVersion

The version of the Q App to use for the session.

Type: Integer

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

Required: Yes

initialValues

Optional initial input values to provide for the Q App session.

Type: Array of CardValue objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

sessionId

The unique identifier of the a Q App session.

Type: String

Required: No

tags

Optional tags to associate with the new Q App session.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "sessionArn": "string",
   "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.

sessionArn

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

Type: String

sessionId

The unique identifier of the new or retrieved Q App session.

Type: String

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