Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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

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

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 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.

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