Request Syntax Request Parameters Response Elements Errors See Also

AssociateVolume

Attaches a volume to a WorkSpace Instance.

Request Syntax


{
   "Device": "string",
   "VolumeId": "string",
   "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.

Device

Device path for volume attachment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32.

Required: Yes

VolumeId

Volume to be attached.

Type: String

Pattern: vol-[0-9a-zA-Z]{1,63}

Required: Yes

WorkspaceInstanceId

WorkSpace Instance to attach volume to.

Type: String

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

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

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

ConflictException

Signals a conflict with the current state of the resource.

Message: Description of the conflict encountered.
ResourceId: Identifier of the conflicting resource.
ResourceType: Type of the conflicting resource.

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