Amazon WorkSpaces 2015-04-08
- Client: Aws\WorkSpaces\WorkSpacesClient
- Service ID: workspaces
- Version: 2015-04-08
This page describes the parameters and results for the operations of the Amazon WorkSpaces (2015-04-08), and shows how to use the Aws\WorkSpaces\WorkSpacesClient object to call the described operations. This documentation is specific to the 2015-04-08 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateConnectionAlias ( array $params = [] )
Associates the specified connection alias with the specified directory to enable cross-Region redirection.
- AssociateIpGroups ( array $params = [] )
Associates the specified IP access control group with the specified directory.
- AuthorizeIpRules ( array $params = [] )
Adds one or more rules to the specified IP access control group.
- CopyWorkspaceImage ( array $params = [] )
Copies the specified image from the specified Region to the current Region.
- CreateConnectClientAddIn ( array $params = [] )
Creates a client-add-in for Amazon Connect within a directory.
- CreateConnectionAlias ( array $params = [] )
Creates the specified connection alias for use with cross-Region redirection.
- CreateIpGroup ( array $params = [] )
Creates an IP access control group.
- CreateStandbyWorkspaces ( array $params = [] )
Creates a standby WorkSpace in a secondary Region.
- CreateTags ( array $params = [] )
Creates the specified tags for the specified WorkSpaces resource.
- CreateUpdatedWorkspaceImage ( array $params = [] )
Creates a new updated WorkSpace image based on the specified source image.
- CreateWorkspaceBundle ( array $params = [] )
Creates the specified WorkSpace bundle.
- CreateWorkspaceImage ( array $params = [] )
Creates a new WorkSpace image from an existing WorkSpace.
- CreateWorkspaces ( array $params = [] )
Creates one or more WorkSpaces.
- DeleteClientBranding ( array $params = [] )
Deletes customized client branding.
- DeleteConnectClientAddIn ( array $params = [] )
Deletes a client-add-in for Amazon Connect that is configured within a directory.
- DeleteConnectionAlias ( array $params = [] )
Deletes the specified connection alias.
- DeleteIpGroup ( array $params = [] )
Deletes the specified IP access control group.
- DeleteTags ( array $params = [] )
Deletes the specified tags from the specified WorkSpaces resource.
- DeleteWorkspaceBundle ( array $params = [] )
Deletes the specified WorkSpace bundle.
- DeleteWorkspaceImage ( array $params = [] )
Deletes the specified image from your account.
- DeregisterWorkspaceDirectory ( array $params = [] )
Deregisters the specified directory.
- DescribeAccount ( array $params = [] )
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
- DescribeAccountModifications ( array $params = [] )
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
- DescribeClientBranding ( array $params = [] )
Describes the specified client branding.
- DescribeClientProperties ( array $params = [] )
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
- DescribeConnectClientAddIns ( array $params = [] )
Retrieves a list of Amazon Connect client add-ins that have been created.
- DescribeConnectionAliasPermissions ( array $params = [] )
Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias.
- DescribeConnectionAliases ( array $params = [] )
Retrieves a list that describes the connection aliases used for cross-Region redirection.
- DescribeIpGroups ( array $params = [] )
Describes one or more of your IP access control groups.
- DescribeTags ( array $params = [] )
Describes the specified tags for the specified WorkSpaces resource.
- DescribeWorkspaceBundles ( array $params = [] )
Retrieves a list that describes the available WorkSpace bundles.
- DescribeWorkspaceDirectories ( array $params = [] )
Describes the available directories that are registered with Amazon WorkSpaces.
- DescribeWorkspaceImagePermissions ( array $params = [] )
Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
- DescribeWorkspaceImages ( array $params = [] )
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
- DescribeWorkspaceSnapshots ( array $params = [] )
Describes the snapshots for the specified WorkSpace.
- DescribeWorkspaces ( array $params = [] )
Describes the specified WorkSpaces.
- DescribeWorkspacesConnectionStatus ( array $params = [] )
Describes the connection status of the specified WorkSpaces.
- DisassociateConnectionAlias ( array $params = [] )
Disassociates a connection alias from a directory.
- DisassociateIpGroups ( array $params = [] )
Disassociates the specified IP access control group from the specified directory.
- ImportClientBranding ( array $params = [] )
Imports client branding.
- ImportWorkspaceImage ( array $params = [] )
Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
- ListAvailableManagementCidrRanges ( array $params = [] )
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
- MigrateWorkspace ( array $params = [] )
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
- ModifyAccount ( array $params = [] )
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
- ModifyCertificateBasedAuthProperties ( array $params = [] )
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
- ModifyClientProperties ( array $params = [] )
Modifies the properties of the specified Amazon WorkSpaces clients.
- ModifySamlProperties ( array $params = [] )
Modifies multiple properties related to SAML 2.
- ModifySelfservicePermissions ( array $params = [] )
Modifies the self-service WorkSpace management capabilities for your users.
- ModifyWorkspaceAccessProperties ( array $params = [] )
Specifies which devices and operating systems users can use to access their WorkSpaces.
- ModifyWorkspaceCreationProperties ( array $params = [] )
Modify the default properties used to create WorkSpaces.
- ModifyWorkspaceProperties ( array $params = [] )
Modifies the specified WorkSpace properties.
- ModifyWorkspaceState ( array $params = [] )
Sets the state of the specified WorkSpace.
- RebootWorkspaces ( array $params = [] )
Reboots the specified WorkSpaces.
- RebuildWorkspaces ( array $params = [] )
Rebuilds the specified WorkSpace.
- RegisterWorkspaceDirectory ( array $params = [] )
Registers the specified directory.
- RestoreWorkspace ( array $params = [] )
Restores the specified WorkSpace to its last known healthy state.
- RevokeIpRules ( array $params = [] )
Removes one or more rules from the specified IP access control group.
- StartWorkspaces ( array $params = [] )
Starts the specified WorkSpaces.
- StopWorkspaces ( array $params = [] )
Stops the specified WorkSpaces.
- TerminateWorkspaces ( array $params = [] )
Terminates the specified WorkSpaces.
- UpdateConnectClientAddIn ( array $params = [] )
Updates a Amazon Connect client add-in.
- UpdateConnectionAliasPermission ( array $params = [] )
Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.
- UpdateRulesOfIpGroup ( array $params = [] )
Replaces the current rules of the specified IP access control group with the specified rules.
- UpdateWorkspaceBundle ( array $params = [] )
Updates a WorkSpace bundle with a new image.
- UpdateWorkspaceImagePermission ( array $params = [] )
Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateConnectionAlias
$result = $client->associateConnectionAlias([/* ... */]); $promise = $client->associateConnectionAliasAsync([/* ... */]);
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Parameter Syntax
$result = $client->associateConnectionAlias([
'AliasId' => '<string>', // REQUIRED
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ConnectionIdentifier' => '<string>',
]
Result Details
Members
Errors
-
The resource is associated with a directory.
-
The user is not authorized to access a resource.
-
The resource could not be found.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
OperationNotSupportedException:
This operation is not supported.
AssociateIpGroups
$result = $client->associateIpGroups([/* ... */]); $promise = $client->associateIpGroupsAsync([/* ... */]);
Associates the specified IP access control group with the specified directory.
Parameter Syntax
$result = $client->associateIpGroups([
'DirectoryId' => '<string>', // REQUIRED
'GroupIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
-
OperationNotSupportedException:
This operation is not supported.
AuthorizeIpRules
$result = $client->authorizeIpRules([/* ... */]); $promise = $client->authorizeIpRulesAsync([/* ... */]);
Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
Parameter Syntax
$result = $client->authorizeIpRules([
'GroupId' => '<string>', // REQUIRED
'UserRules' => [ // REQUIRED
[
'ipRule' => '<string>',
'ruleDesc' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- GroupId
-
- Required: Yes
- Type: string
The identifier of the group.
- UserRules
-
- Required: Yes
- Type: Array of IpRuleItem structures
The rules to add to the group.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
CopyWorkspaceImage
$result = $client->copyWorkspaceImage([/* ... */]); $promise = $client->copyWorkspaceImageAsync([/* ... */]);
Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
Parameter Syntax
$result = $client->copyWorkspaceImage([
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'SourceImageId' => '<string>', // REQUIRED
'SourceRegion' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
A description of the image.
- Name
-
- Required: Yes
- Type: string
The name of the image.
- SourceImageId
-
- Required: Yes
- Type: string
The identifier of the source image.
- SourceRegion
-
- Required: Yes
- Type: string
The identifier of the source Region.
- Tags
-
- Type: Array of Tag structures
The tags for the image.
Result Syntax
[
'ImageId' => '<string>',
]
Result Details
Errors
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The resource could not be found.
-
The specified resource is not available.
-
OperationNotSupportedException:
This operation is not supported.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
CreateConnectClientAddIn
$result = $client->createConnectClientAddIn([/* ... */]); $promise = $client->createConnectClientAddInAsync([/* ... */]);
Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
Parameter Syntax
$result = $client->createConnectClientAddIn([
'Name' => '<string>', // REQUIRED
'ResourceId' => '<string>', // REQUIRED
'URL' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AddInId' => '<string>',
]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
ResourceCreationFailedException:
The resource could not be created.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The user is not authorized to access a resource.
CreateConnectionAlias
$result = $client->createConnectionAlias([/* ... */]); $promise = $client->createConnectionAliasAsync([/* ... */]);
Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Parameter Syntax
$result = $client->createConnectionAlias([
'ConnectionString' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- ConnectionString
-
- Required: Yes
- Type: string
A connection string in the form of a fully qualified domain name (FQDN), such as
www.example.com.After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
- Tags
-
- Type: Array of Tag structures
The tags to associate with the connection alias.
Result Syntax
[
'AliasId' => '<string>',
]
Result Details
Errors
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
OperationNotSupportedException:
This operation is not supported.
CreateIpGroup
$result = $client->createIpGroup([/* ... */]); $promise = $client->createIpGroupAsync([/* ... */]);
Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
Parameter Syntax
$result = $client->createIpGroup([
'GroupDesc' => '<string>',
'GroupName' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
'UserRules' => [
[
'ipRule' => '<string>',
'ruleDesc' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- GroupDesc
-
- Type: string
The description of the group.
- GroupName
-
- Required: Yes
- Type: string
The name of the group.
- Tags
-
- Type: Array of Tag structures
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
- UserRules
-
- Type: Array of IpRuleItem structures
The rules to add to the group.
Result Syntax
[
'GroupId' => '<string>',
]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
ResourceCreationFailedException:
The resource could not be created.
-
The user is not authorized to access a resource.
CreateStandbyWorkspaces
$result = $client->createStandbyWorkspaces([/* ... */]); $promise = $client->createStandbyWorkspacesAsync([/* ... */]);
Creates a standby WorkSpace in a secondary Region.
Parameter Syntax
$result = $client->createStandbyWorkspaces([
'PrimaryRegion' => '<string>', // REQUIRED
'StandbyWorkspaces' => [ // REQUIRED
[
'DirectoryId' => '<string>', // REQUIRED
'PrimaryWorkspaceId' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
'VolumeEncryptionKey' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- PrimaryRegion
-
- Required: Yes
- Type: string
The Region of the primary WorkSpace.
- StandbyWorkspaces
-
- Required: Yes
- Type: Array of StandbyWorkspace structures
Information about the standby WorkSpace to be created.
Result Syntax
[
'FailedStandbyRequests' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'StandbyWorkspaceRequest' => [
'DirectoryId' => '<string>',
'PrimaryWorkspaceId' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VolumeEncryptionKey' => '<string>',
],
],
// ...
],
'PendingStandbyRequests' => [
[
'DirectoryId' => '<string>',
'State' => 'PENDING|AVAILABLE|IMPAIRED|UNHEALTHY|REBOOTING|STARTING|REBUILDING|RESTORING|MAINTENANCE|ADMIN_MAINTENANCE|TERMINATING|TERMINATED|SUSPENDED|UPDATING|STOPPING|STOPPED|ERROR',
'UserName' => '<string>',
'WorkspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedStandbyRequests
-
- Type: Array of FailedCreateStandbyWorkspacesRequest structures
Information about the standby WorkSpace that could not be created.
- PendingStandbyRequests
-
- Type: Array of PendingCreateStandbyWorkspacesRequest structures
Information about the standby WorkSpace that was created.
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
OperationNotSupportedException:
This operation is not supported.
-
The resource could not be found.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
CreateTags
$result = $client->createTags([/* ... */]); $promise = $client->createTagsAsync([/* ... */]);
Creates the specified tags for the specified WorkSpaces resource.
Parameter Syntax
$result = $client->createTags([
'ResourceId' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- ResourceId
-
- Required: Yes
- Type: string
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Result Syntax
[]
Result Details
Errors
-
The resource could not be found.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
CreateUpdatedWorkspaceImage
$result = $client->createUpdatedWorkspaceImage([/* ... */]); $promise = $client->createUpdatedWorkspaceImageAsync([/* ... */]);
Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
-
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
-
Microsoft Windows updates and other application updates are not included in the update process.
-
The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.
Parameter Syntax
$result = $client->createUpdatedWorkspaceImage([
'Description' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'SourceImageId' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Required: Yes
- Type: string
A description of whether updates for the WorkSpace image are available.
- Name
-
- Required: Yes
- Type: string
The name of the new updated WorkSpace image.
- SourceImageId
-
- Required: Yes
- Type: string
The identifier of the source WorkSpace image.
- Tags
-
- Type: Array of Tag structures
The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use
workspaces:CreateTags.
Result Syntax
[
'ImageId' => '<string>',
]
Result Details
Errors
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The resource could not be found.
-
OperationNotSupportedException:
This operation is not supported.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
CreateWorkspaceBundle
$result = $client->createWorkspaceBundle([/* ... */]); $promise = $client->createWorkspaceBundleAsync([/* ... */]);
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
Parameter Syntax
$result = $client->createWorkspaceBundle([
'BundleDescription' => '<string>', // REQUIRED
'BundleName' => '<string>', // REQUIRED
'ComputeType' => [ // REQUIRED
'Name' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
],
'ImageId' => '<string>', // REQUIRED
'RootStorage' => [
'Capacity' => '<string>',
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
'UserStorage' => [ // REQUIRED
'Capacity' => '<string>',
],
]);
Parameter Details
Members
- BundleDescription
-
- Required: Yes
- Type: string
The description of the bundle.
- BundleName
-
- Required: Yes
- Type: string
The name of the bundle.
- ComputeType
-
- Required: Yes
- Type: ComputeType structure
Describes the compute type of the bundle.
- ImageId
-
- Required: Yes
- Type: string
The identifier of the image that is used to create the bundle.
- RootStorage
-
- Type: RootStorage structure
Describes the root volume for a WorkSpace bundle.
- Tags
-
- Type: Array of Tag structures
The tags associated with the bundle.
To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use
workspaces:CreateTags. - UserStorage
-
- Required: Yes
- Type: UserStorage structure
Describes the user volume for a WorkSpace bundle.
Result Syntax
[
'WorkspaceBundle' => [
'BundleId' => '<string>',
'BundleType' => 'REGULAR|STANDBY',
'ComputeType' => [
'Name' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
],
'CreationTime' => <DateTime>,
'Description' => '<string>',
'ImageId' => '<string>',
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'Owner' => '<string>',
'RootStorage' => [
'Capacity' => '<string>',
],
'State' => 'AVAILABLE|PENDING|ERROR',
'UserStorage' => [
'Capacity' => '<string>',
],
],
]
Result Details
Members
- WorkspaceBundle
-
- Type: WorkspaceBundle structure
Describes a WorkSpace bundle.
Errors
-
The specified resource is not available.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
CreateWorkspaceImage
$result = $client->createWorkspaceImage([/* ... */]); $promise = $client->createWorkspaceImageAsync([/* ... */]);
Creates a new WorkSpace image from an existing WorkSpace.
Parameter Syntax
$result = $client->createWorkspaceImage([
'Description' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
'WorkspaceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Required: Yes
- Type: string
The description of the new WorkSpace image.
- Name
-
- Required: Yes
- Type: string
The name of the new WorkSpace image.
- Tags
-
- Type: Array of Tag structures
The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use
workspaces:CreateTags. - WorkspaceId
-
- Required: Yes
- Type: string
The identifier of the source WorkSpace
Result Syntax
[
'Created' => <DateTime>,
'Description' => '<string>',
'ImageId' => '<string>',
'Name' => '<string>',
'OperatingSystem' => [
'Type' => 'WINDOWS|LINUX',
],
'OwnerAccountId' => '<string>',
'RequiredTenancy' => 'DEFAULT|DEDICATED',
'State' => 'AVAILABLE|PENDING|ERROR',
]
Result Details
Members
- Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the image was created.
- Description
-
- Type: string
The description of the image.
- ImageId
-
- Type: string
The identifier of the new WorkSpace image.
- Name
-
- Type: string
The name of the image.
- OperatingSystem
-
- Type: OperatingSystem structure
The operating system that the image is running.
- OwnerAccountId
-
- Type: string
The identifier of the Amazon Web Services account that owns the image.
- RequiredTenancy
-
- Type: string
Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
- State
-
- Type: string
The availability status of the image.
Errors
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The resource could not be found.
-
OperationNotSupportedException:
This operation is not supported.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
CreateWorkspaces
$result = $client->createWorkspaces([/* ... */]); $promise = $client->createWorkspacesAsync([/* ... */]);
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
Parameter Syntax
$result = $client->createWorkspaces([
'Workspaces' => [ // REQUIRED
[
'BundleId' => '<string>', // REQUIRED
'DirectoryId' => '<string>', // REQUIRED
'RootVolumeEncryptionEnabled' => true || false,
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
'UserName' => '<string>', // REQUIRED
'UserVolumeEncryptionEnabled' => true || false,
'VolumeEncryptionKey' => '<string>',
'WorkspaceProperties' => [
'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
'Protocols' => ['<string>', ...],
'RootVolumeSizeGib' => <integer>,
'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
'RunningModeAutoStopTimeoutInMinutes' => <integer>,
'UserVolumeSizeGib' => <integer>,
],
],
// ...
],
]);
Parameter Details
Members
- Workspaces
-
- Required: Yes
- Type: Array of WorkspaceRequest structures
The WorkSpaces to create. You can specify up to 25 WorkSpaces.
Result Syntax
[
'FailedRequests' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'WorkspaceRequest' => [
'BundleId' => '<string>',
'DirectoryId' => '<string>',
'RootVolumeEncryptionEnabled' => true || false,
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UserName' => '<string>',
'UserVolumeEncryptionEnabled' => true || false,
'VolumeEncryptionKey' => '<string>',
'WorkspaceProperties' => [
'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
'Protocols' => ['<string>', ...],
'RootVolumeSizeGib' => <integer>,
'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
'RunningModeAutoStopTimeoutInMinutes' => <integer>,
'UserVolumeSizeGib' => <integer>,
],
],
],
// ...
],
'PendingRequests' => [
[
'BundleId' => '<string>',
'ComputerName' => '<string>',
'DirectoryId' => '<string>',
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'IpAddress' => '<string>',
'ModificationStates' => [
[
'Resource' => 'ROOT_VOLUME|USER_VOLUME|COMPUTE_TYPE',
'State' => 'UPDATE_INITIATED|UPDATE_IN_PROGRESS',
],
// ...
],
'RelatedWorkspaces' => [
[
'Region' => '<string>',
'State' => 'PENDING|AVAILABLE|IMPAIRED|UNHEALTHY|REBOOTING|STARTING|REBUILDING|RESTORING|MAINTENANCE|ADMIN_MAINTENANCE|TERMINATING|TERMINATED|SUSPENDED|UPDATING|STOPPING|STOPPED|ERROR',
'Type' => 'PRIMARY|STANDBY',
'WorkspaceId' => '<string>',
],
// ...
],
'RootVolumeEncryptionEnabled' => true || false,
'State' => 'PENDING|AVAILABLE|IMPAIRED|UNHEALTHY|REBOOTING|STARTING|REBUILDING|RESTORING|MAINTENANCE|ADMIN_MAINTENANCE|TERMINATING|TERMINATED|SUSPENDED|UPDATING|STOPPING|STOPPED|ERROR',
'SubnetId' => '<string>',
'UserName' => '<string>',
'UserVolumeEncryptionEnabled' => true || false,
'VolumeEncryptionKey' => '<string>',
'WorkspaceId' => '<string>',
'WorkspaceProperties' => [
'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
'Protocols' => ['<string>', ...],
'RootVolumeSizeGib' => <integer>,
'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
'RunningModeAutoStopTimeoutInMinutes' => <integer>,
'UserVolumeSizeGib' => <integer>,
],
],
// ...
],
]
Result Details
Members
- FailedRequests
-
- Type: Array of FailedCreateWorkspaceRequest structures
Information about the WorkSpaces that could not be created.
- PendingRequests
-
- Type: Array of Workspace structures
Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
Errors
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
DeleteClientBranding
$result = $client->deleteClientBranding([/* ... */]); $promise = $client->deleteClientBrandingAsync([/* ... */]);
Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.
Parameter Syntax
$result = $client->deleteClientBranding([
'Platforms' => ['<string>', ...], // REQUIRED
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
DeleteConnectClientAddIn
$result = $client->deleteConnectClientAddIn([/* ... */]); $promise = $client->deleteConnectClientAddInAsync([/* ... */]);
Deletes a client-add-in for Amazon Connect that is configured within a directory.
Parameter Syntax
$result = $client->deleteConnectClientAddIn([
'AddInId' => '<string>', // REQUIRED
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
DeleteConnectionAlias
$result = $client->deleteConnectionAlias([/* ... */]); $promise = $client->deleteConnectionAliasAsync([/* ... */]);
Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Parameter Syntax
$result = $client->deleteConnectionAlias([
'AliasId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource could not be found.
-
The resource is associated with a directory.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
OperationNotSupportedException:
This operation is not supported.
DeleteIpGroup
$result = $client->deleteIpGroup([/* ... */]); $promise = $client->deleteIpGroupAsync([/* ... */]);
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
Parameter Syntax
$result = $client->deleteIpGroup([
'GroupId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The resource is associated with a directory.
-
The user is not authorized to access a resource.
DeleteTags
$result = $client->deleteTags([/* ... */]); $promise = $client->deleteTagsAsync([/* ... */]);
Deletes the specified tags from the specified WorkSpaces resource.
Parameter Syntax
$result = $client->deleteTags([
'ResourceId' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource could not be found.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
DeleteWorkspaceBundle
$result = $client->deleteWorkspaceBundle([/* ... */]); $promise = $client->deleteWorkspaceBundleAsync([/* ... */]);
Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
Parameter Syntax
$result = $client->deleteWorkspaceBundle([
'BundleId' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The resource is associated with a directory.
-
The user is not authorized to access a resource.
DeleteWorkspaceImage
$result = $client->deleteWorkspaceImage([/* ... */]); $promise = $client->deleteWorkspaceImageAsync([/* ... */]);
Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
Parameter Syntax
$result = $client->deleteWorkspaceImage([
'ImageId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource is associated with a directory.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
DeregisterWorkspaceDirectory
$result = $client->deregisterWorkspaceDirectory([/* ... */]); $promise = $client->deregisterWorkspaceDirectoryAsync([/* ... */]);
Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Parameter Syntax
$result = $client->deregisterWorkspaceDirectory([
'DirectoryId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
OperationNotSupportedException:
This operation is not supported.
-
The resource could not be found.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
DescribeAccount
$result = $client->describeAccount([/* ... */]); $promise = $client->describeAccountAsync([/* ... */]);
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
Parameter Syntax
$result = $client->describeAccount([ ]);
Parameter Details
Members
Result Syntax
[
'DedicatedTenancyManagementCidrRange' => '<string>',
'DedicatedTenancySupport' => 'ENABLED|DISABLED',
]
Result Details
Members
- DedicatedTenancyManagementCidrRange
-
- Type: string
The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
- DedicatedTenancySupport
-
- Type: string
The status of BYOL (whether BYOL is enabled or disabled).
Errors
-
The user is not authorized to access a resource.
DescribeAccountModifications
$result = $client->describeAccountModifications([/* ... */]); $promise = $client->describeAccountModificationsAsync([/* ... */]);
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
Parameter Syntax
$result = $client->describeAccountModifications([
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AccountModifications' => [
[
'DedicatedTenancyManagementCidrRange' => '<string>',
'DedicatedTenancySupport' => 'ENABLED|DISABLED',
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'ModificationState' => 'PENDING|COMPLETED|FAILED',
'StartTime' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AccountModifications
-
- Type: Array of AccountModification structures
The list of modifications to the configuration of BYOL.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Errors
-
The user is not authorized to access a resource.
DescribeClientBranding
$result = $client->describeClientBranding([/* ... */]); $promise = $client->describeClientBrandingAsync([/* ... */]);
Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.
Parameter Syntax
$result = $client->describeClientBranding([
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DeviceTypeAndroid' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeIos' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo2xUrl' => '<string>',
'Logo3xUrl' => '<string>',
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeLinux' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeOsx' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeWeb' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeWindows' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
]
Result Details
Members
- DeviceTypeAndroid
-
- Type: DefaultClientBrandingAttributes structure
The branding information for Android devices.
- DeviceTypeIos
-
- Type: IosClientBrandingAttributes structure
The branding information for iOS devices.
- DeviceTypeLinux
-
- Type: DefaultClientBrandingAttributes structure
The branding information for Linux devices.
- DeviceTypeOsx
-
- Type: DefaultClientBrandingAttributes structure
The branding information for macOS devices.
- DeviceTypeWeb
-
- Type: DefaultClientBrandingAttributes structure
The branding information for Web access.
- DeviceTypeWindows
-
- Type: DefaultClientBrandingAttributes structure
The branding information for Windows devices.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
DescribeClientProperties
$result = $client->describeClientProperties([/* ... */]); $promise = $client->describeClientPropertiesAsync([/* ... */]);
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
Parameter Syntax
$result = $client->describeClientProperties([
'ResourceIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ClientPropertiesList' => [
[
'ClientProperties' => [
'LogUploadEnabled' => 'ENABLED|DISABLED',
'ReconnectEnabled' => 'ENABLED|DISABLED',
],
'ResourceId' => '<string>',
],
// ...
],
]
Result Details
Members
- ClientPropertiesList
-
- Type: Array of ClientPropertiesResult structures
Information about the specified Amazon WorkSpaces clients.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
DescribeConnectClientAddIns
$result = $client->describeConnectClientAddIns([/* ... */]); $promise = $client->describeConnectClientAddInsAsync([/* ... */]);
Retrieves a list of Amazon Connect client add-ins that have been created.
Parameter Syntax
$result = $client->describeConnectClientAddIns([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of items to return.
- NextToken
-
- Type: string
If you received a
NextTokenfrom a previous call that was paginated, provide this token to receive the next set of results. - ResourceId
-
- Required: Yes
- Type: string
The directory identifier for which the client add-in is configured.
Result Syntax
[
'AddIns' => [
[
'AddInId' => '<string>',
'Name' => '<string>',
'ResourceId' => '<string>',
'URL' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AddIns
-
- Type: Array of ConnectClientAddIn structures
Information about client add-ins.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
DescribeConnectionAliasPermissions
$result = $client->describeConnectionAliasPermissions([/* ... */]); $promise = $client->describeConnectionAliasPermissionsAsync([/* ... */]);
Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Parameter Syntax
$result = $client->describeConnectionAliasPermissions([
'AliasId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AliasId' => '<string>',
'ConnectionAliasPermissions' => [
[
'AllowAssociation' => true || false,
'SharedAccountId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AliasId
-
- Type: string
The identifier of the connection alias.
- ConnectionAliasPermissions
-
- Type: Array of ConnectionAliasPermission structures
The permissions associated with a connection alias.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
OperationNotSupportedException:
This operation is not supported.
DescribeConnectionAliases
$result = $client->describeConnectionAliases([/* ... */]); $promise = $client->describeConnectionAliasesAsync([/* ... */]);
Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Parameter Syntax
$result = $client->describeConnectionAliases([
'AliasIds' => ['<string>', ...],
'Limit' => <integer>,
'NextToken' => '<string>',
'ResourceId' => '<string>',
]);
Parameter Details
Members
- AliasIds
-
- Type: Array of strings
The identifiers of the connection aliases to describe.
- Limit
-
- Type: int
The maximum number of connection aliases to return.
- NextToken
-
- Type: string
If you received a
NextTokenfrom a previous call that was paginated, provide this token to receive the next set of results. - ResourceId
-
- Type: string
The identifier of the directory associated with the connection alias.
Result Syntax
[
'ConnectionAliases' => [
[
'AliasId' => '<string>',
'Associations' => [
[
'AssociatedAccountId' => '<string>',
'AssociationStatus' => 'NOT_ASSOCIATED|ASSOCIATED_WITH_OWNER_ACCOUNT|ASSOCIATED_WITH_SHARED_ACCOUNT|PENDING_ASSOCIATION|PENDING_DISASSOCIATION',
'ConnectionIdentifier' => '<string>',
'ResourceId' => '<string>',
],
// ...
],
'ConnectionString' => '<string>',
'OwnerAccountId' => '<string>',
'State' => 'CREATING|CREATED|DELETING',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ConnectionAliases
-
- Type: Array of ConnectionAlias structures
Information about the specified connection aliases.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
OperationNotSupportedException:
This operation is not supported.
DescribeIpGroups
$result = $client->describeIpGroups([/* ... */]); $promise = $client->describeIpGroupsAsync([/* ... */]);
Describes one or more of your IP access control groups.
Parameter Syntax
$result = $client->describeIpGroups([
'GroupIds' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'Result' => [
[
'groupDesc' => '<string>',
'groupId' => '<string>',
'groupName' => '<string>',
'userRules' => [
[
'ipRule' => '<string>',
'ruleDesc' => '<string>',
],
// ...
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Result
-
- Type: Array of WorkspacesIpGroup structures
Information about the IP access control groups.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The user is not authorized to access a resource.
DescribeTags
$result = $client->describeTags([/* ... */]); $promise = $client->describeTagsAsync([/* ... */]);
Describes the specified tags for the specified WorkSpaces resource.
Parameter Syntax
$result = $client->describeTags([
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'TagList' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- TagList
-
- Type: Array of Tag structures
The tags.
Errors
-
The resource could not be found.
DescribeWorkspaceBundles
$result = $client->describeWorkspaceBundles([/* ... */]); $promise = $client->describeWorkspaceBundlesAsync([/* ... */]);
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
Parameter Syntax
$result = $client->describeWorkspaceBundles([
'BundleIds' => ['<string>', ...],
'NextToken' => '<string>',
'Owner' => '<string>',
]);
Parameter Details
Members
- BundleIds
-
- Type: Array of strings
The identifiers of the bundles. You cannot combine this parameter with any other filter.
- NextToken
-
- Type: string
The token for the next set of results. (You received this token from a previous call.)
- Owner
-
- Type: string
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify
AMAZON. To describe the bundles that belong to your account, don't specify a value.
Result Syntax
[
'Bundles' => [
[
'BundleId' => '<string>',
'BundleType' => 'REGULAR|STANDBY',
'ComputeType' => [
'Name' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
],
'CreationTime' => <DateTime>,
'Description' => '<string>',
'ImageId' => '<string>',
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'Owner' => '<string>',
'RootStorage' => [
'Capacity' => '<string>',
],
'State' => 'AVAILABLE|PENDING|ERROR',
'UserStorage' => [
'Capacity' => '<string>',
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Bundles
-
- Type: Array of WorkspaceBundle structures
Information about the bundles.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
DescribeWorkspaceDirectories
$result = $client->describeWorkspaceDirectories([/* ... */]); $promise = $client->describeWorkspaceDirectoriesAsync([/* ... */]);
Describes the available directories that are registered with Amazon WorkSpaces.
Parameter Syntax
$result = $client->describeWorkspaceDirectories([
'DirectoryIds' => ['<string>', ...],
'Limit' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- DirectoryIds
-
- Type: Array of strings
The identifiers of the directories. If the value is null, all directories are retrieved.
- Limit
-
- Type: int
The maximum number of directories to return.
- NextToken
-
- Type: string
If you received a
NextTokenfrom a previous call that was paginated, provide this token to receive the next set of results.
Result Syntax
[
'Directories' => [
[
'Alias' => '<string>',
'CertificateBasedAuthProperties' => [
'CertificateAuthorityArn' => '<string>',
'Status' => 'DISABLED|ENABLED',
],
'CustomerUserName' => '<string>',
'DirectoryId' => '<string>',
'DirectoryName' => '<string>',
'DirectoryType' => 'SIMPLE_AD|AD_CONNECTOR',
'DnsIpAddresses' => ['<string>', ...],
'IamRoleId' => '<string>',
'RegistrationCode' => '<string>',
'SamlProperties' => [
'RelayStateParameterName' => '<string>',
'Status' => 'DISABLED|ENABLED|ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK',
'UserAccessUrl' => '<string>',
],
'SelfservicePermissions' => [
'ChangeComputeType' => 'ENABLED|DISABLED',
'IncreaseVolumeSize' => 'ENABLED|DISABLED',
'RebuildWorkspace' => 'ENABLED|DISABLED',
'RestartWorkspace' => 'ENABLED|DISABLED',
'SwitchRunningMode' => 'ENABLED|DISABLED',
],
'State' => 'REGISTERING|REGISTERED|DEREGISTERING|DEREGISTERED|ERROR',
'SubnetIds' => ['<string>', ...],
'Tenancy' => 'DEDICATED|SHARED',
'WorkspaceAccessProperties' => [
'DeviceTypeAndroid' => 'ALLOW|DENY',
'DeviceTypeChromeOs' => 'ALLOW|DENY',
'DeviceTypeIos' => 'ALLOW|DENY',
'DeviceTypeLinux' => 'ALLOW|DENY',
'DeviceTypeOsx' => 'ALLOW|DENY',
'DeviceTypeWeb' => 'ALLOW|DENY',
'DeviceTypeWindows' => 'ALLOW|DENY',
'DeviceTypeZeroClient' => 'ALLOW|DENY',
],
'WorkspaceCreationProperties' => [
'CustomSecurityGroupId' => '<string>',
'DefaultOu' => '<string>',
'EnableInternetAccess' => true || false,
'EnableMaintenanceMode' => true || false,
'EnableWorkDocs' => true || false,
'UserEnabledAsLocalAdministrator' => true || false,
],
'WorkspaceSecurityGroupId' => '<string>',
'ipGroupIds' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Directories
-
- Type: Array of WorkspaceDirectory structures
Information about the directories.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
DescribeWorkspaceImagePermissions
$result = $client->describeWorkspaceImagePermissions([/* ... */]); $promise = $client->describeWorkspaceImagePermissionsAsync([/* ... */]);
Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
Parameter Syntax
$result = $client->describeWorkspaceImagePermissions([
'ImageId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ImageId' => '<string>',
'ImagePermissions' => [
[
'SharedAccountId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ImageId
-
- Type: string
The identifier of the image.
- ImagePermissions
-
- Type: Array of ImagePermission structures
The identifiers of the Amazon Web Services accounts that the image has been shared with.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Errors
-
The resource could not be found.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
DescribeWorkspaceImages
$result = $client->describeWorkspaceImages([/* ... */]); $promise = $client->describeWorkspaceImagesAsync([/* ... */]);
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
Parameter Syntax
$result = $client->describeWorkspaceImages([
'ImageIds' => ['<string>', ...],
'ImageType' => 'OWNED|SHARED',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ImageIds
-
- Type: Array of strings
The identifier of the image.
- ImageType
-
- Type: string
The type (owned or shared) of the image.
- MaxResults
-
- Type: int
The maximum number of items to return.
- NextToken
-
- Type: string
If you received a
NextTokenfrom a previous call that was paginated, provide this token to receive the next set of results.
Result Syntax
[
'Images' => [
[
'Created' => <DateTime>,
'Description' => '<string>',
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'ImageId' => '<string>',
'Name' => '<string>',
'OperatingSystem' => [
'Type' => 'WINDOWS|LINUX',
],
'OwnerAccountId' => '<string>',
'RequiredTenancy' => 'DEFAULT|DEDICATED',
'State' => 'AVAILABLE|PENDING|ERROR',
'Updates' => [
'Description' => '<string>',
'UpdateAvailable' => true || false,
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Images
-
- Type: Array of WorkspaceImage structures
Information about the images.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Errors
-
The user is not authorized to access a resource.
DescribeWorkspaceSnapshots
$result = $client->describeWorkspaceSnapshots([/* ... */]); $promise = $client->describeWorkspaceSnapshotsAsync([/* ... */]);
Describes the snapshots for the specified WorkSpace.
Parameter Syntax
$result = $client->describeWorkspaceSnapshots([
'WorkspaceId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'RebuildSnapshots' => [
[
'SnapshotTime' => <DateTime>,
],
// ...
],
'RestoreSnapshots' => [
[
'SnapshotTime' => <DateTime>,
],
// ...
],
]
Result Details
Members
- RebuildSnapshots
-
- Type: Array of Snapshot structures
Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
- RestoreSnapshots
-
- Type: Array of Snapshot structures
Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
DescribeWorkspaces
$result = $client->describeWorkspaces([/* ... */]); $promise = $client->describeWorkspacesAsync([/* ... */]);
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
Parameter Syntax
$result = $client->describeWorkspaces([
'BundleId' => '<string>',
'DirectoryId' => '<string>',
'Limit' => <integer>,
'NextToken' => '<string>',
'UserName' => '<string>',
'WorkspaceIds' => ['<string>', ...],
]);
Parameter Details
Members
- BundleId
-
- Type: string
The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
- DirectoryId
-
- Type: string
The identifier of the directory. In addition, you can optionally specify a specific directory user (see
UserName). You cannot combine this parameter with any other filter. - Limit
-
- Type: int
The maximum number of items to return.
- NextToken
-
- Type: string
If you received a
NextTokenfrom a previous call that was paginated, provide this token to receive the next set of results. - UserName
-
- Type: string
The name of the directory user. You must specify this parameter with
DirectoryId. - WorkspaceIds
-
- Type: Array of strings
The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
Result Syntax
[
'NextToken' => '<string>',
'Workspaces' => [
[
'BundleId' => '<string>',
'ComputerName' => '<string>',
'DirectoryId' => '<string>',
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'IpAddress' => '<string>',
'ModificationStates' => [
[
'Resource' => 'ROOT_VOLUME|USER_VOLUME|COMPUTE_TYPE',
'State' => 'UPDATE_INITIATED|UPDATE_IN_PROGRESS',
],
// ...
],
'RelatedWorkspaces' => [
[
'Region' => '<string>',
'State' => 'PENDING|AVAILABLE|IMPAIRED|UNHEALTHY|REBOOTING|STARTING|REBUILDING|RESTORING|MAINTENANCE|ADMIN_MAINTENANCE|TERMINATING|TERMINATED|SUSPENDED|UPDATING|STOPPING|STOPPED|ERROR',
'Type' => 'PRIMARY|STANDBY',
'WorkspaceId' => '<string>',
],
// ...
],
'RootVolumeEncryptionEnabled' => true || false,
'State' => 'PENDING|AVAILABLE|IMPAIRED|UNHEALTHY|REBOOTING|STARTING|REBUILDING|RESTORING|MAINTENANCE|ADMIN_MAINTENANCE|TERMINATING|TERMINATED|SUSPENDED|UPDATING|STOPPING|STOPPED|ERROR',
'SubnetId' => '<string>',
'UserName' => '<string>',
'UserVolumeEncryptionEnabled' => true || false,
'VolumeEncryptionKey' => '<string>',
'WorkspaceId' => '<string>',
'WorkspaceProperties' => [
'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
'Protocols' => ['<string>', ...],
'RootVolumeSizeGib' => <integer>,
'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
'RunningModeAutoStopTimeoutInMinutes' => <integer>,
'UserVolumeSizeGib' => <integer>,
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Workspaces
-
- Type: Array of Workspace structures
Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The specified resource is not available.
DescribeWorkspacesConnectionStatus
$result = $client->describeWorkspacesConnectionStatus([/* ... */]); $promise = $client->describeWorkspacesConnectionStatusAsync([/* ... */]);
Describes the connection status of the specified WorkSpaces.
Parameter Syntax
$result = $client->describeWorkspacesConnectionStatus([
'NextToken' => '<string>',
'WorkspaceIds' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'WorkspacesConnectionStatus' => [
[
'ConnectionState' => 'CONNECTED|DISCONNECTED|UNKNOWN',
'ConnectionStateCheckTimestamp' => <DateTime>,
'LastKnownUserConnectionTimestamp' => <DateTime>,
'WorkspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- WorkspacesConnectionStatus
-
- Type: Array of WorkspaceConnectionStatus structures
Information about the connection status of the WorkSpace.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
DisassociateConnectionAlias
$result = $client->disassociateConnectionAlias([/* ... */]); $promise = $client->disassociateConnectionAliasAsync([/* ... */]);
Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Parameter Syntax
$result = $client->disassociateConnectionAlias([
'AliasId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
The resource could not be found.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
OperationNotSupportedException:
This operation is not supported.
DisassociateIpGroups
$result = $client->disassociateIpGroups([/* ... */]); $promise = $client->disassociateIpGroupsAsync([/* ... */]);
Disassociates the specified IP access control group from the specified directory.
Parameter Syntax
$result = $client->disassociateIpGroups([
'DirectoryId' => '<string>', // REQUIRED
'GroupIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
ImportClientBranding
$result = $client->importClientBranding([/* ... */]); $promise = $client->importClientBrandingAsync([/* ... */]);
Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
-
You must specify at least one platform type when importing client branding.
-
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. -
Imported data can take up to a minute to appear in the WorkSpaces client.
Parameter Syntax
$result = $client->importClientBranding([
'DeviceTypeAndroid' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo' => <string || resource || Psr\Http\Message\StreamInterface>,
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeIos' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo' => <string || resource || Psr\Http\Message\StreamInterface>,
'Logo2x' => <string || resource || Psr\Http\Message\StreamInterface>,
'Logo3x' => <string || resource || Psr\Http\Message\StreamInterface>,
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeLinux' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo' => <string || resource || Psr\Http\Message\StreamInterface>,
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeOsx' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo' => <string || resource || Psr\Http\Message\StreamInterface>,
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeWeb' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo' => <string || resource || Psr\Http\Message\StreamInterface>,
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeWindows' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo' => <string || resource || Psr\Http\Message\StreamInterface>,
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DeviceTypeAndroid
-
- Type: DefaultImportClientBrandingAttributes structure
The branding information to import for Android devices.
- DeviceTypeIos
-
- Type: IosImportClientBrandingAttributes structure
The branding information to import for iOS devices.
- DeviceTypeLinux
-
- Type: DefaultImportClientBrandingAttributes structure
The branding information to import for Linux devices.
- DeviceTypeOsx
-
- Type: DefaultImportClientBrandingAttributes structure
The branding information to import for macOS devices.
- DeviceTypeWeb
-
- Type: DefaultImportClientBrandingAttributes structure
The branding information to import for web access.
- DeviceTypeWindows
-
- Type: DefaultImportClientBrandingAttributes structure
The branding information to import for Windows devices.
- ResourceId
-
- Required: Yes
- Type: string
The directory identifier of the WorkSpace for which you want to import client branding.
Result Syntax
[
'DeviceTypeAndroid' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeIos' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'Logo2xUrl' => '<string>',
'Logo3xUrl' => '<string>',
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeLinux' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeOsx' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeWeb' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
'DeviceTypeWindows' => [
'ForgotPasswordLink' => '<string>',
'LoginMessage' => ['<string>', ...],
'LogoUrl' => '<string>',
'SupportEmail' => '<string>',
'SupportLink' => '<string>',
],
]
Result Details
Members
- DeviceTypeAndroid
-
- Type: DefaultClientBrandingAttributes structure
The branding information configured for Android devices.
- DeviceTypeIos
-
- Type: IosClientBrandingAttributes structure
The branding information configured for iOS devices.
- DeviceTypeLinux
-
- Type: DefaultClientBrandingAttributes structure
The branding information configured for Linux devices.
- DeviceTypeOsx
-
- Type: DefaultClientBrandingAttributes structure
The branding information configured for macOS devices.
- DeviceTypeWeb
-
- Type: DefaultClientBrandingAttributes structure
The branding information configured for web access.
- DeviceTypeWindows
-
- Type: DefaultClientBrandingAttributes structure
The branding information configured for Windows devices.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The resource could not be found.
-
The user is not authorized to access a resource.
ImportWorkspaceImage
$result = $client->importWorkspaceImage([/* ... */]); $promise = $client->importWorkspaceImageAsync([/* ... */]);
Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
Parameter Syntax
$result = $client->importWorkspaceImage([
'Applications' => ['<string>', ...],
'Ec2ImageId' => '<string>', // REQUIRED
'ImageDescription' => '<string>', // REQUIRED
'ImageName' => '<string>', // REQUIRED
'IngestionProcess' => 'BYOL_REGULAR|BYOL_GRAPHICS|BYOL_GRAPHICSPRO|BYOL_GRAPHICS_G4DN|BYOL_REGULAR_WSP|BYOL_REGULAR_BYOP|BYOL_GRAPHICS_G4DN_BYOP', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Applications
-
- Type: Array of strings
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
- Ec2ImageId
-
- Required: Yes
- Type: string
The identifier of the EC2 image.
- ImageDescription
-
- Required: Yes
- Type: string
The description of the WorkSpace image.
- ImageName
-
- Required: Yes
- Type: string
The name of the WorkSpace image.
- IngestionProcess
-
- Required: Yes
- Type: string
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in
_WSP. To use PCoIP, specify a value that does not end in_WSP. To use BYOP, specify a value that ends in_BYOP.For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify
BYOL_REGULAR,BYOL_REGULAR_WSP, orBYOL_REGULAR_BYOP, depending on the protocol.The
BYOL_REGULAR_BYOPandBYOL_GRAPHICS_G4DN_BYOPvalues are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core. - Tags
-
- Type: Array of Tag structures
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Result Syntax
[
'ImageId' => '<string>',
]
Result Details
Errors
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The resource could not be found.
-
OperationNotSupportedException:
This operation is not supported.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
ListAvailableManagementCidrRanges
$result = $client->listAvailableManagementCidrRanges([/* ... */]); $promise = $client->listAvailableManagementCidrRangesAsync([/* ... */]);
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
Parameter Syntax
$result = $client->listAvailableManagementCidrRanges([
'ManagementCidrRangeConstraint' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ManagementCidrRangeConstraint
-
- Required: Yes
- Type: string
The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
- MaxResults
-
- Type: int
The maximum number of items to return.
- NextToken
-
- Type: string
If you received a
NextTokenfrom a previous call that was paginated, provide this token to receive the next set of results.
Result Syntax
[
'ManagementCidrRanges' => ['<string>', ...],
'NextToken' => '<string>',
]
Result Details
Members
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The user is not authorized to access a resource.
MigrateWorkspace
$result = $client->migrateWorkspace([/* ... */]); $promise = $client->migrateWorkspaceAsync([/* ... */]);
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
Parameter Syntax
$result = $client->migrateWorkspace([
'BundleId' => '<string>', // REQUIRED
'SourceWorkspaceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'SourceWorkspaceId' => '<string>',
'TargetWorkspaceId' => '<string>',
]
Result Details
Members
- SourceWorkspaceId
-
- Type: string
The original identifier of the WorkSpace that is being migrated.
- TargetWorkspaceId
-
- Type: string
The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
-
OperationNotSupportedException:
This operation is not supported.
-
The properties of this WorkSpace are currently being modified. Try again in a moment.
-
The specified resource is not available.
ModifyAccount
$result = $client->modifyAccount([/* ... */]); $promise = $client->modifyAccountAsync([/* ... */]);
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
Parameter Syntax
$result = $client->modifyAccount([
'DedicatedTenancyManagementCidrRange' => '<string>',
'DedicatedTenancySupport' => 'ENABLED',
]);
Parameter Details
Members
- DedicatedTenancyManagementCidrRange
-
- Type: string
The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the
ListAvailableManagementCidrRangesoperation. - DedicatedTenancySupport
-
- Type: string
The status of BYOL.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The user is not authorized to access a resource.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The specified resource is not available.
-
The resource could not be found.
ModifyCertificateBasedAuthProperties
$result = $client->modifyCertificateBasedAuthProperties([/* ... */]); $promise = $client->modifyCertificateBasedAuthPropertiesAsync([/* ... */]);
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
Parameter Syntax
$result = $client->modifyCertificateBasedAuthProperties([
'CertificateBasedAuthProperties' => [
'CertificateAuthorityArn' => '<string>',
'Status' => 'DISABLED|ENABLED',
],
'PropertiesToDelete' => ['<string>', ...],
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- CertificateBasedAuthProperties
-
- Type: CertificateBasedAuthProperties structure
The properties of the certificate-based authentication.
- PropertiesToDelete
-
- Type: Array of strings
The properties of the certificate-based authentication you want to delete.
- ResourceId
-
- Required: Yes
- Type: string
The resource identifiers, in the form of directory IDs.
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
OperationNotSupportedException:
This operation is not supported.
-
The resource could not be found.
ModifyClientProperties
$result = $client->modifyClientProperties([/* ... */]); $promise = $client->modifyClientPropertiesAsync([/* ... */]);
Modifies the properties of the specified Amazon WorkSpaces clients.
Parameter Syntax
$result = $client->modifyClientProperties([
'ClientProperties' => [ // REQUIRED
'LogUploadEnabled' => 'ENABLED|DISABLED',
'ReconnectEnabled' => 'ENABLED|DISABLED',
],
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientProperties
-
- Required: Yes
- Type: ClientProperties structure
Information about the Amazon WorkSpaces client.
- ResourceId
-
- Required: Yes
- Type: string
The resource identifiers, in the form of directory IDs.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
ModifySamlProperties
$result = $client->modifySamlProperties([/* ... */]); $promise = $client->modifySamlPropertiesAsync([/* ... */]);
Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
Parameter Syntax
$result = $client->modifySamlProperties([
'PropertiesToDelete' => ['<string>', ...],
'ResourceId' => '<string>', // REQUIRED
'SamlProperties' => [
'RelayStateParameterName' => '<string>',
'Status' => 'DISABLED|ENABLED|ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK',
'UserAccessUrl' => '<string>',
],
]);
Parameter Details
Members
- PropertiesToDelete
-
- Type: Array of strings
The SAML properties to delete as part of your request.
Specify one of the following options:
-
SAML_PROPERTIES_USER_ACCESS_URLto delete the user access URL. -
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAMEto delete the relay state parameter name.
- ResourceId
-
- Required: Yes
- Type: string
The directory identifier for which you want to configure SAML properties.
- SamlProperties
-
- Type: SamlProperties structure
The properties for configuring SAML 2.0 authentication.
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
OperationNotSupportedException:
This operation is not supported.
-
The resource could not be found.
ModifySelfservicePermissions
$result = $client->modifySelfservicePermissions([/* ... */]); $promise = $client->modifySelfservicePermissionsAsync([/* ... */]);
Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
Parameter Syntax
$result = $client->modifySelfservicePermissions([
'ResourceId' => '<string>', // REQUIRED
'SelfservicePermissions' => [ // REQUIRED
'ChangeComputeType' => 'ENABLED|DISABLED',
'IncreaseVolumeSize' => 'ENABLED|DISABLED',
'RebuildWorkspace' => 'ENABLED|DISABLED',
'RestartWorkspace' => 'ENABLED|DISABLED',
'SwitchRunningMode' => 'ENABLED|DISABLED',
],
]);
Parameter Details
Members
- ResourceId
-
- Required: Yes
- Type: string
The identifier of the directory.
- SelfservicePermissions
-
- Required: Yes
- Type: SelfservicePermissions structure
The permissions to enable or disable self-service capabilities.
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
ModifyWorkspaceAccessProperties
$result = $client->modifyWorkspaceAccessProperties([/* ... */]); $promise = $client->modifyWorkspaceAccessPropertiesAsync([/* ... */]);
Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
Parameter Syntax
$result = $client->modifyWorkspaceAccessProperties([
'ResourceId' => '<string>', // REQUIRED
'WorkspaceAccessProperties' => [ // REQUIRED
'DeviceTypeAndroid' => 'ALLOW|DENY',
'DeviceTypeChromeOs' => 'ALLOW|DENY',
'DeviceTypeIos' => 'ALLOW|DENY',
'DeviceTypeLinux' => 'ALLOW|DENY',
'DeviceTypeOsx' => 'ALLOW|DENY',
'DeviceTypeWeb' => 'ALLOW|DENY',
'DeviceTypeWindows' => 'ALLOW|DENY',
'DeviceTypeZeroClient' => 'ALLOW|DENY',
],
]);
Parameter Details
Members
- ResourceId
-
- Required: Yes
- Type: string
The identifier of the directory.
- WorkspaceAccessProperties
-
- Required: Yes
- Type: WorkspaceAccessProperties structure
The device types and operating systems to enable or disable for access.
Result Syntax
[]
Result Details
Errors
-
The resource could not be found.
-
The user is not authorized to access a resource.
ModifyWorkspaceCreationProperties
$result = $client->modifyWorkspaceCreationProperties([/* ... */]); $promise = $client->modifyWorkspaceCreationPropertiesAsync([/* ... */]);
Modify the default properties used to create WorkSpaces.
Parameter Syntax
$result = $client->modifyWorkspaceCreationProperties([
'ResourceId' => '<string>', // REQUIRED
'WorkspaceCreationProperties' => [ // REQUIRED
'CustomSecurityGroupId' => '<string>',
'DefaultOu' => '<string>',
'EnableInternetAccess' => true || false,
'EnableMaintenanceMode' => true || false,
'EnableWorkDocs' => true || false,
'UserEnabledAsLocalAdministrator' => true || false,
],
]);
Parameter Details
Members
- ResourceId
-
- Required: Yes
- Type: string
The identifier of the directory.
- WorkspaceCreationProperties
-
- Required: Yes
- Type: WorkspaceCreationProperties structure
The default properties for creating WorkSpaces.
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
OperationNotSupportedException:
This operation is not supported.
ModifyWorkspaceProperties
$result = $client->modifyWorkspaceProperties([/* ... */]); $promise = $client->modifyWorkspacePropertiesAsync([/* ... */]);
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
Parameter Syntax
$result = $client->modifyWorkspaceProperties([
'WorkspaceId' => '<string>', // REQUIRED
'WorkspaceProperties' => [ // REQUIRED
'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
'Protocols' => ['<string>', ...],
'RootVolumeSizeGib' => <integer>,
'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
'RunningModeAutoStopTimeoutInMinutes' => <integer>,
'UserVolumeSizeGib' => <integer>,
],
]);
Parameter Details
Members
- WorkspaceId
-
- Required: Yes
- Type: string
The identifier of the WorkSpace.
- WorkspaceProperties
-
- Required: Yes
- Type: WorkspaceProperties structure
The properties of the WorkSpace.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The properties of this WorkSpace are currently being modified. Try again in a moment.
-
UnsupportedWorkspaceConfigurationException:
The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
-
The resource could not be found.
-
The user is not authorized to access a resource.
-
The specified resource is not available.
ModifyWorkspaceState
$result = $client->modifyWorkspaceState([/* ... */]); $promise = $client->modifyWorkspaceStateAsync([/* ... */]);
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.
Parameter Syntax
$result = $client->modifyWorkspaceState([
'WorkspaceId' => '<string>', // REQUIRED
'WorkspaceState' => 'AVAILABLE|ADMIN_MAINTENANCE', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The resource could not be found.
-
OperationNotSupportedException:
This operation is not supported.
RebootWorkspaces
$result = $client->rebootWorkspaces([/* ... */]); $promise = $client->rebootWorkspacesAsync([/* ... */]);
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
Parameter Syntax
$result = $client->rebootWorkspaces([
'RebootWorkspaceRequests' => [ // REQUIRED
[
'WorkspaceId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- RebootWorkspaceRequests
-
- Required: Yes
- Type: Array of RebootRequest structures
The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
Result Syntax
[
'FailedRequests' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'WorkspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedRequests
-
- Type: Array of FailedWorkspaceChangeRequest structures
Information about the WorkSpaces that could not be rebooted.
Errors
-
OperationNotSupportedException:
This operation is not supported.
RebuildWorkspaces
$result = $client->rebuildWorkspaces([/* ... */]); $promise = $client->rebuildWorkspacesAsync([/* ... */]);
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
Parameter Syntax
$result = $client->rebuildWorkspaces([
'RebuildWorkspaceRequests' => [ // REQUIRED
[
'WorkspaceId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- RebuildWorkspaceRequests
-
- Required: Yes
- Type: Array of RebuildRequest structures
The WorkSpace to rebuild. You can specify a single WorkSpace.
Result Syntax
[
'FailedRequests' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'WorkspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedRequests
-
- Type: Array of FailedWorkspaceChangeRequest structures
Information about the WorkSpace that could not be rebuilt.
Errors
-
OperationNotSupportedException:
This operation is not supported.
RegisterWorkspaceDirectory
$result = $client->registerWorkspaceDirectory([/* ... */]); $promise = $client->registerWorkspaceDirectoryAsync([/* ... */]);
Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
Parameter Syntax
$result = $client->registerWorkspaceDirectory([
'DirectoryId' => '<string>', // REQUIRED
'EnableSelfService' => true || false,
'EnableWorkDocs' => true || false, // REQUIRED
'SubnetIds' => ['<string>', ...],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
'Tenancy' => 'DEDICATED|SHARED',
]);
Parameter Details
Members
- DirectoryId
-
- Required: Yes
- Type: string
The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
- EnableSelfService
-
- Type: boolean
Indicates whether self-service capabilities are enabled or disabled.
- EnableWorkDocs
-
- Required: Yes
- Type: boolean
Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set
EnableWorkDocsto disabled, and try again. - SubnetIds
-
- Type: Array of strings
The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
- Tags
-
- Type: Array of Tag structures
The tags associated with the directory.
- Tenancy
-
- Type: string
Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to
DEDICATEDand your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The user is not authorized to access a resource.
-
WorkspacesDefaultRoleNotFoundException:
The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
UnsupportedNetworkConfigurationException:
The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
-
OperationNotSupportedException:
This operation is not supported.
RestoreWorkspace
$result = $client->restoreWorkspace([/* ... */]); $promise = $client->restoreWorkspaceAsync([/* ... */]);
Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
Parameter Syntax
$result = $client->restoreWorkspace([
'WorkspaceId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
-
OperationNotSupportedException:
This operation is not supported.
RevokeIpRules
$result = $client->revokeIpRules([/* ... */]); $promise = $client->revokeIpRulesAsync([/* ... */]);
Removes one or more rules from the specified IP access control group.
Parameter Syntax
$result = $client->revokeIpRules([
'GroupId' => '<string>', // REQUIRED
'UserRules' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
StartWorkspaces
$result = $client->startWorkspaces([/* ... */]); $promise = $client->startWorkspacesAsync([/* ... */]);
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
Parameter Syntax
$result = $client->startWorkspaces([
'StartWorkspaceRequests' => [ // REQUIRED
[
'WorkspaceId' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- StartWorkspaceRequests
-
- Required: Yes
- Type: Array of StartRequest structures
The WorkSpaces to start. You can specify up to 25 WorkSpaces.
Result Syntax
[
'FailedRequests' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'WorkspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedRequests
-
- Type: Array of FailedWorkspaceChangeRequest structures
Information about the WorkSpaces that could not be started.
Errors
There are no errors described for this operation.
StopWorkspaces
$result = $client->stopWorkspaces([/* ... */]); $promise = $client->stopWorkspacesAsync([/* ... */]);
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
Parameter Syntax
$result = $client->stopWorkspaces([
'StopWorkspaceRequests' => [ // REQUIRED
[
'WorkspaceId' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- StopWorkspaceRequests
-
- Required: Yes
- Type: Array of StopRequest structures
The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
Result Syntax
[
'FailedRequests' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'WorkspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedRequests
-
- Type: Array of FailedWorkspaceChangeRequest structures
Information about the WorkSpaces that could not be stopped.
Errors
There are no errors described for this operation.
TerminateWorkspaces
$result = $client->terminateWorkspaces([/* ... */]); $promise = $client->terminateWorkspacesAsync([/* ... */]);
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Parameter Syntax
$result = $client->terminateWorkspaces([
'TerminateWorkspaceRequests' => [ // REQUIRED
[
'WorkspaceId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- TerminateWorkspaceRequests
-
- Required: Yes
- Type: Array of TerminateRequest structures
The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
Result Syntax
[
'FailedRequests' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'WorkspaceId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedRequests
-
- Type: Array of FailedWorkspaceChangeRequest structures
Information about the WorkSpaces that could not be terminated.
Errors
There are no errors described for this operation.
UpdateConnectClientAddIn
$result = $client->updateConnectClientAddIn([/* ... */]); $promise = $client->updateConnectClientAddInAsync([/* ... */]);
Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
Parameter Syntax
$result = $client->updateConnectClientAddIn([
'AddInId' => '<string>', // REQUIRED
'Name' => '<string>',
'ResourceId' => '<string>', // REQUIRED
'URL' => '<string>',
]);
Parameter Details
Members
- AddInId
-
- Required: Yes
- Type: string
The identifier of the client add-in to update.
- Name
-
- Type: string
The name of the client add-in.
- ResourceId
-
- Required: Yes
- Type: string
The directory identifier for which the client add-in is configured.
- URL
-
- Type: string
The endpoint URL of the Amazon Connect client add-in.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The user is not authorized to access a resource.
UpdateConnectionAliasPermission
$result = $client->updateConnectionAliasPermission([/* ... */]); $promise = $client->updateConnectionAliasPermissionAsync([/* ... */]);
Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
-
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is
CREATED. -
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Parameter Syntax
$result = $client->updateConnectionAliasPermission([
'AliasId' => '<string>', // REQUIRED
'ConnectionAliasPermission' => [ // REQUIRED
'AllowAssociation' => true || false, // REQUIRED
'SharedAccountId' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- AliasId
-
- Required: Yes
- Type: string
The identifier of the connection alias that you want to update permissions for.
- ConnectionAliasPermission
-
- Required: Yes
- Type: ConnectionAliasPermission structure
Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The resource could not be found.
-
The resource is associated with a directory.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
OperationNotSupportedException:
This operation is not supported.
UpdateRulesOfIpGroup
$result = $client->updateRulesOfIpGroup([/* ... */]); $promise = $client->updateRulesOfIpGroupAsync([/* ... */]);
Replaces the current rules of the specified IP access control group with the specified rules.
Parameter Syntax
$result = $client->updateRulesOfIpGroup([
'GroupId' => '<string>', // REQUIRED
'UserRules' => [ // REQUIRED
[
'ipRule' => '<string>',
'ruleDesc' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- GroupId
-
- Required: Yes
- Type: string
The identifier of the group.
- UserRules
-
- Required: Yes
- Type: Array of IpRuleItem structures
One or more rules.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
InvalidResourceStateException:
The state of the resource is not valid for this operation.
-
The user is not authorized to access a resource.
UpdateWorkspaceBundle
$result = $client->updateWorkspaceBundle([/* ... */]); $promise = $client->updateWorkspaceBundleAsync([/* ... */]);
Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
Parameter Syntax
$result = $client->updateWorkspaceBundle([
'BundleId' => '<string>',
'ImageId' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
The resource could not be found.
-
The specified resource is not available.
-
OperationNotSupportedException:
This operation is not supported.
UpdateWorkspaceImagePermission
$result = $client->updateWorkspaceImagePermission([/* ... */]); $promise = $client->updateWorkspaceImagePermissionAsync([/* ... */]);
Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
-
To delete an image that has been shared, you must unshare the image before you delete it.
-
Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
Parameter Syntax
$result = $client->updateWorkspaceImagePermission([
'AllowCopyImage' => true || false, // REQUIRED
'ImageId' => '<string>', // REQUIRED
'SharedAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AllowCopyImage
-
- Required: Yes
- Type: boolean
The permission to copy the image. This permission can be revoked only after an image has been shared.
- ImageId
-
- Required: Yes
- Type: string
The identifier of the image.
- SharedAccountId
-
- Required: Yes
- Type: string
The identifier of the Amazon Web Services account to share or unshare the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
Result Syntax
[]
Result Details
Errors
-
The resource could not be found.
-
The specified resource is not available.
-
The user is not authorized to access a resource.
-
InvalidParameterValuesException:
One or more parameter values are not valid.
-
OperationNotSupportedException:
This operation is not supported.
Shapes
AccessDeniedException
AccountModification
Description
Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
Members
- DedicatedTenancyManagementCidrRange
-
- Type: string
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
- DedicatedTenancySupport
-
- Type: string
The status of BYOL (whether BYOL is being enabled or disabled).
- ErrorCode
-
- Type: string
The error code that is returned if the configuration of BYOL cannot be modified.
- ErrorMessage
-
- Type: string
The text of the error message that is returned if the configuration of BYOL cannot be modified.
- ModificationState
-
- Type: string
The state of the modification to the configuration of BYOL.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the modification of the BYOL configuration was started.
CertificateBasedAuthProperties
Description
Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.
Members
ClientProperties
Description
Describes an Amazon WorkSpaces client.
Members
- LogUploadEnabled
-
- Type: string
Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.
- ReconnectEnabled
-
- Type: string
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.
ClientPropertiesResult
Description
Information about the Amazon WorkSpaces client.
Members
- ClientProperties
-
- Type: ClientProperties structure
Information about the Amazon WorkSpaces client.
- ResourceId
-
- Type: string
The resource identifier, in the form of a directory ID.
ComputeType
ConnectClientAddIn
Description
Describes an Amazon Connect client add-in.
Members
ConnectionAlias
Description
Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Members
- AliasId
-
- Type: string
The identifier of the connection alias.
- Associations
-
- Type: Array of ConnectionAliasAssociation structures
The association status of the connection alias.
- ConnectionString
-
- Type: string
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. - OwnerAccountId
-
- Type: string
The identifier of the Amazon Web Services account that owns the connection alias.
- State
-
- Type: string
The current state of the connection alias.
ConnectionAliasAssociation
Description
Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Members
- AssociatedAccountId
-
- Type: string
The identifier of the Amazon Web Services account that associated the connection alias with a directory.
- AssociationStatus
-
- Type: string
The association status of the connection alias.
- ConnectionIdentifier
-
- Type: string
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.
- ResourceId
-
- Type: string
The identifier of the directory associated with a connection alias.
ConnectionAliasPermission
Description
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.
Members
- AllowAssociation
-
- Required: Yes
- Type: boolean
Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
- SharedAccountId
-
- Required: Yes
- Type: string
The identifier of the Amazon Web Services account that the connection alias is shared with.
DefaultClientBrandingAttributes
Description
Returns default client branding attributes that were imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you don't include sensitive information.
Members
- ForgotPasswordLink
-
- Type: string
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
- LoginMessage
-
- Type: Associative array of custom strings keys (ClientLocale) to strings
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is
en_US. The HTML tags supported include the following:a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul. - LogoUrl
-
- Type: string
The logo. The only image format accepted is a binary data object that is converted from a
.pngfile. - SupportEmail
-
- Type: string
The support email. The company's customer support email address.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default email is
workspaces-feedback@amazon.com.
- SupportLink
-
- Type: string
The support link. The link for the company's customer support page for their WorkSpace.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive.You can specify one parameter for each platform type, but not both. -
The default support link is
workspaces-feedback@amazon.com.
DefaultImportClientBrandingAttributes
Description
The default client branding attributes to be imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you do not include sensitive information.
Members
- ForgotPasswordLink
-
- Type: string
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
- LoginMessage
-
- Type: Associative array of custom strings keys (ClientLocale) to strings
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is
en_US. The HTML tags supported include the following:a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul. - Logo
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The logo. The only image format accepted is a binary data object that is converted from a
.pngfile. - SupportEmail
-
- Type: string
The support email. The company's customer support email address.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default email is
workspaces-feedback@amazon.com.
- SupportLink
-
- Type: string
The support link. The link for the company's customer support page for their WorkSpace.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default support link is
workspaces-feedback@amazon.com.
DefaultWorkspaceCreationProperties
Description
Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
Members
- CustomSecurityGroupId
-
- Type: string
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
- DefaultOu
-
- Type: string
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
- EnableInternetAccess
-
- Type: boolean
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.
- EnableMaintenanceMode
-
- Type: boolean
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
- EnableWorkDocs
-
- Type: boolean
Specifies whether the directory is enabled for Amazon WorkDocs.
- UserEnabledAsLocalAdministrator
-
- Type: boolean
Specifies whether WorkSpace users are local administrators on their WorkSpaces.
FailedCreateStandbyWorkspacesRequest
Description
Describes the standby WorkSpace that could not be created.
Members
- ErrorCode
-
- Type: string
The error code that is returned if the standby WorkSpace could not be created.
- ErrorMessage
-
- Type: string
The text of the error message that is returned if the standby WorkSpace could not be created.
- StandbyWorkspaceRequest
-
- Type: StandbyWorkspace structure
Information about the standby WorkSpace that could not be created.
FailedCreateWorkspaceRequest
Description
Describes a WorkSpace that cannot be created.
Members
- ErrorCode
-
- Type: string
The error code that is returned if the WorkSpace cannot be created.
- ErrorMessage
-
- Type: string
The text of the error message that is returned if the WorkSpace cannot be created.
- WorkspaceRequest
-
- Type: WorkspaceRequest structure
Information about the WorkSpace.
FailedWorkspaceChangeRequest
Description
Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
Members
ImagePermission
Description
Describes the Amazon Web Services 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.
Members
InvalidParameterValuesException
Description
One or more parameter values are not valid.
Members
InvalidResourceStateException
IosClientBrandingAttributes
Description
The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.
Client branding attributes are public facing. Ensure you do not include sensitive information.
Members
- ForgotPasswordLink
-
- Type: string
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
- LoginMessage
-
- Type: Associative array of custom strings keys (ClientLocale) to strings
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is
en_US. The HTML tags supported include the following:a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul. - Logo2xUrl
-
- Type: string
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a
.pngfile.For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
- Logo3xUrl
-
- Type: string
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a
.pngfile.For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
- LogoUrl
-
- Type: string
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a
.pngfile. - SupportEmail
-
- Type: string
The support email. The company's customer support email address.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default email is
workspaces-feedback@amazon.com.
- SupportLink
-
- Type: string
The support link. The link for the company's customer support page for their WorkSpace.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default support link is
workspaces-feedback@amazon.com.
IosImportClientBrandingAttributes
Description
The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.
Client branding attributes are public facing. Ensure you do not include sensitive information.
Members
- ForgotPasswordLink
-
- Type: string
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
- LoginMessage
-
- Type: Associative array of custom strings keys (ClientLocale) to strings
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is
en_US. The HTML tags supported include the following:a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul. - Logo
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a
.pngfile. - Logo2x
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a
.pngfile.For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
- Logo3x
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a
.pngfile.For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
- SupportEmail
-
- Type: string
The support email. The company's customer support email address.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default email is
workspaces-feedback@amazon.com.
- SupportLink
-
- Type: string
The support link. The link for the company's customer support page for their WorkSpace.
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default support link is
workspaces-feedback@amazon.com.
IpRuleItem
Description
Describes a rule for an IP access control group.
Members
ModificationState
Description
Describes a WorkSpace modification.
Members
OperatingSystem
Description
The operating system that the image is running.
Members
OperationInProgressException
Description
The properties of this WorkSpace are currently being modified. Try again in a moment.
Members
OperationNotSupportedException
Description
This operation is not supported.
Members
PendingCreateStandbyWorkspacesRequest
Description
Information about the standby WorkSpace.
Members
- DirectoryId
-
- Type: string
The identifier of the directory for the standby WorkSpace.
- State
-
- Type: string
The operational state of the standby WorkSpace.
- UserName
-
- Type: string
Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
- WorkspaceId
-
- Type: string
The identifier of the standby WorkSpace.
RebootRequest
Description
Describes the information used to reboot a WorkSpace.
Members
RebuildRequest
Description
Describes the information used to rebuild a WorkSpace.
Members
RelatedWorkspaceProperties
Description
Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
Members
ResourceAlreadyExistsException
ResourceAssociatedException
ResourceCreationFailedException
ResourceLimitExceededException
Description
Your resource limits have been exceeded.
Members
ResourceNotFoundException
Description
The resource could not be found.
Members
ResourceUnavailableException
Description
The specified resource is not available.
Members
RootStorage
Description
Describes the root volume for a WorkSpace bundle.
Members
SamlProperties
Description
Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
Members
- RelayStateParameterName
-
- Type: string
The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
- Status
-
- Type: string
Indicates the status of SAML 2.0 authentication. These statuses include the following.
-
If the setting is
DISABLED, end users will be directed to login with their directory credentials. -
If the setting is
ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect. -
If the setting is
ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
- UserAccessUrl
-
- Type: string
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
SelfservicePermissions
Description
Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
Members
- ChangeComputeType
-
- Type: string
Specifies whether users can change the compute type (bundle) for their WorkSpace.
- IncreaseVolumeSize
-
- Type: string
Specifies whether users can increase the volume size of the drives on their WorkSpace.
- RebuildWorkspace
-
- Type: string
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
- RestartWorkspace
-
- Type: string
Specifies whether users can restart their WorkSpace.
- SwitchRunningMode
-
- Type: string
Specifies whether users can switch the running mode of their WorkSpace.
Snapshot
Description
Describes a snapshot.
Members
StandbyWorkspace
Description
Describes a standby WorkSpace.
Members
- DirectoryId
-
- Required: Yes
- Type: string
The identifier of the directory for the standby WorkSpace.
- PrimaryWorkspaceId
-
- Required: Yes
- Type: string
The identifier of the standby WorkSpace.
- Tags
-
- Type: Array of Tag structures
The tags associated with the standby WorkSpace.
- VolumeEncryptionKey
-
- Type: string
The volume encryption key of the standby WorkSpace.
StartRequest
Description
Information used to start a WorkSpace.
Members
StopRequest
Description
Describes the information used to stop a WorkSpace.
Members
Tag
Description
Describes a tag.
Members
TerminateRequest
Description
Describes the information used to terminate a WorkSpace.
Members
UnsupportedNetworkConfigurationException
Description
The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
Members
UnsupportedWorkspaceConfigurationException
Description
The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
Members
UpdateResult
Description
Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.
Only Windows 10 WorkSpace images can be programmatically updated at this time.
Members
UserStorage
Description
Describes the user volume for a WorkSpace bundle.
Members
Workspace
Description
Describes a WorkSpace.
Members
- BundleId
-
- Type: string
The identifier of the bundle used to create the WorkSpace.
- ComputerName
-
- Type: string
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
- DirectoryId
-
- Type: string
The identifier of the Directory Service directory for the WorkSpace.
- ErrorCode
-
- Type: string
The error code that is returned if the WorkSpace cannot be created.
- ErrorMessage
-
- Type: string
The text of the error message that is returned if the WorkSpace cannot be created.
- IpAddress
-
- Type: string
The IP address of the WorkSpace.
- ModificationStates
-
- Type: Array of ModificationState structures
The modification states of the WorkSpace.
- RelatedWorkspaces
-
- Type: Array of RelatedWorkspaceProperties structures
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
- RootVolumeEncryptionEnabled
-
- Type: boolean
Indicates whether the data stored on the root volume is encrypted.
- State
-
- Type: string
The operational state of the WorkSpace.
After a WorkSpace is terminated, the
TERMINATEDstate is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated. - SubnetId
-
- Type: string
The identifier of the subnet for the WorkSpace.
- UserName
-
- Type: string
The user for the WorkSpace.
- UserVolumeEncryptionEnabled
-
- Type: boolean
Indicates whether the data stored on the user volume is encrypted.
- VolumeEncryptionKey
-
- Type: string
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
- WorkspaceId
-
- Type: string
The identifier of the WorkSpace.
- WorkspaceProperties
-
- Type: WorkspaceProperties structure
The properties of the WorkSpace.
WorkspaceAccessProperties
Description
The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.
Members
- DeviceTypeAndroid
-
- Type: string
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
- DeviceTypeChromeOs
-
- Type: string
Indicates whether users can use Chromebooks to access their WorkSpaces.
- DeviceTypeIos
-
- Type: string
Indicates whether users can use iOS devices to access their WorkSpaces.
- DeviceTypeLinux
-
- Type: string
Indicates whether users can use Linux clients to access their WorkSpaces.
- DeviceTypeOsx
-
- Type: string
Indicates whether users can use macOS clients to access their WorkSpaces.
- DeviceTypeWeb
-
- Type: string
Indicates whether users can access their WorkSpaces through a web browser.
- DeviceTypeWindows
-
- Type: string
Indicates whether users can use Windows clients to access their WorkSpaces.
- DeviceTypeZeroClient
-
- Type: string
Indicates whether users can use zero client devices to access their WorkSpaces.
WorkspaceBundle
Description
Describes a WorkSpace bundle.
Members
- BundleId
-
- Type: string
The identifier of the bundle.
- BundleType
-
- Type: string
The type of WorkSpace bundle.
- ComputeType
-
- Type: ComputeType structure
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the bundle was created.
- Description
-
- Type: string
The description of the bundle.
- ImageId
-
- Type: string
The identifier of the image that was used to create the bundle.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that the bundle was updated.
- Name
-
- Type: string
The name of the bundle.
- Owner
-
- Type: string
The owner of the bundle. This is the account identifier of the owner, or
AMAZONif the bundle is provided by Amazon Web Services. - RootStorage
-
- Type: RootStorage structure
The size of the root volume.
- State
-
- Type: string
The state of the WorkSpace bundle.
- UserStorage
-
- Type: UserStorage structure
The size of the user volume.
WorkspaceConnectionStatus
Description
Describes the connection status of a WorkSpace.
Members
- ConnectionState
-
- Type: string
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
- ConnectionStateCheckTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the connection status check.
- LastKnownUserConnectionTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last known user connection.
- WorkspaceId
-
- Type: string
The identifier of the WorkSpace.
WorkspaceCreationProperties
Description
Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
Members
- CustomSecurityGroupId
-
- Type: string
The identifier of your custom security group.
- DefaultOu
-
- Type: string
The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form
"OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example,OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.-
To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
-
The API doesn't validate whether the OU exists.
- EnableInternetAccess
-
- Type: boolean
Indicates whether internet access is enabled for your WorkSpaces.
- EnableMaintenanceMode
-
- Type: boolean
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
- EnableWorkDocs
-
- Type: boolean
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
- UserEnabledAsLocalAdministrator
-
- Type: boolean
Indicates whether users are local administrators of their WorkSpaces.
WorkspaceDirectory
Description
Describes a directory that is used with Amazon WorkSpaces.
Members
- Alias
-
- Type: string
The directory alias.
- CertificateBasedAuthProperties
-
- Type: CertificateBasedAuthProperties structure
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
- CustomerUserName
-
- Type: string
The user name for the service account.
- DirectoryId
-
- Type: string
The directory identifier.
- DirectoryName
-
- Type: string
The name of the directory.
- DirectoryType
-
- Type: string
The directory type.
- DnsIpAddresses
-
- Type: Array of strings
The IP addresses of the DNS servers for the directory.
- IamRoleId
-
- Type: string
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
- RegistrationCode
-
- Type: string
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
- SamlProperties
-
- Type: SamlProperties structure
Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
- SelfservicePermissions
-
- Type: SelfservicePermissions structure
The default self-service permissions for WorkSpaces in the directory.
- State
-
- Type: string
The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the
DEREGISTEREDstate is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered. - SubnetIds
-
- Type: Array of strings
The identifiers of the subnets used with the directory.
- Tenancy
-
- Type: string
Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to
DEDICATED. For more information, see Bring Your Own Windows Desktop Images. - WorkspaceAccessProperties
-
- Type: WorkspaceAccessProperties structure
The devices and operating systems that users can use to access WorkSpaces.
- WorkspaceCreationProperties
-
- Type: DefaultWorkspaceCreationProperties structure
The default creation properties for all WorkSpaces in the directory.
- WorkspaceSecurityGroupId
-
- Type: string
The identifier of the security group that is assigned to new WorkSpaces.
- ipGroupIds
-
- Type: Array of strings
The identifiers of the IP access control groups associated with the directory.
WorkspaceImage
Description
Describes a WorkSpace image.
Members
- Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
- Description
-
- Type: string
The description of the image.
- ErrorCode
-
- Type: string
The error code that is returned for the image.
- ErrorMessage
-
- Type: string
The text of the error message that is returned for the image.
- ImageId
-
- Type: string
The identifier of the image.
- Name
-
- Type: string
The name of the image.
- OperatingSystem
-
- Type: OperatingSystem structure
The operating system that the image is running.
- OwnerAccountId
-
- Type: string
The identifier of the Amazon Web Services account that owns the image.
- RequiredTenancy
-
- Type: string
Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to
DEDICATED. For more information, see Bring Your Own Windows Desktop Images. - State
-
- Type: string
The status of the image.
- Updates
-
- Type: UpdateResult structure
The updates (if any) that are available for the specified image.
WorkspaceProperties
Description
Describes a WorkSpace.
Members
- ComputeTypeName
-
- Type: string
The compute type. For more information, see Amazon WorkSpaces Bundles.
- Protocols
-
- Type: Array of strings
The protocol. For more information, see Protocols for Amazon WorkSpaces.
-
Only available for WorkSpaces created with PCoIP bundles.
-
The
Protocolsproperty is case sensitive. Ensure you usePCOIPorWSP. -
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
- RootVolumeSizeGib
-
- Type: int
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
- RunningMode
-
- Type: string
The running mode. For more information, see Manage the WorkSpace Running Mode.
The
MANUALvalue is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. - RunningModeAutoStopTimeoutInMinutes
-
- Type: int
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
- UserVolumeSizeGib
-
- Type: int
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
WorkspaceRequest
Description
Describes the information used to create a WorkSpace.
Members
- BundleId
-
- Required: Yes
- Type: string
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
- DirectoryId
-
- Required: Yes
- Type: string
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
- RootVolumeEncryptionEnabled
-
- Type: boolean
Indicates whether the data stored on the root volume is encrypted.
- Tags
-
- Type: Array of Tag structures
The tags for the WorkSpace.
- UserName
-
- Required: Yes
- Type: string
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
- UserVolumeEncryptionEnabled
-
- Type: boolean
Indicates whether the data stored on the user volume is encrypted.
- VolumeEncryptionKey
-
- Type: string
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
- WorkspaceProperties
-
- Type: WorkspaceProperties structure
The WorkSpace properties.
WorkspacesDefaultRoleNotFoundException
Description
The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
Members
WorkspacesIpGroup
Description
Describes an IP access control group.
Members
- groupDesc
-
- Type: string
The description of the group.
- groupId
-
- Type: string
The identifier of the group.
- groupName
-
- Type: string
The name of the group.
- userRules
-
- Type: Array of IpRuleItem structures
The rules.