amazonka-workspaces-1.3.7: Amazon WorkSpaces SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.WorkSpaces.Types

Contents

Description

 

Synopsis

Service Configuration

workSpaces :: Service Source

API version '2015-04-08' of the Amazon WorkSpaces SDK configuration.

Errors

_ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified resource is not available.

_InvalidParameterValuesException :: AsError a => Getting (First ServiceError) a ServiceError Source

One or more parameter values are not valid.

_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

Your resource limits have been exceeded.

Compute

data Compute Source

Constructors

Performance 
Standard 
Value 

Instances

WorkspaceDirectoryState

data WorkspaceDirectoryState Source

Constructors

Deregistered 
Deregistering 
Error' 
Registered 
Registering 

Instances

WorkspaceDirectoryType

data WorkspaceDirectoryType Source

Constructors

AdConnector 
SimpleAd 

Instances

WorkspaceState

data WorkspaceState Source

Constructors

WSAvailable 
WSError' 
WSImpaired 
WSPending 
WSRebooting 
WSRebuilding 
WSSuspended 
WSTerminated 
WSTerminating 
WSUnhealthy 

Instances

ComputeType

data ComputeType Source

Contains information about the compute type of a WorkSpace bundle.

See: computeType smart constructor.

Instances

computeType :: ComputeType Source

Creates a value of ComputeType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ctName :: Lens' ComputeType (Maybe Compute) Source

The name of the compute type for the bundle.

DefaultWorkspaceCreationProperties

data DefaultWorkspaceCreationProperties Source

Contains default WorkSpace creation information.

See: defaultWorkspaceCreationProperties smart constructor.

Instances

defaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties Source

Creates a value of DefaultWorkspaceCreationProperties with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dwcpCustomSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source

The identifier of any custom security groups that are applied to the WorkSpaces when they are created.

dwcpUserEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source

The WorkSpace user is an administrator on the WorkSpace.

dwcpEnableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source

Specifies if the directory is enabled for Amazon WorkDocs.

dwcpEnableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source

A public IP address will be attached to all WorkSpaces that are created or rebuilt.

dwcpDefaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source

The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in.

FailedCreateWorkspaceRequest

data FailedCreateWorkspaceRequest Source

Contains information about a WorkSpace that could not be created.

See: failedCreateWorkspaceRequest smart constructor.

Instances

failedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest Source

Creates a value of FailedCreateWorkspaceRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fcwrWorkspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest) Source

A WorkspaceRequest object that contains the information about the WorkSpace that could not be created.

fcwrErrorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source

The error code.

fcwrErrorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source

The textual error message.

FailedWorkspaceChangeRequest

data FailedWorkspaceChangeRequest Source

Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), or terminated (TerminateWorkspaces).

See: failedWorkspaceChangeRequest smart constructor.

Instances

failedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest Source

Creates a value of FailedWorkspaceChangeRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fwcrErrorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source

The error code.

fwcrWorkspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source

The identifier of the WorkSpace.

fwcrErrorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source

The textual error message.

RebootRequest

data RebootRequest Source

Contains information used with the RebootWorkspaces operation to reboot a WorkSpace.

See: rebootRequest smart constructor.

Instances

rebootRequest Source

Arguments

:: Text

rWorkspaceId

-> RebootRequest 

Creates a value of RebootRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rWorkspaceId :: Lens' RebootRequest Text Source

The identifier of the WorkSpace to reboot.

RebuildRequest

data RebuildRequest Source

Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace.

See: rebuildRequest smart constructor.

Instances

rebuildRequest Source

Arguments

:: Text

rrWorkspaceId

-> RebuildRequest 

Creates a value of RebuildRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rrWorkspaceId :: Lens' RebuildRequest Text Source

The identifier of the WorkSpace to rebuild.

TerminateRequest

data TerminateRequest Source

Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace.

See: terminateRequest smart constructor.

Instances

terminateRequest Source

Arguments

:: Text

trWorkspaceId

-> TerminateRequest 

Creates a value of TerminateRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

trWorkspaceId :: Lens' TerminateRequest Text Source

The identifier of the WorkSpace to terminate.

UserStorage

data UserStorage Source

Contains information about the user storage for a WorkSpace bundle.

See: userStorage smart constructor.

Instances

userStorage :: UserStorage Source

Creates a value of UserStorage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

usCapacity :: Lens' UserStorage (Maybe Text) Source

The amount of user storage for the bundle.

Workspace

data Workspace Source

Contains information about a WorkSpace.

See: workspace smart constructor.

Instances

workspace :: Workspace Source

Creates a value of Workspace with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wDirectoryId :: Lens' Workspace (Maybe Text) Source

The identifier of the AWS Directory Service directory that the WorkSpace belongs to.

wState :: Lens' Workspace (Maybe WorkspaceState) Source

The operational state of the WorkSpace.

wIPAddress :: Lens' Workspace (Maybe Text) Source

The IP address of the WorkSpace.

wUserName :: Lens' Workspace (Maybe Text) Source

The user that the WorkSpace is assigned to.

wSubnetId :: Lens' Workspace (Maybe Text) Source

The identifier of the subnet that the WorkSpace is in.

wBundleId :: Lens' Workspace (Maybe Text) Source

The identifier of the bundle that the WorkSpace was created from.

wRootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

wErrorCode :: Lens' Workspace (Maybe Text) Source

If the WorkSpace could not be created, this contains the error code.

wVolumeEncryptionKey :: Lens' Workspace (Maybe Text) Source

The KMS key used to encrypt data stored on your WorkSpace.

wComputerName :: Lens' Workspace (Maybe Text) Source

The name of the WorkSpace as seen by the operating system.

wWorkspaceId :: Lens' Workspace (Maybe Text) Source

The identifier of the WorkSpace.

wUserVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

wErrorMessage :: Lens' Workspace (Maybe Text) Source

If the WorkSpace could not be created, this contains a textual error message that describes the failure.

WorkspaceBundle

data WorkspaceBundle Source

Contains information about a WorkSpace bundle.

See: workspaceBundle smart constructor.

Instances

workspaceBundle :: WorkspaceBundle Source

Creates a value of WorkspaceBundle with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wbBundleId :: Lens' WorkspaceBundle (Maybe Text) Source

The bundle identifier.

wbOwner :: Lens' WorkspaceBundle (Maybe Text) Source

The owner of the bundle. This contains the owner's account identifier, or AMAZON if the bundle is provided by AWS.

wbName :: Lens' WorkspaceBundle (Maybe Text) Source

The name of the bundle.

wbComputeType :: Lens' WorkspaceBundle (Maybe ComputeType) Source

A ComputeType object that specifies the compute type for the bundle.

wbUserStorage :: Lens' WorkspaceBundle (Maybe UserStorage) Source

A UserStorage object that specifies the amount of user storage that the bundle contains.

wbDescription :: Lens' WorkspaceBundle (Maybe Text) Source

The bundle description.

WorkspaceDirectory

data WorkspaceDirectory Source

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

See: workspaceDirectory smart constructor.

Instances

workspaceDirectory :: WorkspaceDirectory Source

Creates a value of WorkspaceDirectory with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wdRegistrationCode :: Lens' WorkspaceDirectory (Maybe Text) Source

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

wdIAMRoleId :: Lens' WorkspaceDirectory (Maybe Text) Source

The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

wdDirectoryId :: Lens' WorkspaceDirectory (Maybe Text) Source

The directory identifier.

wdState :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState) Source

The state of the directory's registration with Amazon WorkSpaces

wdCustomerUserName :: Lens' WorkspaceDirectory (Maybe Text) Source

The user name for the service account.

wdSubnetIds :: Lens' WorkspaceDirectory [Text] Source

An array of strings that contains the identifiers of the subnets used with the directory.

wdAlias :: Lens' WorkspaceDirectory (Maybe Text) Source

The directory alias.

wdWorkspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text) Source

The identifier of the security group that is assigned to new WorkSpaces.

wdDirectoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType) Source

The directory type.

wdWorkspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties) Source

A structure that specifies the default creation properties for all WorkSpaces in the directory.

wdDNSIPAddresses :: Lens' WorkspaceDirectory [Text] Source

An array of strings that contains the IP addresses of the DNS servers for the directory.

wdDirectoryName :: Lens' WorkspaceDirectory (Maybe Text) Source

The name of the directory.

WorkspaceRequest

data WorkspaceRequest Source

Contains information about a WorkSpace creation request.

See: workspaceRequest smart constructor.

Instances

workspaceRequest Source

Arguments

:: Text

wrDirectoryId

-> Text

wrUserName

-> Text

wrBundleId

-> WorkspaceRequest 

Creates a value of WorkspaceRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wrRootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

wrVolumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text) Source

The KMS key used to encrypt data stored on your WorkSpace.

wrUserVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

wrDirectoryId :: Lens' WorkspaceRequest Text Source

The identifier of the AWS Directory Service directory to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available.

wrUserName :: Lens' WorkspaceRequest Text Source

The username that the WorkSpace is assigned to. This username must exist in the AWS Directory Service directory specified by the DirectoryId member.

wrBundleId :: Lens' WorkspaceRequest Text Source

The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available.