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

This reference provides detailed information about the Amazon WorkSpaces operations.

METHODS

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 tags for a WorkSpace.

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.

DeleteTags(ResourceId => Str, TagKeys => ArrayRef[Str|Undef])

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

Returns: a Paws::WorkSpaces::DeleteTagsResult instance

  Deletes tags from a WorkSpace.

DescribeTags(ResourceId => Str)

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

Returns: a Paws::WorkSpaces::DescribeTagsResult instance

  Describes tags for a WorkSpace.

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

  Obtains information about the WorkSpace bundles that are available to
your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

DescribeWorkspaceDirectories([DirectoryIds => ArrayRef[Str|Undef], NextToken => Str])

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

Returns: a Paws::WorkSpaces::DescribeWorkspaceDirectoriesResult instance

  Retrieves information about the AWS Directory Service directories in
the region that are registered with Amazon WorkSpaces and are available
to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

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

  Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

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 a specified WorkSpace.

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 WorkSpace properties, including the RunningMode and
AutoStop time.

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.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.

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

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:

  • The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.

  • The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR.

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

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. The API only works with WorkSpaces
that have RunningMode configured as AutoStop and the State set to
E<ldquo>STOPPED.E<rdquo>

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. The API only works with WorkSpaces that
have RunningMode configured as AutoStop and the State set to 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 not maintained and will be 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.

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

PAGINATORS

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

DescribeAllWorkspaceBundles(sub { },[BundleIds => ArrayRef[Str|Undef], NextToken => Str, Owner => Str])

DescribeAllWorkspaceBundles([BundleIds => ArrayRef[Str|Undef], NextToken => Str, Owner => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

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

DescribeAllWorkspaceDirectories(sub { },[DirectoryIds => ArrayRef[Str|Undef], NextToken => Str])

DescribeAllWorkspaceDirectories([DirectoryIds => ArrayRef[Str|Undef], NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

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

DescribeAllWorkspaces(sub { },[BundleId => Str, DirectoryId => Str, Limit => Int, NextToken => Str, UserName => Str, WorkspaceIds => ArrayRef[Str|Undef]])

DescribeAllWorkspaces([BundleId => Str, DirectoryId => Str, Limit => Int, NextToken => Str, UserName => Str, WorkspaceIds => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

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

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

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