-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon WorkSpaces SDK.
--
-- Amazon WorkSpaces Service This is the Amazon WorkSpaces API
-- Reference. This guide provides detailed information about Amazon
-- WorkSpaces operations, data types, parameters, and errors.
--
-- The types from this library are intended to be used with
-- amazonka, which provides mechanisms for specifying AuthN/AuthZ
-- information and sending requests.
--
-- Use of lenses is required for constructing and manipulating types.
-- This is due to the amount of nesting of AWS types and transparency
-- regarding de/serialisation into more palatable Haskell values. The
-- provided lenses should be compatible with any of the major lens
-- libraries such as lens or lens-family-core.
--
-- See Network.AWS.WorkSpaces or the AWS Documentation to
-- get started.
@package amazonka-workspaces
@version 1.4.3
module Network.AWS.WorkSpaces.Types
-- | API version '2015-04-08' of the Amazon WorkSpaces SDK configuration.
workSpaces :: Service
-- | The specified resource is not available.
_ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
-- | One or more parameter values are not valid.
_InvalidParameterValuesException :: AsError a => Getting (First ServiceError) a ServiceError
-- | Your resource limits have been exceeded.
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
data Compute
Performance :: Compute
Standard :: Compute
Value :: Compute
data WorkspaceDirectoryState
Deregistered :: WorkspaceDirectoryState
Deregistering :: WorkspaceDirectoryState
Error' :: WorkspaceDirectoryState
Registered :: WorkspaceDirectoryState
Registering :: WorkspaceDirectoryState
data WorkspaceDirectoryType
AdConnector :: WorkspaceDirectoryType
SimpleAd :: WorkspaceDirectoryType
data WorkspaceState
WSAvailable :: WorkspaceState
WSError' :: WorkspaceState
WSImpaired :: WorkspaceState
WSPending :: WorkspaceState
WSRebooting :: WorkspaceState
WSRebuilding :: WorkspaceState
WSSuspended :: WorkspaceState
WSTerminated :: WorkspaceState
WSTerminating :: WorkspaceState
WSUnhealthy :: WorkspaceState
-- | Contains information about the compute type of a WorkSpace bundle.
--
-- See: computeType smart constructor.
data 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:
--
--
computeType :: ComputeType
-- | The name of the compute type for the bundle.
ctName :: Lens' ComputeType (Maybe Compute)
-- | Contains default WorkSpace creation information.
--
-- See: defaultWorkspaceCreationProperties smart
-- constructor.
data 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:
--
--
defaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties
-- | The identifier of any custom security groups that are applied to the
-- WorkSpaces when they are created.
dwcpCustomSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
-- | The WorkSpace user is an administrator on the WorkSpace.
dwcpUserEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
-- | Specifies if the directory is enabled for Amazon WorkDocs.
dwcpEnableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
-- | A public IP address will be attached to all WorkSpaces that are
-- created or rebuilt.
dwcpEnableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
-- | The organizational unit (OU) in the directory that the WorkSpace
-- machine accounts are placed in.
dwcpDefaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
-- | Contains information about a WorkSpace that could not be created.
--
-- See: failedCreateWorkspaceRequest smart constructor.
data 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:
--
--
failedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest
-- | A WorkspaceRequest object that contains the information about
-- the WorkSpace that could not be created.
fcwrWorkspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest)
-- | The error code.
fcwrErrorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
-- | The textual error message.
fcwrErrorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
-- | Contains information about a WorkSpace that could not be rebooted
-- (RebootWorkspaces), rebuilt (RebuildWorkspaces), or
-- terminated (TerminateWorkspaces).
--
-- See: failedWorkspaceChangeRequest smart constructor.
data 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:
--
--
failedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest
-- | The error code.
fwcrErrorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
-- | The identifier of the WorkSpace.
fwcrWorkspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
-- | The textual error message.
fwcrErrorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
-- | Contains information used with the RebootWorkspaces operation
-- to reboot a WorkSpace.
--
-- See: rebootRequest smart constructor.
data 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:
--
--
rebootRequest :: Text -> RebootRequest
-- | The identifier of the WorkSpace to reboot.
rWorkspaceId :: Lens' RebootRequest Text
-- | Contains information used with the RebuildWorkspaces operation
-- to rebuild a WorkSpace.
--
-- See: rebuildRequest smart constructor.
data 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:
--
--
rebuildRequest :: Text -> RebuildRequest
-- | The identifier of the WorkSpace to rebuild.
rrWorkspaceId :: Lens' RebuildRequest Text
-- | Contains information used with the TerminateWorkspaces
-- operation to terminate a WorkSpace.
--
-- See: terminateRequest smart constructor.
data 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:
--
--
terminateRequest :: Text -> TerminateRequest
-- | The identifier of the WorkSpace to terminate.
trWorkspaceId :: Lens' TerminateRequest Text
-- | Contains information about the user storage for a WorkSpace bundle.
--
-- See: userStorage smart constructor.
data 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:
--
--
userStorage :: UserStorage
-- | The amount of user storage for the bundle.
usCapacity :: Lens' UserStorage (Maybe Text)
-- | Contains information about a WorkSpace.
--
-- See: workspace smart constructor.
data 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:
--
--
workspace :: Workspace
-- | The identifier of the AWS Directory Service directory that the
-- WorkSpace belongs to.
wDirectoryId :: Lens' Workspace (Maybe Text)
-- | The operational state of the WorkSpace.
wState :: Lens' Workspace (Maybe WorkspaceState)
-- | The IP address of the WorkSpace.
wIPAddress :: Lens' Workspace (Maybe Text)
-- | The user that the WorkSpace is assigned to.
wUserName :: Lens' Workspace (Maybe Text)
-- | The identifier of the subnet that the WorkSpace is in.
wSubnetId :: Lens' Workspace (Maybe Text)
-- | The identifier of the bundle that the WorkSpace was created from.
wBundleId :: Lens' Workspace (Maybe Text)
-- | Specifies whether the data stored on the root volume, or C: drive, is
-- encrypted.
wRootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
-- | If the WorkSpace could not be created, this contains the error code.
wErrorCode :: Lens' Workspace (Maybe Text)
-- | The KMS key used to encrypt data stored on your WorkSpace.
wVolumeEncryptionKey :: Lens' Workspace (Maybe Text)
-- | The name of the WorkSpace as seen by the operating system.
wComputerName :: Lens' Workspace (Maybe Text)
-- | The identifier of the WorkSpace.
wWorkspaceId :: Lens' Workspace (Maybe Text)
-- | Specifies whether the data stored on the user volume, or D: drive, is
-- encrypted.
wUserVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
-- | If the WorkSpace could not be created, this contains a textual error
-- message that describes the failure.
wErrorMessage :: Lens' Workspace (Maybe Text)
-- | Contains information about a WorkSpace bundle.
--
-- See: workspaceBundle smart constructor.
data 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:
--
--
workspaceBundle :: WorkspaceBundle
-- | The bundle identifier.
wbBundleId :: 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.
wbOwner :: Lens' WorkspaceBundle (Maybe Text)
-- | The name of the bundle.
wbName :: Lens' WorkspaceBundle (Maybe Text)
-- | A ComputeType object that specifies the compute type for the
-- bundle.
wbComputeType :: Lens' WorkspaceBundle (Maybe ComputeType)
-- | A UserStorage object that specifies the amount of user storage
-- that the bundle contains.
wbUserStorage :: Lens' WorkspaceBundle (Maybe UserStorage)
-- | The bundle description.
wbDescription :: Lens' WorkspaceBundle (Maybe Text)
-- | Contains information about an AWS Directory Service directory for use
-- with Amazon WorkSpaces.
--
-- See: workspaceDirectory smart constructor.
data 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:
--
--
workspaceDirectory :: WorkspaceDirectory
-- | The registration code for the directory. This is the code that users
-- enter in their Amazon WorkSpaces client application to connect to the
-- directory.
wdRegistrationCode :: 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.
wdIAMRoleId :: Lens' WorkspaceDirectory (Maybe Text)
-- | The directory identifier.
wdDirectoryId :: Lens' WorkspaceDirectory (Maybe Text)
-- | The state of the directory's registration with Amazon WorkSpaces
wdState :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState)
-- | The user name for the service account.
wdCustomerUserName :: Lens' WorkspaceDirectory (Maybe Text)
-- | An array of strings that contains the identifiers of the subnets used
-- with the directory.
wdSubnetIds :: Lens' WorkspaceDirectory [Text]
-- | The directory alias.
wdAlias :: Lens' WorkspaceDirectory (Maybe Text)
-- | The identifier of the security group that is assigned to new
-- WorkSpaces.
wdWorkspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text)
-- | The directory type.
wdDirectoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType)
-- | A structure that specifies the default creation properties for all
-- WorkSpaces in the directory.
wdWorkspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties)
-- | An array of strings that contains the IP addresses of the DNS servers
-- for the directory.
wdDNSIPAddresses :: Lens' WorkspaceDirectory [Text]
-- | The name of the directory.
wdDirectoryName :: Lens' WorkspaceDirectory (Maybe Text)
-- | Contains information about a WorkSpace creation request.
--
-- See: workspaceRequest smart constructor.
data 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:
--
--
workspaceRequest :: Text -> Text -> Text -> WorkspaceRequest
-- | Specifies whether the data stored on the root volume, or C: drive, is
-- encrypted.
wrRootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
-- | The KMS key used to encrypt data stored on your WorkSpace.
wrVolumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text)
-- | Specifies whether the data stored on the user volume, or D: drive, is
-- encrypted.
wrUserVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
-- | 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.
wrDirectoryId :: 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.
wrUserName :: 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.
wrBundleId :: Lens' WorkspaceRequest Text
module Network.AWS.WorkSpaces.Waiters
-- | Terminates the specified WorkSpaces.
--
-- Terminating a WorkSpace is a permanent action and cannot be undone.
-- The user's data is not maintained and will be destroyed. If you need
-- to archive any user data, contact Amazon Web Services before
-- terminating the WorkSpace.
--
-- You can terminate a WorkSpace that is in any state except
-- SUSPENDED.
--
-- This operation is asynchronous and will return before the WorkSpaces
-- have been completely terminated.
module Network.AWS.WorkSpaces.TerminateWorkspaces
-- | Creates a value of TerminateWorkspaces with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
terminateWorkspaces :: NonEmpty TerminateRequest -> TerminateWorkspaces
-- | Contains the inputs for the TerminateWorkspaces operation.
--
-- See: terminateWorkspaces smart constructor.
data TerminateWorkspaces
-- | An array of structures that specify the WorkSpaces to terminate.
twTerminateWorkspaceRequests :: Lens' TerminateWorkspaces (NonEmpty TerminateRequest)
-- | Creates a value of TerminateWorkspacesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
terminateWorkspacesResponse :: Int -> TerminateWorkspacesResponse
-- | Contains the results of the TerminateWorkspaces operation.
--
-- See: terminateWorkspacesResponse smart constructor.
data TerminateWorkspacesResponse
-- | An array of structures that represent any WorkSpaces that could not be
-- terminated.
twrsFailedRequests :: Lens' TerminateWorkspacesResponse [FailedWorkspaceChangeRequest]
-- | The response status code.
twrsResponseStatus :: Lens' TerminateWorkspacesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspacesResponse
instance Data.Data.Data Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspacesResponse
instance GHC.Show.Show Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspacesResponse
instance GHC.Read.Read Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspacesResponse
instance GHC.Classes.Eq Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspacesResponse
instance GHC.Generics.Generic Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Data.Data.Data Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance GHC.Show.Show Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance GHC.Read.Read Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance GHC.Classes.Eq Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Network.AWS.Types.AWSRequest Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Data.Hashable.Class.Hashable Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.TerminateWorkspaces.TerminateWorkspacesResponse
-- | Rebuilds the specified WorkSpaces.
--
-- Rebuilding a WorkSpace is a potentially destructive action that can
-- result in the loss of data. Rebuilding a WorkSpace causes the
-- following to occur:
--
--
-- - The system is restored to the image of the bundle that the
-- WorkSpace is created from. Any applications that have been installed,
-- or system settings that have been made since the WorkSpace was created
-- will be lost.
-- - The data drive (D drive) is re-created from the last automatic
-- snapshot taken of the data drive. The current contents of the data
-- drive are overwritten. Automatic snapshots of the data drive are taken
-- every 12 hours, so the snapshot can be as much as 12 hours old.
--
--
-- To be able to rebuild a WorkSpace, the WorkSpace must have a
-- State of AVAILABLE or ERROR.
--
-- This operation is asynchronous and will return before the WorkSpaces
-- have been completely rebuilt.
module Network.AWS.WorkSpaces.RebuildWorkspaces
-- | Creates a value of RebuildWorkspaces with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
rebuildWorkspaces :: NonEmpty RebuildRequest -> RebuildWorkspaces
-- | Contains the inputs for the RebuildWorkspaces operation.
--
-- See: rebuildWorkspaces smart constructor.
data RebuildWorkspaces
-- | An array of structures that specify the WorkSpaces to rebuild.
rwRebuildWorkspaceRequests :: Lens' RebuildWorkspaces (NonEmpty RebuildRequest)
-- | Creates a value of RebuildWorkspacesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
rebuildWorkspacesResponse :: Int -> RebuildWorkspacesResponse
-- | Contains the results of the RebuildWorkspaces operation.
--
-- See: rebuildWorkspacesResponse smart constructor.
data RebuildWorkspacesResponse
-- | An array of structures that represent any WorkSpaces that could not be
-- rebuilt.
rwrsFailedRequests :: Lens' RebuildWorkspacesResponse [FailedWorkspaceChangeRequest]
-- | The response status code.
rwrsResponseStatus :: Lens' RebuildWorkspacesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspacesResponse
instance Data.Data.Data Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspacesResponse
instance GHC.Show.Show Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspacesResponse
instance GHC.Read.Read Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspacesResponse
instance GHC.Classes.Eq Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspacesResponse
instance GHC.Generics.Generic Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Data.Data.Data Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance GHC.Show.Show Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance GHC.Read.Read Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance GHC.Classes.Eq Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Network.AWS.Types.AWSRequest Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Data.Hashable.Class.Hashable Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.RebuildWorkspaces.RebuildWorkspacesResponse
-- | Reboots the specified WorkSpaces.
--
-- To be able to reboot a WorkSpace, the WorkSpace must have a
-- State of AVAILABLE, IMPAIRED, or
-- INOPERABLE.
--
-- This operation is asynchronous and will return before the WorkSpaces
-- have rebooted.
module Network.AWS.WorkSpaces.RebootWorkspaces
-- | Creates a value of RebootWorkspaces with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
rebootWorkspaces :: NonEmpty RebootRequest -> RebootWorkspaces
-- | Contains the inputs for the RebootWorkspaces operation.
--
-- See: rebootWorkspaces smart constructor.
data RebootWorkspaces
-- | An array of structures that specify the WorkSpaces to reboot.
rwRebootWorkspaceRequests :: Lens' RebootWorkspaces (NonEmpty RebootRequest)
-- | Creates a value of RebootWorkspacesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
rebootWorkspacesResponse :: Int -> RebootWorkspacesResponse
-- | Contains the results of the RebootWorkspaces operation.
--
-- See: rebootWorkspacesResponse smart constructor.
data RebootWorkspacesResponse
-- | An array of structures that represent any WorkSpaces that could not be
-- rebooted.
rrsFailedRequests :: Lens' RebootWorkspacesResponse [FailedWorkspaceChangeRequest]
-- | The response status code.
rrsResponseStatus :: Lens' RebootWorkspacesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspacesResponse
instance Data.Data.Data Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspacesResponse
instance GHC.Show.Show Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspacesResponse
instance GHC.Read.Read Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspacesResponse
instance GHC.Classes.Eq Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspacesResponse
instance GHC.Generics.Generic Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Data.Data.Data Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance GHC.Show.Show Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance GHC.Read.Read Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance GHC.Classes.Eq Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Network.AWS.Types.AWSRequest Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Data.Hashable.Class.Hashable Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.RebootWorkspaces.RebootWorkspacesResponse
-- | Obtains information about the specified WorkSpaces.
--
-- Only one of the filter parameters, such as BundleId,
-- DirectoryId, or WorkspaceIds, can be specified at a
-- time.
--
-- This operation supports pagination with the use of the
-- NextToken request and response parameters. If more results
-- are available, the NextToken response member contains a token
-- that you pass in the next call to this operation to retrieve the next
-- set of items.
module Network.AWS.WorkSpaces.DescribeWorkspaces
-- | Creates a value of DescribeWorkspaces with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeWorkspaces :: DescribeWorkspaces
-- | Contains the inputs for the DescribeWorkspaces operation.
--
-- See: describeWorkspaces smart constructor.
data DescribeWorkspaces
-- | Specifies the directory identifier to which to limit the WorkSpaces.
-- Optionally, you can specify a specific directory user with the
-- UserName parameter. This parameter cannot be combined with
-- any other filter parameter.
dwDirectoryId :: Lens' DescribeWorkspaces (Maybe Text)
-- | An array of strings that contain the identifiers of the WorkSpaces for
-- which to retrieve information. This parameter cannot be combined with
-- any other filter parameter.
--
-- Because the CreateWorkspaces operation is asynchronous, the
-- identifier returned by CreateWorkspaces is not immediately
-- available. If you immediately call DescribeWorkspaces with this
-- identifier, no information will be returned.
dwWorkspaceIds :: Lens' DescribeWorkspaces (Maybe (NonEmpty Text))
-- | Used with the DirectoryId parameter to specify the directory
-- user for which to obtain the WorkSpace.
dwUserName :: Lens' DescribeWorkspaces (Maybe Text)
-- | The identifier of a bundle to obtain the WorkSpaces for. All
-- WorkSpaces that are created from this bundle will be retrieved. This
-- parameter cannot be combined with any other filter parameter.
dwBundleId :: Lens' DescribeWorkspaces (Maybe Text)
-- | The NextToken value from a previous call to this operation.
-- Pass null if this is the first call.
dwNextToken :: Lens' DescribeWorkspaces (Maybe Text)
-- | The maximum number of items to return.
dwLimit :: Lens' DescribeWorkspaces (Maybe Natural)
-- | Creates a value of DescribeWorkspacesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeWorkspacesResponse :: Int -> DescribeWorkspacesResponse
-- | Contains the results for the DescribeWorkspaces operation.
--
-- See: describeWorkspacesResponse smart constructor.
data DescribeWorkspacesResponse
-- | If not null, more results are available. Pass this value for the
-- NextToken parameter in a subsequent call to this operation to
-- retrieve the next set of items. This token is valid for one day and
-- must be used within that timeframe.
dwrsNextToken :: Lens' DescribeWorkspacesResponse (Maybe Text)
-- | An array of structures that contain the information about the
-- WorkSpaces.
--
-- Because the CreateWorkspaces operation is asynchronous, some of
-- this information may be incomplete for a newly-created WorkSpace.
dwrsWorkspaces :: Lens' DescribeWorkspacesResponse [Workspace]
-- | The response status code.
dwrsResponseStatus :: Lens' DescribeWorkspacesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspacesResponse
instance Data.Data.Data Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspacesResponse
instance GHC.Show.Show Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspacesResponse
instance GHC.Read.Read Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspacesResponse
instance GHC.Classes.Eq Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspacesResponse
instance GHC.Generics.Generic Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Data.Data.Data Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance GHC.Show.Show Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance GHC.Read.Read Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance GHC.Classes.Eq Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Network.AWS.Types.AWSRequest Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Data.Hashable.Class.Hashable Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.DescribeWorkspaces.DescribeWorkspacesResponse
-- | Retrieves information about the AWS Directory Service directories in
-- the region that are registered with Amazon WorkSpaces and are
-- available to your account.
--
-- This operation supports pagination with the use of the
-- NextToken request and response parameters. If more results
-- are available, the NextToken response member contains a token
-- that you pass in the next call to this operation to retrieve the next
-- set of items.
module Network.AWS.WorkSpaces.DescribeWorkspaceDirectories
-- | Creates a value of DescribeWorkspaceDirectories with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeWorkspaceDirectories :: DescribeWorkspaceDirectories
-- | Contains the inputs for the DescribeWorkspaceDirectories
-- operation.
--
-- See: describeWorkspaceDirectories smart constructor.
data DescribeWorkspaceDirectories
-- | The NextToken value from a previous call to this operation.
-- Pass null if this is the first call.
dwdNextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text)
-- | An array of strings that contains the directory identifiers to
-- retrieve information for. If this member is null, all directories are
-- retrieved.
dwdDirectoryIds :: Lens' DescribeWorkspaceDirectories (Maybe (NonEmpty Text))
-- | Creates a value of DescribeWorkspaceDirectoriesResponse with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeWorkspaceDirectoriesResponse :: Int -> DescribeWorkspaceDirectoriesResponse
-- | Contains the results of the DescribeWorkspaceDirectories
-- operation.
--
-- See: describeWorkspaceDirectoriesResponse smart
-- constructor.
data DescribeWorkspaceDirectoriesResponse
-- | An array of structures that contain information about the directories.
dwdrsDirectories :: Lens' DescribeWorkspaceDirectoriesResponse [WorkspaceDirectory]
-- | If not null, more results are available. Pass this value for the
-- NextToken parameter in a subsequent call to this operation to
-- retrieve the next set of items. This token is valid for one day and
-- must be used within that timeframe.
dwdrsNextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text)
-- | The response status code.
dwdrsResponseStatus :: Lens' DescribeWorkspaceDirectoriesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectoriesResponse
instance Data.Data.Data Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectoriesResponse
instance GHC.Show.Show Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectoriesResponse
instance GHC.Read.Read Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectoriesResponse
instance GHC.Classes.Eq Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectoriesResponse
instance GHC.Generics.Generic Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Data.Data.Data Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance GHC.Show.Show Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance GHC.Read.Read Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance GHC.Classes.Eq Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Network.AWS.Types.AWSRequest Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Data.Hashable.Class.Hashable Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectories
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.DescribeWorkspaceDirectories.DescribeWorkspaceDirectoriesResponse
-- | Obtains information about the WorkSpace bundles that are available to
-- your account in the specified region.
--
-- You can filter the results with either the BundleIds
-- parameter, or the Owner parameter, but not both.
--
-- This operation supports pagination with the use of the
-- NextToken request and response parameters. If more results
-- are available, the NextToken response member contains a token
-- that you pass in the next call to this operation to retrieve the next
-- set of items.
module Network.AWS.WorkSpaces.DescribeWorkspaceBundles
-- | Creates a value of DescribeWorkspaceBundles with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeWorkspaceBundles :: DescribeWorkspaceBundles
-- | Contains the inputs for the DescribeWorkspaceBundles operation.
--
-- See: describeWorkspaceBundles smart constructor.
data DescribeWorkspaceBundles
-- | An array of strings that contains the identifiers of the bundles to
-- retrieve. This parameter cannot be combined with any other filter
-- parameter.
dwbBundleIds :: Lens' DescribeWorkspaceBundles (Maybe (NonEmpty Text))
-- | The owner of the bundles to retrieve. This parameter cannot be
-- combined with any other filter parameter.
--
-- This contains one of the following values:
--
--
-- - null - Retrieves the bundles that belong to the account making the
-- call.
-- - AMAZON - Retrieves the bundles that are provided by
-- AWS.
--
dwbOwner :: Lens' DescribeWorkspaceBundles (Maybe Text)
-- | The NextToken value from a previous call to this operation.
-- Pass null if this is the first call.
dwbNextToken :: Lens' DescribeWorkspaceBundles (Maybe Text)
-- | Creates a value of DescribeWorkspaceBundlesResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeWorkspaceBundlesResponse :: Int -> DescribeWorkspaceBundlesResponse
-- | Contains the results of the DescribeWorkspaceBundles operation.
--
-- See: describeWorkspaceBundlesResponse smart constructor.
data DescribeWorkspaceBundlesResponse
-- | An array of structures that contain information about the bundles.
dwbrsBundles :: Lens' DescribeWorkspaceBundlesResponse [WorkspaceBundle]
-- | If not null, more results are available. Pass this value for the
-- NextToken parameter in a subsequent call to this operation to
-- retrieve the next set of items. This token is valid for one day and
-- must be used within that timeframe.
dwbrsNextToken :: Lens' DescribeWorkspaceBundlesResponse (Maybe Text)
-- | The response status code.
dwbrsResponseStatus :: Lens' DescribeWorkspaceBundlesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundlesResponse
instance Data.Data.Data Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundlesResponse
instance GHC.Show.Show Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundlesResponse
instance GHC.Read.Read Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundlesResponse
instance GHC.Classes.Eq Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundlesResponse
instance GHC.Generics.Generic Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Data.Data.Data Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance GHC.Show.Show Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance GHC.Read.Read Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance GHC.Classes.Eq Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Network.AWS.Types.AWSRequest Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Data.Hashable.Class.Hashable Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundles
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.DescribeWorkspaceBundles.DescribeWorkspaceBundlesResponse
-- | Creates one or more WorkSpaces.
--
-- This operation is asynchronous and returns before the WorkSpaces are
-- created.
module Network.AWS.WorkSpaces.CreateWorkspaces
-- | Creates a value of CreateWorkspaces with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createWorkspaces :: NonEmpty WorkspaceRequest -> CreateWorkspaces
-- | Contains the inputs for the CreateWorkspaces operation.
--
-- See: createWorkspaces smart constructor.
data CreateWorkspaces
-- | An array of structures that specify the WorkSpaces to create.
cwWorkspaces :: Lens' CreateWorkspaces (NonEmpty WorkspaceRequest)
-- | Creates a value of CreateWorkspacesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createWorkspacesResponse :: Int -> CreateWorkspacesResponse
-- | Contains the result of the CreateWorkspaces operation.
--
-- See: createWorkspacesResponse smart constructor.
data CreateWorkspacesResponse
-- | An array of structures that represent the WorkSpaces that could not be
-- created.
cwrsFailedRequests :: Lens' CreateWorkspacesResponse [FailedCreateWorkspaceRequest]
-- | An array of structures that represent the WorkSpaces that were
-- created.
--
-- Because this operation is asynchronous, the identifier in
-- WorkspaceId is not immediately available. If you immediately
-- call DescribeWorkspaces with this identifier, no information
-- will be returned.
cwrsPendingRequests :: Lens' CreateWorkspacesResponse [Workspace]
-- | The response status code.
cwrsResponseStatus :: Lens' CreateWorkspacesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspacesResponse
instance Data.Data.Data Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspacesResponse
instance GHC.Show.Show Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspacesResponse
instance GHC.Read.Read Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspacesResponse
instance GHC.Classes.Eq Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspacesResponse
instance GHC.Generics.Generic Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Data.Data.Data Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance GHC.Show.Show Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance GHC.Read.Read Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance GHC.Classes.Eq Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Network.AWS.Types.AWSRequest Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Data.Hashable.Class.Hashable Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspaces
instance Control.DeepSeq.NFData Network.AWS.WorkSpaces.CreateWorkspaces.CreateWorkspacesResponse
-- | Amazon WorkSpaces Service
--
-- This is the Amazon WorkSpaces API Reference. This guide
-- provides detailed information about Amazon WorkSpaces operations, data
-- types, parameters, and errors.
module Network.AWS.WorkSpaces
-- | API version '2015-04-08' of the Amazon WorkSpaces SDK configuration.
workSpaces :: Service
-- | The specified resource is not available.
_ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
-- | One or more parameter values are not valid.
_InvalidParameterValuesException :: AsError a => Getting (First ServiceError) a ServiceError
-- | Your resource limits have been exceeded.
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
data Compute
Performance :: Compute
Standard :: Compute
Value :: Compute
data WorkspaceDirectoryState
Deregistered :: WorkspaceDirectoryState
Deregistering :: WorkspaceDirectoryState
Error' :: WorkspaceDirectoryState
Registered :: WorkspaceDirectoryState
Registering :: WorkspaceDirectoryState
data WorkspaceDirectoryType
AdConnector :: WorkspaceDirectoryType
SimpleAd :: WorkspaceDirectoryType
data WorkspaceState
WSAvailable :: WorkspaceState
WSError' :: WorkspaceState
WSImpaired :: WorkspaceState
WSPending :: WorkspaceState
WSRebooting :: WorkspaceState
WSRebuilding :: WorkspaceState
WSSuspended :: WorkspaceState
WSTerminated :: WorkspaceState
WSTerminating :: WorkspaceState
WSUnhealthy :: WorkspaceState
-- | Contains information about the compute type of a WorkSpace bundle.
--
-- See: computeType smart constructor.
data 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:
--
--
computeType :: ComputeType
-- | The name of the compute type for the bundle.
ctName :: Lens' ComputeType (Maybe Compute)
-- | Contains default WorkSpace creation information.
--
-- See: defaultWorkspaceCreationProperties smart
-- constructor.
data 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:
--
--
defaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties
-- | The identifier of any custom security groups that are applied to the
-- WorkSpaces when they are created.
dwcpCustomSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
-- | The WorkSpace user is an administrator on the WorkSpace.
dwcpUserEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
-- | Specifies if the directory is enabled for Amazon WorkDocs.
dwcpEnableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
-- | A public IP address will be attached to all WorkSpaces that are
-- created or rebuilt.
dwcpEnableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
-- | The organizational unit (OU) in the directory that the WorkSpace
-- machine accounts are placed in.
dwcpDefaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
-- | Contains information about a WorkSpace that could not be created.
--
-- See: failedCreateWorkspaceRequest smart constructor.
data 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:
--
--
failedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest
-- | A WorkspaceRequest object that contains the information about
-- the WorkSpace that could not be created.
fcwrWorkspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest)
-- | The error code.
fcwrErrorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
-- | The textual error message.
fcwrErrorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
-- | Contains information about a WorkSpace that could not be rebooted
-- (RebootWorkspaces), rebuilt (RebuildWorkspaces), or
-- terminated (TerminateWorkspaces).
--
-- See: failedWorkspaceChangeRequest smart constructor.
data 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:
--
--
failedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest
-- | The error code.
fwcrErrorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
-- | The identifier of the WorkSpace.
fwcrWorkspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
-- | The textual error message.
fwcrErrorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
-- | Contains information used with the RebootWorkspaces operation
-- to reboot a WorkSpace.
--
-- See: rebootRequest smart constructor.
data 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:
--
--
rebootRequest :: Text -> RebootRequest
-- | The identifier of the WorkSpace to reboot.
rWorkspaceId :: Lens' RebootRequest Text
-- | Contains information used with the RebuildWorkspaces operation
-- to rebuild a WorkSpace.
--
-- See: rebuildRequest smart constructor.
data 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:
--
--
rebuildRequest :: Text -> RebuildRequest
-- | The identifier of the WorkSpace to rebuild.
rrWorkspaceId :: Lens' RebuildRequest Text
-- | Contains information used with the TerminateWorkspaces
-- operation to terminate a WorkSpace.
--
-- See: terminateRequest smart constructor.
data 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:
--
--
terminateRequest :: Text -> TerminateRequest
-- | The identifier of the WorkSpace to terminate.
trWorkspaceId :: Lens' TerminateRequest Text
-- | Contains information about the user storage for a WorkSpace bundle.
--
-- See: userStorage smart constructor.
data 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:
--
--
userStorage :: UserStorage
-- | The amount of user storage for the bundle.
usCapacity :: Lens' UserStorage (Maybe Text)
-- | Contains information about a WorkSpace.
--
-- See: workspace smart constructor.
data 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:
--
--
workspace :: Workspace
-- | The identifier of the AWS Directory Service directory that the
-- WorkSpace belongs to.
wDirectoryId :: Lens' Workspace (Maybe Text)
-- | The operational state of the WorkSpace.
wState :: Lens' Workspace (Maybe WorkspaceState)
-- | The IP address of the WorkSpace.
wIPAddress :: Lens' Workspace (Maybe Text)
-- | The user that the WorkSpace is assigned to.
wUserName :: Lens' Workspace (Maybe Text)
-- | The identifier of the subnet that the WorkSpace is in.
wSubnetId :: Lens' Workspace (Maybe Text)
-- | The identifier of the bundle that the WorkSpace was created from.
wBundleId :: Lens' Workspace (Maybe Text)
-- | Specifies whether the data stored on the root volume, or C: drive, is
-- encrypted.
wRootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
-- | If the WorkSpace could not be created, this contains the error code.
wErrorCode :: Lens' Workspace (Maybe Text)
-- | The KMS key used to encrypt data stored on your WorkSpace.
wVolumeEncryptionKey :: Lens' Workspace (Maybe Text)
-- | The name of the WorkSpace as seen by the operating system.
wComputerName :: Lens' Workspace (Maybe Text)
-- | The identifier of the WorkSpace.
wWorkspaceId :: Lens' Workspace (Maybe Text)
-- | Specifies whether the data stored on the user volume, or D: drive, is
-- encrypted.
wUserVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
-- | If the WorkSpace could not be created, this contains a textual error
-- message that describes the failure.
wErrorMessage :: Lens' Workspace (Maybe Text)
-- | Contains information about a WorkSpace bundle.
--
-- See: workspaceBundle smart constructor.
data 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:
--
--
workspaceBundle :: WorkspaceBundle
-- | The bundle identifier.
wbBundleId :: 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.
wbOwner :: Lens' WorkspaceBundle (Maybe Text)
-- | The name of the bundle.
wbName :: Lens' WorkspaceBundle (Maybe Text)
-- | A ComputeType object that specifies the compute type for the
-- bundle.
wbComputeType :: Lens' WorkspaceBundle (Maybe ComputeType)
-- | A UserStorage object that specifies the amount of user storage
-- that the bundle contains.
wbUserStorage :: Lens' WorkspaceBundle (Maybe UserStorage)
-- | The bundle description.
wbDescription :: Lens' WorkspaceBundle (Maybe Text)
-- | Contains information about an AWS Directory Service directory for use
-- with Amazon WorkSpaces.
--
-- See: workspaceDirectory smart constructor.
data 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:
--
--
workspaceDirectory :: WorkspaceDirectory
-- | The registration code for the directory. This is the code that users
-- enter in their Amazon WorkSpaces client application to connect to the
-- directory.
wdRegistrationCode :: 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.
wdIAMRoleId :: Lens' WorkspaceDirectory (Maybe Text)
-- | The directory identifier.
wdDirectoryId :: Lens' WorkspaceDirectory (Maybe Text)
-- | The state of the directory's registration with Amazon WorkSpaces
wdState :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState)
-- | The user name for the service account.
wdCustomerUserName :: Lens' WorkspaceDirectory (Maybe Text)
-- | An array of strings that contains the identifiers of the subnets used
-- with the directory.
wdSubnetIds :: Lens' WorkspaceDirectory [Text]
-- | The directory alias.
wdAlias :: Lens' WorkspaceDirectory (Maybe Text)
-- | The identifier of the security group that is assigned to new
-- WorkSpaces.
wdWorkspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text)
-- | The directory type.
wdDirectoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType)
-- | A structure that specifies the default creation properties for all
-- WorkSpaces in the directory.
wdWorkspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties)
-- | An array of strings that contains the IP addresses of the DNS servers
-- for the directory.
wdDNSIPAddresses :: Lens' WorkspaceDirectory [Text]
-- | The name of the directory.
wdDirectoryName :: Lens' WorkspaceDirectory (Maybe Text)
-- | Contains information about a WorkSpace creation request.
--
-- See: workspaceRequest smart constructor.
data 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:
--
--
workspaceRequest :: Text -> Text -> Text -> WorkspaceRequest
-- | Specifies whether the data stored on the root volume, or C: drive, is
-- encrypted.
wrRootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
-- | The KMS key used to encrypt data stored on your WorkSpace.
wrVolumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text)
-- | Specifies whether the data stored on the user volume, or D: drive, is
-- encrypted.
wrUserVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
-- | 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.
wrDirectoryId :: 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.
wrUserName :: 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.
wrBundleId :: Lens' WorkspaceRequest Text