DrainSessionInstance
Drains the instance hosting the specified streaming session. The instance stops accepting new sessions while existing sessions continue uninterrupted. Once all sessions end, the instance is reclaimed and replaced. This only applies to multi-session fleets.
Request Syntax
{
"SessionId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- SessionId
-
The identifier of the streaming session.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
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 Error Types.
- ConcurrentModificationException
-
An API error occurred. Wait a few minutes and try again.
- Message
-
The error message in the exception.
HTTP Status Code: 400
- OperationNotPermittedException
-
The attempted operation is not permitted.
- Message
-
The error message in the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The error message in the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
