DescribeWorkspacesConnectionStatus - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.


If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

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

Required: No


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.


The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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


Information about the connection status of the WorkSpace.

Type: Array of WorkspaceConnectionStatus objects


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


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 Amazon SDKs, see the following: