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

DescribeWorkspacesConnectionStatus

Describes the connection status of the specified WorkSpaces.

Request Syntax

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

Request Parameters

The request accepts the following data in JSON format.

NextToken

The token for the next set of results. (You received this token from a previous call.)

Type: String

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

Required: No

WorkspaceIds

The identifiers of the WorkSpaces. You can specify up to 25 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 token to use to retrieve the next set of results, or null if there are no more results available.

Type: String

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

WorkspacesConnectionStatus

Information about 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: