TerminateSession
Terminates an active session. A TerminateSession call on a session that
is already inactive (for example, in a FAILED, TERMINATED or
TERMINATING state) succeeds but has no effect. Calculations running in
the session when TerminateSession is called are forcefully stopped, but may
display as FAILED instead of STOPPED.
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 session ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Syntax
{
"State": "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.
- State
-
The state of the session. A description of each state follows.
CREATING- The session is being started, including acquiring resources.CREATED- The session has been started.IDLE- The session is able to accept a calculation.BUSY- The session is processing another task and is unable to accept a calculation.TERMINATING- The session is in the process of shutting down.TERMINATED- The session and its resources are no longer running.DEGRADED- The session has no healthy coordinators.FAILED- Due to a failure, the session and its resources are no longer running.Type: String
Valid Values:
CREATING | CREATED | IDLE | BUSY | TERMINATING | TERMINATED | DEGRADED | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
Indicates a platform issue, which may be due to a transient condition or outage.
HTTP Status Code: 500
- InvalidRequestException
-
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource, such as a workgroup, was not 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:
