Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Amazon WorkSpaces Service
This is the Amazon WorkSpaces API Reference. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.
- workSpaces :: Service
- _ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValuesException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.WorkSpaces.DescribeWorkspaceDirectories
- module Network.AWS.WorkSpaces.DescribeWorkspaceBundles
- module Network.AWS.WorkSpaces.RebuildWorkspaces
- module Network.AWS.WorkSpaces.RebootWorkspaces
- module Network.AWS.WorkSpaces.TerminateWorkspaces
- module Network.AWS.WorkSpaces.CreateWorkspaces
- module Network.AWS.WorkSpaces.DescribeWorkspaces
- data Compute
- = Performance
- | Standard
- | Value
- data WorkspaceDirectoryState
- data WorkspaceDirectoryType
- data WorkspaceState
- data ComputeType
- computeType :: ComputeType
- ctName :: Lens' ComputeType (Maybe Compute)
- data DefaultWorkspaceCreationProperties
- defaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties
- dwcpCustomSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
- dwcpUserEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- dwcpEnableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- dwcpEnableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- dwcpDefaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
- data FailedCreateWorkspaceRequest
- failedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest
- fcwrWorkspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest)
- fcwrErrorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
- fcwrErrorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
- data FailedWorkspaceChangeRequest
- failedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest
- fwcrErrorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- fwcrWorkspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- fwcrErrorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- data RebootRequest
- rebootRequest :: Text -> RebootRequest
- rWorkspaceId :: Lens' RebootRequest Text
- data RebuildRequest
- rebuildRequest :: Text -> RebuildRequest
- rrWorkspaceId :: Lens' RebuildRequest Text
- data TerminateRequest
- terminateRequest :: Text -> TerminateRequest
- trWorkspaceId :: Lens' TerminateRequest Text
- data UserStorage
- userStorage :: UserStorage
- usCapacity :: Lens' UserStorage (Maybe Text)
- data Workspace
- workspace :: Workspace
- wDirectoryId :: Lens' Workspace (Maybe Text)
- wState :: Lens' Workspace (Maybe WorkspaceState)
- wIPAddress :: Lens' Workspace (Maybe Text)
- wUserName :: Lens' Workspace (Maybe Text)
- wSubnetId :: Lens' Workspace (Maybe Text)
- wBundleId :: Lens' Workspace (Maybe Text)
- wRootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
- wErrorCode :: Lens' Workspace (Maybe Text)
- wVolumeEncryptionKey :: Lens' Workspace (Maybe Text)
- wComputerName :: Lens' Workspace (Maybe Text)
- wWorkspaceId :: Lens' Workspace (Maybe Text)
- wUserVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
- wErrorMessage :: Lens' Workspace (Maybe Text)
- data WorkspaceBundle
- workspaceBundle :: WorkspaceBundle
- wbBundleId :: Lens' WorkspaceBundle (Maybe Text)
- wbOwner :: Lens' WorkspaceBundle (Maybe Text)
- wbName :: Lens' WorkspaceBundle (Maybe Text)
- wbComputeType :: Lens' WorkspaceBundle (Maybe ComputeType)
- wbUserStorage :: Lens' WorkspaceBundle (Maybe UserStorage)
- wbDescription :: Lens' WorkspaceBundle (Maybe Text)
- data WorkspaceDirectory
- workspaceDirectory :: WorkspaceDirectory
- wdRegistrationCode :: Lens' WorkspaceDirectory (Maybe Text)
- wdIAMRoleId :: Lens' WorkspaceDirectory (Maybe Text)
- wdDirectoryId :: Lens' WorkspaceDirectory (Maybe Text)
- wdState :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState)
- wdCustomerUserName :: Lens' WorkspaceDirectory (Maybe Text)
- wdSubnetIds :: Lens' WorkspaceDirectory [Text]
- wdAlias :: Lens' WorkspaceDirectory (Maybe Text)
- wdWorkspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text)
- wdDirectoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType)
- wdWorkspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties)
- wdDNSIPAddresses :: Lens' WorkspaceDirectory [Text]
- wdDirectoryName :: Lens' WorkspaceDirectory (Maybe Text)
- data WorkspaceRequest
- workspaceRequest :: Text -> Text -> Text -> WorkspaceRequest
- wrRootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- wrVolumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text)
- wrUserVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- wrDirectoryId :: Lens' WorkspaceRequest Text
- wrUserName :: Lens' WorkspaceRequest Text
- wrBundleId :: Lens' WorkspaceRequest Text
Service Configuration
workSpaces :: Service Source #
API version '2015-04-08' of the Amazon WorkSpaces SDK configuration.
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
.
ResourceUnavailableException
_ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is not available.
InvalidParameterValuesException
_InvalidParameterValuesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameter values are not valid.
ResourceLimitExceededException
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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
DescribeWorkspaceBundles
RebuildWorkspaces
RebootWorkspaces
TerminateWorkspaces
CreateWorkspaces
DescribeWorkspaces
Types
Compute
WorkspaceDirectoryState
data WorkspaceDirectoryState Source #
WorkspaceDirectoryType
data WorkspaceDirectoryType Source #
WorkspaceState
data WorkspaceState Source #
WSAvailable | |
WSError' | |
WSImpaired | |
WSPending | |
WSRebooting | |
WSRebuilding | |
WSSuspended | |
WSTerminated | |
WSTerminating | |
WSUnhealthy |
ComputeType
data ComputeType Source #
Contains information about the compute type of a WorkSpace bundle.
See: computeType
smart constructor.
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:
DefaultWorkspaceCreationProperties
data DefaultWorkspaceCreationProperties Source #
Contains default WorkSpace creation information.
See: defaultWorkspaceCreationProperties
smart constructor.
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.
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.
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.
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.
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.
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.
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
Contains information about a WorkSpace.
See: workspace
smart constructor.
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.
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.
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.
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.
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.
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.
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.
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.