StopQAppSession
Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.
Request Syntax
POST /runtime.deleteMiniAppRun HTTP/1.1
instance-id: instanceId
Content-type: application/json
{
"sessionId": "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.
- sessionId
-
The unique identifier of the Q App session to stop.
Type: String
Pattern:
[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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:
