Paws::WorkSpaces - Perl Interface to AWS Amazon WorkSpaces
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' } ], );
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
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.
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.
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.
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.
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.
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.
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.
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.
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 un-share the image if it is shared with other accounts.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspacesConnectionStatus
Returns: a Paws::WorkSpaces::DescribeWorkspacesConnectionStatusResult instance
Describes the connection status of the specified WorkSpaces.
Each argument is described in detail in: Paws::WorkSpaces::DescribeWorkspaceSnapshots
Returns: a Paws::WorkSpaces::DescribeWorkspaceSnapshotsResult instance
Describes the snapshots for the specified WorkSpace.
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.
Each argument is described in detail in: Paws::WorkSpaces::ImportWorkspaceImage
Returns: a Paws::WorkSpaces::ImportWorkspaceImageResult instance
Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
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).
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.
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.
D:\Users\%USERNAME%
D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated
D:\Users\%USERNAME%\
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).
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.
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.
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).
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).
Each argument is described in detail in: Paws::WorkSpaces::ModifyWorkspaceCreationProperties
Returns: a Paws::WorkSpaces::ModifyWorkspaceCreationPropertiesResult instance
Modify the default properties used to create WorkSpaces.
Each argument is described in detail in: Paws::WorkSpaces::ModifyWorkspaceProperties
Returns: a Paws::WorkSpaces::ModifyWorkspacePropertiesResult instance
Modifies the specified WorkSpace properties.
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.
ADMIN_MAINTENANCE
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.
AVAILABLE
UNHEALTHY
This operation is asynchronous and returns before the WorkSpaces have rebooted.
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, or STOPPED.
ERROR
STOPPED
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.
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).
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.
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.
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.
AutoStop
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.
IMPAIRED
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 Amazon Web Services before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED.
SUSPENDED
This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
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.
Paginator methods are helpers that repetively call methods that return partial results
If passed a sub as first parameter, it will call the sub for each element found in :
- AccountModifications, passing the object as the first parameter, and the string 'AccountModifications' as the second parameter
If not, it will return a a Paws::WorkSpaces::DescribeAccountModificationsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
param
- Result, passing the object as the first parameter, and the string 'Result' as the second parameter
If not, it will return a a Paws::WorkSpaces::DescribeIpGroupsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Bundles, passing the object as the first parameter, and the string 'Bundles' as the second parameter
If not, it will return a a Paws::WorkSpaces::DescribeWorkspaceBundlesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Directories, passing the object as the first parameter, and the string 'Directories' as the second parameter
If not, it will return a a Paws::WorkSpaces::DescribeWorkspaceDirectoriesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Images, passing the object as the first parameter, and the string 'Images' as the second parameter
If not, it will return a a Paws::WorkSpaces::DescribeWorkspaceImagesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Workspaces, passing the object as the first parameter, and the string 'Workspaces' as the second parameter
If not, it will return a a Paws::WorkSpaces::DescribeWorkspacesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- WorkspacesConnectionStatus, passing the object as the first parameter, and the string 'WorkspacesConnectionStatus' as the second parameter
If not, it will return a a Paws::WorkSpaces::DescribeWorkspacesConnectionStatusResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- ManagementCidrRanges, passing the object as the first parameter, and the string 'ManagementCidrRanges' as the second parameter
If not, it will return a a Paws::WorkSpaces::ListAvailableManagementCidrRangesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
This service class forms part of Paws
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.