Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetWorkspaceInstance

Retrieves detailed information about a specific WorkSpace Instance.

Request Syntax


{
   "WorkspaceInstanceId": "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.

WorkspaceInstanceId

Unique identifier of the WorkSpace Instance to retrieve.

Type: String

Length Constraints: Minimum length of 15. Maximum length of 70.

Pattern: wsinst-[0-9a-zA-Z]{8,63}

Required: Yes

Response Syntax


{
   "EC2InstanceErrors": [ 
      { 
         "EC2ErrorCode": "string",
         "EC2ErrorMessage": "string",
         "EC2ExceptionType": "string"
      }
   ],
   "EC2ManagedInstance": { 
      "InstanceId": "string"
   },
   "ProvisionState": "string",
   "WorkspaceInstanceErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "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.

EC2InstanceErrors

Includes any underlying EC2 instance errors encountered.

Type: Array of EC2InstanceError objects

EC2ManagedInstance

Details of the associated EC2 managed instance.

Type: EC2ManagedInstance object

ProvisionState

Current provisioning state of the WorkSpaces Instance.

Type: String

WorkspaceInstanceErrors

Captures any errors specific to the WorkSpace Instance lifecycle.

Type: Array of WorkspaceInstanceError objects

WorkspaceInstanceId

Unique identifier of the retrieved WorkSpaces Instance.

Type: String

Length Constraints: Minimum length of 15. Maximum length of 70.

Pattern: wsinst-[0-9a-zA-Z]{8,63}

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

ResourceNotFoundException

Indicates the requested resource could not be found.

Message: Details about the missing resource.
ResourceId: Identifier of the resource that was not found.
ResourceType: Type of the resource that was not found.

HTTP Status Code: 400

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