TerminateWorkspacesPoolSession
Note
End of support notice: On December 31, 2027, AWS will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support.
Terminates the pool session.
Request Syntax
{
"SessionId": "string"
}
Request Parameters
The request accepts the following data in JSON format.
- SessionId
-
The identifier of the pool session.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}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.
- AccessDeniedException
-
The user is not authorized to access a resource.
HTTP Status Code: 400
- InvalidParameterValuesException
-
One or more parameter values are not valid.
- message
-
The exception error message.
HTTP Status Code: 400
- OperationInProgressException
-
The properties of this WorkSpace are currently being modified. Try again in a moment.
HTTP Status Code: 400
- OperationNotSupportedException
-
This operation is not supported.
- message
-
The exception error message.
- reason
-
The exception error reason.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource could not be found.
- message
-
The resource could not be found.
- ResourceId
-
The ID of the resource that could not be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: