Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetSessionStatus

Gets the current status of a session.

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


{
   "SessionId": "string",
   "Status": { 
      "EndDateTime": number,
      "IdleSinceDateTime": number,
      "LastModifiedDateTime": number,
      "StartDateTime": number,
      "State": "string",
      "StateChangeReason": "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.

SessionId

The session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Status

Contains information about the status of the session.

Type: SessionStatus object

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