Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- AccessDeniedException
- ResourceCreationFailedException
- ResourceUnavailableException
- InvalidParameterValuesException
- ResourceAssociatedException
- OperationInProgressException
- ResourceAlreadyExistsException
- ResourceLimitExceededException
- InvalidResourceStateException
- OperationNotSupportedException
- UnsupportedWorkspaceConfigurationException
- ResourceNotFoundException
- Waiters
- Operations
- RevokeIPRules
- ModifyWorkspaceProperties
- DescribeTags
- DescribeWorkspaceDirectories (Paginated)
- DisassociateIPGroups
- DescribeWorkspaceBundles (Paginated)
- AuthorizeIPRules
- RebuildWorkspaces
- ModifyWorkspaceState
- CreateIPGroup
- CreateTags
- DeleteTags
- UpdateRulesOfIPGroup
- StopWorkspaces
- AssociateIPGroups
- DescribeWorkspacesConnectionStatus
- RebootWorkspaces
- DeleteIPGroup
- TerminateWorkspaces
- CreateWorkspaces
- DescribeIPGroups
- DescribeWorkspaces (Paginated)
- StartWorkspaces
- Types
- Compute
- ConnectionState
- ModificationResourceEnum
- ModificationStateEnum
- RunningMode
- TargetWorkspaceState
- WorkspaceDirectoryState
- WorkspaceDirectoryType
- WorkspaceState
- ComputeType
- DefaultWorkspaceCreationProperties
- FailedCreateWorkspaceRequest
- FailedWorkspaceChangeRequest
- IPRuleItem
- ModificationState
- RebootRequest
- RebuildRequest
- RootStorage
- StartRequest
- StopRequest
- Tag
- TerminateRequest
- UserStorage
- Workspace
- WorkspaceBundle
- WorkspaceConnectionStatus
- WorkspaceDirectory
- WorkspaceProperties
- WorkspaceRequest
- WorkspacesIPGroup
Amazon WorkSpaces Service
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows desktops for your users.
Synopsis
- workSpaces :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceCreationFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValuesException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAssociatedException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidResourceStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedWorkspaceConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.WorkSpaces.RevokeIPRules
- module Network.AWS.WorkSpaces.ModifyWorkspaceProperties
- module Network.AWS.WorkSpaces.DescribeTags
- module Network.AWS.WorkSpaces.DescribeWorkspaceDirectories
- module Network.AWS.WorkSpaces.DisassociateIPGroups
- module Network.AWS.WorkSpaces.DescribeWorkspaceBundles
- module Network.AWS.WorkSpaces.AuthorizeIPRules
- module Network.AWS.WorkSpaces.RebuildWorkspaces
- module Network.AWS.WorkSpaces.ModifyWorkspaceState
- module Network.AWS.WorkSpaces.CreateIPGroup
- module Network.AWS.WorkSpaces.CreateTags
- module Network.AWS.WorkSpaces.DeleteTags
- module Network.AWS.WorkSpaces.UpdateRulesOfIPGroup
- module Network.AWS.WorkSpaces.StopWorkspaces
- module Network.AWS.WorkSpaces.AssociateIPGroups
- module Network.AWS.WorkSpaces.DescribeWorkspacesConnectionStatus
- module Network.AWS.WorkSpaces.RebootWorkspaces
- module Network.AWS.WorkSpaces.DeleteIPGroup
- module Network.AWS.WorkSpaces.TerminateWorkspaces
- module Network.AWS.WorkSpaces.CreateWorkspaces
- module Network.AWS.WorkSpaces.DescribeIPGroups
- module Network.AWS.WorkSpaces.DescribeWorkspaces
- module Network.AWS.WorkSpaces.StartWorkspaces
- data Compute
- = Graphics
- | Performance
- | Power
- | Standard
- | Value
- data ConnectionState
- data ModificationResourceEnum
- data ModificationStateEnum
- data RunningMode
- data TargetWorkspaceState
- 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 IPRuleItem
- ipRuleItem :: IPRuleItem
- iriRuleDesc :: Lens' IPRuleItem (Maybe Text)
- iriIpRule :: Lens' IPRuleItem (Maybe Text)
- data ModificationState
- modificationState :: ModificationState
- msState :: Lens' ModificationState (Maybe ModificationStateEnum)
- msResource :: Lens' ModificationState (Maybe ModificationResourceEnum)
- data RebootRequest
- rebootRequest :: Text -> RebootRequest
- rWorkspaceId :: Lens' RebootRequest Text
- data RebuildRequest
- rebuildRequest :: Text -> RebuildRequest
- rrWorkspaceId :: Lens' RebuildRequest Text
- data RootStorage
- rootStorage :: RootStorage
- rsCapacity :: Lens' RootStorage (Maybe Text)
- data StartRequest
- startRequest :: StartRequest
- sWorkspaceId :: Lens' StartRequest (Maybe Text)
- data StopRequest
- stopRequest :: StopRequest
- srWorkspaceId :: Lens' StopRequest (Maybe Text)
- data Tag
- tag :: Text -> Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag 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)
- wModificationStates :: Lens' Workspace [ModificationState]
- wUserName :: Lens' Workspace (Maybe Text)
- wSubnetId :: Lens' Workspace (Maybe Text)
- wBundleId :: Lens' Workspace (Maybe Text)
- wWorkspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties)
- 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)
- wbRootStorage :: Lens' WorkspaceBundle (Maybe RootStorage)
- wbName :: Lens' WorkspaceBundle (Maybe Text)
- wbComputeType :: Lens' WorkspaceBundle (Maybe ComputeType)
- wbUserStorage :: Lens' WorkspaceBundle (Maybe UserStorage)
- wbDescription :: Lens' WorkspaceBundle (Maybe Text)
- data WorkspaceConnectionStatus
- workspaceConnectionStatus :: WorkspaceConnectionStatus
- wcsLastKnownUserConnectionTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime)
- wcsConnectionStateCheckTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime)
- wcsWorkspaceId :: Lens' WorkspaceConnectionStatus (Maybe Text)
- wcsConnectionState :: Lens' WorkspaceConnectionStatus (Maybe ConnectionState)
- 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]
- wdIpGroupIds :: 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 WorkspaceProperties
- workspaceProperties :: WorkspaceProperties
- wpComputeTypeName :: Lens' WorkspaceProperties (Maybe Compute)
- wpRunningMode :: Lens' WorkspaceProperties (Maybe RunningMode)
- wpRootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)
- wpRunningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int)
- wpUserVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)
- data WorkspaceRequest
- workspaceRequest :: Text -> Text -> Text -> WorkspaceRequest
- wrWorkspaceProperties :: Lens' WorkspaceRequest (Maybe WorkspaceProperties)
- wrRootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- wrVolumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text)
- wrUserVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- wrTags :: Lens' WorkspaceRequest [Tag]
- wrDirectoryId :: Lens' WorkspaceRequest Text
- wrUserName :: Lens' WorkspaceRequest Text
- wrBundleId :: Lens' WorkspaceRequest Text
- data WorkspacesIPGroup
- workspacesIPGroup :: WorkspacesIPGroup
- wigGroupDesc :: Lens' WorkspacesIPGroup (Maybe Text)
- wigUserRules :: Lens' WorkspacesIPGroup [IPRuleItem]
- wigGroupId :: Lens' WorkspacesIPGroup (Maybe Text)
- wigGroupName :: Lens' WorkspacesIPGroup (Maybe 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
.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user is not authorized to access a resource.
ResourceCreationFailedException
_ResourceCreationFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource could not be created.
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.
ResourceAssociatedException
_ResourceAssociatedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is associated with a directory.
OperationInProgressException
_OperationInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The properties of this WorkSpace are currently being modified. Try again in a moment.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource already exists.
ResourceLimitExceededException
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your resource limits have been exceeded.
InvalidResourceStateException
_InvalidResourceStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the resource is not valid for this operation.
OperationNotSupportedException
_OperationNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This operation is not supported.
UnsupportedWorkspaceConfigurationException
_UnsupportedWorkspaceConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration Guide .
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource could not be found.
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.
RevokeIPRules
ModifyWorkspaceProperties
DescribeTags
DescribeWorkspaceDirectories (Paginated)
DisassociateIPGroups
DescribeWorkspaceBundles (Paginated)
AuthorizeIPRules
RebuildWorkspaces
ModifyWorkspaceState
CreateIPGroup
CreateTags
DeleteTags
UpdateRulesOfIPGroup
StopWorkspaces
AssociateIPGroups
DescribeWorkspacesConnectionStatus
RebootWorkspaces
DeleteIPGroup
TerminateWorkspaces
CreateWorkspaces
DescribeIPGroups
DescribeWorkspaces (Paginated)
StartWorkspaces
Types
Compute
Instances
ConnectionState
data ConnectionState Source #
Instances
ModificationResourceEnum
data ModificationResourceEnum Source #
Instances
ModificationStateEnum
data ModificationStateEnum Source #
Instances
RunningMode
data RunningMode Source #
Instances
TargetWorkspaceState
data TargetWorkspaceState Source #
Instances
WorkspaceDirectoryState
data WorkspaceDirectoryState Source #
Instances
WorkspaceDirectoryType
data WorkspaceDirectoryType Source #
Instances
WorkspaceState
data WorkspaceState Source #
WSAdminMaintenance | |
WSAvailable | |
WSError' | |
WSImpaired | |
WSMaintenance | |
WSPending | |
WSRebooting | |
WSRebuilding | |
WSStarting | |
WSStopped | |
WSStopping | |
WSSuspended | |
WSTerminated | |
WSTerminating | |
WSUnhealthy | |
WSUpdating |
Instances
ComputeType
data ComputeType Source #
Information about the compute type.
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
- The compute type.
DefaultWorkspaceCreationProperties
data DefaultWorkspaceCreationProperties Source #
Information about defaults used to create a WorkSpace.
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
- The identifier of any security groups to apply to WorkSpaces when they are created.dwcpUserEnabledAsLocalAdministrator
- Indicates whether the WorkSpace user is an administrator on the WorkSpace.dwcpEnableWorkDocs
- Indicates whether the directory is enabled for Amazon WorkDocs.dwcpEnableInternetAccess
- The public IP address to attach to all WorkSpaces that are created or rebuilt.dwcpDefaultOu
- The organizational unit (OU) in the directory for the WorkSpace machine accounts.
dwcpCustomSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #
The identifier of any security groups to apply to WorkSpaces when they are created.
dwcpUserEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether the WorkSpace user is an administrator on the WorkSpace.
dwcpEnableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether the directory is enabled for Amazon WorkDocs.
dwcpEnableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
The public IP address to attach to all WorkSpaces that are created or rebuilt.
dwcpDefaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
FailedCreateWorkspaceRequest
data FailedCreateWorkspaceRequest Source #
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
- Information about the WorkSpace.fcwrErrorCode
- The error code.fcwrErrorMessage
- The textual error message.
fcwrWorkspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest) Source #
Information about the WorkSpace.
fcwrErrorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #
The error code.
fcwrErrorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #
The textual error message.
FailedWorkspaceChangeRequest
data FailedWorkspaceChangeRequest Source #
Information about a WorkSpace that could not be rebooted (RebootWorkspaces
), rebuilt (RebuildWorkspaces
), terminated (TerminateWorkspaces
), started (StartWorkspaces
), or stopped (StopWorkspaces
).
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
- The error code.fwcrWorkspaceId
- The identifier of the WorkSpace.fwcrErrorMessage
- The textual error message.
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.
IPRuleItem
data IPRuleItem Source #
Information about a rule for an IP access control group.
See: ipRuleItem
smart constructor.
Instances
ipRuleItem :: IPRuleItem Source #
Creates a value of IPRuleItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iriRuleDesc
- The description.iriIpRule
- The IP address range, in CIDR notation.
iriRuleDesc :: Lens' IPRuleItem (Maybe Text) Source #
The description.
ModificationState
data ModificationState Source #
Information about a WorkSpace modification.
See: modificationState
smart constructor.
Instances
modificationState :: ModificationState Source #
Creates a value of ModificationState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
msState
- The modification state.msResource
- The resource.
msState :: Lens' ModificationState (Maybe ModificationStateEnum) Source #
The modification state.
msResource :: Lens' ModificationState (Maybe ModificationResourceEnum) Source #
The resource.
RebootRequest
data RebootRequest Source #
Information used to reboot a WorkSpace.
See: rebootRequest
smart constructor.
Instances
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
- The ID of the WorkSpace.
rWorkspaceId :: Lens' RebootRequest Text Source #
The ID of the WorkSpace.
RebuildRequest
data RebuildRequest Source #
Information used to rebuild a WorkSpace.
See: rebuildRequest
smart constructor.
Instances
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
- The ID of the WorkSpace.
rrWorkspaceId :: Lens' RebuildRequest Text Source #
The ID of the WorkSpace.
RootStorage
data RootStorage Source #
Information about the root volume for a WorkSpace bundle.
See: rootStorage
smart constructor.
Instances
rootStorage :: RootStorage Source #
Creates a value of RootStorage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsCapacity
- The size of the root volume.
rsCapacity :: Lens' RootStorage (Maybe Text) Source #
The size of the root volume.
StartRequest
data StartRequest Source #
Information used to start a WorkSpace.
See: startRequest
smart constructor.
Instances
startRequest :: StartRequest Source #
Creates a value of StartRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sWorkspaceId
- The ID of the WorkSpace.
sWorkspaceId :: Lens' StartRequest (Maybe Text) Source #
The ID of the WorkSpace.
StopRequest
data StopRequest Source #
Information used to stop a WorkSpace.
See: stopRequest
smart constructor.
Instances
stopRequest :: StopRequest Source #
Creates a value of StopRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srWorkspaceId
- The ID of the WorkSpace.
srWorkspaceId :: Lens' StopRequest (Maybe Text) Source #
The ID of the WorkSpace.
Tag
Information about a tag.
See: tag
smart constructor.
Instances
Eq Tag Source # | |
Data Tag Source # | |
Defined in Network.AWS.WorkSpaces.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # dataTypeOf :: Tag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Tag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) # gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
Hashable Tag Source # | |
Defined in Network.AWS.WorkSpaces.Types.Product | |
ToJSON Tag Source # | |
Defined in Network.AWS.WorkSpaces.Types.Product | |
FromJSON Tag Source # | |
NFData Tag Source # | |
Defined in Network.AWS.WorkSpaces.Types.Product | |
type Rep Tag Source # | |
Defined in Network.AWS.WorkSpaces.Types.Product type Rep Tag = D1 (MetaData "Tag" "Network.AWS.WorkSpaces.Types.Product" "amazonka-workspaces-1.6.1-5Hv8h1qwyt66H9W1muWLiX" False) (C1 (MetaCons "Tag'" PrefixI True) (S1 (MetaSel (Just "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) |
TerminateRequest
data TerminateRequest Source #
Information used to terminate a WorkSpace.
See: terminateRequest
smart constructor.
Instances
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
- The ID of the WorkSpace.
trWorkspaceId :: Lens' TerminateRequest Text Source #
The ID of the WorkSpace.
UserStorage
data UserStorage Source #
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
- The size of the user storage.
usCapacity :: Lens' UserStorage (Maybe Text) Source #
The size of the user storage.
Workspace
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
- The identifier of the AWS Directory Service directory for the WorkSpace.wState
- The operational state of the WorkSpace.wIPAddress
- The IP address of the WorkSpace.wModificationStates
- The modification states of the WorkSpace.wUserName
- The user for the WorkSpace.wSubnetId
- The identifier of the subnet for the WorkSpace.wBundleId
- The identifier of the bundle used to create the WorkSpace.wWorkspaceProperties
- The properties of the WorkSpace.wRootVolumeEncryptionEnabled
- Indicates whether the data stored on the root volume is encrypted.wErrorCode
- If the WorkSpace could not be created, contains the error code.wVolumeEncryptionKey
- The KMS key used to encrypt data stored on your WorkSpace.wComputerName
- The name of the WorkSpace, as seen by the operating system.wWorkspaceId
- The identifier of the WorkSpace.wUserVolumeEncryptionEnabled
- Indicates whether the data stored on the user volume is encrypted.wErrorMessage
- If the WorkSpace could not be created, contains a textual error message that describes the failure.
wDirectoryId :: Lens' Workspace (Maybe Text) Source #
The identifier of the AWS Directory Service directory for the WorkSpace.
wModificationStates :: Lens' Workspace [ModificationState] Source #
The modification states of the WorkSpace.
wBundleId :: Lens' Workspace (Maybe Text) Source #
The identifier of the bundle used to create the WorkSpace.
wWorkspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties) Source #
The properties of the WorkSpace.
wRootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #
Indicates whether the data stored on the root volume is encrypted.
wErrorCode :: Lens' Workspace (Maybe Text) Source #
If the WorkSpace could not be created, 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 #
Indicates whether the data stored on the user volume is encrypted.
wErrorMessage :: Lens' Workspace (Maybe Text) Source #
If the WorkSpace could not be created, contains a textual error message that describes the failure.
WorkspaceBundle
data WorkspaceBundle Source #
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
- The bundle identifier.wbOwner
- The owner of the bundle. This is the account identifier of the owner, orAMAZON
if the bundle is provided by AWS.wbRootStorage
- The size of the root volume.wbName
- The name of the bundle.wbComputeType
- The compute type. For more information, see Amazon WorkSpaces Bundles .wbUserStorage
- The size of the user storage.wbDescription
- A description.
wbBundleId :: Lens' WorkspaceBundle (Maybe Text) Source #
The bundle identifier.
wbOwner :: Lens' WorkspaceBundle (Maybe Text) Source #
The owner of the bundle. This is the account identifier of the owner, or AMAZON
if the bundle is provided by AWS.
wbRootStorage :: Lens' WorkspaceBundle (Maybe RootStorage) Source #
The size of the root volume.
wbComputeType :: Lens' WorkspaceBundle (Maybe ComputeType) Source #
The compute type. For more information, see Amazon WorkSpaces Bundles .
wbUserStorage :: Lens' WorkspaceBundle (Maybe UserStorage) Source #
The size of the user storage.
wbDescription :: Lens' WorkspaceBundle (Maybe Text) Source #
A description.
WorkspaceConnectionStatus
data WorkspaceConnectionStatus Source #
Describes the connection status of a WorkSpace.
See: workspaceConnectionStatus
smart constructor.
Instances
workspaceConnectionStatus :: WorkspaceConnectionStatus Source #
Creates a value of WorkspaceConnectionStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wcsLastKnownUserConnectionTimestamp
- The timestamp of the last known user connection.wcsConnectionStateCheckTimestamp
- The timestamp of the connection state check.wcsWorkspaceId
- The ID of the WorkSpace.wcsConnectionState
- The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
wcsLastKnownUserConnectionTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #
The timestamp of the last known user connection.
wcsConnectionStateCheckTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #
The timestamp of the connection state check.
wcsWorkspaceId :: Lens' WorkspaceConnectionStatus (Maybe Text) Source #
The ID of the WorkSpace.
wcsConnectionState :: Lens' WorkspaceConnectionStatus (Maybe ConnectionState) Source #
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
WorkspaceDirectory
data WorkspaceDirectory Source #
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
- 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
- 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
- The directory identifier.wdState
- The state of the directory's registration with Amazon WorkSpaceswdCustomerUserName
- The user name for the service account.wdSubnetIds
- The identifiers of the subnets used with the directory.wdIpGroupIds
- The identifiers of the IP access control groups associated with the directory.wdAlias
- The directory alias.wdWorkspaceSecurityGroupId
- The identifier of the security group that is assigned to new WorkSpaces.wdDirectoryType
- The directory type.wdWorkspaceCreationProperties
- The default creation properties for all WorkSpaces in the directory.wdDNSIPAddresses
- The IP addresses of the DNS servers for the directory.wdDirectoryName
- The name of the directory.
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 #
The identifiers of the subnets used with the directory.
wdIpGroupIds :: Lens' WorkspaceDirectory [Text] Source #
The identifiers of the IP access control groups associated 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 #
The default creation properties for all WorkSpaces in the directory.
wdDNSIPAddresses :: Lens' WorkspaceDirectory [Text] Source #
The IP addresses of the DNS servers for the directory.
wdDirectoryName :: Lens' WorkspaceDirectory (Maybe Text) Source #
The name of the directory.
WorkspaceProperties
data WorkspaceProperties Source #
Information about a WorkSpace.
See: workspaceProperties
smart constructor.
Instances
workspaceProperties :: WorkspaceProperties Source #
Creates a value of WorkspaceProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wpComputeTypeName
- The compute type. For more information, see Amazon WorkSpaces Bundles .wpRunningMode
- The running mode. For more information, see Manage the WorkSpace Running Mode .wpRootVolumeSizeGib
- The size of the root volume.wpRunningModeAutoStopTimeoutInMinutes
- The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.wpUserVolumeSizeGib
- The size of the user storage.
wpComputeTypeName :: Lens' WorkspaceProperties (Maybe Compute) Source #
The compute type. For more information, see Amazon WorkSpaces Bundles .
wpRunningMode :: Lens' WorkspaceProperties (Maybe RunningMode) Source #
The running mode. For more information, see Manage the WorkSpace Running Mode .
wpRootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #
The size of the root volume.
wpRunningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int) Source #
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.
wpUserVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #
The size of the user storage.
WorkspaceRequest
data WorkspaceRequest Source #
Information used to create a WorkSpace.
See: workspaceRequest
smart constructor.
Instances
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:
wrWorkspaceProperties
- The WorkSpace properties.wrRootVolumeEncryptionEnabled
- Indicates whether the data stored on the root volume is encrypted.wrVolumeEncryptionKey
- The KMS key used to encrypt data stored on your WorkSpace.wrUserVolumeEncryptionEnabled
- Indicates whether the data stored on the user volume is encrypted.wrTags
- The tags for the WorkSpace.wrDirectoryId
- The identifier of the AWS Directory Service directory for the WorkSpace. You can useDescribeWorkspaceDirectories
to list the available directories.wrUserName
- The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.wrBundleId
- The identifier of the bundle for the WorkSpace. You can useDescribeWorkspaceBundles
to list the available bundles.
wrWorkspaceProperties :: Lens' WorkspaceRequest (Maybe WorkspaceProperties) Source #
The WorkSpace properties.
wrRootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source #
Indicates whether the data stored on the root volume 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 #
Indicates whether the data stored on the user volume is encrypted.
wrDirectoryId :: Lens' WorkspaceRequest Text Source #
The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories
to list the available directories.
wrUserName :: Lens' WorkspaceRequest Text Source #
The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.
wrBundleId :: Lens' WorkspaceRequest Text Source #
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles
to list the available bundles.
WorkspacesIPGroup
data WorkspacesIPGroup Source #
Information about an IP access control group.
See: workspacesIPGroup
smart constructor.
Instances
workspacesIPGroup :: WorkspacesIPGroup Source #
Creates a value of WorkspacesIPGroup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wigGroupDesc
- The description of the group.wigUserRules
- The rules.wigGroupId
- The ID of the group.wigGroupName
- The name of the group.
wigGroupDesc :: Lens' WorkspacesIPGroup (Maybe Text) Source #
The description of the group.
wigUserRules :: Lens' WorkspacesIPGroup [IPRuleItem] Source #
The rules.
wigGroupId :: Lens' WorkspacesIPGroup (Maybe Text) Source #
The ID of the group.
wigGroupName :: Lens' WorkspacesIPGroup (Maybe Text) Source #
The name of the group.