RelatedWorkspaceProperties

Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

Contents

Region

The Region of the related WorkSpace.

Type: String

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

Pattern: ^[-0-9a-z]{1,31}$

Required: No

State

Indicates the state of the WorkSpace.

Type: String

Valid Values: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING | REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR

Required: No

Type

Indicates the type of WorkSpace.

Type: String

Valid Values: PRIMARY | STANDBY

Required: No

WorkspaceId

The identifier of the related WorkSpace.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

Required: No

See Also

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

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3