The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::WorkSpaces::Workspace

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::WorkSpaces::Workspace object:

  $service_obj->Method(Att1 => { BundleId => $value, ..., WorkspaceProperties => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::Workspace object:

  $result = $service_obj->Method(...);
  $result->Att1->BundleId

DESCRIPTION

Describes a WorkSpace.

ATTRIBUTES

BundleId => Str

The identifier of the bundle used to create the WorkSpace.

ComputerName => Str

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html).

DirectoryId => Str

The identifier of the AWS Directory Service directory for the WorkSpace.

ErrorCode => Str

The error code that is returned if the WorkSpace cannot be created.

ErrorMessage => Str

The text of the error message that is returned if the WorkSpace cannot be created.

IpAddress => Str

The IP address of the WorkSpace.

ModificationStates => ArrayRef[Paws::WorkSpaces::ModificationState]

The modification states of the WorkSpace.

RootVolumeEncryptionEnabled => Bool

Indicates whether the data stored on the root volume is encrypted.

State => Str

The operational state of the WorkSpace.

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.

SubnetId => Str

The identifier of the subnet for the WorkSpace.

UserName => Str

The user for the WorkSpace.

UserVolumeEncryptionEnabled => Bool

Indicates whether the data stored on the user volume is encrypted.

VolumeEncryptionKey => Str

The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.

WorkspaceId => Str

The identifier of the WorkSpace.

WorkspaceProperties => Paws::WorkSpaces::WorkspaceProperties

The properties of the WorkSpace.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::WorkSpaces

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