Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListWorkspaceInstances

Retrieves a collection of WorkSpaces Instances based on specified filters.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "ProvisionStates": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

Maximum number of WorkSpaces Instances to return in a single response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

Pagination token for retrieving subsequent pages of WorkSpaces Instances.

Type: String

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

Required: No

ProvisionStates

Filter WorkSpaces Instances by their current provisioning states.

Type: Array of strings

Required: No

Response Syntax


{
   "NextToken": "string",
   "WorkspaceInstances": [ 
      { 
         "EC2ManagedInstance": { 
            "InstanceId": "string"
         },
         "ProvisionState": "string",
         "WorkspaceInstanceId": "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

Token for retrieving additional WorkSpaces Instances if the result set is paginated.

Type: String

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

WorkspaceInstances

Collection of WorkSpaces Instances returned by the query.

Type: Array of WorkspaceInstance objects

Errors

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

AccessDeniedException

Indicates insufficient permissions to perform the requested action.

Message: Detailed explanation of the access denial.

HTTP Status Code: 400

InternalServerException

Indicates an unexpected server-side error occurred.

Message: Description of the internal server error.
RetryAfterSeconds: Recommended wait time before retrying the request.

HTTP Status Code: 500

ThrottlingException

Indicates the request rate has exceeded limits.

Message: Description of the throttling event.
QuotaCode: Specific code for the throttling quota.
RetryAfterSeconds: Recommended wait time before retrying the request.
ServiceCode: Code identifying the service experiencing throttling.

HTTP Status Code: 400

ValidationException

Indicates invalid input parameters in the request.

FieldList: List of fields that failed validation.
Message: Overall description of validation failures.
Reason: Specific reason for the validation failure.

HTTP Status Code: 400