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

DescribeClientProperties

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Request Syntax

{ "ResourceIds": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

ResourceIds

The resource identifier, in the form of directory IDs.

Type: Array of strings

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

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{ "ClientPropertiesList": [ { "ClientProperties": { "ReconnectEnabled": "string" }, "ResourceId": "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.

ClientPropertiesList

Information about the specified Amazon WorkSpaces clients.

Type: Array of ClientPropertiesResult objects

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

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