| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.WorkSpaces.Types
Contents
- Service Configuration
- Errors
- AccessPropertyValue
- Application
- AssociationStatus
- BundleType
- CertificateBasedAuthStatusEnum
- ClientDeviceType
- Compute
- ConnectionAliasState
- ConnectionState
- DedicatedTenancyModificationStateEnum
- DedicatedTenancySupportEnum
- DedicatedTenancySupportResultEnum
- DeletableCertificateBasedAuthProperty
- DeletableSamlProperty
- ImageType
- LogUploadEnum
- ModificationResourceEnum
- ModificationStateEnum
- OperatingSystemType
- Protocol
- ReconnectEnum
- RunningMode
- SamlStatusEnum
- StandbyWorkspaceRelationshipType
- TargetWorkspaceState
- Tenancy
- WorkspaceBundleState
- WorkspaceDirectoryState
- WorkspaceDirectoryType
- WorkspaceImageIngestionProcess
- WorkspaceImageRequiredTenancy
- WorkspaceImageState
- WorkspaceState
- AccountModification
- CertificateBasedAuthProperties
- ClientProperties
- ClientPropertiesResult
- ComputeType
- ConnectClientAddIn
- ConnectionAlias
- ConnectionAliasAssociation
- ConnectionAliasPermission
- DefaultClientBrandingAttributes
- DefaultImportClientBrandingAttributes
- DefaultWorkspaceCreationProperties
- FailedCreateStandbyWorkspacesRequest
- FailedCreateWorkspaceRequest
- FailedWorkspaceChangeRequest
- ImagePermission
- IosClientBrandingAttributes
- IosImportClientBrandingAttributes
- IpRuleItem
- ModificationState
- OperatingSystem
- PendingCreateStandbyWorkspacesRequest
- RebootRequest
- RebuildRequest
- RelatedWorkspaceProperties
- RootStorage
- SamlProperties
- SelfservicePermissions
- Snapshot
- StandbyWorkspace
- StartRequest
- StopRequest
- Tag
- TerminateRequest
- UpdateResult
- UserStorage
- Workspace
- WorkspaceAccessProperties
- WorkspaceBundle
- WorkspaceConnectionStatus
- WorkspaceCreationProperties
- WorkspaceDirectory
- WorkspaceImage
- WorkspaceProperties
- WorkspaceRequest
- WorkspacesIpGroup
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _InvalidParameterValuesException :: AsError a => Fold a ServiceError
- _InvalidResourceStateException :: AsError a => Fold a ServiceError
- _OperationInProgressException :: AsError a => Fold a ServiceError
- _OperationNotSupportedException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceAssociatedException :: AsError a => Fold a ServiceError
- _ResourceCreationFailedException :: AsError a => Fold a ServiceError
- _ResourceLimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ResourceUnavailableException :: AsError a => Fold a ServiceError
- _UnsupportedNetworkConfigurationException :: AsError a => Fold a ServiceError
- _UnsupportedWorkspaceConfigurationException :: AsError a => Fold a ServiceError
- _WorkspacesDefaultRoleNotFoundException :: AsError a => Fold a ServiceError
- newtype AccessPropertyValue where
- newtype Application where
- Application' { }
- pattern Application_Microsoft_Office_2016 :: Application
- pattern Application_Microsoft_Office_2019 :: Application
- newtype AssociationStatus where
- AssociationStatus' { }
- pattern AssociationStatus_ASSOCIATED_WITH_OWNER_ACCOUNT :: AssociationStatus
- pattern AssociationStatus_ASSOCIATED_WITH_SHARED_ACCOUNT :: AssociationStatus
- pattern AssociationStatus_NOT_ASSOCIATED :: AssociationStatus
- pattern AssociationStatus_PENDING_ASSOCIATION :: AssociationStatus
- pattern AssociationStatus_PENDING_DISASSOCIATION :: AssociationStatus
- newtype BundleType where
- BundleType' { }
- pattern BundleType_REGULAR :: BundleType
- pattern BundleType_STANDBY :: BundleType
- newtype CertificateBasedAuthStatusEnum where
- newtype ClientDeviceType where
- ClientDeviceType' { }
- pattern ClientDeviceType_DeviceTypeAndroid :: ClientDeviceType
- pattern ClientDeviceType_DeviceTypeIos :: ClientDeviceType
- pattern ClientDeviceType_DeviceTypeLinux :: ClientDeviceType
- pattern ClientDeviceType_DeviceTypeOsx :: ClientDeviceType
- pattern ClientDeviceType_DeviceTypeWeb :: ClientDeviceType
- pattern ClientDeviceType_DeviceTypeWindows :: ClientDeviceType
- newtype Compute where
- Compute' {
- fromCompute :: Text
- pattern Compute_GRAPHICS :: Compute
- pattern Compute_GRAPHICSPRO :: Compute
- pattern Compute_GRAPHICSPRO_G4DN :: Compute
- pattern Compute_GRAPHICS_G4DN :: Compute
- pattern Compute_PERFORMANCE :: Compute
- pattern Compute_POWER :: Compute
- pattern Compute_POWERPRO :: Compute
- pattern Compute_STANDARD :: Compute
- pattern Compute_VALUE :: Compute
- Compute' {
- newtype ConnectionAliasState where
- newtype ConnectionState where
- ConnectionState' { }
- pattern ConnectionState_CONNECTED :: ConnectionState
- pattern ConnectionState_DISCONNECTED :: ConnectionState
- pattern ConnectionState_UNKNOWN :: ConnectionState
- newtype DedicatedTenancyModificationStateEnum where
- DedicatedTenancyModificationStateEnum' { }
- pattern DedicatedTenancyModificationStateEnum_COMPLETED :: DedicatedTenancyModificationStateEnum
- pattern DedicatedTenancyModificationStateEnum_FAILED :: DedicatedTenancyModificationStateEnum
- pattern DedicatedTenancyModificationStateEnum_PENDING :: DedicatedTenancyModificationStateEnum
- newtype DedicatedTenancySupportEnum where
- newtype DedicatedTenancySupportResultEnum where
- newtype DeletableCertificateBasedAuthProperty where
- newtype DeletableSamlProperty where
- newtype ImageType where
- ImageType' { }
- pattern ImageType_OWNED :: ImageType
- pattern ImageType_SHARED :: ImageType
- newtype LogUploadEnum where
- LogUploadEnum' { }
- pattern LogUploadEnum_DISABLED :: LogUploadEnum
- pattern LogUploadEnum_ENABLED :: LogUploadEnum
- newtype ModificationResourceEnum where
- newtype ModificationStateEnum where
- newtype OperatingSystemType where
- newtype Protocol where
- Protocol' {
- fromProtocol :: Text
- pattern Protocol_PCOIP :: Protocol
- pattern Protocol_WSP :: Protocol
- Protocol' {
- newtype ReconnectEnum where
- ReconnectEnum' { }
- pattern ReconnectEnum_DISABLED :: ReconnectEnum
- pattern ReconnectEnum_ENABLED :: ReconnectEnum
- newtype RunningMode where
- RunningMode' { }
- pattern RunningMode_ALWAYS_ON :: RunningMode
- pattern RunningMode_AUTO_STOP :: RunningMode
- pattern RunningMode_MANUAL :: RunningMode
- newtype SamlStatusEnum where
- SamlStatusEnum' { }
- pattern SamlStatusEnum_DISABLED :: SamlStatusEnum
- pattern SamlStatusEnum_ENABLED :: SamlStatusEnum
- pattern SamlStatusEnum_ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK :: SamlStatusEnum
- newtype StandbyWorkspaceRelationshipType where
- newtype TargetWorkspaceState where
- newtype Tenancy where
- Tenancy' {
- fromTenancy :: Text
- pattern Tenancy_DEDICATED :: Tenancy
- pattern Tenancy_SHARED :: Tenancy
- Tenancy' {
- newtype WorkspaceBundleState where
- newtype WorkspaceDirectoryState where
- WorkspaceDirectoryState' { }
- pattern WorkspaceDirectoryState_DEREGISTERED :: WorkspaceDirectoryState
- pattern WorkspaceDirectoryState_DEREGISTERING :: WorkspaceDirectoryState
- pattern WorkspaceDirectoryState_ERROR :: WorkspaceDirectoryState
- pattern WorkspaceDirectoryState_REGISTERED :: WorkspaceDirectoryState
- pattern WorkspaceDirectoryState_REGISTERING :: WorkspaceDirectoryState
- newtype WorkspaceDirectoryType where
- newtype WorkspaceImageIngestionProcess where
- WorkspaceImageIngestionProcess' { }
- pattern WorkspaceImageIngestionProcess_BYOL_GRAPHICS :: WorkspaceImageIngestionProcess
- pattern WorkspaceImageIngestionProcess_BYOL_GRAPHICSPRO :: WorkspaceImageIngestionProcess
- pattern WorkspaceImageIngestionProcess_BYOL_GRAPHICS_G4DN :: WorkspaceImageIngestionProcess
- pattern WorkspaceImageIngestionProcess_BYOL_GRAPHICS_G4DN_BYOP :: WorkspaceImageIngestionProcess
- pattern WorkspaceImageIngestionProcess_BYOL_REGULAR :: WorkspaceImageIngestionProcess
- pattern WorkspaceImageIngestionProcess_BYOL_REGULAR_BYOP :: WorkspaceImageIngestionProcess
- pattern WorkspaceImageIngestionProcess_BYOL_REGULAR_WSP :: WorkspaceImageIngestionProcess
- newtype WorkspaceImageRequiredTenancy where
- newtype WorkspaceImageState where
- newtype WorkspaceState where
- WorkspaceState' { }
- pattern WorkspaceState_ADMIN_MAINTENANCE :: WorkspaceState
- pattern WorkspaceState_AVAILABLE :: WorkspaceState
- pattern WorkspaceState_ERROR :: WorkspaceState
- pattern WorkspaceState_IMPAIRED :: WorkspaceState
- pattern WorkspaceState_MAINTENANCE :: WorkspaceState
- pattern WorkspaceState_PENDING :: WorkspaceState
- pattern WorkspaceState_REBOOTING :: WorkspaceState
- pattern WorkspaceState_REBUILDING :: WorkspaceState
- pattern WorkspaceState_RESTORING :: WorkspaceState
- pattern WorkspaceState_STARTING :: WorkspaceState
- pattern WorkspaceState_STOPPED :: WorkspaceState
- pattern WorkspaceState_STOPPING :: WorkspaceState
- pattern WorkspaceState_SUSPENDED :: WorkspaceState
- pattern WorkspaceState_TERMINATED :: WorkspaceState
- pattern WorkspaceState_TERMINATING :: WorkspaceState
- pattern WorkspaceState_UNHEALTHY :: WorkspaceState
- pattern WorkspaceState_UPDATING :: WorkspaceState
- data AccountModification = AccountModification' {}
- newAccountModification :: AccountModification
- accountModification_dedicatedTenancyManagementCidrRange :: Lens' AccountModification (Maybe Text)
- accountModification_dedicatedTenancySupport :: Lens' AccountModification (Maybe DedicatedTenancySupportResultEnum)
- accountModification_errorCode :: Lens' AccountModification (Maybe Text)
- accountModification_errorMessage :: Lens' AccountModification (Maybe Text)
- accountModification_modificationState :: Lens' AccountModification (Maybe DedicatedTenancyModificationStateEnum)
- accountModification_startTime :: Lens' AccountModification (Maybe UTCTime)
- data CertificateBasedAuthProperties = CertificateBasedAuthProperties' {}
- newCertificateBasedAuthProperties :: CertificateBasedAuthProperties
- certificateBasedAuthProperties_certificateAuthorityArn :: Lens' CertificateBasedAuthProperties (Maybe Text)
- certificateBasedAuthProperties_status :: Lens' CertificateBasedAuthProperties (Maybe CertificateBasedAuthStatusEnum)
- data ClientProperties = ClientProperties' {}
- newClientProperties :: ClientProperties
- clientProperties_logUploadEnabled :: Lens' ClientProperties (Maybe LogUploadEnum)
- clientProperties_reconnectEnabled :: Lens' ClientProperties (Maybe ReconnectEnum)
- data ClientPropertiesResult = ClientPropertiesResult' {}
- newClientPropertiesResult :: ClientPropertiesResult
- clientPropertiesResult_clientProperties :: Lens' ClientPropertiesResult (Maybe ClientProperties)
- clientPropertiesResult_resourceId :: Lens' ClientPropertiesResult (Maybe Text)
- data ComputeType = ComputeType' {}
- newComputeType :: ComputeType
- computeType_name :: Lens' ComputeType (Maybe Compute)
- data ConnectClientAddIn = ConnectClientAddIn' {}
- newConnectClientAddIn :: ConnectClientAddIn
- connectClientAddIn_addInId :: Lens' ConnectClientAddIn (Maybe Text)
- connectClientAddIn_name :: Lens' ConnectClientAddIn (Maybe Text)
- connectClientAddIn_resourceId :: Lens' ConnectClientAddIn (Maybe Text)
- connectClientAddIn_url :: Lens' ConnectClientAddIn (Maybe Text)
- data ConnectionAlias = ConnectionAlias' {}
- newConnectionAlias :: ConnectionAlias
- connectionAlias_aliasId :: Lens' ConnectionAlias (Maybe Text)
- connectionAlias_associations :: Lens' ConnectionAlias (Maybe (NonEmpty ConnectionAliasAssociation))
- connectionAlias_connectionString :: Lens' ConnectionAlias (Maybe Text)
- connectionAlias_ownerAccountId :: Lens' ConnectionAlias (Maybe Text)
- connectionAlias_state :: Lens' ConnectionAlias (Maybe ConnectionAliasState)
- data ConnectionAliasAssociation = ConnectionAliasAssociation' {}
- newConnectionAliasAssociation :: ConnectionAliasAssociation
- connectionAliasAssociation_associatedAccountId :: Lens' ConnectionAliasAssociation (Maybe Text)
- connectionAliasAssociation_associationStatus :: Lens' ConnectionAliasAssociation (Maybe AssociationStatus)
- connectionAliasAssociation_connectionIdentifier :: Lens' ConnectionAliasAssociation (Maybe Text)
- connectionAliasAssociation_resourceId :: Lens' ConnectionAliasAssociation (Maybe Text)
- data ConnectionAliasPermission = ConnectionAliasPermission' {}
- newConnectionAliasPermission :: Text -> Bool -> ConnectionAliasPermission
- connectionAliasPermission_sharedAccountId :: Lens' ConnectionAliasPermission Text
- connectionAliasPermission_allowAssociation :: Lens' ConnectionAliasPermission Bool
- data DefaultClientBrandingAttributes = DefaultClientBrandingAttributes' {
- forgotPasswordLink :: Maybe Text
- loginMessage :: Maybe (HashMap Text Text)
- logoUrl :: Maybe Text
- supportEmail :: Maybe Text
- supportLink :: Maybe Text
- newDefaultClientBrandingAttributes :: DefaultClientBrandingAttributes
- defaultClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultClientBrandingAttributes (Maybe Text)
- defaultClientBrandingAttributes_loginMessage :: Lens' DefaultClientBrandingAttributes (Maybe (HashMap Text Text))
- defaultClientBrandingAttributes_logoUrl :: Lens' DefaultClientBrandingAttributes (Maybe Text)
- defaultClientBrandingAttributes_supportEmail :: Lens' DefaultClientBrandingAttributes (Maybe Text)
- defaultClientBrandingAttributes_supportLink :: Lens' DefaultClientBrandingAttributes (Maybe Text)
- data DefaultImportClientBrandingAttributes = DefaultImportClientBrandingAttributes' {
- forgotPasswordLink :: Maybe Text
- loginMessage :: Maybe (HashMap Text Text)
- logo :: Maybe Base64
- supportEmail :: Maybe Text
- supportLink :: Maybe Text
- newDefaultImportClientBrandingAttributes :: DefaultImportClientBrandingAttributes
- defaultImportClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text)
- defaultImportClientBrandingAttributes_loginMessage :: Lens' DefaultImportClientBrandingAttributes (Maybe (HashMap Text Text))
- defaultImportClientBrandingAttributes_logo :: Lens' DefaultImportClientBrandingAttributes (Maybe ByteString)
- defaultImportClientBrandingAttributes_supportEmail :: Lens' DefaultImportClientBrandingAttributes (Maybe Text)
- defaultImportClientBrandingAttributes_supportLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text)
- data DefaultWorkspaceCreationProperties = DefaultWorkspaceCreationProperties' {}
- newDefaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties
- defaultWorkspaceCreationProperties_customSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
- defaultWorkspaceCreationProperties_defaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
- defaultWorkspaceCreationProperties_enableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- defaultWorkspaceCreationProperties_enableMaintenanceMode :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- defaultWorkspaceCreationProperties_enableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- defaultWorkspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- data FailedCreateStandbyWorkspacesRequest = FailedCreateStandbyWorkspacesRequest' {}
- newFailedCreateStandbyWorkspacesRequest :: FailedCreateStandbyWorkspacesRequest
- failedCreateStandbyWorkspacesRequest_errorCode :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe Text)
- failedCreateStandbyWorkspacesRequest_errorMessage :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe Text)
- failedCreateStandbyWorkspacesRequest_standbyWorkspaceRequest :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe StandbyWorkspace)
- data FailedCreateWorkspaceRequest = FailedCreateWorkspaceRequest' {}
- newFailedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest
- failedCreateWorkspaceRequest_errorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
- failedCreateWorkspaceRequest_errorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
- failedCreateWorkspaceRequest_workspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest)
- data FailedWorkspaceChangeRequest = FailedWorkspaceChangeRequest' {
- errorCode :: Maybe Text
- errorMessage :: Maybe Text
- workspaceId :: Maybe Text
- newFailedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest
- failedWorkspaceChangeRequest_errorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- failedWorkspaceChangeRequest_errorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- failedWorkspaceChangeRequest_workspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- data ImagePermission = ImagePermission' {}
- newImagePermission :: ImagePermission
- imagePermission_sharedAccountId :: Lens' ImagePermission (Maybe Text)
- data IosClientBrandingAttributes = IosClientBrandingAttributes' {}
- newIosClientBrandingAttributes :: IosClientBrandingAttributes
- iosClientBrandingAttributes_forgotPasswordLink :: Lens' IosClientBrandingAttributes (Maybe Text)
- iosClientBrandingAttributes_loginMessage :: Lens' IosClientBrandingAttributes (Maybe (HashMap Text Text))
- iosClientBrandingAttributes_logo2xUrl :: Lens' IosClientBrandingAttributes (Maybe Text)
- iosClientBrandingAttributes_logo3xUrl :: Lens' IosClientBrandingAttributes (Maybe Text)
- iosClientBrandingAttributes_logoUrl :: Lens' IosClientBrandingAttributes (Maybe Text)
- iosClientBrandingAttributes_supportEmail :: Lens' IosClientBrandingAttributes (Maybe Text)
- iosClientBrandingAttributes_supportLink :: Lens' IosClientBrandingAttributes (Maybe Text)
- data IosImportClientBrandingAttributes = IosImportClientBrandingAttributes' {}
- newIosImportClientBrandingAttributes :: IosImportClientBrandingAttributes
- iosImportClientBrandingAttributes_forgotPasswordLink :: Lens' IosImportClientBrandingAttributes (Maybe Text)
- iosImportClientBrandingAttributes_loginMessage :: Lens' IosImportClientBrandingAttributes (Maybe (HashMap Text Text))
- iosImportClientBrandingAttributes_logo :: Lens' IosImportClientBrandingAttributes (Maybe ByteString)
- iosImportClientBrandingAttributes_logo2x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString)
- iosImportClientBrandingAttributes_logo3x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString)
- iosImportClientBrandingAttributes_supportEmail :: Lens' IosImportClientBrandingAttributes (Maybe Text)
- iosImportClientBrandingAttributes_supportLink :: Lens' IosImportClientBrandingAttributes (Maybe Text)
- data IpRuleItem = IpRuleItem' {}
- newIpRuleItem :: IpRuleItem
- ipRuleItem_ipRule :: Lens' IpRuleItem (Maybe Text)
- ipRuleItem_ruleDesc :: Lens' IpRuleItem (Maybe Text)
- data ModificationState = ModificationState' {}
- newModificationState :: ModificationState
- modificationState_resource :: Lens' ModificationState (Maybe ModificationResourceEnum)
- modificationState_state :: Lens' ModificationState (Maybe ModificationStateEnum)
- data OperatingSystem = OperatingSystem' {}
- newOperatingSystem :: OperatingSystem
- operatingSystem_type :: Lens' OperatingSystem (Maybe OperatingSystemType)
- data PendingCreateStandbyWorkspacesRequest = PendingCreateStandbyWorkspacesRequest' {}
- newPendingCreateStandbyWorkspacesRequest :: PendingCreateStandbyWorkspacesRequest
- pendingCreateStandbyWorkspacesRequest_directoryId :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text)
- pendingCreateStandbyWorkspacesRequest_state :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe WorkspaceState)
- pendingCreateStandbyWorkspacesRequest_userName :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text)
- pendingCreateStandbyWorkspacesRequest_workspaceId :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text)
- data RebootRequest = RebootRequest' {
- workspaceId :: Text
- newRebootRequest :: Text -> RebootRequest
- rebootRequest_workspaceId :: Lens' RebootRequest Text
- data RebuildRequest = RebuildRequest' {
- workspaceId :: Text
- newRebuildRequest :: Text -> RebuildRequest
- rebuildRequest_workspaceId :: Lens' RebuildRequest Text
- data RelatedWorkspaceProperties = RelatedWorkspaceProperties' {}
- newRelatedWorkspaceProperties :: RelatedWorkspaceProperties
- relatedWorkspaceProperties_region :: Lens' RelatedWorkspaceProperties (Maybe Text)
- relatedWorkspaceProperties_state :: Lens' RelatedWorkspaceProperties (Maybe WorkspaceState)
- relatedWorkspaceProperties_type :: Lens' RelatedWorkspaceProperties (Maybe StandbyWorkspaceRelationshipType)
- relatedWorkspaceProperties_workspaceId :: Lens' RelatedWorkspaceProperties (Maybe Text)
- data RootStorage = RootStorage' {}
- newRootStorage :: RootStorage
- rootStorage_capacity :: Lens' RootStorage (Maybe Text)
- data SamlProperties = SamlProperties' {}
- newSamlProperties :: SamlProperties
- samlProperties_relayStateParameterName :: Lens' SamlProperties (Maybe Text)
- samlProperties_status :: Lens' SamlProperties (Maybe SamlStatusEnum)
- samlProperties_userAccessUrl :: Lens' SamlProperties (Maybe Text)
- data SelfservicePermissions = SelfservicePermissions' {}
- newSelfservicePermissions :: SelfservicePermissions
- selfservicePermissions_changeComputeType :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_increaseVolumeSize :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_rebuildWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_restartWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_switchRunningMode :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- data Snapshot = Snapshot' {}
- newSnapshot :: Snapshot
- snapshot_snapshotTime :: Lens' Snapshot (Maybe UTCTime)
- data StandbyWorkspace = StandbyWorkspace' {
- tags :: Maybe [Tag]
- volumeEncryptionKey :: Maybe Text
- primaryWorkspaceId :: Text
- directoryId :: Text
- newStandbyWorkspace :: Text -> Text -> StandbyWorkspace
- standbyWorkspace_tags :: Lens' StandbyWorkspace (Maybe [Tag])
- standbyWorkspace_volumeEncryptionKey :: Lens' StandbyWorkspace (Maybe Text)
- standbyWorkspace_primaryWorkspaceId :: Lens' StandbyWorkspace Text
- standbyWorkspace_directoryId :: Lens' StandbyWorkspace Text
- data StartRequest = StartRequest' {
- workspaceId :: Maybe Text
- newStartRequest :: StartRequest
- startRequest_workspaceId :: Lens' StartRequest (Maybe Text)
- data StopRequest = StopRequest' {
- workspaceId :: Maybe Text
- newStopRequest :: StopRequest
- stopRequest_workspaceId :: Lens' StopRequest (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- data TerminateRequest = TerminateRequest' {
- workspaceId :: Text
- newTerminateRequest :: Text -> TerminateRequest
- terminateRequest_workspaceId :: Lens' TerminateRequest Text
- data UpdateResult = UpdateResult' {}
- newUpdateResult :: UpdateResult
- updateResult_description :: Lens' UpdateResult (Maybe Text)
- updateResult_updateAvailable :: Lens' UpdateResult (Maybe Bool)
- data UserStorage = UserStorage' {}
- newUserStorage :: UserStorage
- userStorage_capacity :: Lens' UserStorage (Maybe Text)
- data Workspace = Workspace' {
- bundleId :: Maybe Text
- computerName :: Maybe Text
- directoryId :: Maybe Text
- errorCode :: Maybe Text
- errorMessage :: Maybe Text
- ipAddress :: Maybe Text
- modificationStates :: Maybe [ModificationState]
- relatedWorkspaces :: Maybe [RelatedWorkspaceProperties]
- rootVolumeEncryptionEnabled :: Maybe Bool
- state :: Maybe WorkspaceState
- subnetId :: Maybe Text
- userName :: Maybe Text
- userVolumeEncryptionEnabled :: Maybe Bool
- volumeEncryptionKey :: Maybe Text
- workspaceId :: Maybe Text
- workspaceProperties :: Maybe WorkspaceProperties
- newWorkspace :: Workspace
- workspace_bundleId :: Lens' Workspace (Maybe Text)
- workspace_computerName :: Lens' Workspace (Maybe Text)
- workspace_directoryId :: Lens' Workspace (Maybe Text)
- workspace_errorCode :: Lens' Workspace (Maybe Text)
- workspace_errorMessage :: Lens' Workspace (Maybe Text)
- workspace_ipAddress :: Lens' Workspace (Maybe Text)
- workspace_modificationStates :: Lens' Workspace (Maybe [ModificationState])
- workspace_relatedWorkspaces :: Lens' Workspace (Maybe [RelatedWorkspaceProperties])
- workspace_rootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
- workspace_state :: Lens' Workspace (Maybe WorkspaceState)
- workspace_subnetId :: Lens' Workspace (Maybe Text)
- workspace_userName :: Lens' Workspace (Maybe Text)
- workspace_userVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
- workspace_volumeEncryptionKey :: Lens' Workspace (Maybe Text)
- workspace_workspaceId :: Lens' Workspace (Maybe Text)
- workspace_workspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties)
- data WorkspaceAccessProperties = WorkspaceAccessProperties' {
- deviceTypeAndroid :: Maybe AccessPropertyValue
- deviceTypeChromeOs :: Maybe AccessPropertyValue
- deviceTypeIos :: Maybe AccessPropertyValue
- deviceTypeLinux :: Maybe AccessPropertyValue
- deviceTypeOsx :: Maybe AccessPropertyValue
- deviceTypeWeb :: Maybe AccessPropertyValue
- deviceTypeWindows :: Maybe AccessPropertyValue
- deviceTypeZeroClient :: Maybe AccessPropertyValue
- newWorkspaceAccessProperties :: WorkspaceAccessProperties
- workspaceAccessProperties_deviceTypeAndroid :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeChromeOs :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeIos :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeLinux :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeOsx :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeWeb :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeWindows :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeZeroClient :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- data WorkspaceBundle = WorkspaceBundle' {
- bundleId :: Maybe Text
- bundleType :: Maybe BundleType
- computeType :: Maybe ComputeType
- creationTime :: Maybe POSIX
- description :: Maybe Text
- imageId :: Maybe Text
- lastUpdatedTime :: Maybe POSIX
- name :: Maybe Text
- owner :: Maybe Text
- rootStorage :: Maybe RootStorage
- state :: Maybe WorkspaceBundleState
- userStorage :: Maybe UserStorage
- newWorkspaceBundle :: WorkspaceBundle
- workspaceBundle_bundleId :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_bundleType :: Lens' WorkspaceBundle (Maybe BundleType)
- workspaceBundle_computeType :: Lens' WorkspaceBundle (Maybe ComputeType)
- workspaceBundle_creationTime :: Lens' WorkspaceBundle (Maybe UTCTime)
- workspaceBundle_description :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_imageId :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_lastUpdatedTime :: Lens' WorkspaceBundle (Maybe UTCTime)
- workspaceBundle_name :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_owner :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_rootStorage :: Lens' WorkspaceBundle (Maybe RootStorage)
- workspaceBundle_state :: Lens' WorkspaceBundle (Maybe WorkspaceBundleState)
- workspaceBundle_userStorage :: Lens' WorkspaceBundle (Maybe UserStorage)
- data WorkspaceConnectionStatus = WorkspaceConnectionStatus' {}
- newWorkspaceConnectionStatus :: WorkspaceConnectionStatus
- workspaceConnectionStatus_connectionState :: Lens' WorkspaceConnectionStatus (Maybe ConnectionState)
- workspaceConnectionStatus_connectionStateCheckTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime)
- workspaceConnectionStatus_lastKnownUserConnectionTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime)
- workspaceConnectionStatus_workspaceId :: Lens' WorkspaceConnectionStatus (Maybe Text)
- data WorkspaceCreationProperties = WorkspaceCreationProperties' {}
- newWorkspaceCreationProperties :: WorkspaceCreationProperties
- workspaceCreationProperties_customSecurityGroupId :: Lens' WorkspaceCreationProperties (Maybe Text)
- workspaceCreationProperties_defaultOu :: Lens' WorkspaceCreationProperties (Maybe Text)
- workspaceCreationProperties_enableInternetAccess :: Lens' WorkspaceCreationProperties (Maybe Bool)
- workspaceCreationProperties_enableMaintenanceMode :: Lens' WorkspaceCreationProperties (Maybe Bool)
- workspaceCreationProperties_enableWorkDocs :: Lens' WorkspaceCreationProperties (Maybe Bool)
- workspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' WorkspaceCreationProperties (Maybe Bool)
- data WorkspaceDirectory = WorkspaceDirectory' {
- alias :: Maybe Text
- certificateBasedAuthProperties :: Maybe CertificateBasedAuthProperties
- customerUserName :: Maybe Text
- directoryId :: Maybe Text
- directoryName :: Maybe Text
- directoryType :: Maybe WorkspaceDirectoryType
- dnsIpAddresses :: Maybe [Text]
- iamRoleId :: Maybe Text
- registrationCode :: Maybe Text
- samlProperties :: Maybe SamlProperties
- selfservicePermissions :: Maybe SelfservicePermissions
- state :: Maybe WorkspaceDirectoryState
- subnetIds :: Maybe [Text]
- tenancy :: Maybe Tenancy
- workspaceAccessProperties :: Maybe WorkspaceAccessProperties
- workspaceCreationProperties :: Maybe DefaultWorkspaceCreationProperties
- workspaceSecurityGroupId :: Maybe Text
- ipGroupIds :: Maybe [Text]
- newWorkspaceDirectory :: WorkspaceDirectory
- workspaceDirectory_alias :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_certificateBasedAuthProperties :: Lens' WorkspaceDirectory (Maybe CertificateBasedAuthProperties)
- workspaceDirectory_customerUserName :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_directoryId :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_directoryName :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_directoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType)
- workspaceDirectory_dnsIpAddresses :: Lens' WorkspaceDirectory (Maybe [Text])
- workspaceDirectory_iamRoleId :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_registrationCode :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_samlProperties :: Lens' WorkspaceDirectory (Maybe SamlProperties)
- workspaceDirectory_selfservicePermissions :: Lens' WorkspaceDirectory (Maybe SelfservicePermissions)
- workspaceDirectory_state :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState)
- workspaceDirectory_subnetIds :: Lens' WorkspaceDirectory (Maybe [Text])
- workspaceDirectory_tenancy :: Lens' WorkspaceDirectory (Maybe Tenancy)
- workspaceDirectory_workspaceAccessProperties :: Lens' WorkspaceDirectory (Maybe WorkspaceAccessProperties)
- workspaceDirectory_workspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties)
- workspaceDirectory_workspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_ipGroupIds :: Lens' WorkspaceDirectory (Maybe [Text])
- data WorkspaceImage = WorkspaceImage' {
- created :: Maybe POSIX
- description :: Maybe Text
- errorCode :: Maybe Text
- errorMessage :: Maybe Text
- imageId :: Maybe Text
- name :: Maybe Text
- operatingSystem :: Maybe OperatingSystem
- ownerAccountId :: Maybe Text
- requiredTenancy :: Maybe WorkspaceImageRequiredTenancy
- state :: Maybe WorkspaceImageState
- updates :: Maybe UpdateResult
- newWorkspaceImage :: WorkspaceImage
- workspaceImage_created :: Lens' WorkspaceImage (Maybe UTCTime)
- workspaceImage_description :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_errorCode :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_errorMessage :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_imageId :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_name :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_operatingSystem :: Lens' WorkspaceImage (Maybe OperatingSystem)
- workspaceImage_ownerAccountId :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_requiredTenancy :: Lens' WorkspaceImage (Maybe WorkspaceImageRequiredTenancy)
- workspaceImage_state :: Lens' WorkspaceImage (Maybe WorkspaceImageState)
- workspaceImage_updates :: Lens' WorkspaceImage (Maybe UpdateResult)
- data WorkspaceProperties = WorkspaceProperties' {}
- newWorkspaceProperties :: WorkspaceProperties
- workspaceProperties_computeTypeName :: Lens' WorkspaceProperties (Maybe Compute)
- workspaceProperties_protocols :: Lens' WorkspaceProperties (Maybe [Protocol])
- workspaceProperties_rootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)
- workspaceProperties_runningMode :: Lens' WorkspaceProperties (Maybe RunningMode)
- workspaceProperties_runningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int)
- workspaceProperties_userVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)
- data WorkspaceRequest = WorkspaceRequest' {}
- newWorkspaceRequest :: Text -> Text -> Text -> WorkspaceRequest
- workspaceRequest_rootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- workspaceRequest_tags :: Lens' WorkspaceRequest (Maybe [Tag])
- workspaceRequest_userVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- workspaceRequest_volumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text)
- workspaceRequest_workspaceProperties :: Lens' WorkspaceRequest (Maybe WorkspaceProperties)
- workspaceRequest_directoryId :: Lens' WorkspaceRequest Text
- workspaceRequest_userName :: Lens' WorkspaceRequest Text
- workspaceRequest_bundleId :: Lens' WorkspaceRequest Text
- data WorkspacesIpGroup = WorkspacesIpGroup' {}
- newWorkspacesIpGroup :: WorkspacesIpGroup
- workspacesIpGroup_groupDesc :: Lens' WorkspacesIpGroup (Maybe Text)
- workspacesIpGroup_groupId :: Lens' WorkspacesIpGroup (Maybe Text)
- workspacesIpGroup_groupName :: Lens' WorkspacesIpGroup (Maybe Text)
- workspacesIpGroup_userRules :: Lens' WorkspacesIpGroup (Maybe [IpRuleItem])
Service Configuration
defaultService :: Service Source #
API version 2015-04-08 of the Amazon WorkSpaces SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The user is not authorized to access a resource.
_InvalidParameterValuesException :: AsError a => Fold a ServiceError Source #
One or more parameter values are not valid.
_InvalidResourceStateException :: AsError a => Fold a ServiceError Source #
The state of the resource is not valid for this operation.
_OperationInProgressException :: AsError a => Fold a ServiceError Source #
The properties of this WorkSpace are currently being modified. Try again in a moment.
_OperationNotSupportedException :: AsError a => Fold a ServiceError Source #
This operation is not supported.
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified resource already exists.
_ResourceAssociatedException :: AsError a => Fold a ServiceError Source #
The resource is associated with a directory.
_ResourceCreationFailedException :: AsError a => Fold a ServiceError Source #
The resource could not be created.
_ResourceLimitExceededException :: AsError a => Fold a ServiceError Source #
Your resource limits have been exceeded.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource could not be found.
_ResourceUnavailableException :: AsError a => Fold a ServiceError Source #
The specified resource is not available.
_UnsupportedNetworkConfigurationException :: AsError a => Fold a ServiceError Source #
The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
_UnsupportedWorkspaceConfigurationException :: AsError a => Fold a ServiceError Source #
The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
_WorkspacesDefaultRoleNotFoundException :: AsError a => Fold a ServiceError Source #
The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
AccessPropertyValue
newtype AccessPropertyValue Source #
Constructors
| AccessPropertyValue' | |
Fields | |
Bundled Patterns
| pattern AccessPropertyValue_ALLOW :: AccessPropertyValue | |
| pattern AccessPropertyValue_DENY :: AccessPropertyValue |
Instances
Application
newtype Application Source #
Constructors
| Application' | |
Fields | |
Bundled Patterns
| pattern Application_Microsoft_Office_2016 :: Application | |
| pattern Application_Microsoft_Office_2019 :: Application |
Instances
AssociationStatus
newtype AssociationStatus Source #
Constructors
| AssociationStatus' | |
Fields | |
Bundled Patterns
Instances
BundleType
newtype BundleType Source #
Constructors
| BundleType' | |
Fields | |
Bundled Patterns
| pattern BundleType_REGULAR :: BundleType | |
| pattern BundleType_STANDBY :: BundleType |
Instances
CertificateBasedAuthStatusEnum
newtype CertificateBasedAuthStatusEnum Source #
Constructors
| CertificateBasedAuthStatusEnum' | |
Fields | |
Bundled Patterns
| pattern CertificateBasedAuthStatusEnum_DISABLED :: CertificateBasedAuthStatusEnum | |
| pattern CertificateBasedAuthStatusEnum_ENABLED :: CertificateBasedAuthStatusEnum |
Instances
ClientDeviceType
newtype ClientDeviceType Source #
Constructors
| ClientDeviceType' | |
Fields | |
Bundled Patterns
| pattern ClientDeviceType_DeviceTypeAndroid :: ClientDeviceType | |
| pattern ClientDeviceType_DeviceTypeIos :: ClientDeviceType | |
| pattern ClientDeviceType_DeviceTypeLinux :: ClientDeviceType | |
| pattern ClientDeviceType_DeviceTypeOsx :: ClientDeviceType | |
| pattern ClientDeviceType_DeviceTypeWeb :: ClientDeviceType | |
| pattern ClientDeviceType_DeviceTypeWindows :: ClientDeviceType |
Instances
Compute
Constructors
| Compute' | |
Fields
| |
Bundled Patterns
| pattern Compute_GRAPHICS :: Compute | |
| pattern Compute_GRAPHICSPRO :: Compute | |
| pattern Compute_GRAPHICSPRO_G4DN :: Compute | |
| pattern Compute_GRAPHICS_G4DN :: Compute | |
| pattern Compute_PERFORMANCE :: Compute | |
| pattern Compute_POWER :: Compute | |
| pattern Compute_POWERPRO :: Compute | |
| pattern Compute_STANDARD :: Compute | |
| pattern Compute_VALUE :: Compute |
Instances
ConnectionAliasState
newtype ConnectionAliasState Source #
Constructors
| ConnectionAliasState' | |
Fields | |
Bundled Patterns
| pattern ConnectionAliasState_CREATED :: ConnectionAliasState | |
| pattern ConnectionAliasState_CREATING :: ConnectionAliasState | |
| pattern ConnectionAliasState_DELETING :: ConnectionAliasState |
Instances
ConnectionState
newtype ConnectionState Source #
Constructors
| ConnectionState' | |
Fields | |
Bundled Patterns
| pattern ConnectionState_CONNECTED :: ConnectionState | |
| pattern ConnectionState_DISCONNECTED :: ConnectionState | |
| pattern ConnectionState_UNKNOWN :: ConnectionState |
Instances
DedicatedTenancyModificationStateEnum
newtype DedicatedTenancyModificationStateEnum Source #
Constructors
| DedicatedTenancyModificationStateEnum' | |
Bundled Patterns
Instances
DedicatedTenancySupportEnum
newtype DedicatedTenancySupportEnum Source #
Constructors
| DedicatedTenancySupportEnum' | |
Fields | |
Bundled Patterns
| pattern DedicatedTenancySupportEnum_ENABLED :: DedicatedTenancySupportEnum |
Instances
DedicatedTenancySupportResultEnum
newtype DedicatedTenancySupportResultEnum Source #
Constructors
| DedicatedTenancySupportResultEnum' | |
Bundled Patterns
| pattern DedicatedTenancySupportResultEnum_DISABLED :: DedicatedTenancySupportResultEnum | |
| pattern DedicatedTenancySupportResultEnum_ENABLED :: DedicatedTenancySupportResultEnum |
Instances
DeletableCertificateBasedAuthProperty
newtype DeletableCertificateBasedAuthProperty Source #
Constructors
| DeletableCertificateBasedAuthProperty' | |
Bundled Patterns
| pattern DeletableCertificateBasedAuthProperty_CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN :: DeletableCertificateBasedAuthProperty |
Instances
DeletableSamlProperty
newtype DeletableSamlProperty Source #
Constructors
| DeletableSamlProperty' | |
Fields | |
Bundled Patterns
| pattern DeletableSamlProperty_SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME :: DeletableSamlProperty | |
| pattern DeletableSamlProperty_SAML_PROPERTIES_USER_ACCESS_URL :: DeletableSamlProperty |
Instances
ImageType
Constructors
| ImageType' | |
Fields | |
Bundled Patterns
| pattern ImageType_OWNED :: ImageType | |
| pattern ImageType_SHARED :: ImageType |
Instances
LogUploadEnum
newtype LogUploadEnum Source #
Constructors
| LogUploadEnum' | |
Fields | |
Bundled Patterns
| pattern LogUploadEnum_DISABLED :: LogUploadEnum | |
| pattern LogUploadEnum_ENABLED :: LogUploadEnum |
Instances
ModificationResourceEnum
newtype ModificationResourceEnum Source #
Constructors
| ModificationResourceEnum' | |
Fields | |
Bundled Patterns
Instances
ModificationStateEnum
newtype ModificationStateEnum Source #
Constructors
| ModificationStateEnum' | |
Fields | |
Bundled Patterns
| pattern ModificationStateEnum_UPDATE_INITIATED :: ModificationStateEnum | |
| pattern ModificationStateEnum_UPDATE_IN_PROGRESS :: ModificationStateEnum |
Instances
OperatingSystemType
newtype OperatingSystemType Source #
Constructors
| OperatingSystemType' | |
Fields | |
Bundled Patterns
| pattern OperatingSystemType_LINUX :: OperatingSystemType | |
| pattern OperatingSystemType_WINDOWS :: OperatingSystemType |
Instances
Protocol
Constructors
| Protocol' | |
Fields
| |
Bundled Patterns
| pattern Protocol_PCOIP :: Protocol | |
| pattern Protocol_WSP :: Protocol |
Instances
ReconnectEnum
newtype ReconnectEnum Source #
Constructors
| ReconnectEnum' | |
Fields | |
Bundled Patterns
| pattern ReconnectEnum_DISABLED :: ReconnectEnum | |
| pattern ReconnectEnum_ENABLED :: ReconnectEnum |
Instances
RunningMode
newtype RunningMode Source #
Constructors
| RunningMode' | |
Fields | |
Bundled Patterns
| pattern RunningMode_ALWAYS_ON :: RunningMode | |
| pattern RunningMode_AUTO_STOP :: RunningMode | |
| pattern RunningMode_MANUAL :: RunningMode |
Instances
SamlStatusEnum
newtype SamlStatusEnum Source #
Constructors
| SamlStatusEnum' | |
Fields | |
Bundled Patterns
| pattern SamlStatusEnum_DISABLED :: SamlStatusEnum | |
| pattern SamlStatusEnum_ENABLED :: SamlStatusEnum | |
| pattern SamlStatusEnum_ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK :: SamlStatusEnum |
Instances
StandbyWorkspaceRelationshipType
newtype StandbyWorkspaceRelationshipType Source #
Constructors
| StandbyWorkspaceRelationshipType' | |
Fields | |
Bundled Patterns
| pattern StandbyWorkspaceRelationshipType_PRIMARY :: StandbyWorkspaceRelationshipType | |
| pattern StandbyWorkspaceRelationshipType_STANDBY :: StandbyWorkspaceRelationshipType |
Instances
TargetWorkspaceState
newtype TargetWorkspaceState Source #
Constructors
| TargetWorkspaceState' | |
Fields | |
Bundled Patterns
| pattern TargetWorkspaceState_ADMIN_MAINTENANCE :: TargetWorkspaceState | |
| pattern TargetWorkspaceState_AVAILABLE :: TargetWorkspaceState |
Instances
Tenancy
Constructors
| Tenancy' | |
Fields
| |
Bundled Patterns
| pattern Tenancy_DEDICATED :: Tenancy | |
| pattern Tenancy_SHARED :: Tenancy |
Instances
WorkspaceBundleState
newtype WorkspaceBundleState Source #
Constructors
| WorkspaceBundleState' | |
Fields | |
Bundled Patterns
| pattern WorkspaceBundleState_AVAILABLE :: WorkspaceBundleState | |
| pattern WorkspaceBundleState_ERROR :: WorkspaceBundleState | |
| pattern WorkspaceBundleState_PENDING :: WorkspaceBundleState |
Instances
WorkspaceDirectoryState
newtype WorkspaceDirectoryState Source #
Constructors
| WorkspaceDirectoryState' | |
Fields | |
Bundled Patterns
Instances
WorkspaceDirectoryType
newtype WorkspaceDirectoryType Source #
Constructors
| WorkspaceDirectoryType' | |
Fields | |
Bundled Patterns
| pattern WorkspaceDirectoryType_AD_CONNECTOR :: WorkspaceDirectoryType | |
| pattern WorkspaceDirectoryType_SIMPLE_AD :: WorkspaceDirectoryType |
Instances
WorkspaceImageIngestionProcess
newtype WorkspaceImageIngestionProcess Source #
Constructors
| WorkspaceImageIngestionProcess' | |
Fields | |
Bundled Patterns
Instances
WorkspaceImageRequiredTenancy
newtype WorkspaceImageRequiredTenancy Source #
Constructors
| WorkspaceImageRequiredTenancy' | |
Fields | |
Bundled Patterns
| pattern WorkspaceImageRequiredTenancy_DEDICATED :: WorkspaceImageRequiredTenancy | |
| pattern WorkspaceImageRequiredTenancy_DEFAULT :: WorkspaceImageRequiredTenancy |
Instances
WorkspaceImageState
newtype WorkspaceImageState Source #
Constructors
| WorkspaceImageState' | |
Fields | |
Bundled Patterns
| pattern WorkspaceImageState_AVAILABLE :: WorkspaceImageState | |
| pattern WorkspaceImageState_ERROR :: WorkspaceImageState | |
| pattern WorkspaceImageState_PENDING :: WorkspaceImageState |
Instances
WorkspaceState
newtype WorkspaceState Source #
Constructors
| WorkspaceState' | |
Fields | |
Bundled Patterns
| pattern WorkspaceState_ADMIN_MAINTENANCE :: WorkspaceState | |
| pattern WorkspaceState_AVAILABLE :: WorkspaceState | |
| pattern WorkspaceState_ERROR :: WorkspaceState | |
| pattern WorkspaceState_IMPAIRED :: WorkspaceState | |
| pattern WorkspaceState_MAINTENANCE :: WorkspaceState | |
| pattern WorkspaceState_PENDING :: WorkspaceState | |
| pattern WorkspaceState_REBOOTING :: WorkspaceState | |
| pattern WorkspaceState_REBUILDING :: WorkspaceState | |
| pattern WorkspaceState_RESTORING :: WorkspaceState | |
| pattern WorkspaceState_STARTING :: WorkspaceState | |
| pattern WorkspaceState_STOPPED :: WorkspaceState | |
| pattern WorkspaceState_STOPPING :: WorkspaceState | |
| pattern WorkspaceState_SUSPENDED :: WorkspaceState | |
| pattern WorkspaceState_TERMINATED :: WorkspaceState | |
| pattern WorkspaceState_TERMINATING :: WorkspaceState | |
| pattern WorkspaceState_UNHEALTHY :: WorkspaceState | |
| pattern WorkspaceState_UPDATING :: WorkspaceState |
Instances
AccountModification
data AccountModification Source #
Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
See: newAccountModification smart constructor.
Constructors
| AccountModification' | |
Fields
| |
Instances
newAccountModification :: AccountModification Source #
Create a value of AccountModification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dedicatedTenancyManagementCidrRange:AccountModification', accountModification_dedicatedTenancyManagementCidrRange - The IP address range, specified as an IPv4 CIDR block, for the
management network interface used for the account.
$sel:dedicatedTenancySupport:AccountModification', accountModification_dedicatedTenancySupport - The status of BYOL (whether BYOL is being enabled or disabled).
$sel:errorCode:AccountModification', accountModification_errorCode - The error code that is returned if the configuration of BYOL cannot be
modified.
$sel:errorMessage:AccountModification', accountModification_errorMessage - The text of the error message that is returned if the configuration of
BYOL cannot be modified.
$sel:modificationState:AccountModification', accountModification_modificationState - The state of the modification to the configuration of BYOL.
$sel:startTime:AccountModification', accountModification_startTime - The timestamp when the modification of the BYOL configuration was
started.
accountModification_dedicatedTenancyManagementCidrRange :: Lens' AccountModification (Maybe Text) Source #
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
accountModification_dedicatedTenancySupport :: Lens' AccountModification (Maybe DedicatedTenancySupportResultEnum) Source #
The status of BYOL (whether BYOL is being enabled or disabled).
accountModification_errorCode :: Lens' AccountModification (Maybe Text) Source #
The error code that is returned if the configuration of BYOL cannot be modified.
accountModification_errorMessage :: Lens' AccountModification (Maybe Text) Source #
The text of the error message that is returned if the configuration of BYOL cannot be modified.
accountModification_modificationState :: Lens' AccountModification (Maybe DedicatedTenancyModificationStateEnum) Source #
The state of the modification to the configuration of BYOL.
accountModification_startTime :: Lens' AccountModification (Maybe UTCTime) Source #
The timestamp when the modification of the BYOL configuration was started.
CertificateBasedAuthProperties
data CertificateBasedAuthProperties Source #
Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.
See: newCertificateBasedAuthProperties smart constructor.
Constructors
| CertificateBasedAuthProperties' | |
Fields
| |
Instances
newCertificateBasedAuthProperties :: CertificateBasedAuthProperties Source #
Create a value of CertificateBasedAuthProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateAuthorityArn:CertificateBasedAuthProperties', certificateBasedAuthProperties_certificateAuthorityArn - The Amazon Resource Name (ARN) of the Amazon Web Services Certificate
Manager Private CA resource.
$sel:status:CertificateBasedAuthProperties', certificateBasedAuthProperties_status - The status of the certificate-based authentication properties.
certificateBasedAuthProperties_certificateAuthorityArn :: Lens' CertificateBasedAuthProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
certificateBasedAuthProperties_status :: Lens' CertificateBasedAuthProperties (Maybe CertificateBasedAuthStatusEnum) Source #
The status of the certificate-based authentication properties.
ClientProperties
data ClientProperties Source #
Describes an Amazon WorkSpaces client.
See: newClientProperties smart constructor.
Constructors
| ClientProperties' | |
Fields
| |
Instances
newClientProperties :: ClientProperties Source #
Create a value of ClientProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logUploadEnabled:ClientProperties', clientProperties_logUploadEnabled - Specifies whether users can upload diagnostic log files of Amazon
WorkSpaces client directly to WorkSpaces to troubleshoot issues when
using the WorkSpaces client. When enabled, the log files will be sent to
WorkSpaces automatically and will be applied to all users in the
specified directory.
$sel:reconnectEnabled:ClientProperties', clientProperties_reconnectEnabled - Specifies whether users can cache their credentials on the Amazon
WorkSpaces client. When enabled, users can choose to reconnect to their
WorkSpaces without re-entering their credentials.
clientProperties_logUploadEnabled :: Lens' ClientProperties (Maybe LogUploadEnum) Source #
Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.
clientProperties_reconnectEnabled :: Lens' ClientProperties (Maybe ReconnectEnum) Source #
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
ClientPropertiesResult
data ClientPropertiesResult Source #
Information about the Amazon WorkSpaces client.
See: newClientPropertiesResult smart constructor.
Constructors
| ClientPropertiesResult' | |
Fields
| |
Instances
newClientPropertiesResult :: ClientPropertiesResult Source #
Create a value of ClientPropertiesResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientProperties:ClientPropertiesResult', clientPropertiesResult_clientProperties - Information about the Amazon WorkSpaces client.
$sel:resourceId:ClientPropertiesResult', clientPropertiesResult_resourceId - The resource identifier, in the form of a directory ID.
clientPropertiesResult_clientProperties :: Lens' ClientPropertiesResult (Maybe ClientProperties) Source #
Information about the Amazon WorkSpaces client.
clientPropertiesResult_resourceId :: Lens' ClientPropertiesResult (Maybe Text) Source #
The resource identifier, in the form of a directory ID.
ComputeType
data ComputeType Source #
Describes the compute type of the bundle.
See: newComputeType smart constructor.
Constructors
| ComputeType' | |
Instances
newComputeType :: ComputeType Source #
Create a value of ComputeType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ComputeType', computeType_name - The compute type.
computeType_name :: Lens' ComputeType (Maybe Compute) Source #
The compute type.
ConnectClientAddIn
data ConnectClientAddIn Source #
Describes an Amazon Connect client add-in.
See: newConnectClientAddIn smart constructor.
Constructors
| ConnectClientAddIn' | |
Instances
newConnectClientAddIn :: ConnectClientAddIn Source #
Create a value of ConnectClientAddIn with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addInId:ConnectClientAddIn', connectClientAddIn_addInId - The client add-in identifier.
$sel:name:ConnectClientAddIn', connectClientAddIn_name - The name of the client add in.
$sel:resourceId:ConnectClientAddIn', connectClientAddIn_resourceId - The directory identifier for which the client add-in is configured.
$sel:url:ConnectClientAddIn', connectClientAddIn_url - The endpoint URL of the client add-in.
connectClientAddIn_addInId :: Lens' ConnectClientAddIn (Maybe Text) Source #
The client add-in identifier.
connectClientAddIn_name :: Lens' ConnectClientAddIn (Maybe Text) Source #
The name of the client add in.
connectClientAddIn_resourceId :: Lens' ConnectClientAddIn (Maybe Text) Source #
The directory identifier for which the client add-in is configured.
connectClientAddIn_url :: Lens' ConnectClientAddIn (Maybe Text) Source #
The endpoint URL of the client add-in.
ConnectionAlias
data ConnectionAlias Source #
Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
See: newConnectionAlias smart constructor.
Constructors
| ConnectionAlias' | |
Fields
| |
Instances
newConnectionAlias :: ConnectionAlias Source #
Create a value of ConnectionAlias with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aliasId:ConnectionAlias', connectionAlias_aliasId - The identifier of the connection alias.
$sel:associations:ConnectionAlias', connectionAlias_associations - The association status of the connection alias.
$sel:connectionString:ConnectionAlias', connectionAlias_connectionString - The connection string specified for the connection alias. The connection
string must be in the form of a fully qualified domain name (FQDN), such
as www.example.com.
$sel:ownerAccountId:ConnectionAlias', connectionAlias_ownerAccountId - The identifier of the Amazon Web Services account that owns the
connection alias.
$sel:state:ConnectionAlias', connectionAlias_state - The current state of the connection alias.
connectionAlias_aliasId :: Lens' ConnectionAlias (Maybe Text) Source #
The identifier of the connection alias.
connectionAlias_associations :: Lens' ConnectionAlias (Maybe (NonEmpty ConnectionAliasAssociation)) Source #
The association status of the connection alias.
connectionAlias_connectionString :: Lens' ConnectionAlias (Maybe Text) Source #
The connection string specified for the connection alias. The connection
string must be in the form of a fully qualified domain name (FQDN), such
as www.example.com.
connectionAlias_ownerAccountId :: Lens' ConnectionAlias (Maybe Text) Source #
The identifier of the Amazon Web Services account that owns the connection alias.
connectionAlias_state :: Lens' ConnectionAlias (Maybe ConnectionAliasState) Source #
The current state of the connection alias.
ConnectionAliasAssociation
data ConnectionAliasAssociation Source #
Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
See: newConnectionAliasAssociation smart constructor.
Constructors
| ConnectionAliasAssociation' | |
Fields
| |
Instances
newConnectionAliasAssociation :: ConnectionAliasAssociation Source #
Create a value of ConnectionAliasAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedAccountId:ConnectionAliasAssociation', connectionAliasAssociation_associatedAccountId - The identifier of the Amazon Web Services account that associated the
connection alias with a directory.
$sel:associationStatus:ConnectionAliasAssociation', connectionAliasAssociation_associationStatus - The association status of the connection alias.
$sel:connectionIdentifier:ConnectionAliasAssociation', connectionAliasAssociation_connectionIdentifier - The identifier of the connection alias association. You use the
connection identifier in the DNS TXT record when you're configuring
your DNS routing policies.
$sel:resourceId:ConnectionAliasAssociation', connectionAliasAssociation_resourceId - The identifier of the directory associated with a connection alias.
connectionAliasAssociation_associatedAccountId :: Lens' ConnectionAliasAssociation (Maybe Text) Source #
The identifier of the Amazon Web Services account that associated the connection alias with a directory.
connectionAliasAssociation_associationStatus :: Lens' ConnectionAliasAssociation (Maybe AssociationStatus) Source #
The association status of the connection alias.
connectionAliasAssociation_connectionIdentifier :: Lens' ConnectionAliasAssociation (Maybe Text) Source #
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
connectionAliasAssociation_resourceId :: Lens' ConnectionAliasAssociation (Maybe Text) Source #
The identifier of the directory associated with a connection alias.
ConnectionAliasPermission
data ConnectionAliasPermission Source #
Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
See: newConnectionAliasPermission smart constructor.
Constructors
| ConnectionAliasPermission' | |
Fields
| |
Instances
newConnectionAliasPermission Source #
Arguments
| :: Text | |
| -> Bool | |
| -> ConnectionAliasPermission |
Create a value of ConnectionAliasPermission with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sharedAccountId:ConnectionAliasPermission', connectionAliasPermission_sharedAccountId - The identifier of the Amazon Web Services account that the connection
alias is shared with.
$sel:allowAssociation:ConnectionAliasPermission', connectionAliasPermission_allowAssociation - Indicates whether the specified Amazon Web Services account is allowed
to associate the connection alias with a directory.
connectionAliasPermission_sharedAccountId :: Lens' ConnectionAliasPermission Text Source #
The identifier of the Amazon Web Services account that the connection alias is shared with.
connectionAliasPermission_allowAssociation :: Lens' ConnectionAliasPermission Bool Source #
Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
DefaultClientBrandingAttributes
data DefaultClientBrandingAttributes Source #
Returns default client branding attributes that were imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you don't include sensitive information.
See: newDefaultClientBrandingAttributes smart constructor.
Constructors
| DefaultClientBrandingAttributes' | |
Fields
| |
Instances
newDefaultClientBrandingAttributes :: DefaultClientBrandingAttributes Source #
Create a value of DefaultClientBrandingAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forgotPasswordLink:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_forgotPasswordLink - The forgotten password link. This is the web address that users can go
to if they forget the password for their WorkSpace.
$sel:loginMessage:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_loginMessage - The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
$sel:logoUrl:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_logoUrl - The logo. The only image format accepted is a binary data object that is
converted from a .png file.
$sel:supportEmail:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_supportEmail - The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
$sel:supportLink:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_supportLink - The support link. The link for the company's customer support page for
their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive.You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
defaultClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
defaultClientBrandingAttributes_loginMessage :: Lens' DefaultClientBrandingAttributes (Maybe (HashMap Text Text)) Source #
The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
defaultClientBrandingAttributes_logoUrl :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #
The logo. The only image format accepted is a binary data object that is
converted from a .png file.
defaultClientBrandingAttributes_supportEmail :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #
The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
defaultClientBrandingAttributes_supportLink :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #
The support link. The link for the company's customer support page for their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive.You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
DefaultImportClientBrandingAttributes
data DefaultImportClientBrandingAttributes Source #
The default client branding attributes to be imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you do not include sensitive information.
See: newDefaultImportClientBrandingAttributes smart constructor.
Constructors
| DefaultImportClientBrandingAttributes' | |
Fields
| |
Instances
newDefaultImportClientBrandingAttributes :: DefaultImportClientBrandingAttributes Source #
Create a value of DefaultImportClientBrandingAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forgotPasswordLink:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_forgotPasswordLink - The forgotten password link. This is the web address that users can go
to if they forget the password for their WorkSpace.
$sel:loginMessage:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_loginMessage - The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
$sel:logo:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_logo - The logo. The only image format accepted is a binary data object that is
converted from a .png file.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:supportEmail:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_supportEmail - The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
$sel:supportLink:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_supportLink - The support link. The link for the company's customer support page for
their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
defaultImportClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
defaultImportClientBrandingAttributes_loginMessage :: Lens' DefaultImportClientBrandingAttributes (Maybe (HashMap Text Text)) Source #
The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
defaultImportClientBrandingAttributes_logo :: Lens' DefaultImportClientBrandingAttributes (Maybe ByteString) Source #
The logo. The only image format accepted is a binary data object that is
converted from a .png file.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
defaultImportClientBrandingAttributes_supportEmail :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #
The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
defaultImportClientBrandingAttributes_supportLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #
The support link. The link for the company's customer support page for their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
DefaultWorkspaceCreationProperties
data DefaultWorkspaceCreationProperties Source #
Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
See: newDefaultWorkspaceCreationProperties smart constructor.
Constructors
| DefaultWorkspaceCreationProperties' | |
Fields
| |
Instances
newDefaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties Source #
Create a value of DefaultWorkspaceCreationProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customSecurityGroupId:DefaultWorkspaceCreationProperties', defaultWorkspaceCreationProperties_customSecurityGroupId - The identifier of the default security group to apply to WorkSpaces when
they are created. For more information, see
Security Groups for Your WorkSpaces.
$sel:defaultOu:DefaultWorkspaceCreationProperties', defaultWorkspaceCreationProperties_defaultOu - The organizational unit (OU) in the directory for the WorkSpace machine
accounts.
$sel:enableInternetAccess:DefaultWorkspaceCreationProperties', defaultWorkspaceCreationProperties_enableInternetAccess - Specifies whether to automatically assign an Elastic public IP address
to WorkSpaces in this directory by default. If enabled, the Elastic
public IP address allows outbound internet access from your WorkSpaces
when you’re using an internet gateway in the Amazon VPC in which your
WorkSpaces are located. If you're using a Network Address Translation
(NAT) gateway for outbound internet access from your VPC, or if your
WorkSpaces are in public subnets and you manually assign them Elastic IP
addresses, you should disable this setting. This setting applies to new
WorkSpaces that you launch or to existing WorkSpaces that you rebuild.
For more information, see
Configure a VPC for Amazon WorkSpaces.
$sel:enableMaintenanceMode:DefaultWorkspaceCreationProperties', defaultWorkspaceCreationProperties_enableMaintenanceMode - Specifies whether maintenance mode is enabled for WorkSpaces. For more
information, see
WorkSpace Maintenance.
$sel:enableWorkDocs:DefaultWorkspaceCreationProperties', defaultWorkspaceCreationProperties_enableWorkDocs - Specifies whether the directory is enabled for Amazon WorkDocs.
$sel:userEnabledAsLocalAdministrator:DefaultWorkspaceCreationProperties', defaultWorkspaceCreationProperties_userEnabledAsLocalAdministrator - Specifies whether WorkSpace users are local administrators on their
WorkSpaces.
defaultWorkspaceCreationProperties_customSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
defaultWorkspaceCreationProperties_defaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
defaultWorkspaceCreationProperties_enableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
defaultWorkspaceCreationProperties_enableMaintenanceMode :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
defaultWorkspaceCreationProperties_enableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether the directory is enabled for Amazon WorkDocs.
defaultWorkspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether WorkSpace users are local administrators on their WorkSpaces.
FailedCreateStandbyWorkspacesRequest
data FailedCreateStandbyWorkspacesRequest Source #
Describes the Standby WorkSpace that could not be created.
See: newFailedCreateStandbyWorkspacesRequest smart constructor.
Constructors
| FailedCreateStandbyWorkspacesRequest' | |
Fields
| |
Instances
newFailedCreateStandbyWorkspacesRequest :: FailedCreateStandbyWorkspacesRequest Source #
Create a value of FailedCreateStandbyWorkspacesRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:FailedCreateStandbyWorkspacesRequest', failedCreateStandbyWorkspacesRequest_errorCode - The error code that is returned if the Standby WorkSpace could not be
created.
$sel:errorMessage:FailedCreateStandbyWorkspacesRequest', failedCreateStandbyWorkspacesRequest_errorMessage - The text of the error message that is returned if the Standby WorkSpace
could not be created.
$sel:standbyWorkspaceRequest:FailedCreateStandbyWorkspacesRequest', failedCreateStandbyWorkspacesRequest_standbyWorkspaceRequest - Information about the Standby WorkSpace that could not be created.
failedCreateStandbyWorkspacesRequest_errorCode :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe Text) Source #
The error code that is returned if the Standby WorkSpace could not be created.
failedCreateStandbyWorkspacesRequest_errorMessage :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe Text) Source #
The text of the error message that is returned if the Standby WorkSpace could not be created.
failedCreateStandbyWorkspacesRequest_standbyWorkspaceRequest :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe StandbyWorkspace) Source #
Information about the Standby WorkSpace that could not be created.
FailedCreateWorkspaceRequest
data FailedCreateWorkspaceRequest Source #
Describes a WorkSpace that cannot be created.
See: newFailedCreateWorkspaceRequest smart constructor.
Constructors
| FailedCreateWorkspaceRequest' | |
Fields
| |
Instances
newFailedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest Source #
Create a value of FailedCreateWorkspaceRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:FailedCreateWorkspaceRequest', failedCreateWorkspaceRequest_errorCode - The error code that is returned if the WorkSpace cannot be created.
$sel:errorMessage:FailedCreateWorkspaceRequest', failedCreateWorkspaceRequest_errorMessage - The text of the error message that is returned if the WorkSpace cannot
be created.
$sel:workspaceRequest:FailedCreateWorkspaceRequest', failedCreateWorkspaceRequest_workspaceRequest - Information about the WorkSpace.
failedCreateWorkspaceRequest_errorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #
The error code that is returned if the WorkSpace cannot be created.
failedCreateWorkspaceRequest_errorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #
The text of the error message that is returned if the WorkSpace cannot be created.
failedCreateWorkspaceRequest_workspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest) Source #
Information about the WorkSpace.
FailedWorkspaceChangeRequest
data FailedWorkspaceChangeRequest Source #
Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
See: newFailedWorkspaceChangeRequest smart constructor.
Constructors
| FailedWorkspaceChangeRequest' | |
Fields
| |
Instances
newFailedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest Source #
Create a value of FailedWorkspaceChangeRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:FailedWorkspaceChangeRequest', failedWorkspaceChangeRequest_errorCode - The error code that is returned if the WorkSpace cannot be rebooted.
$sel:errorMessage:FailedWorkspaceChangeRequest', failedWorkspaceChangeRequest_errorMessage - The text of the error message that is returned if the WorkSpace cannot
be rebooted.
$sel:workspaceId:FailedWorkspaceChangeRequest', failedWorkspaceChangeRequest_workspaceId - The identifier of the WorkSpace.
failedWorkspaceChangeRequest_errorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #
The error code that is returned if the WorkSpace cannot be rebooted.
failedWorkspaceChangeRequest_errorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #
The text of the error message that is returned if the WorkSpace cannot be rebooted.
failedWorkspaceChangeRequest_workspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #
The identifier of the WorkSpace.
ImagePermission
data ImagePermission Source #
Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
See: newImagePermission smart constructor.
Constructors
| ImagePermission' | |
Fields
| |
Instances
newImagePermission :: ImagePermission Source #
Create a value of ImagePermission with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sharedAccountId:ImagePermission', imagePermission_sharedAccountId - The identifier of the Amazon Web Services account that an image has been
shared with.
imagePermission_sharedAccountId :: Lens' ImagePermission (Maybe Text) Source #
The identifier of the Amazon Web Services account that an image has been shared with.
IosClientBrandingAttributes
data IosClientBrandingAttributes Source #
The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.
Client branding attributes are public facing. Ensure you do not include sensitive information.
See: newIosClientBrandingAttributes smart constructor.
Constructors
| IosClientBrandingAttributes' | |
Fields
| |
Instances
newIosClientBrandingAttributes :: IosClientBrandingAttributes Source #
Create a value of IosClientBrandingAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forgotPasswordLink:IosClientBrandingAttributes', iosClientBrandingAttributes_forgotPasswordLink - The forgotten password link. This is the web address that users can go
to if they forget the password for their WorkSpace.
$sel:loginMessage:IosClientBrandingAttributes', iosClientBrandingAttributes_loginMessage - The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
$sel:logo2xUrl:IosClientBrandingAttributes', iosClientBrandingAttributes_logo2xUrl - The @2x version of the logo. This is the higher resolution display that
offers a scale factor of 2.0 (or @2x). The only image format accepted
is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
$sel:logo3xUrl:IosClientBrandingAttributes', iosClientBrandingAttributes_logo3xUrl - The @3x version of the logo. This is the higher resolution display that
offers a scale factor of 3.0 (or @3x).The only image format accepted is
a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
$sel:logoUrl:IosClientBrandingAttributes', iosClientBrandingAttributes_logoUrl - The logo. This is the standard-resolution display that has a 1:1 pixel
density (or @1x), where one pixel is equal to one point. The only image
format accepted is a binary data object that is converted from a .png
file.
$sel:supportEmail:IosClientBrandingAttributes', iosClientBrandingAttributes_supportEmail - The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
$sel:supportLink:IosClientBrandingAttributes', iosClientBrandingAttributes_supportLink - The support link. The link for the company's customer support page for
their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
iosClientBrandingAttributes_forgotPasswordLink :: Lens' IosClientBrandingAttributes (Maybe Text) Source #
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
iosClientBrandingAttributes_loginMessage :: Lens' IosClientBrandingAttributes (Maybe (HashMap Text Text)) Source #
The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
iosClientBrandingAttributes_logo2xUrl :: Lens' IosClientBrandingAttributes (Maybe Text) Source #
The @2x version of the logo. This is the higher resolution display that
offers a scale factor of 2.0 (or @2x). The only image format accepted
is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
iosClientBrandingAttributes_logo3xUrl :: Lens' IosClientBrandingAttributes (Maybe Text) Source #
The @3x version of the logo. This is the higher resolution display that
offers a scale factor of 3.0 (or @3x).The only image format accepted is
a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
iosClientBrandingAttributes_logoUrl :: Lens' IosClientBrandingAttributes (Maybe Text) Source #
The logo. This is the standard-resolution display that has a 1:1 pixel
density (or @1x), where one pixel is equal to one point. The only image
format accepted is a binary data object that is converted from a .png
file.
iosClientBrandingAttributes_supportEmail :: Lens' IosClientBrandingAttributes (Maybe Text) Source #
The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
iosClientBrandingAttributes_supportLink :: Lens' IosClientBrandingAttributes (Maybe Text) Source #
The support link. The link for the company's customer support page for their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
IosImportClientBrandingAttributes
data IosImportClientBrandingAttributes Source #
The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.
Client branding attributes are public facing. Ensure you do not include sensitive information.
See: newIosImportClientBrandingAttributes smart constructor.
Constructors
| IosImportClientBrandingAttributes' | |
Fields
| |
Instances
newIosImportClientBrandingAttributes :: IosImportClientBrandingAttributes Source #
Create a value of IosImportClientBrandingAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forgotPasswordLink:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_forgotPasswordLink - The forgotten password link. This is the web address that users can go
to if they forget the password for their WorkSpace.
$sel:loginMessage:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_loginMessage - The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
$sel:logo:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_logo - The logo. This is the standard-resolution display that has a 1:1 pixel
density (or @1x), where one pixel is equal to one point. The only image
format accepted is a binary data object that is converted from a .png
file.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:logo2x:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_logo2x - The @2x version of the logo. This is the higher resolution display that
offers a scale factor of 2.0 (or @2x). The only image format accepted
is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see
Image Size and Resolution
in the Apple Human Interface Guidelines.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:logo3x:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_logo3x - The @3x version of the logo. This is the higher resolution display that
offers a scale factor of 3.0 (or @3x). The only image format accepted
is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see
Image Size and Resolution
in the Apple Human Interface Guidelines.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:supportEmail:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_supportEmail - The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
$sel:supportLink:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_supportLink - The support link. The link for the company's customer support page for
their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
iosImportClientBrandingAttributes_forgotPasswordLink :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
iosImportClientBrandingAttributes_loginMessage :: Lens' IosImportClientBrandingAttributes (Maybe (HashMap Text Text)) Source #
The login message. Specified as a key value pair, in which the key is a
locale and the value is the localized message for that locale. The only
key supported is en_US. The HTML tags supported include the following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
iosImportClientBrandingAttributes_logo :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #
The logo. This is the standard-resolution display that has a 1:1 pixel
density (or @1x), where one pixel is equal to one point. The only image
format accepted is a binary data object that is converted from a .png
file.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
iosImportClientBrandingAttributes_logo2x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #
The @2x version of the logo. This is the higher resolution display that
offers a scale factor of 2.0 (or @2x). The only image format accepted
is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see
Image Size and Resolution
in the Apple Human Interface Guidelines.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
iosImportClientBrandingAttributes_logo3x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #
The @3x version of the logo. This is the higher resolution display that
offers a scale factor of 3.0 (or @3x). The only image format accepted
is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see
Image Size and Resolution
in the Apple Human Interface Guidelines.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
iosImportClientBrandingAttributes_supportEmail :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #
The support email. The company's customer support email address.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default email is
workspaces-feedback@amazon.com.
iosImportClientBrandingAttributes_supportLink :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #
The support link. The link for the company's customer support page for their WorkSpace.
- In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. - The default support link is
workspaces-feedback@amazon.com.
IpRuleItem
data IpRuleItem Source #
Describes a rule for an IP access control group.
See: newIpRuleItem smart constructor.
Constructors
| IpRuleItem' | |
Instances
newIpRuleItem :: IpRuleItem Source #
Create a value of IpRuleItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipRule:IpRuleItem', ipRuleItem_ipRule - The IP address range, in CIDR notation.
$sel:ruleDesc:IpRuleItem', ipRuleItem_ruleDesc - The description.
ipRuleItem_ipRule :: Lens' IpRuleItem (Maybe Text) Source #
The IP address range, in CIDR notation.
ipRuleItem_ruleDesc :: Lens' IpRuleItem (Maybe Text) Source #
The description.
ModificationState
data ModificationState Source #
Describes a WorkSpace modification.
See: newModificationState smart constructor.
Constructors
| ModificationState' | |
Fields
| |
Instances
newModificationState :: ModificationState Source #
Create a value of ModificationState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resource:ModificationState', modificationState_resource - The resource.
$sel:state:ModificationState', modificationState_state - The modification state.
modificationState_resource :: Lens' ModificationState (Maybe ModificationResourceEnum) Source #
The resource.
modificationState_state :: Lens' ModificationState (Maybe ModificationStateEnum) Source #
The modification state.
OperatingSystem
data OperatingSystem Source #
The operating system that the image is running.
See: newOperatingSystem smart constructor.
Constructors
| OperatingSystem' | |
Fields
| |
Instances
newOperatingSystem :: OperatingSystem Source #
Create a value of OperatingSystem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':OperatingSystem', operatingSystem_type - The operating system.
operatingSystem_type :: Lens' OperatingSystem (Maybe OperatingSystemType) Source #
The operating system.
PendingCreateStandbyWorkspacesRequest
data PendingCreateStandbyWorkspacesRequest Source #
Information about the Standby WorkSpace.
See: newPendingCreateStandbyWorkspacesRequest smart constructor.
Constructors
| PendingCreateStandbyWorkspacesRequest' | |
Fields
| |
Instances
newPendingCreateStandbyWorkspacesRequest :: PendingCreateStandbyWorkspacesRequest Source #
Create a value of PendingCreateStandbyWorkspacesRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryId:PendingCreateStandbyWorkspacesRequest', pendingCreateStandbyWorkspacesRequest_directoryId - The identifier of the directory for the Standby WorkSpace.
$sel:state:PendingCreateStandbyWorkspacesRequest', pendingCreateStandbyWorkspacesRequest_state - The operational state of the Standby WorkSpace.
$sel:userName:PendingCreateStandbyWorkspacesRequest', pendingCreateStandbyWorkspacesRequest_userName - Describes the Standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
$sel:workspaceId:PendingCreateStandbyWorkspacesRequest', pendingCreateStandbyWorkspacesRequest_workspaceId - The identifier of the Standby WorkSpace.
pendingCreateStandbyWorkspacesRequest_directoryId :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text) Source #
The identifier of the directory for the Standby WorkSpace.
pendingCreateStandbyWorkspacesRequest_state :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe WorkspaceState) Source #
The operational state of the Standby WorkSpace.
pendingCreateStandbyWorkspacesRequest_userName :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text) Source #
Describes the Standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
pendingCreateStandbyWorkspacesRequest_workspaceId :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text) Source #
The identifier of the Standby WorkSpace.
RebootRequest
data RebootRequest Source #
Describes the information used to reboot a WorkSpace.
See: newRebootRequest smart constructor.
Constructors
| RebootRequest' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RebootRequest |
Create a value of RebootRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:RebootRequest', rebootRequest_workspaceId - The identifier of the WorkSpace.
rebootRequest_workspaceId :: Lens' RebootRequest Text Source #
The identifier of the WorkSpace.
RebuildRequest
data RebuildRequest Source #
Describes the information used to rebuild a WorkSpace.
See: newRebuildRequest smart constructor.
Constructors
| RebuildRequest' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RebuildRequest |
Create a value of RebuildRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:RebuildRequest', rebuildRequest_workspaceId - The identifier of the WorkSpace.
rebuildRequest_workspaceId :: Lens' RebuildRequest Text Source #
The identifier of the WorkSpace.
RelatedWorkspaceProperties
data RelatedWorkspaceProperties Source #
Describes the related WorkSpace. The related WorkSpace could be a Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.
See: newRelatedWorkspaceProperties smart constructor.
Constructors
| RelatedWorkspaceProperties' | |
Fields
| |
Instances
newRelatedWorkspaceProperties :: RelatedWorkspaceProperties Source #
Create a value of RelatedWorkspaceProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:region:RelatedWorkspaceProperties', relatedWorkspaceProperties_region - The Region of the related WorkSpace.
$sel:state:RelatedWorkspaceProperties', relatedWorkspaceProperties_state - Indicates the state of the WorkSpace.
$sel:type':RelatedWorkspaceProperties', relatedWorkspaceProperties_type - Indicates the type of WorkSpace.
$sel:workspaceId:RelatedWorkspaceProperties', relatedWorkspaceProperties_workspaceId - The identifier of the related WorkSpace.
relatedWorkspaceProperties_region :: Lens' RelatedWorkspaceProperties (Maybe Text) Source #
The Region of the related WorkSpace.
relatedWorkspaceProperties_state :: Lens' RelatedWorkspaceProperties (Maybe WorkspaceState) Source #
Indicates the state of the WorkSpace.
relatedWorkspaceProperties_type :: Lens' RelatedWorkspaceProperties (Maybe StandbyWorkspaceRelationshipType) Source #
Indicates the type of WorkSpace.
relatedWorkspaceProperties_workspaceId :: Lens' RelatedWorkspaceProperties (Maybe Text) Source #
The identifier of the related WorkSpace.
RootStorage
data RootStorage Source #
Describes the root volume for a WorkSpace bundle.
See: newRootStorage smart constructor.
Constructors
| RootStorage' | |
Instances
newRootStorage :: RootStorage Source #
Create a value of RootStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacity:RootStorage', rootStorage_capacity - The size of the root volume.
rootStorage_capacity :: Lens' RootStorage (Maybe Text) Source #
The size of the root volume.
SamlProperties
data SamlProperties Source #
Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
See: newSamlProperties smart constructor.
Constructors
| SamlProperties' | |
Fields
| |
Instances
newSamlProperties :: SamlProperties Source #
Create a value of SamlProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relayStateParameterName:SamlProperties', samlProperties_relayStateParameterName - The relay state parameter name supported by the SAML 2.0 identity
provider (IdP). When the end user is redirected to the user access URL
from the WorkSpaces client application, this relay state parameter name
is appended as a query parameter to the URL along with the relay state
endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
$sel:status:SamlProperties', samlProperties_status - Indicates the status of SAML 2.0 authentication. These statuses include
the following.
- If the setting is
DISABLED, end users will be directed to login with their directory credentials. - If the setting is
ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect. - If the setting is
ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
$sel:userAccessUrl:SamlProperties', samlProperties_userAccessUrl - The SAML 2.0 identity provider (IdP) user access URL is the URL a user
would navigate to in their web browser in order to federate from the IdP
and directly access the application, without any SAML 2.0 service
provider (SP) bindings.
samlProperties_relayStateParameterName :: Lens' SamlProperties (Maybe Text) Source #
The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
samlProperties_status :: Lens' SamlProperties (Maybe SamlStatusEnum) Source #
Indicates the status of SAML 2.0 authentication. These statuses include the following.
- If the setting is
DISABLED, end users will be directed to login with their directory credentials. - If the setting is
ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect. - If the setting is
ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
samlProperties_userAccessUrl :: Lens' SamlProperties (Maybe Text) Source #
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
SelfservicePermissions
data SelfservicePermissions Source #
Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
See: newSelfservicePermissions smart constructor.
Constructors
| SelfservicePermissions' | |
Fields
| |
Instances
newSelfservicePermissions :: SelfservicePermissions Source #
Create a value of SelfservicePermissions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:changeComputeType:SelfservicePermissions', selfservicePermissions_changeComputeType - Specifies whether users can change the compute type (bundle) for their
WorkSpace.
$sel:increaseVolumeSize:SelfservicePermissions', selfservicePermissions_increaseVolumeSize - Specifies whether users can increase the volume size of the drives on
their WorkSpace.
$sel:rebuildWorkspace:SelfservicePermissions', selfservicePermissions_rebuildWorkspace - Specifies whether users can rebuild the operating system of a WorkSpace
to its original state.
$sel:restartWorkspace:SelfservicePermissions', selfservicePermissions_restartWorkspace - Specifies whether users can restart their WorkSpace.
$sel:switchRunningMode:SelfservicePermissions', selfservicePermissions_switchRunningMode - Specifies whether users can switch the running mode of their WorkSpace.
selfservicePermissions_changeComputeType :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can change the compute type (bundle) for their WorkSpace.
selfservicePermissions_increaseVolumeSize :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can increase the volume size of the drives on their WorkSpace.
selfservicePermissions_rebuildWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
selfservicePermissions_restartWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can restart their WorkSpace.
selfservicePermissions_switchRunningMode :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can switch the running mode of their WorkSpace.
Snapshot
Describes a snapshot.
See: newSnapshot smart constructor.
Constructors
| Snapshot' | |
Fields
| |
Instances
| FromJSON Snapshot Source # | |
| Generic Snapshot Source # | |
| Read Snapshot Source # | |
| Show Snapshot Source # | |
| NFData Snapshot Source # | |
Defined in Amazonka.WorkSpaces.Types.Snapshot | |
| Eq Snapshot Source # | |
| Hashable Snapshot Source # | |
Defined in Amazonka.WorkSpaces.Types.Snapshot | |
| type Rep Snapshot Source # | |
Defined in Amazonka.WorkSpaces.Types.Snapshot | |
newSnapshot :: Snapshot Source #
Create a value of Snapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshotTime:Snapshot', snapshot_snapshotTime - The time when the snapshot was created.
snapshot_snapshotTime :: Lens' Snapshot (Maybe UTCTime) Source #
The time when the snapshot was created.
StandbyWorkspace
data StandbyWorkspace Source #
Describes a Standby WorkSpace.
See: newStandbyWorkspace smart constructor.
Constructors
| StandbyWorkspace' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StandbyWorkspace |
Create a value of StandbyWorkspace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:StandbyWorkspace', standbyWorkspace_tags - The tags associated with the Standby WorkSpace.
$sel:volumeEncryptionKey:StandbyWorkspace', standbyWorkspace_volumeEncryptionKey - The volume encryption key of the Standby WorkSpace.
$sel:primaryWorkspaceId:StandbyWorkspace', standbyWorkspace_primaryWorkspaceId - The identifier of the Standby WorkSpace.
$sel:directoryId:StandbyWorkspace', standbyWorkspace_directoryId - The identifier of the directory for the Standby WorkSpace.
standbyWorkspace_tags :: Lens' StandbyWorkspace (Maybe [Tag]) Source #
The tags associated with the Standby WorkSpace.
standbyWorkspace_volumeEncryptionKey :: Lens' StandbyWorkspace (Maybe Text) Source #
The volume encryption key of the Standby WorkSpace.
standbyWorkspace_primaryWorkspaceId :: Lens' StandbyWorkspace Text Source #
The identifier of the Standby WorkSpace.
standbyWorkspace_directoryId :: Lens' StandbyWorkspace Text Source #
The identifier of the directory for the Standby WorkSpace.
StartRequest
data StartRequest Source #
Information used to start a WorkSpace.
See: newStartRequest smart constructor.
Constructors
| StartRequest' | |
Fields
| |
Instances
newStartRequest :: StartRequest Source #
Create a value of StartRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:StartRequest', startRequest_workspaceId - The identifier of the WorkSpace.
startRequest_workspaceId :: Lens' StartRequest (Maybe Text) Source #
The identifier of the WorkSpace.
StopRequest
data StopRequest Source #
Describes the information used to stop a WorkSpace.
See: newStopRequest smart constructor.
Constructors
| StopRequest' | |
Fields
| |
Instances
newStopRequest :: StopRequest Source #
Create a value of StopRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:StopRequest', stopRequest_workspaceId - The identifier of the WorkSpace.
stopRequest_workspaceId :: Lens' StopRequest (Maybe Text) Source #
The identifier of the WorkSpace.
Tag
Describes a tag.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.WorkSpaces.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.WorkSpaces.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.WorkSpaces.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.WorkSpaces.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.WorkSpaces.Types.Tag" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag', tag_value - The value of the tag.
$sel:key:Tag', tag_key - The key of the tag.
TerminateRequest
data TerminateRequest Source #
Describes the information used to terminate a WorkSpace.
See: newTerminateRequest smart constructor.
Constructors
| TerminateRequest' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> TerminateRequest |
Create a value of TerminateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:TerminateRequest', terminateRequest_workspaceId - The identifier of the WorkSpace.
terminateRequest_workspaceId :: Lens' TerminateRequest Text Source #
The identifier of the WorkSpace.
UpdateResult
data UpdateResult Source #
Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.
Only Windows 10 WorkSpace images can be programmatically updated at this time.
See: newUpdateResult smart constructor.
Constructors
| UpdateResult' | |
Fields
| |
Instances
newUpdateResult :: UpdateResult Source #
Create a value of UpdateResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:UpdateResult', updateResult_description - A description of whether updates for the WorkSpace image are pending or
available.
$sel:updateAvailable:UpdateResult', updateResult_updateAvailable - Indicates whether updated drivers or other components are available for
the specified WorkSpace image.
updateResult_description :: Lens' UpdateResult (Maybe Text) Source #
A description of whether updates for the WorkSpace image are pending or available.
updateResult_updateAvailable :: Lens' UpdateResult (Maybe Bool) Source #
Indicates whether updated drivers or other components are available for the specified WorkSpace image.
UserStorage
data UserStorage Source #
Describes the user volume for a WorkSpace bundle.
See: newUserStorage smart constructor.
Constructors
| UserStorage' | |
Instances
newUserStorage :: UserStorage Source #
Create a value of UserStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacity:UserStorage', userStorage_capacity - The size of the user volume.
userStorage_capacity :: Lens' UserStorage (Maybe Text) Source #
The size of the user volume.
Workspace
Describes a WorkSpace.
See: newWorkspace smart constructor.
Constructors
| Workspace' | |
Fields
| |
Instances
newWorkspace :: Workspace Source #
Create a value of Workspace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bundleId:Workspace', workspace_bundleId - The identifier of the bundle used to create the WorkSpace.
$sel:computerName:Workspace', workspace_computerName - The name of the WorkSpace, as seen by the operating system. The format
of this name varies. For more information, see
Launch a WorkSpace.
$sel:directoryId:Workspace', workspace_directoryId - The identifier of the Directory Service directory for the WorkSpace.
$sel:errorCode:Workspace', workspace_errorCode - The error code that is returned if the WorkSpace cannot be created.
$sel:errorMessage:Workspace', workspace_errorMessage - The text of the error message that is returned if the WorkSpace cannot
be created.
$sel:ipAddress:Workspace', workspace_ipAddress - The IP address of the WorkSpace.
$sel:modificationStates:Workspace', workspace_modificationStates - The modification states of the WorkSpace.
$sel:relatedWorkspaces:Workspace', workspace_relatedWorkspaces - The Standby WorkSpace or Primary WorkSpace related to the specified
WorkSpace.
$sel:rootVolumeEncryptionEnabled:Workspace', workspace_rootVolumeEncryptionEnabled - Indicates whether the data stored on the root volume is encrypted.
Workspace, workspace_state - The operational state of the WorkSpace.
After a WorkSpace is terminated, the TERMINATED state is returned only
briefly before the WorkSpace directory metadata is cleaned up, so this
state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using
DescribeWorkSpaces.
If the WorkSpace ID isn't returned, then the WorkSpace has been
successfully terminated.
$sel:subnetId:Workspace', workspace_subnetId - The identifier of the subnet for the WorkSpace.
$sel:userName:Workspace', workspace_userName - The user for the WorkSpace.
$sel:userVolumeEncryptionEnabled:Workspace', workspace_userVolumeEncryptionEnabled - Indicates whether the data stored on the user volume is encrypted.
$sel:volumeEncryptionKey:Workspace', workspace_volumeEncryptionKey - The symmetric KMS key used to encrypt data stored on your WorkSpace.
Amazon WorkSpaces does not support asymmetric KMS keys.
Workspace, workspace_workspaceId - The identifier of the WorkSpace.
$sel:workspaceProperties:Workspace', workspace_workspaceProperties - The properties of the WorkSpace.
workspace_bundleId :: Lens' Workspace (Maybe Text) Source #
The identifier of the bundle used to create the WorkSpace.
workspace_computerName :: Lens' Workspace (Maybe Text) Source #
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
workspace_directoryId :: Lens' Workspace (Maybe Text) Source #
The identifier of the Directory Service directory for the WorkSpace.
workspace_errorCode :: Lens' Workspace (Maybe Text) Source #
The error code that is returned if the WorkSpace cannot be created.
workspace_errorMessage :: Lens' Workspace (Maybe Text) Source #
The text of the error message that is returned if the WorkSpace cannot be created.
workspace_modificationStates :: Lens' Workspace (Maybe [ModificationState]) Source #
The modification states of the WorkSpace.
workspace_relatedWorkspaces :: Lens' Workspace (Maybe [RelatedWorkspaceProperties]) Source #
The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.
workspace_rootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #
Indicates whether the data stored on the root volume is encrypted.
workspace_state :: Lens' Workspace (Maybe WorkspaceState) Source #
The operational state of the WorkSpace.
After a WorkSpace is terminated, the TERMINATED state is returned only
briefly before the WorkSpace directory metadata is cleaned up, so this
state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using
DescribeWorkSpaces.
If the WorkSpace ID isn't returned, then the WorkSpace has been
successfully terminated.
workspace_subnetId :: Lens' Workspace (Maybe Text) Source #
The identifier of the subnet for the WorkSpace.
workspace_userVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #
Indicates whether the data stored on the user volume is encrypted.
workspace_volumeEncryptionKey :: Lens' Workspace (Maybe Text) Source #
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspace_workspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties) Source #
The properties of the WorkSpace.
WorkspaceAccessProperties
data WorkspaceAccessProperties Source #
The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.
See: newWorkspaceAccessProperties smart constructor.
Constructors
| WorkspaceAccessProperties' | |
Fields
| |
Instances
newWorkspaceAccessProperties :: WorkspaceAccessProperties Source #
Create a value of WorkspaceAccessProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceTypeAndroid:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeAndroid - Indicates whether users can use Android and Android-compatible Chrome OS
devices to access their WorkSpaces.
$sel:deviceTypeChromeOs:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeChromeOs - Indicates whether users can use Chromebooks to access their WorkSpaces.
$sel:deviceTypeIos:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeIos - Indicates whether users can use iOS devices to access their WorkSpaces.
$sel:deviceTypeLinux:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeLinux - Indicates whether users can use Linux clients to access their
WorkSpaces.
$sel:deviceTypeOsx:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeOsx - Indicates whether users can use macOS clients to access their
WorkSpaces.
$sel:deviceTypeWeb:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeWeb - Indicates whether users can access their WorkSpaces through a web
browser.
$sel:deviceTypeWindows:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeWindows - Indicates whether users can use Windows clients to access their
WorkSpaces.
$sel:deviceTypeZeroClient:WorkspaceAccessProperties', workspaceAccessProperties_deviceTypeZeroClient - Indicates whether users can use zero client devices to access their
WorkSpaces.
workspaceAccessProperties_deviceTypeAndroid :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
workspaceAccessProperties_deviceTypeChromeOs :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Chromebooks to access their WorkSpaces.
workspaceAccessProperties_deviceTypeIos :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use iOS devices to access their WorkSpaces.
workspaceAccessProperties_deviceTypeLinux :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Linux clients to access their WorkSpaces.
workspaceAccessProperties_deviceTypeOsx :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use macOS clients to access their WorkSpaces.
workspaceAccessProperties_deviceTypeWeb :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can access their WorkSpaces through a web browser.
workspaceAccessProperties_deviceTypeWindows :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Windows clients to access their WorkSpaces.
workspaceAccessProperties_deviceTypeZeroClient :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use zero client devices to access their WorkSpaces.
WorkspaceBundle
data WorkspaceBundle Source #
Describes a WorkSpace bundle.
See: newWorkspaceBundle smart constructor.
Constructors
| WorkspaceBundle' | |
Fields
| |
Instances
newWorkspaceBundle :: WorkspaceBundle Source #
Create a value of WorkspaceBundle with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bundleId:WorkspaceBundle', workspaceBundle_bundleId - The identifier of the bundle.
$sel:bundleType:WorkspaceBundle', workspaceBundle_bundleType - The type of WorkSpace bundle.
$sel:computeType:WorkspaceBundle', workspaceBundle_computeType - The compute type of the bundle. For more information, see
Amazon WorkSpaces Bundles.
$sel:creationTime:WorkspaceBundle', workspaceBundle_creationTime - The time when the bundle was created.
$sel:description:WorkspaceBundle', workspaceBundle_description - The description of the bundle.
$sel:imageId:WorkspaceBundle', workspaceBundle_imageId - The identifier of the image that was used to create the bundle.
$sel:lastUpdatedTime:WorkspaceBundle', workspaceBundle_lastUpdatedTime - The last time that the bundle was updated.
WorkspaceBundle, workspaceBundle_name - The name of the bundle.
$sel:owner:WorkspaceBundle', workspaceBundle_owner - The owner of the bundle. This is the account identifier of the owner, or
AMAZON if the bundle is provided by Amazon Web Services.
$sel:rootStorage:WorkspaceBundle', workspaceBundle_rootStorage - The size of the root volume.
$sel:state:WorkspaceBundle', workspaceBundle_state - The state of the WorkSpace bundle.
$sel:userStorage:WorkspaceBundle', workspaceBundle_userStorage - The size of the user volume.
workspaceBundle_bundleId :: Lens' WorkspaceBundle (Maybe Text) Source #
The identifier of the bundle.
workspaceBundle_bundleType :: Lens' WorkspaceBundle (Maybe BundleType) Source #
The type of WorkSpace bundle.
workspaceBundle_computeType :: Lens' WorkspaceBundle (Maybe ComputeType) Source #
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
workspaceBundle_creationTime :: Lens' WorkspaceBundle (Maybe UTCTime) Source #
The time when the bundle was created.
workspaceBundle_description :: Lens' WorkspaceBundle (Maybe Text) Source #
The description of the bundle.
workspaceBundle_imageId :: Lens' WorkspaceBundle (Maybe Text) Source #
The identifier of the image that was used to create the bundle.
workspaceBundle_lastUpdatedTime :: Lens' WorkspaceBundle (Maybe UTCTime) Source #
The last time that the bundle was updated.
workspaceBundle_name :: Lens' WorkspaceBundle (Maybe Text) Source #
The name of the bundle.
workspaceBundle_owner :: 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 Amazon Web Services.
workspaceBundle_rootStorage :: Lens' WorkspaceBundle (Maybe RootStorage) Source #
The size of the root volume.
workspaceBundle_state :: Lens' WorkspaceBundle (Maybe WorkspaceBundleState) Source #
The state of the WorkSpace bundle.
workspaceBundle_userStorage :: Lens' WorkspaceBundle (Maybe UserStorage) Source #
The size of the user volume.
WorkspaceConnectionStatus
data WorkspaceConnectionStatus Source #
Describes the connection status of a WorkSpace.
See: newWorkspaceConnectionStatus smart constructor.
Constructors
| WorkspaceConnectionStatus' | |
Fields
| |
Instances
newWorkspaceConnectionStatus :: WorkspaceConnectionStatus Source #
Create a value of WorkspaceConnectionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionState:WorkspaceConnectionStatus', workspaceConnectionStatus_connectionState - The connection state of the WorkSpace. The connection state is unknown
if the WorkSpace is stopped.
$sel:connectionStateCheckTimestamp:WorkspaceConnectionStatus', workspaceConnectionStatus_connectionStateCheckTimestamp - The timestamp of the connection status check.
$sel:lastKnownUserConnectionTimestamp:WorkspaceConnectionStatus', workspaceConnectionStatus_lastKnownUserConnectionTimestamp - The timestamp of the last known user connection.
$sel:workspaceId:WorkspaceConnectionStatus', workspaceConnectionStatus_workspaceId - The identifier of the WorkSpace.
workspaceConnectionStatus_connectionState :: Lens' WorkspaceConnectionStatus (Maybe ConnectionState) Source #
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
workspaceConnectionStatus_connectionStateCheckTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #
The timestamp of the connection status check.
workspaceConnectionStatus_lastKnownUserConnectionTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #
The timestamp of the last known user connection.
workspaceConnectionStatus_workspaceId :: Lens' WorkspaceConnectionStatus (Maybe Text) Source #
The identifier of the WorkSpace.
WorkspaceCreationProperties
data WorkspaceCreationProperties Source #
Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
See: newWorkspaceCreationProperties smart constructor.
Constructors
| WorkspaceCreationProperties' | |
Fields
| |
Instances
newWorkspaceCreationProperties :: WorkspaceCreationProperties Source #
Create a value of WorkspaceCreationProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customSecurityGroupId:WorkspaceCreationProperties', workspaceCreationProperties_customSecurityGroupId - The identifier of your custom security group.
$sel:defaultOu:WorkspaceCreationProperties', workspaceCreationProperties_defaultOu - The default organizational unit (OU) for your WorkSpaces directories.
This string must be the full Lightweight Directory Access Protocol
(LDAP) distinguished name for the target domain and OU. It must be in
the form "OU=value,DC=value,DC=value", where
value is any string of characters, and the number of domain components
(DCs) is two or more. For example,
OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
- To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
- The API doesn't validate whether the OU exists.
$sel:enableInternetAccess:WorkspaceCreationProperties', workspaceCreationProperties_enableInternetAccess - Indicates whether internet access is enabled for your WorkSpaces.
$sel:enableMaintenanceMode:WorkspaceCreationProperties', workspaceCreationProperties_enableMaintenanceMode - Indicates whether maintenance mode is enabled for your WorkSpaces. For
more information, see
WorkSpace Maintenance.
$sel:enableWorkDocs:WorkspaceCreationProperties', workspaceCreationProperties_enableWorkDocs - Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
$sel:userEnabledAsLocalAdministrator:WorkspaceCreationProperties', workspaceCreationProperties_userEnabledAsLocalAdministrator - Indicates whether users are local administrators of their WorkSpaces.
workspaceCreationProperties_customSecurityGroupId :: Lens' WorkspaceCreationProperties (Maybe Text) Source #
The identifier of your custom security group.
workspaceCreationProperties_defaultOu :: Lens' WorkspaceCreationProperties (Maybe Text) Source #
The default organizational unit (OU) for your WorkSpaces directories.
This string must be the full Lightweight Directory Access Protocol
(LDAP) distinguished name for the target domain and OU. It must be in
the form "OU=value,DC=value,DC=value", where
value is any string of characters, and the number of domain components
(DCs) is two or more. For example,
OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
- To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
- The API doesn't validate whether the OU exists.
workspaceCreationProperties_enableInternetAccess :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether internet access is enabled for your WorkSpaces.
workspaceCreationProperties_enableMaintenanceMode :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
workspaceCreationProperties_enableWorkDocs :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
workspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether users are local administrators of their WorkSpaces.
WorkspaceDirectory
data WorkspaceDirectory Source #
Describes a directory that is used with Amazon WorkSpaces.
See: newWorkspaceDirectory smart constructor.
Constructors
| WorkspaceDirectory' | |
Fields
| |
Instances
newWorkspaceDirectory :: WorkspaceDirectory Source #
Create a value of WorkspaceDirectory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alias:WorkspaceDirectory', workspaceDirectory_alias - The directory alias.
$sel:certificateBasedAuthProperties:WorkspaceDirectory', workspaceDirectory_certificateBasedAuthProperties - The certificate-based authentication properties used to authenticate
SAML 2.0 Identity Provider (IdP) user identities to Active Directory for
WorkSpaces login.
$sel:customerUserName:WorkspaceDirectory', workspaceDirectory_customerUserName - The user name for the service account.
$sel:directoryId:WorkspaceDirectory', workspaceDirectory_directoryId - The directory identifier.
$sel:directoryName:WorkspaceDirectory', workspaceDirectory_directoryName - The name of the directory.
$sel:directoryType:WorkspaceDirectory', workspaceDirectory_directoryType - The directory type.
$sel:dnsIpAddresses:WorkspaceDirectory', workspaceDirectory_dnsIpAddresses - The IP addresses of the DNS servers for the directory.
$sel:iamRoleId:WorkspaceDirectory', workspaceDirectory_iamRoleId - 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.
$sel:registrationCode:WorkspaceDirectory', workspaceDirectory_registrationCode - The registration code for the directory. This is the code that users
enter in their Amazon WorkSpaces client application to connect to the
directory.
$sel:samlProperties:WorkspaceDirectory', workspaceDirectory_samlProperties - Describes the enablement status, user access URL, and relay state
parameter name that are used for configuring federation with an SAML 2.0
identity provider.
$sel:selfservicePermissions:WorkspaceDirectory', workspaceDirectory_selfservicePermissions - The default self-service permissions for WorkSpaces in the directory.
$sel:state:WorkspaceDirectory', workspaceDirectory_state - The state of the directory's registration with Amazon WorkSpaces. After
a directory is deregistered, the DEREGISTERED state is returned very
briefly before the directory metadata is cleaned up, so this state is
rarely returned. To confirm that a directory is deregistered, check for
the directory ID by using
DescribeWorkspaceDirectories.
If the directory ID isn't returned, then the directory has been
successfully deregistered.
$sel:subnetIds:WorkspaceDirectory', workspaceDirectory_subnetIds - The identifiers of the subnets used with the directory.
$sel:tenancy:WorkspaceDirectory', workspaceDirectory_tenancy - Specifies whether the directory is dedicated or shared. To use Bring
Your Own License (BYOL), this value must be set to DEDICATED. For more
information, see
Bring Your Own Windows Desktop Images.
$sel:workspaceAccessProperties:WorkspaceDirectory', workspaceDirectory_workspaceAccessProperties - The devices and operating systems that users can use to access
WorkSpaces.
$sel:workspaceCreationProperties:WorkspaceDirectory', workspaceDirectory_workspaceCreationProperties - The default creation properties for all WorkSpaces in the directory.
$sel:workspaceSecurityGroupId:WorkspaceDirectory', workspaceDirectory_workspaceSecurityGroupId - The identifier of the security group that is assigned to new WorkSpaces.
$sel:ipGroupIds:WorkspaceDirectory', workspaceDirectory_ipGroupIds - The identifiers of the IP access control groups associated with the
directory.
workspaceDirectory_alias :: Lens' WorkspaceDirectory (Maybe Text) Source #
The directory alias.
workspaceDirectory_certificateBasedAuthProperties :: Lens' WorkspaceDirectory (Maybe CertificateBasedAuthProperties) Source #
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
workspaceDirectory_customerUserName :: Lens' WorkspaceDirectory (Maybe Text) Source #
The user name for the service account.
workspaceDirectory_directoryId :: Lens' WorkspaceDirectory (Maybe Text) Source #
The directory identifier.
workspaceDirectory_directoryName :: Lens' WorkspaceDirectory (Maybe Text) Source #
The name of the directory.
workspaceDirectory_directoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType) Source #
The directory type.
workspaceDirectory_dnsIpAddresses :: Lens' WorkspaceDirectory (Maybe [Text]) Source #
The IP addresses of the DNS servers for the directory.
workspaceDirectory_iamRoleId :: 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.
workspaceDirectory_registrationCode :: 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.
workspaceDirectory_samlProperties :: Lens' WorkspaceDirectory (Maybe SamlProperties) Source #
Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
workspaceDirectory_selfservicePermissions :: Lens' WorkspaceDirectory (Maybe SelfservicePermissions) Source #
The default self-service permissions for WorkSpaces in the directory.
workspaceDirectory_state :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState) Source #
The state of the directory's registration with Amazon WorkSpaces. After
a directory is deregistered, the DEREGISTERED state is returned very
briefly before the directory metadata is cleaned up, so this state is
rarely returned. To confirm that a directory is deregistered, check for
the directory ID by using
DescribeWorkspaceDirectories.
If the directory ID isn't returned, then the directory has been
successfully deregistered.
workspaceDirectory_subnetIds :: Lens' WorkspaceDirectory (Maybe [Text]) Source #
The identifiers of the subnets used with the directory.
workspaceDirectory_tenancy :: Lens' WorkspaceDirectory (Maybe Tenancy) Source #
Specifies whether the directory is dedicated or shared. To use Bring
Your Own License (BYOL), this value must be set to DEDICATED. For more
information, see
Bring Your Own Windows Desktop Images.
workspaceDirectory_workspaceAccessProperties :: Lens' WorkspaceDirectory (Maybe WorkspaceAccessProperties) Source #
The devices and operating systems that users can use to access WorkSpaces.
workspaceDirectory_workspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties) Source #
The default creation properties for all WorkSpaces in the directory.
workspaceDirectory_workspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text) Source #
The identifier of the security group that is assigned to new WorkSpaces.
workspaceDirectory_ipGroupIds :: Lens' WorkspaceDirectory (Maybe [Text]) Source #
The identifiers of the IP access control groups associated with the directory.
WorkspaceImage
data WorkspaceImage Source #
Describes a WorkSpace image.
See: newWorkspaceImage smart constructor.
Constructors
| WorkspaceImage' | |
Fields
| |
Instances
newWorkspaceImage :: WorkspaceImage Source #
Create a value of WorkspaceImage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:created:WorkspaceImage', workspaceImage_created - The date when the image was created. If the image has been shared, the
Amazon Web Services account that the image has been shared with sees the
original creation date of the image.
WorkspaceImage, workspaceImage_description - The description of the image.
$sel:errorCode:WorkspaceImage', workspaceImage_errorCode - The error code that is returned for the image.
$sel:errorMessage:WorkspaceImage', workspaceImage_errorMessage - The text of the error message that is returned for the image.
$sel:imageId:WorkspaceImage', workspaceImage_imageId - The identifier of the image.
$sel:name:WorkspaceImage', workspaceImage_name - The name of the image.
$sel:operatingSystem:WorkspaceImage', workspaceImage_operatingSystem - The operating system that the image is running.
$sel:ownerAccountId:WorkspaceImage', workspaceImage_ownerAccountId - The identifier of the Amazon Web Services account that owns the image.
$sel:requiredTenancy:WorkspaceImage', workspaceImage_requiredTenancy - Specifies whether the image is running on dedicated hardware. When Bring
Your Own License (BYOL) is enabled, this value is set to DEDICATED.
For more information, see
Bring Your Own Windows Desktop Images.
$sel:state:WorkspaceImage', workspaceImage_state - The status of the image.
$sel:updates:WorkspaceImage', workspaceImage_updates - The updates (if any) that are available for the specified image.
workspaceImage_created :: Lens' WorkspaceImage (Maybe UTCTime) Source #
The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
workspaceImage_description :: Lens' WorkspaceImage (Maybe Text) Source #
The description of the image.
workspaceImage_errorCode :: Lens' WorkspaceImage (Maybe Text) Source #
The error code that is returned for the image.
workspaceImage_errorMessage :: Lens' WorkspaceImage (Maybe Text) Source #
The text of the error message that is returned for the image.
workspaceImage_imageId :: Lens' WorkspaceImage (Maybe Text) Source #
The identifier of the image.
workspaceImage_name :: Lens' WorkspaceImage (Maybe Text) Source #
The name of the image.
workspaceImage_operatingSystem :: Lens' WorkspaceImage (Maybe OperatingSystem) Source #
The operating system that the image is running.
workspaceImage_ownerAccountId :: Lens' WorkspaceImage (Maybe Text) Source #
The identifier of the Amazon Web Services account that owns the image.
workspaceImage_requiredTenancy :: Lens' WorkspaceImage (Maybe WorkspaceImageRequiredTenancy) Source #
Specifies whether the image is running on dedicated hardware. When Bring
Your Own License (BYOL) is enabled, this value is set to DEDICATED.
For more information, see
Bring Your Own Windows Desktop Images.
workspaceImage_state :: Lens' WorkspaceImage (Maybe WorkspaceImageState) Source #
The status of the image.
workspaceImage_updates :: Lens' WorkspaceImage (Maybe UpdateResult) Source #
The updates (if any) that are available for the specified image.
WorkspaceProperties
data WorkspaceProperties Source #
Describes a WorkSpace.
See: newWorkspaceProperties smart constructor.
Constructors
| WorkspaceProperties' | |
Fields
| |
Instances
newWorkspaceProperties :: WorkspaceProperties Source #
Create a value of WorkspaceProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeTypeName:WorkspaceProperties', workspaceProperties_computeTypeName - The compute type. For more information, see
Amazon WorkSpaces Bundles.
$sel:protocols:WorkspaceProperties', workspaceProperties_protocols - The protocol. For more information, see
Protocols for Amazon WorkSpaces.
- Only available for WorkSpaces created with PCoIP bundles.
- The
Protocolsproperty is case sensitive. Ensure you usePCOIPorWSP. - Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
$sel:rootVolumeSizeGib:WorkspaceProperties', workspaceProperties_rootVolumeSizeGib - The size of the root volume. For important information about how to
modify the size of the root and user volumes, see
Modify a WorkSpace.
$sel:runningMode:WorkspaceProperties', workspaceProperties_runningMode - The running mode. For more information, see
Manage the WorkSpace Running Mode.
The MANUAL value is only supported by Amazon WorkSpaces Core. Contact
your account team to be allow-listed to use this value. For more
information, see
Amazon WorkSpaces Core.
$sel:runningModeAutoStopTimeoutInMinutes:WorkspaceProperties', workspaceProperties_runningModeAutoStopTimeoutInMinutes - The time after a user logs off when WorkSpaces are automatically
stopped. Configured in 60-minute intervals.
$sel:userVolumeSizeGib:WorkspaceProperties', workspaceProperties_userVolumeSizeGib - The size of the user storage. For important information about how to
modify the size of the root and user volumes, see
Modify a WorkSpace.
workspaceProperties_computeTypeName :: Lens' WorkspaceProperties (Maybe Compute) Source #
The compute type. For more information, see Amazon WorkSpaces Bundles.
workspaceProperties_protocols :: Lens' WorkspaceProperties (Maybe [Protocol]) Source #
The protocol. For more information, see Protocols for Amazon WorkSpaces.
- Only available for WorkSpaces created with PCoIP bundles.
- The
Protocolsproperty is case sensitive. Ensure you usePCOIPorWSP. - Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
workspaceProperties_rootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
workspaceProperties_runningMode :: Lens' WorkspaceProperties (Maybe RunningMode) Source #
The running mode. For more information, see Manage the WorkSpace Running Mode.
The MANUAL value is only supported by Amazon WorkSpaces Core. Contact
your account team to be allow-listed to use this value. For more
information, see
Amazon WorkSpaces Core.
workspaceProperties_runningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int) Source #
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
workspaceProperties_userVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
WorkspaceRequest
data WorkspaceRequest Source #
Describes the information used to create a WorkSpace.
See: newWorkspaceRequest smart constructor.
Constructors
| WorkspaceRequest' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> WorkspaceRequest |
Create a value of WorkspaceRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rootVolumeEncryptionEnabled:WorkspaceRequest', workspaceRequest_rootVolumeEncryptionEnabled - Indicates whether the data stored on the root volume is encrypted.
$sel:tags:WorkspaceRequest', workspaceRequest_tags - The tags for the WorkSpace.
$sel:userVolumeEncryptionEnabled:WorkspaceRequest', workspaceRequest_userVolumeEncryptionEnabled - Indicates whether the data stored on the user volume is encrypted.
$sel:volumeEncryptionKey:WorkspaceRequest', workspaceRequest_volumeEncryptionKey - The symmetric KMS key used to encrypt data stored on your WorkSpace.
Amazon WorkSpaces does not support asymmetric KMS keys.
$sel:workspaceProperties:WorkspaceRequest', workspaceRequest_workspaceProperties - The WorkSpace properties.
$sel:directoryId:WorkspaceRequest', workspaceRequest_directoryId - The identifier of the Directory Service directory for the WorkSpace. You
can use DescribeWorkspaceDirectories to list the available directories.
$sel:userName:WorkspaceRequest', workspaceRequest_userName - The user name of the user for the WorkSpace. This user name must exist
in the Directory Service directory for the WorkSpace.
$sel:bundleId:WorkspaceRequest', workspaceRequest_bundleId - The identifier of the bundle for the WorkSpace. You can use
DescribeWorkspaceBundles to list the available bundles.
workspaceRequest_rootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source #
Indicates whether the data stored on the root volume is encrypted.
workspaceRequest_tags :: Lens' WorkspaceRequest (Maybe [Tag]) Source #
The tags for the WorkSpace.
workspaceRequest_userVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source #
Indicates whether the data stored on the user volume is encrypted.
workspaceRequest_volumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text) Source #
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceRequest_workspaceProperties :: Lens' WorkspaceRequest (Maybe WorkspaceProperties) Source #
The WorkSpace properties.
workspaceRequest_directoryId :: Lens' WorkspaceRequest Text Source #
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
workspaceRequest_userName :: Lens' WorkspaceRequest Text Source #
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
workspaceRequest_bundleId :: 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 #
Describes an IP access control group.
See: newWorkspacesIpGroup smart constructor.
Constructors
| WorkspacesIpGroup' | |
Instances
newWorkspacesIpGroup :: WorkspacesIpGroup Source #
Create a value of WorkspacesIpGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupDesc:WorkspacesIpGroup', workspacesIpGroup_groupDesc - The description of the group.
$sel:groupId:WorkspacesIpGroup', workspacesIpGroup_groupId - The identifier of the group.
$sel:groupName:WorkspacesIpGroup', workspacesIpGroup_groupName - The name of the group.
$sel:userRules:WorkspacesIpGroup', workspacesIpGroup_userRules - The rules.
workspacesIpGroup_groupDesc :: Lens' WorkspacesIpGroup (Maybe Text) Source #
The description of the group.
workspacesIpGroup_groupId :: Lens' WorkspacesIpGroup (Maybe Text) Source #
The identifier of the group.
workspacesIpGroup_groupName :: Lens' WorkspacesIpGroup (Maybe Text) Source #
The name of the group.
workspacesIpGroup_userRules :: Lens' WorkspacesIpGroup (Maybe [IpRuleItem]) Source #
The rules.