Network.AWS.WorkSpaces

Amazon WorkSpaces Service

This is the Amazon WorkSpaces API Reference. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.

See: AWS API Reference

Service

data WorkSpaces

Version 2015-04-08 of the Amazon WorkSpaces SDK.

Instances

AWSService WorkSpaces

type Sg WorkSpaces = V4

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by WorkSpaces.

InvalidParameterValuesException

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

One or more parameter values are not valid.

ResourceUnavailableException

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

The specified resource is not available.

ResourceLimitExceededException

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

Your resource limits have been exceeded.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DescribeWorkspaceDirectories

module Network.AWS.WorkSpaces.DescribeWorkspaceDirectories

DescribeWorkspaceBundles

module Network.AWS.WorkSpaces.DescribeWorkspaceBundles

RebuildWorkspaces

module Network.AWS.WorkSpaces.RebuildWorkspaces

RebootWorkspaces

module Network.AWS.WorkSpaces.RebootWorkspaces

TerminateWorkspaces

module Network.AWS.WorkSpaces.TerminateWorkspaces

CreateWorkspaces

module Network.AWS.WorkSpaces.CreateWorkspaces

DescribeWorkspaces

module Network.AWS.WorkSpaces.DescribeWorkspaces

Types

Compute

data Compute

Constructors

Performance

Standard

Value

Instances

Enum Compute

Eq Compute

Data Compute

Ord Compute

Read Compute

Show Compute

Generic Compute

FromJSON Compute

Hashable Compute

ToHeader Compute

ToQuery Compute

ToByteString Compute

FromText Compute

ToText Compute

Typeable * Compute

type Rep Compute

WorkspaceDirectoryState

data WorkspaceDirectoryState

Constructors

Deregistered

Deregistering

Error'

Registered

Registering

Instances

Enum WorkspaceDirectoryState

Eq WorkspaceDirectoryState

Data WorkspaceDirectoryState

Ord WorkspaceDirectoryState

Read WorkspaceDirectoryState

Show WorkspaceDirectoryState

Generic WorkspaceDirectoryState

FromJSON WorkspaceDirectoryState

Hashable WorkspaceDirectoryState

ToHeader WorkspaceDirectoryState

ToQuery WorkspaceDirectoryState

ToByteString WorkspaceDirectoryState

FromText WorkspaceDirectoryState

ToText WorkspaceDirectoryState

Typeable * WorkspaceDirectoryState

type Rep WorkspaceDirectoryState

WorkspaceDirectoryType

data WorkspaceDirectoryType

Constructors

AdConnector

SimpleAd

Instances

Enum WorkspaceDirectoryType

Eq WorkspaceDirectoryType

Data WorkspaceDirectoryType

Ord WorkspaceDirectoryType

Read WorkspaceDirectoryType

Show WorkspaceDirectoryType

Generic WorkspaceDirectoryType

FromJSON WorkspaceDirectoryType

Hashable WorkspaceDirectoryType

ToHeader WorkspaceDirectoryType

ToQuery WorkspaceDirectoryType

ToByteString WorkspaceDirectoryType

FromText WorkspaceDirectoryType

ToText WorkspaceDirectoryType

Typeable * WorkspaceDirectoryType

type Rep WorkspaceDirectoryType

WorkspaceState

data WorkspaceState

Constructors

WSAvailable

WSError'

WSImpaired

WSPending

WSRebooting

WSRebuilding

WSSuspended

WSTerminated

WSTerminating

WSUnhealthy

Instances

Enum WorkspaceState

Eq WorkspaceState

Data WorkspaceState

Ord WorkspaceState

Read WorkspaceState

Show WorkspaceState

Generic WorkspaceState

FromJSON WorkspaceState

Hashable WorkspaceState

ToHeader WorkspaceState

ToQuery WorkspaceState

ToByteString WorkspaceState

FromText WorkspaceState

ToText WorkspaceState

Typeable * WorkspaceState

type Rep WorkspaceState

ComputeType

data ComputeType

Contains information about the compute type of a WorkSpace bundle.

See: computeType smart constructor.

Instances

Eq ComputeType

Data ComputeType

Read ComputeType

Show ComputeType

Generic ComputeType

FromJSON ComputeType

Typeable * ComputeType

type Rep ComputeType

computeType :: ComputeType

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

ctName :: Lens' ComputeType (Maybe Compute)

The name of the compute type for the bundle.

DefaultWorkspaceCreationProperties

data DefaultWorkspaceCreationProperties

Contains default WorkSpace creation information.

See: defaultWorkspaceCreationProperties smart constructor.

Instances

Eq DefaultWorkspaceCreationProperties

Data DefaultWorkspaceCreationProperties

Read DefaultWorkspaceCreationProperties

Show DefaultWorkspaceCreationProperties

Generic DefaultWorkspaceCreationProperties

FromJSON DefaultWorkspaceCreationProperties

Typeable * DefaultWorkspaceCreationProperties

type Rep DefaultWorkspaceCreationProperties

defaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties

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
• dwcpUserEnabledAsLocalAdministrator
• dwcpEnableWorkDocs
• dwcpEnableInternetAccess
• dwcpDefaultOu

dwcpCustomSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)

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

dwcpUserEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)

The WorkSpace user is an administrator on the WorkSpace.

dwcpEnableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)

Specifies if the directory is enabled for Amazon WorkDocs.

dwcpEnableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)

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

dwcpDefaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)

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

FailedCreateWorkspaceRequest

data FailedCreateWorkspaceRequest

Contains information about a WorkSpace that could not be created.

See: failedCreateWorkspaceRequest smart constructor.

Instances

Eq FailedCreateWorkspaceRequest

Data FailedCreateWorkspaceRequest

Read FailedCreateWorkspaceRequest

Show FailedCreateWorkspaceRequest

Generic FailedCreateWorkspaceRequest

FromJSON FailedCreateWorkspaceRequest

Typeable * FailedCreateWorkspaceRequest

type Rep FailedCreateWorkspaceRequest

failedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest

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
• fcwrErrorCode
• fcwrErrorMessage

fcwrWorkspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest)

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

fcwrErrorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text)

The error code.

fcwrErrorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text)

The textual error message.

FailedWorkspaceChangeRequest

data FailedWorkspaceChangeRequest

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

See: failedWorkspaceChangeRequest smart constructor.

Instances

Eq FailedWorkspaceChangeRequest

Data FailedWorkspaceChangeRequest

Read FailedWorkspaceChangeRequest

Show FailedWorkspaceChangeRequest

Generic FailedWorkspaceChangeRequest

FromJSON FailedWorkspaceChangeRequest

Typeable * FailedWorkspaceChangeRequest

type Rep FailedWorkspaceChangeRequest

failedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest

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
• fwcrWorkspaceId
• fwcrErrorMessage

fwcrErrorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text)

The error code.

fwcrWorkspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text)

The identifier of the WorkSpace.

fwcrErrorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text)

The textual error message.

RebootRequest

data RebootRequest

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

See: rebootRequest smart constructor.

Instances

Eq RebootRequest

Data RebootRequest

Read RebootRequest

Show RebootRequest

Generic RebootRequest

ToJSON RebootRequest

Typeable * RebootRequest

type Rep RebootRequest

rebootRequest

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

rWorkspaceId :: Lens' RebootRequest Text

The identifier of the WorkSpace to reboot.

RebuildRequest

data RebuildRequest

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

See: rebuildRequest smart constructor.

Instances

Eq RebuildRequest

Data RebuildRequest

Read RebuildRequest

Show RebuildRequest

Generic RebuildRequest

ToJSON RebuildRequest

Typeable * RebuildRequest

type Rep RebuildRequest

rebuildRequest

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

rrWorkspaceId :: Lens' RebuildRequest Text

The identifier of the WorkSpace to rebuild.

TerminateRequest

data TerminateRequest

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

See: terminateRequest smart constructor.

Instances

Eq TerminateRequest

Data TerminateRequest

Read TerminateRequest

Show TerminateRequest

Generic TerminateRequest

ToJSON TerminateRequest

Typeable * TerminateRequest

type Rep TerminateRequest

terminateRequest

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

trWorkspaceId :: Lens' TerminateRequest Text

The identifier of the WorkSpace to terminate.

UserStorage

data UserStorage

Contains information about the user storage for a WorkSpace bundle.

See: userStorage smart constructor.

Instances

Eq UserStorage

Data UserStorage

Read UserStorage

Show UserStorage

Generic UserStorage

FromJSON UserStorage

Typeable * UserStorage

type Rep UserStorage

userStorage :: UserStorage

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

usCapacity :: Lens' UserStorage (Maybe Text)

The amount of user storage for the bundle.

Workspace

data Workspace

Contains information about a WorkSpace.

See: workspace smart constructor.

Instances

Eq Workspace

Data Workspace

Read Workspace

Show Workspace

Generic Workspace

FromJSON Workspace

Typeable * Workspace

type Rep Workspace

workspace :: Workspace

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
• wIPAddress
• wState
• wUserName
• wSubnetId
• wBundleId
• wErrorCode
• wWorkspaceId
• wErrorMessage

wDirectoryId :: Lens' Workspace (Maybe Text)

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

wIPAddress :: Lens' Workspace (Maybe Text)

The IP address of the WorkSpace.

wState :: Lens' Workspace (Maybe WorkspaceState)

The operational state of the WorkSpace.

wUserName :: Lens' Workspace (Maybe Text)

The user that the WorkSpace is assigned to.

wSubnetId :: Lens' Workspace (Maybe Text)

The identifier of the subnet that the WorkSpace is in.

wBundleId :: Lens' Workspace (Maybe Text)

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

wErrorCode :: Lens' Workspace (Maybe Text)

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

wWorkspaceId :: Lens' Workspace (Maybe Text)

The identifier of the WorkSpace.

wErrorMessage :: Lens' Workspace (Maybe Text)

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

WorkspaceBundle

data WorkspaceBundle

Contains information about a WorkSpace bundle.

See: workspaceBundle smart constructor.

Instances

Eq WorkspaceBundle

Data WorkspaceBundle

Read WorkspaceBundle

Show WorkspaceBundle

Generic WorkspaceBundle

FromJSON WorkspaceBundle

Typeable * WorkspaceBundle

type Rep WorkspaceBundle

workspaceBundle :: WorkspaceBundle

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:

• wbOwner
• wbBundleId
• wbName
• wbComputeType
• wbUserStorage
• wbDescription

wbOwner :: Lens' WorkspaceBundle (Maybe Text)

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

wbBundleId :: Lens' WorkspaceBundle (Maybe Text)

The bundle identifier.

wbName :: Lens' WorkspaceBundle (Maybe Text)

The name of the bundle.

wbComputeType :: Lens' WorkspaceBundle (Maybe ComputeType)

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

wbUserStorage :: Lens' WorkspaceBundle (Maybe UserStorage)

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

wbDescription :: Lens' WorkspaceBundle (Maybe Text)

The bundle description.

WorkspaceDirectory

data WorkspaceDirectory

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

See: workspaceDirectory smart constructor.

Instances

Eq WorkspaceDirectory

Data WorkspaceDirectory

Read WorkspaceDirectory

Show WorkspaceDirectory

Generic WorkspaceDirectory

FromJSON WorkspaceDirectory

Typeable * WorkspaceDirectory

type Rep WorkspaceDirectory

workspaceDirectory :: WorkspaceDirectory

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
• wdIAMRoleId
• wdDirectoryId
• wdState
• wdCustomerUserName
• wdSubnetIds
• wdAlias
• wdDirectoryType
• wdWorkspaceSecurityGroupId
• wdWorkspaceCreationProperties
• wdDNSIPAddresses
• wdDirectoryName

wdRegistrationCode :: Lens' WorkspaceDirectory (Maybe Text)

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)

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)

The directory identifier.

wdState :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState)

The state of the directory's registration with Amazon WorkSpaces

wdCustomerUserName :: Lens' WorkspaceDirectory (Maybe Text)

The user name for the service account.

wdSubnetIds :: Lens' WorkspaceDirectory [Text]

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

wdAlias :: Lens' WorkspaceDirectory (Maybe Text)

The directory alias.

wdDirectoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType)

The directory type.

wdWorkspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text)

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

wdWorkspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties)

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

wdDNSIPAddresses :: Lens' WorkspaceDirectory [Text]

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

wdDirectoryName :: Lens' WorkspaceDirectory (Maybe Text)

The name of the directory.

WorkspaceRequest

data WorkspaceRequest

Contains information about a WorkSpace creation request.

See: workspaceRequest smart constructor.

Instances

Eq WorkspaceRequest

Data WorkspaceRequest

Read WorkspaceRequest

Show WorkspaceRequest

Generic WorkspaceRequest

ToJSON WorkspaceRequest

FromJSON WorkspaceRequest

Typeable * WorkspaceRequest

type Rep WorkspaceRequest

workspaceRequest

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:

• wrDirectoryId
• wrUserName
• wrBundleId

wrDirectoryId :: Lens' WorkspaceRequest Text

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

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

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.