AcceptAccountLinkInvitation

$result = $client->acceptAccountLinkInvitation([/* ... */]);
$promise = $client->acceptAccountLinkInvitationAsync([/* ... */]);

Accepts the account link invitation.

Parameter Syntax

$result = $client->acceptAccountLinkInvitation([
    'ClientToken' => '<string>',
    'LinkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountLink' => [
        'AccountLinkId' => '<string>',
        'AccountLinkStatus' => 'LINKED|LINKING_FAILED|LINK_NOT_FOUND|PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT|REJECTED',
        'SourceAccountId' => '<string>',
        'TargetAccountId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

The user is not authorized to access a resource.

ConflictException:

The TargetAccountId is already linked or invited.

InternalServerException:

Unexpected server error occured.

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.

Parameter Syntax

$result = $client->associateConnectionAlias([
    'AliasId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConnectionIdentifier' => '<string>',
]

Result Details

Errors

ResourceAssociatedException:

The resource is associated with a directory.

AccessDeniedException:

The user is not authorized to access a resource.

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

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.

AccessDeniedException:

The user is not authorized to access a resource.

OperationNotSupportedException:

This operation is not supported.

AssociateWorkspaceApplication

$result = $client->associateWorkspaceApplication([/* ... */]);
$promise = $client->associateWorkspaceApplicationAsync([/* ... */]);

Associates the specified application to the specified WorkSpace.

Parameter Syntax

$result = $client->associateWorkspaceApplication([
    'ApplicationId' => '<string>', // REQUIRED
    'WorkspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Association' => [
        'AssociatedResourceId' => '<string>',
        'AssociatedResourceType' => 'APPLICATION',
        'Created' => <DateTime>,
        'LastUpdatedTime' => <DateTime>,
        'State' => 'PENDING_INSTALL|PENDING_INSTALL_DEPLOYMENT|PENDING_UNINSTALL|PENDING_UNINSTALL_DEPLOYMENT|INSTALLING|UNINSTALLING|ERROR|COMPLETED|REMOVED',
        'StateReason' => [
            'ErrorCode' => 'ValidationError.InsufficientDiskSpace|ValidationError.InsufficientMemory|ValidationError.UnsupportedOperatingSystem|DeploymentError.InternalServerError|DeploymentError.WorkspaceUnreachable',
            'ErrorMessage' => '<string>',
        ],
        'WorkspaceId' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceInUseException:

The specified resource is currently in use.

ResourceNotFoundException:

The resource could not be found.

ComputeNotCompatibleException:

The compute type of the WorkSpace is not compatible with the application.

OperatingSystemNotCompatibleException:

The operating system of the WorkSpace is not compatible with the application.

ApplicationNotSupportedException:

The specified application is not supported.

IncompatibleApplicationsException:

The specified application is not compatible with the resource.

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

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.

AccessDeniedException:

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 ServicesSupport.

Parameter Syntax

$result = $client->copyWorkspaceImage([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'SourceImageId' => '<string>', // REQUIRED
    'SourceRegion' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ImageId' => '<string>',
]

Result Details

Errors

ResourceLimitExceededException:

Your resource limits have been exceeded.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

The resource could not be found.

ResourceUnavailableException:

The specified resource is not available.

OperationNotSupportedException:

This operation is not supported.

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

CreateAccountLinkInvitation

$result = $client->createAccountLinkInvitation([/* ... */]);
$promise = $client->createAccountLinkInvitationAsync([/* ... */]);

Creates the account link invitation.

Parameter Syntax

$result = $client->createAccountLinkInvitation([
    'ClientToken' => '<string>',
    'TargetAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountLink' => [
        'AccountLinkId' => '<string>',
        'AccountLinkStatus' => 'LINKED|LINKING_FAILED|LINK_NOT_FOUND|PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT|REJECTED',
        'SourceAccountId' => '<string>',
        'TargetAccountId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

AccessDeniedException:

The user is not authorized to access a resource.

ConflictException:

The TargetAccountId is already linked or invited.

InternalServerException:

Unexpected server error occured.

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

Result Syntax

[
    'AddInId' => '<string>',
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

ResourceCreationFailedException:

The resource could not be created.

ResourceAlreadyExistsException:

The specified resource already exists.

AccessDeniedException:

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

Result Syntax

[
    'AliasId' => '<string>',
]

Result Details

Errors

ResourceAlreadyExistsException:

The specified resource already exists.

AccessDeniedException:

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

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.

AccessDeniedException:

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
        [
            'DataReplication' => 'NO_REPLICATION|PRIMARY_AS_SOURCE',
            'DirectoryId' => '<string>', // REQUIRED
            'PrimaryWorkspaceId' => '<string>', // REQUIRED
            'Tags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VolumeEncryptionKey' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FailedStandbyRequests' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'StandbyWorkspaceRequest' => [
                'DataReplication' => 'NO_REPLICATION|PRIMARY_AS_SOURCE',
                '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

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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.

Parameter Syntax

$result = $client->createUpdatedWorkspaceImage([
    'Description' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'SourceImageId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ImageId' => '<string>',
]

Result Details

Errors

ResourceLimitExceededException:

Your resource limits have been exceeded.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

The resource could not be found.

OperationNotSupportedException:

This operation is not supported.

InvalidResourceStateException:

The state of the resource is not valid for this operation.

AccessDeniedException:

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|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
    ],
    'ImageId' => '<string>', // REQUIRED
    'RootStorage' => [
        'Capacity' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserStorage' => [ // REQUIRED
        'Capacity' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'WorkspaceBundle' => [
        'BundleId' => '<string>',
        'BundleType' => 'REGULAR|STANDBY',
        'ComputeType' => [
            'Name' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|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

Errors

ResourceUnavailableException:

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.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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

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

Errors

ResourceLimitExceededException:

Your resource limits have been exceeded.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

The resource could not be found.

OperationNotSupportedException:

This operation is not supported.

InvalidResourceStateException:

The state of the resource is not valid for this operation.

AccessDeniedException:

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.

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>',
            'WorkspaceName' => '<string>',
            'WorkspaceProperties' => [
                'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
                'GlobalAccelerator' => [
                    'Mode' => 'ENABLED_AUTO|DISABLED|INHERITED', // REQUIRED
                    'PreferredProtocol' => 'TCP|NONE|INHERITED',
                ],
                'OperatingSystemName' => 'AMAZON_LINUX_2|UBUNTU_18_04|UBUNTU_20_04|UBUNTU_22_04|UNKNOWN|WINDOWS_10|WINDOWS_11|WINDOWS_7|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|RHEL_8|ROCKY_8',
                'Protocols' => ['<string>', ...],
                'RootVolumeSizeGib' => <integer>,
                'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
                'RunningModeAutoStopTimeoutInMinutes' => <integer>,
                'UserVolumeSizeGib' => <integer>,
            ],
        ],
        // ...
    ],
]);

Parameter Details

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>',
                'WorkspaceName' => '<string>',
                'WorkspaceProperties' => [
                    'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
                    'GlobalAccelerator' => [
                        'Mode' => 'ENABLED_AUTO|DISABLED|INHERITED',
                        'PreferredProtocol' => 'TCP|NONE|INHERITED',
                    ],
                    'OperatingSystemName' => 'AMAZON_LINUX_2|UBUNTU_18_04|UBUNTU_20_04|UBUNTU_22_04|UNKNOWN|WINDOWS_10|WINDOWS_11|WINDOWS_7|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|RHEL_8|ROCKY_8',
                    'Protocols' => ['<string>', ...],
                    'RootVolumeSizeGib' => <integer>,
                    'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
                    'RunningModeAutoStopTimeoutInMinutes' => <integer>,
                    'UserVolumeSizeGib' => <integer>,
                ],
            ],
        ],
        // ...
    ],
    'PendingRequests' => [
        [
            'BundleId' => '<string>',
            'ComputerName' => '<string>',
            'DataReplicationSettings' => [
                'DataReplication' => 'NO_REPLICATION|PRIMARY_AS_SOURCE',
                'RecoverySnapshotTime' => <DateTime>,
            ],
            '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,
            'StandbyWorkspacesProperties' => [
                [
                    'DataReplication' => 'NO_REPLICATION|PRIMARY_AS_SOURCE',
                    'RecoverySnapshotTime' => <DateTime>,
                    'StandbyWorkspaceId' => '<string>',
                ],
                // ...
            ],
            '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>',
            'WorkspaceName' => '<string>',
            'WorkspaceProperties' => [
                'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
                'GlobalAccelerator' => [
                    'Mode' => 'ENABLED_AUTO|DISABLED|INHERITED',
                    'PreferredProtocol' => 'TCP|NONE|INHERITED',
                ],
                'OperatingSystemName' => 'AMAZON_LINUX_2|UBUNTU_18_04|UBUNTU_20_04|UBUNTU_22_04|UNKNOWN|WINDOWS_10|WINDOWS_11|WINDOWS_7|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|RHEL_8|ROCKY_8',
                'Protocols' => ['<string>', ...],
                'RootVolumeSizeGib' => <integer>,
                'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
                'RunningModeAutoStopTimeoutInMinutes' => <integer>,
                'UserVolumeSizeGib' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceLimitExceededException:

Your resource limits have been exceeded.

InvalidParameterValuesException:

One or more parameter values are not valid.

CreateWorkspacesPool

$result = $client->createWorkspacesPool([/* ... */]);
$promise = $client->createWorkspacesPoolAsync([/* ... */]);

Creates a pool of WorkSpaces.

Parameter Syntax

$result = $client->createWorkspacesPool([
    'ApplicationSettings' => [
        'SettingsGroup' => '<string>',
        'Status' => 'DISABLED|ENABLED', // REQUIRED
    ],
    'BundleId' => '<string>', // REQUIRED
    'Capacity' => [ // REQUIRED
        'DesiredUserSessions' => <integer>, // REQUIRED
    ],
    'Description' => '<string>', // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
    'PoolName' => '<string>', // REQUIRED
    'RunningMode' => 'AUTO_STOP|ALWAYS_ON',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TimeoutSettings' => [
        'DisconnectTimeoutInSeconds' => <integer>,
        'IdleDisconnectTimeoutInSeconds' => <integer>,
        'MaxUserDurationInSeconds' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'WorkspacesPool' => [
        'ApplicationSettings' => [
            'S3BucketName' => '<string>',
            'SettingsGroup' => '<string>',
            'Status' => 'DISABLED|ENABLED',
        ],
        'BundleId' => '<string>',
        'CapacityStatus' => [
            'ActiveUserSessions' => <integer>,
            'ActualUserSessions' => <integer>,
            'AvailableUserSessions' => <integer>,
            'DesiredUserSessions' => <integer>,
        ],
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DirectoryId' => '<string>',
        'Errors' => [
            [
                'ErrorCode' => 'IAM_SERVICE_ROLE_IS_MISSING|IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|WORKSPACES_POOL_STOPPED|WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR|DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING|DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE|DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID|DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND|DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND|DOMAIN_JOIN_ERROR_SECRET_INVALID|BUNDLE_NOT_FOUND|DIRECTORY_NOT_FOUND|INSUFFICIENT_PERMISSIONS_ERROR|DEFAULT_OU_IS_MISSING',
                'ErrorMessage' => '<string>',
            ],
            // ...
        ],
        'PoolArn' => '<string>',
        'PoolId' => '<string>',
        'PoolName' => '<string>',
        'RunningMode' => 'AUTO_STOP|ALWAYS_ON',
        'State' => 'CREATING|DELETING|RUNNING|STARTING|STOPPED|STOPPING|UPDATING',
        'TimeoutSettings' => [
            'DisconnectTimeoutInSeconds' => <integer>,
            'IdleDisconnectTimeoutInSeconds' => <integer>,
            'MaxUserDurationInSeconds' => <integer>,
        ],
    ],
]

Result Details

Errors

ResourceLimitExceededException:

Your resource limits have been exceeded.

ResourceNotFoundException:

The resource could not be found.

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceAlreadyExistsException:

The specified resource already exists.

OperationNotSupportedException:

This operation is not supported.

AccessDeniedException:

The user is not authorized to access a resource.

DeleteAccountLinkInvitation

$result = $client->deleteAccountLinkInvitation([/* ... */]);
$promise = $client->deleteAccountLinkInvitationAsync([/* ... */]);

Deletes the account link invitation.

Parameter Syntax

$result = $client->deleteAccountLinkInvitation([
    'ClientToken' => '<string>',
    'LinkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountLink' => [
        'AccountLinkId' => '<string>',
        'AccountLinkStatus' => 'LINKED|LINKING_FAILED|LINK_NOT_FOUND|PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT|REJECTED',
        'SourceAccountId' => '<string>',
        'TargetAccountId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

AccessDeniedException:

The user is not authorized to access a resource.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The TargetAccountId is already linked or invited.

InternalServerException:

Unexpected server error occured.

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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.

Parameter Syntax

$result = $client->deleteConnectionAlias([
    'AliasId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

ResourceAssociatedException:

The resource is associated with a directory.

AccessDeniedException:

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.

ResourceNotFoundException:

The resource could not be found.

ResourceAssociatedException:

The resource is associated with a directory.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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.

ResourceNotFoundException:

The resource could not be found.

ResourceAssociatedException:

The resource is associated with a directory.

AccessDeniedException:

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

ResourceAssociatedException:

The resource is associated with a directory.

InvalidResourceStateException:

The state of the resource is not valid for this operation.

AccessDeniedException:

The user is not authorized to access a resource.

DeployWorkspaceApplications

$result = $client->deployWorkspaceApplications([/* ... */]);
$promise = $client->deployWorkspaceApplicationsAsync([/* ... */]);

Deploys associated applications to the specified WorkSpace

Parameter Syntax

$result = $client->deployWorkspaceApplications([
    'Force' => true || false,
    'WorkspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Deployment' => [
        'Associations' => [
            [
                'AssociatedResourceId' => '<string>',
                'AssociatedResourceType' => 'APPLICATION',
                'Created' => <DateTime>,
                'LastUpdatedTime' => <DateTime>,
                'State' => 'PENDING_INSTALL|PENDING_INSTALL_DEPLOYMENT|PENDING_UNINSTALL|PENDING_UNINSTALL_DEPLOYMENT|INSTALLING|UNINSTALLING|ERROR|COMPLETED|REMOVED',
                'StateReason' => [
                    'ErrorCode' => 'ValidationError.InsufficientDiskSpace|ValidationError.InsufficientMemory|ValidationError.UnsupportedOperatingSystem|DeploymentError.InternalServerError|DeploymentError.WorkspaceUnreachable',
                    'ErrorMessage' => '<string>',
                ],
                'WorkspaceId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceInUseException:

The specified resource is currently in use.

ResourceNotFoundException:

The resource could not be found.

IncompatibleApplicationsException:

The specified application is not compatible with the 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.

Parameter Syntax

$result = $client->deregisterWorkspaceDirectory([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

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

Result Syntax

[
    'DedicatedTenancyAccountType' => 'SOURCE_ACCOUNT|TARGET_ACCOUNT',
    'DedicatedTenancyManagementCidrRange' => '<string>',
    'DedicatedTenancySupport' => 'ENABLED|DISABLED',
]

Result Details

Errors

AccessDeniedException:

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

Result Syntax

[
    'AccountModifications' => [
        [
            'DedicatedTenancyManagementCidrRange' => '<string>',
            'DedicatedTenancySupport' => 'ENABLED|DISABLED',
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ModificationState' => 'PENDING|COMPLETED|FAILED',
            'StartTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

DescribeApplicationAssociations

$result = $client->describeApplicationAssociations([/* ... */]);
$promise = $client->describeApplicationAssociationsAsync([/* ... */]);

Describes the associations between the application and the specified associated resources.

Parameter Syntax

$result = $client->describeApplicationAssociations([
    'ApplicationId' => '<string>', // REQUIRED
    'AssociatedResourceTypes' => ['<string>', ...], // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Associations' => [
        [
            'ApplicationId' => '<string>',
            'AssociatedResourceId' => '<string>',
            'AssociatedResourceType' => 'WORKSPACE|BUNDLE|IMAGE',
            'Created' => <DateTime>,
            'LastUpdatedTime' => <DateTime>,
            'State' => 'PENDING_INSTALL|PENDING_INSTALL_DEPLOYMENT|PENDING_UNINSTALL|PENDING_UNINSTALL_DEPLOYMENT|INSTALLING|UNINSTALLING|ERROR|COMPLETED|REMOVED',
            'StateReason' => [
                'ErrorCode' => 'ValidationError.InsufficientDiskSpace|ValidationError.InsufficientMemory|ValidationError.UnsupportedOperatingSystem|DeploymentError.InternalServerError|DeploymentError.WorkspaceUnreachable',
                'ErrorMessage' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

The resource could not be found.

DescribeApplications

$result = $client->describeApplications([/* ... */]);
$promise = $client->describeApplicationsAsync([/* ... */]);

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Parameter Syntax

$result = $client->describeApplications([
    'ApplicationIds' => ['<string>', ...],
    'ComputeTypeNames' => ['<string>', ...],
    'LicenseType' => 'LICENSED|UNLICENSED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperatingSystemNames' => ['<string>', ...],
    'Owner' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Applications' => [
        [
            'ApplicationId' => '<string>',
            'Created' => <DateTime>,
            'Description' => '<string>',
            'LicenseType' => 'LICENSED|UNLICENSED',
            'Name' => '<string>',
            'Owner' => '<string>',
            'State' => 'PENDING|ERROR|AVAILABLE|UNINSTALL_ONLY',
            'SupportedComputeTypeNames' => ['<string>', ...],
            'SupportedOperatingSystemNames' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

The resource could not be found.

DescribeBundleAssociations

$result = $client->describeBundleAssociations([/* ... */]);
$promise = $client->describeBundleAssociationsAsync([/* ... */]);

Describes the associations between the applications and the specified bundle.

Parameter Syntax

$result = $client->describeBundleAssociations([
    'AssociatedResourceTypes' => ['<string>', ...], // REQUIRED
    'BundleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Associations' => [
        [
            'AssociatedResourceId' => '<string>',
            'AssociatedResourceType' => 'APPLICATION',
            'BundleId' => '<string>',
            'Created' => <DateTime>,
            'LastUpdatedTime' => <DateTime>,
            'State' => 'PENDING_INSTALL|PENDING_INSTALL_DEPLOYMENT|PENDING_UNINSTALL|PENDING_UNINSTALL_DEPLOYMENT|INSTALLING|UNINSTALLING|ERROR|COMPLETED|REMOVED',
            'StateReason' => [
                'ErrorCode' => 'ValidationError.InsufficientDiskSpace|ValidationError.InsufficientMemory|ValidationError.UnsupportedOperatingSystem|DeploymentError.InternalServerError|DeploymentError.WorkspaceUnreachable',
                'ErrorMessage' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

The resource could not be found.

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.

Parameter Syntax

$result = $client->describeClientBranding([
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

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

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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

Result Syntax

[
    'ClientPropertiesList' => [
        [
            'ClientProperties' => [
                'LogUploadEnabled' => 'ENABLED|DISABLED',
                'ReconnectEnabled' => 'ENABLED|DISABLED',
            ],
            'ResourceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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

Result Syntax

[
    'AddIns' => [
        [
            'AddInId' => '<string>',
            'Name' => '<string>',
            'ResourceId' => '<string>',
            'URL' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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

Result Syntax

[
    'AliasId' => '<string>',
    'ConnectionAliasPermissions' => [
        [
            'AllowAssociation' => true || false,
            'SharedAccountId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

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

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

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

DescribeImageAssociations

$result = $client->describeImageAssociations([/* ... */]);
$promise = $client->describeImageAssociationsAsync([/* ... */]);

Describes the associations between the applications and the specified image.

Parameter Syntax

$result = $client->describeImageAssociations([
    'AssociatedResourceTypes' => ['<string>', ...], // REQUIRED
    'ImageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Associations' => [
        [
            'AssociatedResourceId' => '<string>',
            'AssociatedResourceType' => 'APPLICATION',
            'Created' => <DateTime>,
            'ImageId' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'State' => 'PENDING_INSTALL|PENDING_INSTALL_DEPLOYMENT|PENDING_UNINSTALL|PENDING_UNINSTALL_DEPLOYMENT|INSTALLING|UNINSTALLING|ERROR|COMPLETED|REMOVED',
            'StateReason' => [
                'ErrorCode' => 'ValidationError.InsufficientDiskSpace|ValidationError.InsufficientMemory|ValidationError.UnsupportedOperatingSystem|DeploymentError.InternalServerError|DeploymentError.WorkspaceUnreachable',
                'ErrorMessage' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

The resource could not be found.

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

Result Syntax

[
    'NextToken' => '<string>',
    'Result' => [
        [
            'groupDesc' => '<string>',
            'groupId' => '<string>',
            'groupName' => '<string>',
            'userRules' => [
                [
                    'ipRule' => '<string>',
                    'ruleDesc' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

AccessDeniedException:

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

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

DescribeWorkspaceAssociations

$result = $client->describeWorkspaceAssociations([/* ... */]);
$promise = $client->describeWorkspaceAssociationsAsync([/* ... */]);

Describes the associations betweens applications and the specified WorkSpace.

Parameter Syntax

$result = $client->describeWorkspaceAssociations([
    'AssociatedResourceTypes' => ['<string>', ...], // REQUIRED
    'WorkspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Associations' => [
        [
            'AssociatedResourceId' => '<string>',
            'AssociatedResourceType' => 'APPLICATION',
            'Created' => <DateTime>,
            'LastUpdatedTime' => <DateTime>,
            'State' => 'PENDING_INSTALL|PENDING_INSTALL_DEPLOYMENT|PENDING_UNINSTALL|PENDING_UNINSTALL_DEPLOYMENT|INSTALLING|UNINSTALLING|ERROR|COMPLETED|REMOVED',
            'StateReason' => [
                'ErrorCode' => 'ValidationError.InsufficientDiskSpace|ValidationError.InsufficientMemory|ValidationError.UnsupportedOperatingSystem|DeploymentError.InternalServerError|DeploymentError.WorkspaceUnreachable',
                'ErrorMessage' => '<string>',
            ],
            'WorkspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

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

Result Syntax

[
    'Bundles' => [
        [
            'BundleId' => '<string>',
            'BundleType' => 'REGULAR|STANDBY',
            'ComputeType' => [
                'Name' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|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

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>', ...],
    'Filters' => [
        [
            'Name' => 'USER_IDENTITY_TYPE|WORKSPACE_TYPE', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'WorkspaceDirectoryNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Directories' => [
        [
            'ActiveDirectoryConfig' => [
                'DomainName' => '<string>',
                'ServiceAccountSecretArn' => '<string>',
            ],
            'Alias' => '<string>',
            'CertificateBasedAuthProperties' => [
                'CertificateAuthorityArn' => '<string>',
                'Status' => 'DISABLED|ENABLED',
            ],
            'CustomerUserName' => '<string>',
            'DirectoryId' => '<string>',
            'DirectoryName' => '<string>',
            'DirectoryType' => 'SIMPLE_AD|AD_CONNECTOR|CUSTOMER_MANAGED|AWS_IAM_IDENTITY_CENTER',
            'DnsIpAddresses' => ['<string>', ...],
            'EndpointEncryptionMode' => 'STANDARD_TLS|FIPS_VALIDATED',
            'ErrorMessage' => '<string>',
            'IDCConfig' => [
                'ApplicationArn' => '<string>',
                'InstanceArn' => '<string>',
            ],
            'IamRoleId' => '<string>',
            'MicrosoftEntraConfig' => [
                'ApplicationConfigSecretArn' => '<string>',
                'TenantId' => '<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',
            'StreamingProperties' => [
                'GlobalAccelerator' => [
                    'Mode' => 'ENABLED_AUTO|DISABLED',
                    'PreferredProtocol' => 'TCP|NONE',
                ],
                'StorageConnectors' => [
                    [
                        'ConnectorType' => 'HOME_FOLDER',
                        'Status' => 'ENABLED|DISABLED',
                    ],
                    // ...
                ],
                'StreamingExperiencePreferredProtocol' => 'TCP|UDP',
                'UserSettings' => [
                    [
                        'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|PRINTING_TO_LOCAL_DEVICE|SMART_CARD',
                        'MaximumLength' => <integer>,
                        'Permission' => 'ENABLED|DISABLED',
                    ],
                    // ...
                ],
            ],
            'SubnetIds' => ['<string>', ...],
            'Tenancy' => 'DEDICATED|SHARED',
            'UserIdentityType' => 'CUSTOMER_MANAGED|AWS_DIRECTORY_SERVICE|AWS_IAM_IDENTITY_CENTER',
            'WorkspaceAccessProperties' => [
                'DeviceTypeAndroid' => 'ALLOW|DENY',
                'DeviceTypeChromeOs' => 'ALLOW|DENY',
                'DeviceTypeIos' => 'ALLOW|DENY',
                'DeviceTypeLinux' => 'ALLOW|DENY',
                'DeviceTypeOsx' => 'ALLOW|DENY',
                'DeviceTypeWeb' => 'ALLOW|DENY',
                'DeviceTypeWindows' => 'ALLOW|DENY',
                'DeviceTypeWorkSpacesThinClient' => 'ALLOW|DENY',
                'DeviceTypeZeroClient' => 'ALLOW|DENY',
            ],
            'WorkspaceCreationProperties' => [
                'CustomSecurityGroupId' => '<string>',
                'DefaultOu' => '<string>',
                'EnableInternetAccess' => true || false,
                'EnableMaintenanceMode' => true || false,
                'InstanceIamRoleArn' => '<string>',
                'UserEnabledAsLocalAdministrator' => true || false,
            ],
            'WorkspaceDirectoryDescription' => '<string>',
            'WorkspaceDirectoryName' => '<string>',
            'WorkspaceSecurityGroupId' => '<string>',
            'WorkspaceType' => 'PERSONAL|POOLS',
            'ipGroupIds' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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

Result Syntax

[
    'ImageId' => '<string>',
    'ImagePermissions' => [
        [
            'SharedAccountId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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

Result Syntax

[
    'Images' => [
        [
            'Created' => <DateTime>,
            'Description' => '<string>',
            'ErrorCode' => '<string>',
            'ErrorDetails' => [
                [
                    'ErrorCode' => 'OutdatedPowershellVersion|OfficeInstalled|PCoIPAgentInstalled|WindowsUpdatesEnabled|AutoMountDisabled|WorkspacesBYOLAccountNotFound|WorkspacesBYOLAccountDisabled|DHCPDisabled|DiskFreeSpace|AdditionalDrivesAttached|OSNotSupported|DomainJoined|AzureDomainJoined|FirewallEnabled|VMWareToolsInstalled|DiskSizeExceeded|IncompatiblePartitioning|PendingReboot|AutoLogonEnabled|RealTimeUniversalDisabled|MultipleBootPartition|Requires64BitOS|ZeroRearmCount|InPlaceUpgrade|AntiVirusInstalled|UEFINotSupported|UnknownError|AppXPackagesInstalled|ReservedStorageInUse|AdditionalDrivesPresent|WindowsUpdatesRequired|SysPrepFileMissing|UserProfileMissing|InsufficientDiskSpace|EnvironmentVariablesPathMissingEntries|DomainAccountServicesFound|InvalidIp|RemoteDesktopServicesDisabled|WindowsModulesInstallerDisabled|AmazonSsmAgentEnabled|UnsupportedSecurityProtocol|MultipleUserProfiles|StagedAppxPackage|UnsupportedOsUpgrade|InsufficientRearmCount|ProtocolOSIncompatibility|MemoryIntegrityIncompatibility|RestrictedDriveLetterInUse',
                    'ErrorMessage' => '<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

Errors

AccessDeniedException:

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

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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>', ...],
    'WorkspaceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Workspaces' => [
        [
            'BundleId' => '<string>',
            'ComputerName' => '<string>',
            'DataReplicationSettings' => [
                'DataReplication' => 'NO_REPLICATION|PRIMARY_AS_SOURCE',
                'RecoverySnapshotTime' => <DateTime>,
            ],
            '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,
            'StandbyWorkspacesProperties' => [
                [
                    'DataReplication' => 'NO_REPLICATION|PRIMARY_AS_SOURCE',
                    'RecoverySnapshotTime' => <DateTime>,
                    'StandbyWorkspaceId' => '<string>',
                ],
                // ...
            ],
            '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>',
            'WorkspaceName' => '<string>',
            'WorkspaceProperties' => [
                'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
                'GlobalAccelerator' => [
                    'Mode' => 'ENABLED_AUTO|DISABLED|INHERITED',
                    'PreferredProtocol' => 'TCP|NONE|INHERITED',
                ],
                'OperatingSystemName' => 'AMAZON_LINUX_2|UBUNTU_18_04|UBUNTU_20_04|UBUNTU_22_04|UNKNOWN|WINDOWS_10|WINDOWS_11|WINDOWS_7|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|RHEL_8|ROCKY_8',
                'Protocols' => ['<string>', ...],
                'RootVolumeSizeGib' => <integer>,
                'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
                'RunningModeAutoStopTimeoutInMinutes' => <integer>,
                'UserVolumeSizeGib' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceUnavailableException:

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

Result Syntax

[
    'NextToken' => '<string>',
    'WorkspacesConnectionStatus' => [
        [
            'ConnectionState' => 'CONNECTED|DISCONNECTED|UNKNOWN',
            'ConnectionStateCheckTimestamp' => <DateTime>,
            'LastKnownUserConnectionTimestamp' => <DateTime>,
            'WorkspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

DescribeWorkspacesPoolSessions

$result = $client->describeWorkspacesPoolSessions([/* ... */]);
$promise = $client->describeWorkspacesPoolSessionsAsync([/* ... */]);

Retrieves a list that describes the streaming sessions for a specified pool.

Parameter Syntax

$result = $client->describeWorkspacesPoolSessions([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'PoolId' => '<string>', // REQUIRED
    'UserId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Sessions' => [
        [
            'AuthenticationType' => 'SAML',
            'ConnectionState' => 'CONNECTED|NOT_CONNECTED',
            'ExpirationTime' => <DateTime>,
            'InstanceId' => '<string>',
            'NetworkAccessConfiguration' => [
                'EniId' => '<string>',
                'EniPrivateIpAddress' => '<string>',
            ],
            'PoolId' => '<string>',
            'SessionId' => '<string>',
            'StartTime' => <DateTime>,
            'UserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

The user is not authorized to access a resource.

DescribeWorkspacesPools

$result = $client->describeWorkspacesPools([/* ... */]);
$promise = $client->describeWorkspacesPoolsAsync([/* ... */]);

Describes the specified WorkSpaces Pools.

Parameter Syntax

$result = $client->describeWorkspacesPools([
    'Filters' => [
        [
            'Name' => 'PoolName', // REQUIRED
            'Operator' => 'EQUALS|NOTEQUALS|CONTAINS|NOTCONTAINS', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'PoolIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'WorkspacesPools' => [
        [
            'ApplicationSettings' => [
                'S3BucketName' => '<string>',
                'SettingsGroup' => '<string>',
                'Status' => 'DISABLED|ENABLED',
            ],
            'BundleId' => '<string>',
            'CapacityStatus' => [
                'ActiveUserSessions' => <integer>,
                'ActualUserSessions' => <integer>,
                'AvailableUserSessions' => <integer>,
                'DesiredUserSessions' => <integer>,
            ],
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'DirectoryId' => '<string>',
            'Errors' => [
                [
                    'ErrorCode' => 'IAM_SERVICE_ROLE_IS_MISSING|IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION|IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION|NETWORK_INTERFACE_LIMIT_EXCEEDED|INTERNAL_SERVICE_ERROR|MACHINE_ROLE_IS_MISSING|STS_DISABLED_IN_REGION|SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION|SUBNET_NOT_FOUND|IMAGE_NOT_FOUND|INVALID_SUBNET_CONFIGURATION|SECURITY_GROUPS_NOT_FOUND|IGW_NOT_ATTACHED|IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION|WORKSPACES_POOL_STOPPED|WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE|DOMAIN_JOIN_ERROR_FILE_NOT_FOUND|DOMAIN_JOIN_ERROR_ACCESS_DENIED|DOMAIN_JOIN_ERROR_LOGON_FAILURE|DOMAIN_JOIN_ERROR_INVALID_PARAMETER|DOMAIN_JOIN_ERROR_MORE_DATA|DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN|DOMAIN_JOIN_ERROR_NOT_SUPPORTED|DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME|DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED|DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED|DOMAIN_JOIN_NERR_PASSWORD_EXPIRED|DOMAIN_JOIN_INTERNAL_SERVICE_ERROR|DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING|DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE|DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID|DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND|DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND|DOMAIN_JOIN_ERROR_SECRET_INVALID|BUNDLE_NOT_FOUND|DIRECTORY_NOT_FOUND|INSUFFICIENT_PERMISSIONS_ERROR|DEFAULT_OU_IS_MISSING',
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
            'PoolArn' => '<string>',
            'PoolId' => '<string>',
            'PoolName' => '<string>',
            'RunningMode' => 'AUTO_STOP|ALWAYS_ON',
            'State' => 'CREATING|DELETING|RUNNING|STARTING|STOPPED|STOPPING|UPDATING',
            'TimeoutSettings' => [
                'DisconnectTimeoutInSeconds' => <integer>,
                'IdleDisconnectTimeoutInSeconds' => <integer>,
                'MaxUserDurationInSeconds' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

The user is not authorized to access a resource.

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.

Parameter Syntax

$result = $client->disassociateConnectionAlias([
    'AliasId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

InvalidResourceStateException:

The state of the resource is not valid for this operation.

AccessDeniedException:

The user is not authorized to access a resource.

OperationNotSupportedException:

This operation is not supported.

DisassociateWorkspaceApplication

$result = $client->disassociateWorkspaceApplication([/* ... */]);
$promise = $client->disassociateWorkspaceApplicationAsync([/* ... */]);

Disassociates the specified application from a WorkSpace.

Parameter Syntax

$result = $client->disassociateWorkspaceApplication([
    'ApplicationId' => '<string>', // REQUIRED
    'WorkspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Association' => [
        'AssociatedResourceId' => '<string>',
        'AssociatedResourceType' => 'APPLICATION',
        'Created' => <DateTime>,
        'LastUpdatedTime' => <DateTime>,
        'State' => 'PENDING_INSTALL|PENDING_INSTALL_DEPLOYMENT|PENDING_UNINSTALL|PENDING_UNINSTALL_DEPLOYMENT|INSTALLING|UNINSTALLING|ERROR|COMPLETED|REMOVED',
        'StateReason' => [
            'ErrorCode' => 'ValidationError.InsufficientDiskSpace|ValidationError.InsufficientMemory|ValidationError.UnsupportedOperatingSystem|DeploymentError.InternalServerError|DeploymentError.WorkspaceUnreachable',
            'ErrorMessage' => '<string>',
        ],
        'WorkspaceId' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceInUseException:

The specified resource is currently in use.

ResourceNotFoundException:

The resource could not be found.

GetAccountLink

$result = $client->getAccountLink([/* ... */]);
$promise = $client->getAccountLinkAsync([/* ... */]);

Retrieves account link information.

Parameter Syntax

$result = $client->getAccountLink([
    'LinkId' => '<string>',
    'LinkedAccountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AccountLink' => [
        'AccountLinkId' => '<string>',
        'AccountLinkStatus' => 'LINKED|LINKING_FAILED|LINK_NOT_FOUND|PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT|REJECTED',
        'SourceAccountId' => '<string>',
        'TargetAccountId' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

ValidationException:

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

ResourceNotFoundException:

The resource could not be found.

InternalServerException:

Unexpected server error occured.

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

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

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

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceLimitExceededException:

Your resource limits have been exceeded.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

The user is not authorized to access a resource.

ImportWorkspaceImage

$result = $client->importWorkspaceImage([/* ... */]);
$promise = $client->importWorkspaceImageAsync([/* ... */]);

Imports the specified Windows 10 or 11 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_GRAPHICS_G4DN_WSP|BYOL_REGULAR_BYOP|BYOL_GRAPHICS_G4DN_BYOP', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ImageId' => '<string>',
]

Result Details

Errors

ResourceLimitExceededException:

Your resource limits have been exceeded.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

The resource could not be found.

OperationNotSupportedException:

This operation is not supported.

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

ListAccountLinks

$result = $client->listAccountLinks([/* ... */]);
$promise = $client->listAccountLinksAsync([/* ... */]);

Lists all account links.

Parameter Syntax

$result = $client->listAccountLinks([
    'LinkStatusFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AccountLinks' => [
        [
            'AccountLinkId' => '<string>',
            'AccountLinkStatus' => 'LINKED|LINKING_FAILED|LINK_NOT_FOUND|PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT|REJECTED',
            'SourceAccountId' => '<string>',
            'TargetAccountId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

ValidationException:

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

InternalServerException:

Unexpected server error occured.

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

Result Syntax

[
    'ManagementCidrRanges' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

AccessDeniedException:

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

Result Syntax

[
    'SourceWorkspaceId' => '<string>',
    'TargetWorkspaceId' => '<string>',
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

The user is not authorized to access a resource.

OperationNotSupportedException:

This operation is not supported.

OperationInProgressException:

The properties of this WorkSpace are currently being modified. Try again in a moment.

ResourceUnavailableException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

AccessDeniedException:

The user is not authorized to access a resource.

InvalidResourceStateException:

The state of the resource is not valid for this operation.

ResourceUnavailableException:

The specified resource is not available.

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

The user is not authorized to access a resource.

OperationNotSupportedException:

This operation is not supported.

ModifyEndpointEncryptionMode

$result = $client->modifyEndpointEncryptionMode([/* ... */]);
$promise = $client->modifyEndpointEncryptionModeAsync([/* ... */]);

Modifies the endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.

Parameter Syntax

$result = $client->modifyEndpointEncryptionMode([
    'DirectoryId' => '<string>', // REQUIRED
    'EndpointEncryptionMode' => 'STANDARD_TLS|FIPS_VALIDATED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

ResourceNotFoundException:

The resource could not be found.

OperationNotSupportedException:

This operation is not supported.

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

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

OperationNotSupportedException:

This operation is not supported.

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

OperationNotSupportedException:

This operation is not supported.

ModifyStreamingProperties

$result = $client->modifyStreamingProperties([/* ... */]);
$promise = $client->modifyStreamingPropertiesAsync([/* ... */]);

Modifies the specified streaming properties.

Parameter Syntax

$result = $client->modifyStreamingProperties([
    'ResourceId' => '<string>', // REQUIRED
    'StreamingProperties' => [
        'GlobalAccelerator' => [
            'Mode' => 'ENABLED_AUTO|DISABLED', // REQUIRED
            'PreferredProtocol' => 'TCP|NONE',
        ],
        'StorageConnectors' => [
            [
                'ConnectorType' => 'HOME_FOLDER', // REQUIRED
                'Status' => 'ENABLED|DISABLED', // REQUIRED
            ],
            // ...
        ],
        'StreamingExperiencePreferredProtocol' => 'TCP|UDP',
        'UserSettings' => [
            [
                'Action' => 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE|CLIPBOARD_COPY_TO_LOCAL_DEVICE|PRINTING_TO_LOCAL_DEVICE|SMART_CARD', // REQUIRED
                'MaximumLength' => <integer>,
                'Permission' => 'ENABLED|DISABLED', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

OperationNotSupportedException:

This operation is not supported.

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',
        'DeviceTypeWorkSpacesThinClient' => 'ALLOW|DENY',
        'DeviceTypeZeroClient' => 'ALLOW|DENY',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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,
        'InstanceIamRoleArn' => '<string>',
        'UserEnabledAsLocalAdministrator' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

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.

Parameter Syntax

$result = $client->modifyWorkspaceProperties([
    'DataReplication' => 'NO_REPLICATION|PRIMARY_AS_SOURCE',
    'WorkspaceId' => '<string>', // REQUIRED
    'WorkspaceProperties' => [
        'ComputeTypeName' => 'VALUE|STANDARD|PERFORMANCE|POWER|GRAPHICS|POWERPRO|GENERALPURPOSE_4XLARGE|GENERALPURPOSE_8XLARGE|GRAPHICSPRO|GRAPHICS_G4DN|GRAPHICSPRO_G4DN',
        'GlobalAccelerator' => [
            'Mode' => 'ENABLED_AUTO|DISABLED|INHERITED', // REQUIRED
            'PreferredProtocol' => 'TCP|NONE|INHERITED',
        ],
        'OperatingSystemName' => 'AMAZON_LINUX_2|UBUNTU_18_04|UBUNTU_20_04|UBUNTU_22_04|UNKNOWN|WINDOWS_10|WINDOWS_11|WINDOWS_7|WINDOWS_SERVER_2016|WINDOWS_SERVER_2019|WINDOWS_SERVER_2022|RHEL_8|ROCKY_8',
        'Protocols' => ['<string>', ...],
        'RootVolumeSizeGib' => <integer>,
        'RunningMode' => 'AUTO_STOP|ALWAYS_ON|MANUAL',
        'RunningModeAutoStopTimeoutInMinutes' => <integer>,
        'UserVolumeSizeGib' => <integer>,
    ],
]);

Parameter Details

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.

OperationInProgressException:

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 .

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

The user is not authorized to access a resource.

ResourceUnavailableException:

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

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.

ResourceNotFoundException:

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, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.

This operation is asynchronous and returns before the WorkSpaces have rebooted.

Parameter Syntax

$result = $client->rebootWorkspaces([
    'RebootWorkspaceRequests' => [ // REQUIRED
        [
            'WorkspaceId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FailedRequests' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'WorkspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

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

Result Syntax

[
    'FailedRequests' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'WorkspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

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([
    'ActiveDirectoryConfig' => [
        'DomainName' => '<string>', // REQUIRED
        'ServiceAccountSecretArn' => '<string>', // REQUIRED
    ],
    'DirectoryId' => '<string>',
    'EnableSelfService' => true || false,
    'IdcInstanceArn' => '<string>',
    'MicrosoftEntraConfig' => [
        'ApplicationConfigSecretArn' => '<string>',
        'TenantId' => '<string>',
    ],
    'SubnetIds' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'Tenancy' => 'DEDICATED|SHARED',
    'UserIdentityType' => 'CUSTOMER_MANAGED|AWS_DIRECTORY_SERVICE|AWS_IAM_IDENTITY_CENTER',
    'WorkspaceDirectoryDescription' => '<string>',
    'WorkspaceDirectoryName' => '<string>',
    'WorkspaceType' => 'PERSONAL|POOLS',
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'State' => 'REGISTERING|REGISTERED|DEREGISTERING|DEREGISTERED|ERROR',
]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

ResourceLimitExceededException:

Your resource limits have been exceeded.

AccessDeniedException:

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.

ResourceAlreadyExistsException:

The specified resource already exists.

RejectAccountLinkInvitation

$result = $client->rejectAccountLinkInvitation([/* ... */]);
$promise = $client->rejectAccountLinkInvitationAsync([/* ... */]);

Rejects the account link invitation.

Parameter Syntax

$result = $client->rejectAccountLinkInvitation([
    'ClientToken' => '<string>',
    'LinkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountLink' => [
        'AccountLinkId' => '<string>',
        'AccountLinkStatus' => 'LINKED|LINKING_FAILED|LINK_NOT_FOUND|PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT|REJECTED',
        'SourceAccountId' => '<string>',
        'TargetAccountId' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The user is not authorized to access a resource.

ValidationException:

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The TargetAccountId is already linked or invited.

InternalServerException:

Unexpected server error occured.

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.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValuesException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource could not be found.

InvalidResourceStateException:

The state of the resource is not valid for this operation.

AccessDeniedException:

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 or Manual and a state of STOPPED.

Parameter Syntax

$result = $client->startWorkspaces([
    'StartWorkspaceRequests' => [ // REQUIRED
        [
            'WorkspaceId' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FailedRequests' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'WorkspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

StartWorkspacesPool

$result = $client->startWorkspacesPool([/* ... */]);
$promise = $client->startWorkspacesPoolAsync([/* ... */]);

Starts the specified pool.

You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.

Parameter Syntax

$result = $client->startWorkspacesPool([
    'PoolId' => '<string>', // REQUIRED
]);

Parameter Details

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.

ResourceLimitExceededException:

Your resource limits have been exceeded.

ResourceNotFoundException:

The resource could not be found.

OperationNotSupportedException:

This operation is not supported.

OperationInProgressException:

The properties of this WorkSpace are currently being modified. Try again in a moment.

AccessDeniedException:

The user is not authorized to access a resource.

StopWorkspaces

$result = $client->stopWorkspaces([/* ... */]);
$promise = $client->stopWorkspacesAsync([/* ... */]);

Stops the specified WorkSpaces.

You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Parameter Syntax

$result = $client->stopWorkspaces([
    'StopWorkspaceRequests' => [ // REQUIRED
        [
            'WorkspaceId' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details