Menu
Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

DescribeWorkspacesConnectionStatus

Describes the connection status of a specified WorkSpace.

Request Syntax

{
   "NextToken": "string",
   "WorkspaceIds": [ "string" ]
}

Request Parameters

The request accepts the following data in JSON format.

NextToken

The next token of the request.

Type: String

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

Required: No

WorkspaceIds

An array of strings that contain the identifiers of the WorkSpaces.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Pattern: ^ws-[0-9a-z]{8,63}$

Required: No

Response Syntax

{
   "NextToken": "string",
   "WorkspacesConnectionStatus": [ 
      { 
         "ConnectionState": "string",
         "ConnectionStateCheckTimestamp": number,
         "LastKnownUserConnectionTimestamp": number,
         "WorkspaceId": "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.

NextToken

The next token of the result.

Type: String

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

WorkspacesConnectionStatus

The connection status of the WorkSpace.

Type: Array of WorkspaceConnectionStatus objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: