AccountModification
Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
Contents
DedicatedTenancyManagementCidrRange
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
Type: String
Pattern: (^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9]
[0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.0\.0)(\/(16$))$
Required: No
DedicatedTenancySupport
The status of BYOL (whether BYOL is being enabled or disabled).
Type: String
Valid Values: ENABLED | DISABLED Required: No
ErrorCode
The error code that is returned if the configuration of BYOL cannot be modified.
Type: String Required: No ErrorMessage
The text of the error message that is returned if the configuration of BYOL cannot be modified.
Type: String Required: No ModificationState
The state of the modification to the configuration of BYOL.
Type: String
Valid Values: PENDING | COMPLETED | FAILED Required: No
StartTime
The timestamp when the modification of the BYOL configuration was started.
Amazon WorkSpaces Service API Reference See Also
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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 146
ClientProperties
ClientProperties
Describes an Amazon WorkSpaces client.
Contents
ReconnectEnabled
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
Type: String
Valid Values: ENABLED | DISABLED 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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference ClientPropertiesResult
ClientPropertiesResult
Information about the Amazon WorkSpaces client.
Contents
ClientProperties
Information about the Amazon WorkSpaces client.
Type: ClientProperties (p. 147) object Required: No
ResourceId
The resource identifier, in the form of a directory ID.
Type: String
Length Constraints: Minimum length of 1.
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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 148
ComputeType
ComputeType
Describes the compute type of the bundle.
Contents
Name
The compute type.
Type: String
Valid Values: VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GRAPHICSPRO
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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference ConnectClientAddIn
ConnectClientAddIn
Describes an Amazon Connect client add-in.
Contents
AddInId
The client add-in identifier.
Type: String
Length Constraints: Fixed length of 36.
Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
Required: No Name
The name of the client add in.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^.*$
Required: No ResourceId
The directory identifier for which the client add-in is configured.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 65.
Pattern: ^d-[0-9a-f]{8,63}$
Required: No URL
The endpoint URL of the client add-in.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^(http|https)\://\S+
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 Go
API Version 2015-04-08 150
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference ConnectionAlias
ConnectionAlias
Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Contents
AliasId
The identifier of the connection alias.
Type: String
Length Constraints: Minimum length of 13. Maximum length of 68.
Pattern: ^wsca-[0-9a-z]{8,63}$
Required: No Associations
The association status of the connection alias.
Type: Array of ConnectionAliasAssociation (p. 154) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: No ConnectionString
The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[.0-9a-zA-Z\-]{1,255}$
Required: No OwnerAccountId
The identifier of the AWS account that owns the connection alias.
Type: String Pattern: ^\d{12}$
Required: No State
The current state of the connection alias.
Type: String
Valid Values: CREATING | CREATED | DELETING Required: No
API Version 2015-04-08 152
See Also
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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference ConnectionAliasAssociation
ConnectionAliasAssociation
Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Contents
AssociatedAccountId
The identifier of the AWS account that associated the connection alias with a directory.
Type: String Pattern: ^\d{12}$
Required: No AssociationStatus
The association status of the connection alias.
Type: String
Valid Values: NOT_ASSOCIATED | ASSOCIATED_WITH_OWNER_ACCOUNT
| ASSOCIATED_WITH_SHARED_ACCOUNT | PENDING_ASSOCIATION | PENDING_DISASSOCIATION
Required: No ConnectionIdentifier
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^[a-zA-Z0-9]+$
Required: No ResourceId
The identifier of the directory associated with a connection alias.
Type: String
Length Constraints: Minimum length of 1.
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 Go
• AWS SDK for Java V2
API Version 2015-04-08 154
See Also
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference ConnectionAliasPermission
ConnectionAliasPermission
Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Contents
AllowAssociation
Indicates whether the specified AWS account is allowed to associate the connection alias with a directory.
Type: Boolean Required: Yes SharedAccountId
The identifier of the AWS account that the connection alias is shared with.
Type: String Pattern: ^\d{12}$
Required: Yes
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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 156
DefaultWorkspaceCreationProperties
DefaultWorkspaceCreationProperties
Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
Contents
CustomSecurityGroupId
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 20.
Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$
Required: No DefaultOu
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
Type: String Required: No EnableInternetAccess
Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
Type: Boolean Required: No
EnableMaintenanceMode
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
Type: Boolean Required: No EnableWorkDocs
Specifies whether the directory is enabled for Amazon WorkDocs.
Type: Boolean Required: No
Amazon WorkSpaces Service API Reference See Also
Type: Boolean 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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 158
FailedCreateWorkspaceRequest
FailedCreateWorkspaceRequest
Describes a WorkSpace that cannot be created.
Contents
ErrorCode
The error code that is returned if the WorkSpace cannot be created.
Type: String Required: No ErrorMessage
The text of the error message that is returned if the WorkSpace cannot be created.
Type: String Required: No WorkspaceRequest
Information about the WorkSpace.
Type: WorkspaceRequest (p. 194) object 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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference FailedWorkspaceChangeRequest
FailedWorkspaceChangeRequest
Describes a WorkSpace that could not be rebooted. (RebootWorkspaces (p. 116)), rebuilt (RebuildWorkspaces (p. 118)), restored (RestoreWorkspace (p. 123)), terminated (TerminateWorkspaces (p. 131)), started (StartWorkspaces (p. 127)), or stopped (StopWorkspaces (p. 129)).
Contents
ErrorCode
The error code that is returned if the WorkSpace cannot be rebooted.
Type: String Required: No ErrorMessage
The text of the error message that is returned if the WorkSpace cannot be rebooted.
Type: String Required: No WorkspaceId
The identifier of the 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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 160
ImagePermission
ImagePermission
Describes the AWS accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
Contents
SharedAccountId
The identifier of the AWS account that an image has been shared with.
Type: String Pattern: ^\d{12}$
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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference IpRuleItem
IpRuleItem
Describes a rule for an IP access control group.
Contents
ipRule
The IP address range, in CIDR notation.
Type: String Required: No ruleDesc
The description.
Type: String 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 Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 162