NAME

Paws::WorkSpaces - Perl Interface to AWS Amazon WorkSpaces

SYNOPSIS

  use Paws;
  my $obj = Paws->service('WorkSpaces');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08>

METHODS

Each argument is described in detail in: Paws::WorkSpaces::AssociateConnectionAlias

Returns: a Paws::WorkSpaces::AssociateConnectionAliasResult instance

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) to make sure that the current state of the connection alias is "CREATED".

AssociateIpGroups

DirectoryId => Str
GroupIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::WorkSpaces::AssociateIpGroups

Returns: a Paws::WorkSpaces::AssociateIpGroupsResult instance

Associates the specified IP access control group with the specified directory.

AuthorizeIpRules

GroupId => Str
UserRules => ArrayRef[Paws::WorkSpaces::IpRuleItem]

Each argument is described in detail in: Paws::WorkSpaces::AuthorizeIpRules

Returns: a Paws::WorkSpaces::AuthorizeIpRulesResult instance

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.

CopyWorkspaceImage

Name => Str
SourceImageId => Str
SourceRegion => Str
[Description => Str]
[Tags => ArrayRef[Paws::WorkSpaces::Tag]]

Each argument is described in detail in: Paws::WorkSpaces::CopyWorkspaceImage

Returns: a Paws::WorkSpaces::CopyWorkspaceImageResult instance

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html).

In the China (Ningxia) Region, you can copy images only within the same Region.

In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.

Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the DescribeWorkSpaceImages (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) and DescribeWorkspaceImagePermissions (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html) API operations.

CreateConnectionAlias

ConnectionString => Str
[Tags => ArrayRef[Paws::WorkSpaces::Tag]]

Each argument is described in detail in: Paws::WorkSpaces::CreateConnectionAlias

Returns: a Paws::WorkSpaces::CreateConnectionAliasResult instance

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

CreateIpGroup

GroupName => Str
[GroupDesc => Str]
[Tags => ArrayRef[Paws::WorkSpaces::Tag]]
[UserRules => ArrayRef[Paws::WorkSpaces::IpRuleItem]]

Each argument is described in detail in: Paws::WorkSpaces::CreateIpGroup

Returns: a Paws::WorkSpaces::CreateIpGroupResult instance

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.

CreateTags

ResourceId => Str
Tags => ArrayRef[Paws::WorkSpaces::Tag]

Each argument is described in detail in: Paws::WorkSpaces::CreateTags

Returns: a Paws::WorkSpaces::CreateTagsResult instance

Creates the specified tags for the specified WorkSpaces resource.

CreateWorkspaceBundle

BundleDescription => Str
BundleName => Str
ComputeType => Paws::WorkSpaces::ComputeType
ImageId => Str
UserStorage => Paws::WorkSpaces::UserStorage
[RootStorage => Paws::WorkSpaces::RootStorage]
[Tags => ArrayRef[Paws::WorkSpaces::Tag]]

Each argument is described in detail in: Paws::WorkSpaces::CreateWorkspaceBundle

Returns: a Paws::WorkSpaces::CreateWorkspaceBundleResult instance

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html).

CreateWorkspaces

Workspaces => ArrayRef[Paws::WorkSpaces::WorkspaceRequest]

Each argument is described in detail in: Paws::WorkSpaces::CreateWorkspaces

Returns: a Paws::WorkSpaces::CreateWorkspacesResult instance

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

DeleteConnectionAlias

AliasId => Str

Each argument is described in detail in: Paws::WorkSpaces::DeleteConnectionAlias

Returns: a Paws::WorkSpaces::DeleteConnectionAliasResult instance

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations).

To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

DeleteIpGroup

GroupId => Str

Each argument is described in detail in: Paws::WorkSpaces::DeleteIpGroup

Returns: a Paws::WorkSpaces::DeleteIpGroupResult instance

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

DeleteTags

ResourceId => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::WorkSpaces::DeleteTags

Returns: a Paws::WorkSpaces::DeleteTagsResult instance

Deletes the specified tags from the specified WorkSpaces resource.

DeleteWorkspaceBundle

[BundleId => Str]

Each argument is described in detail in: Paws::WorkSpaces::DeleteWorkspaceBundle

Returns: a Paws::WorkSpaces::DeleteWorkspaceBundleResult instance

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html).

DeleteWorkspaceImage

ImageId => Str

Each argument is described in detail in: Paws::WorkSpaces::DeleteWorkspaceImage

Returns: a Paws::WorkSpaces::DeleteWorkspaceImageResult instance

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.

DeregisterWorkspaceDirectory

DirectoryId => Str

Each argument is described in detail in: Paws::WorkSpaces::DeregisterWorkspaceDirectory

Returns: a Paws::WorkSpaces::DeregisterWorkspaceDirectoryResult instance

Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms (http://aws.amazon.com/directoryservice/pricing/).

To delete empty directories, see Delete the Directory for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

DescribeAccount

Each argument is described in detail in: Paws::WorkSpaces::DescribeAccount

Returns: a Paws::WorkSpaces::DescribeAccountResult instance

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

DescribeAccountModifications

[NextToken => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeAccountModifications

Returns: a Paws::WorkSpaces::DescribeAccountModificationsResult instance

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

DescribeClientProperties

ResourceIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::WorkSpaces::DescribeClientProperties

Returns: a Paws::WorkSpaces::DescribeClientPropertiesResult instance

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

DescribeConnectionAliases

[AliasIds => ArrayRef[Str|Undef]]
[Limit => Int]
[NextToken => Str]
[ResourceId => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeConnectionAliases

Returns: a Paws::WorkSpaces::DescribeConnectionAliasesResult instance

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

DescribeConnectionAliasPermissions

AliasId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeConnectionAliasPermissions

Returns: a Paws::WorkSpaces::DescribeConnectionAliasPermissionsResult instance

Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

DescribeIpGroups

[GroupIds => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeIpGroups

Returns: a Paws::WorkSpaces::DescribeIpGroupsResult instance

Describes one or more of your IP access control groups.

DescribeTags

ResourceId => Str

Each argument is described in detail in: Paws::WorkSpaces::DescribeTags

Returns: a Paws::WorkSpaces::DescribeTagsResult instance

Describes the specified tags for the specified WorkSpaces resource.

DescribeWorkspaceBundles

[BundleIds => ArrayRef[Str|Undef]]
[NextToken => Str]
[Owner => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspaceBundles

Returns: a Paws::WorkSpaces::DescribeWorkspaceBundlesResult instance

Retrieves a list that describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

DescribeWorkspaceDirectories

[DirectoryIds => ArrayRef[Str|Undef]]
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspaceDirectories

Returns: a Paws::WorkSpaces::DescribeWorkspaceDirectoriesResult instance

Describes the available directories that are registered with Amazon WorkSpaces.

DescribeWorkspaceImagePermissions

ImageId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspaceImagePermissions

Returns: a Paws::WorkSpaces::DescribeWorkspaceImagePermissionsResult instance

Describes the permissions that the owner of an image has granted to other AWS accounts for an image.

DescribeWorkspaceImages

[ImageIds => ArrayRef[Str|Undef]]
[ImageType => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspaceImages

Returns: a Paws::WorkSpaces::DescribeWorkspaceImagesResult instance

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

DescribeWorkspaces

[BundleId => Str]
[DirectoryId => Str]
[Limit => Int]
[NextToken => Str]
[UserName => Str]
[WorkspaceIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspaces

Returns: a Paws::WorkSpaces::DescribeWorkspacesResult instance

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.

DescribeWorkspacesConnectionStatus

[NextToken => Str]
[WorkspaceIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspacesConnectionStatus

Returns: a Paws::WorkSpaces::DescribeWorkspacesConnectionStatusResult instance

Describes the connection status of the specified WorkSpaces.

DescribeWorkspaceSnapshots

WorkspaceId => Str

Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspaceSnapshots

Returns: a Paws::WorkSpaces::DescribeWorkspaceSnapshotsResult instance

Describes the snapshots for the specified WorkSpace.

DisassociateConnectionAlias

AliasId => Str

Each argument is described in detail in: Paws::WorkSpaces::DisassociateConnectionAlias

Returns: a Paws::WorkSpaces::DisassociateConnectionAliasResult instance

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

DisassociateIpGroups

DirectoryId => Str
GroupIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::WorkSpaces::DisassociateIpGroups

Returns: a Paws::WorkSpaces::DisassociateIpGroupsResult instance

Disassociates the specified IP access control group from the specified directory.

ImportWorkspaceImage

Ec2ImageId => Str
ImageDescription => Str
ImageName => Str
IngestionProcess => Str
[Applications => ArrayRef[Str|Undef]]
[Tags => ArrayRef[Paws::WorkSpaces::Tag]]

Each argument is described in detail in: Paws::WorkSpaces::ImportWorkspaceImage

Returns: a Paws::WorkSpaces::ImportWorkspaceImageResult instance

Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).

ListAvailableManagementCidrRanges

ManagementCidrRangeConstraint => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WorkSpaces::ListAvailableManagementCidrRanges

Returns: a Paws::WorkSpaces::ListAvailableManagementCidrRangesResult instance

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

MigrateWorkspace

BundleId => Str
SourceWorkspaceId => Str

Each argument is described in detail in: Paws::WorkSpaces::MigrateWorkspace

Returns: a Paws::WorkSpaces::MigrateWorkspaceResult instance

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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html).

ModifyAccount

[DedicatedTenancyManagementCidrRange => Str]
[DedicatedTenancySupport => Str]

Each argument is described in detail in: Paws::WorkSpaces::ModifyAccount

Returns: a Paws::WorkSpaces::ModifyAccountResult instance

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

ModifyClientProperties

ClientProperties => Paws::WorkSpaces::ClientProperties
ResourceId => Str

Each argument is described in detail in: Paws::WorkSpaces::ModifyClientProperties

Returns: a Paws::WorkSpaces::ModifyClientPropertiesResult instance

Modifies the properties of the specified Amazon WorkSpaces clients.

ModifySelfservicePermissions

ResourceId => Str
SelfservicePermissions => Paws::WorkSpaces::SelfservicePermissions

Each argument is described in detail in: Paws::WorkSpaces::ModifySelfservicePermissions

Returns: a Paws::WorkSpaces::ModifySelfservicePermissionsResult instance

Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html).

ModifyWorkspaceAccessProperties

ResourceId => Str
WorkspaceAccessProperties => Paws::WorkSpaces::WorkspaceAccessProperties

Each argument is described in detail in: Paws::WorkSpaces::ModifyWorkspaceAccessProperties

Returns: a Paws::WorkSpaces::ModifyWorkspaceAccessPropertiesResult instance

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access).

ModifyWorkspaceCreationProperties

ResourceId => Str
WorkspaceCreationProperties => Paws::WorkSpaces::WorkspaceCreationProperties

Each argument is described in detail in: Paws::WorkSpaces::ModifyWorkspaceCreationProperties

Returns: a Paws::WorkSpaces::ModifyWorkspaceCreationPropertiesResult instance

Modify the default properties used to create WorkSpaces.

ModifyWorkspaceProperties

WorkspaceId => Str
WorkspaceProperties => Paws::WorkSpaces::WorkspaceProperties

Each argument is described in detail in: Paws::WorkSpaces::ModifyWorkspaceProperties

Returns: a Paws::WorkSpaces::ModifyWorkspacePropertiesResult instance

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html).

ModifyWorkspaceState

WorkspaceId => Str
WorkspaceState => Str

Each argument is described in detail in: Paws::WorkSpaces::ModifyWorkspaceState

Returns: a Paws::WorkSpaces::ModifyWorkspaceStateResult instance

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.

RebootWorkspaces

RebootWorkspaceRequests => ArrayRef[Paws::WorkSpaces::RebootRequest]

Each argument is described in detail in: Paws::WorkSpaces::RebootWorkspaces

Returns: a Paws::WorkSpaces::RebootWorkspacesResult instance

Reboots the specified WorkSpaces.

You cannot reboot a WorkSpace unless its state is "AVAILABLE" or "UNHEALTHY".

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

RebuildWorkspaces

RebuildWorkspaceRequests => ArrayRef[Paws::WorkSpaces::RebuildRequest]

Each argument is described in detail in: Paws::WorkSpaces::RebuildWorkspaces

Returns: a Paws::WorkSpaces::RebuildWorkspacesResult instance

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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html).

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

RegisterWorkspaceDirectory

DirectoryId => Str
EnableWorkDocs => Bool
[EnableSelfService => Bool]
[SubnetIds => ArrayRef[Str|Undef]]
[Tags => ArrayRef[Paws::WorkSpaces::Tag]]
[Tenancy => Str]

Each argument is described in detail in: Paws::WorkSpaces::RegisterWorkspaceDirectory

Returns: a Paws::WorkSpaces::RegisterWorkspaceDirectoryResult instance

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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role).

RestoreWorkspace

WorkspaceId => Str

Each argument is described in detail in: Paws::WorkSpaces::RestoreWorkspace

Returns: a Paws::WorkSpaces::RestoreWorkspaceResult instance

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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html).

This operation is asynchronous and returns before the WorkSpace is completely restored.

RevokeIpRules

GroupId => Str
UserRules => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::WorkSpaces::RevokeIpRules

Returns: a Paws::WorkSpaces::RevokeIpRulesResult instance

Removes one or more rules from the specified IP access control group.

StartWorkspaces

StartWorkspaceRequests => ArrayRef[Paws::WorkSpaces::StartRequest]

Each argument is described in detail in: Paws::WorkSpaces::StartWorkspaces

Returns: a Paws::WorkSpaces::StartWorkspacesResult instance

Starts the specified WorkSpaces.

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

StopWorkspaces

StopWorkspaceRequests => ArrayRef[Paws::WorkSpaces::StopRequest]

Each argument is described in detail in: Paws::WorkSpaces::StopWorkspaces

Returns: a Paws::WorkSpaces::StopWorkspacesResult instance

Stops the specified WorkSpaces.

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

TerminateWorkspaces

TerminateWorkspaceRequests => ArrayRef[Paws::WorkSpaces::TerminateRequest]

Each argument is described in detail in: Paws::WorkSpaces::TerminateWorkspaces

Returns: a Paws::WorkSpaces::TerminateWorkspacesResult instance

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact AWS Support before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except "SUSPENDED".

This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the "TERMINATED" state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

UpdateConnectionAliasPermission

AliasId => Str
ConnectionAliasPermission => Paws::WorkSpaces::ConnectionAliasPermission

Each argument is described in detail in: Paws::WorkSpaces::UpdateConnectionAliasPermission

Returns: a Paws::WorkSpaces::UpdateConnectionAliasPermissionResult instance

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) to make sure that the current state of the connection alias is "CREATED".
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

UpdateRulesOfIpGroup

GroupId => Str
UserRules => ArrayRef[Paws::WorkSpaces::IpRuleItem]

Each argument is described in detail in: Paws::WorkSpaces::UpdateRulesOfIpGroup

Returns: a Paws::WorkSpaces::UpdateRulesOfIpGroupResult instance

Replaces the current rules of the specified IP access control group with the specified rules.

UpdateWorkspaceBundle

[BundleId => Str]
[ImageId => Str]

Each argument is described in detail in: Paws::WorkSpaces::UpdateWorkspaceBundle

Returns: a Paws::WorkSpaces::UpdateWorkspaceBundleResult instance

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html).

Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

UpdateWorkspaceImagePermission

AllowCopyImage => Bool
ImageId => Str
SharedAccountId => Str

Each argument is described in detail in: Paws::WorkSpaces::UpdateWorkspaceImagePermission

Returns: a Paws::WorkSpaces::UpdateWorkspaceImagePermissionResult instance

Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

After an image has been shared, the recipient account can copy the image to other AWS Regions as needed.

In the China (Ningxia) Region, you can copy images only within the same Region.

In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.

For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html).

To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results