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
Contents
- Service Configuration
- Errors
- AccessDeniedException
- InvalidParameterValuesException
- InvalidResourceStateException
- OperationInProgressException
- OperationNotSupportedException
- ResourceAlreadyExistsException
- ResourceAssociatedException
- ResourceCreationFailedException
- ResourceLimitExceededException
- ResourceNotFoundException
- ResourceUnavailableException
- UnsupportedNetworkConfigurationException
- UnsupportedWorkspaceConfigurationException
- WorkspacesDefaultRoleNotFoundException
- Waiters
- Operations
- AssociateConnectionAlias
- AssociateIpGroups
- AuthorizeIpRules
- CopyWorkspaceImage
- CreateConnectClientAddIn
- CreateConnectionAlias
- CreateIpGroup
- CreateStandbyWorkspaces
- CreateTags
- CreateUpdatedWorkspaceImage
- CreateWorkspaceBundle
- CreateWorkspaceImage
- CreateWorkspaces
- DeleteClientBranding
- DeleteConnectClientAddIn
- DeleteConnectionAlias
- DeleteIpGroup
- DeleteTags
- DeleteWorkspaceBundle
- DeleteWorkspaceImage
- DeregisterWorkspaceDirectory
- DescribeAccount
- DescribeAccountModifications (Paginated)
- DescribeClientBranding
- DescribeClientProperties
- DescribeConnectClientAddIns
- DescribeConnectionAliasPermissions
- DescribeConnectionAliases
- DescribeIpGroups (Paginated)
- DescribeTags
- DescribeWorkspaceBundles (Paginated)
- DescribeWorkspaceDirectories (Paginated)
- DescribeWorkspaceImagePermissions
- DescribeWorkspaceImages (Paginated)
- DescribeWorkspaceSnapshots
- DescribeWorkspaces (Paginated)
- DescribeWorkspacesConnectionStatus (Paginated)
- DisassociateConnectionAlias
- DisassociateIpGroups
- ImportClientBranding
- ImportWorkspaceImage
- ListAvailableManagementCidrRanges (Paginated)
- MigrateWorkspace
- ModifyAccount
- ModifyCertificateBasedAuthProperties
- ModifyClientProperties
- ModifySamlProperties
- ModifySelfservicePermissions
- ModifyWorkspaceAccessProperties
- ModifyWorkspaceCreationProperties
- ModifyWorkspaceProperties
- ModifyWorkspaceState
- RebootWorkspaces
- RebuildWorkspaces
- RegisterWorkspaceDirectory
- RestoreWorkspace
- RevokeIpRules
- StartWorkspaces
- StopWorkspaces
- TerminateWorkspaces
- UpdateConnectClientAddIn
- UpdateConnectionAliasPermission
- UpdateRulesOfIpGroup
- UpdateWorkspaceBundle
- UpdateWorkspaceImagePermission
- Types
- 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
Derived from API version 2015-04-08
of the AWS service descriptions, licensed under Apache 2.0.
Amazon WorkSpaces Service
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.
You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.
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
- data AssociateConnectionAlias = AssociateConnectionAlias' Text Text
- newAssociateConnectionAlias :: Text -> Text -> AssociateConnectionAlias
- data AssociateConnectionAliasResponse = AssociateConnectionAliasResponse' (Maybe Text) Int
- newAssociateConnectionAliasResponse :: Int -> AssociateConnectionAliasResponse
- data AssociateIpGroups = AssociateIpGroups' Text [Text]
- newAssociateIpGroups :: Text -> AssociateIpGroups
- data AssociateIpGroupsResponse = AssociateIpGroupsResponse' Int
- newAssociateIpGroupsResponse :: Int -> AssociateIpGroupsResponse
- data AuthorizeIpRules = AuthorizeIpRules' Text [IpRuleItem]
- newAuthorizeIpRules :: Text -> AuthorizeIpRules
- data AuthorizeIpRulesResponse = AuthorizeIpRulesResponse' Int
- newAuthorizeIpRulesResponse :: Int -> AuthorizeIpRulesResponse
- data CopyWorkspaceImage = CopyWorkspaceImage' (Maybe Text) (Maybe [Tag]) Text Text Text
- newCopyWorkspaceImage :: Text -> Text -> Text -> CopyWorkspaceImage
- data CopyWorkspaceImageResponse = CopyWorkspaceImageResponse' (Maybe Text) Int
- newCopyWorkspaceImageResponse :: Int -> CopyWorkspaceImageResponse
- data CreateConnectClientAddIn = CreateConnectClientAddIn' Text Text Text
- newCreateConnectClientAddIn :: Text -> Text -> Text -> CreateConnectClientAddIn
- data CreateConnectClientAddInResponse = CreateConnectClientAddInResponse' (Maybe Text) Int
- newCreateConnectClientAddInResponse :: Int -> CreateConnectClientAddInResponse
- data CreateConnectionAlias = CreateConnectionAlias' (Maybe [Tag]) Text
- newCreateConnectionAlias :: Text -> CreateConnectionAlias
- data CreateConnectionAliasResponse = CreateConnectionAliasResponse' (Maybe Text) Int
- newCreateConnectionAliasResponse :: Int -> CreateConnectionAliasResponse
- data CreateIpGroup = CreateIpGroup' (Maybe Text) (Maybe [Tag]) (Maybe [IpRuleItem]) Text
- newCreateIpGroup :: Text -> CreateIpGroup
- data CreateIpGroupResponse = CreateIpGroupResponse' (Maybe Text) Int
- newCreateIpGroupResponse :: Int -> CreateIpGroupResponse
- data CreateStandbyWorkspaces = CreateStandbyWorkspaces' Text [StandbyWorkspace]
- newCreateStandbyWorkspaces :: Text -> CreateStandbyWorkspaces
- data CreateStandbyWorkspacesResponse = CreateStandbyWorkspacesResponse' (Maybe [FailedCreateStandbyWorkspacesRequest]) (Maybe [PendingCreateStandbyWorkspacesRequest]) Int
- newCreateStandbyWorkspacesResponse :: Int -> CreateStandbyWorkspacesResponse
- data CreateTags = CreateTags' Text [Tag]
- newCreateTags :: Text -> CreateTags
- data CreateTagsResponse = CreateTagsResponse' Int
- newCreateTagsResponse :: Int -> CreateTagsResponse
- data CreateUpdatedWorkspaceImage = CreateUpdatedWorkspaceImage' (Maybe [Tag]) Text Text Text
- newCreateUpdatedWorkspaceImage :: Text -> Text -> Text -> CreateUpdatedWorkspaceImage
- data CreateUpdatedWorkspaceImageResponse = CreateUpdatedWorkspaceImageResponse' (Maybe Text) Int
- newCreateUpdatedWorkspaceImageResponse :: Int -> CreateUpdatedWorkspaceImageResponse
- data CreateWorkspaceBundle = CreateWorkspaceBundle' (Maybe RootStorage) (Maybe [Tag]) Text Text Text ComputeType UserStorage
- newCreateWorkspaceBundle :: Text -> Text -> Text -> ComputeType -> UserStorage -> CreateWorkspaceBundle
- data CreateWorkspaceBundleResponse = CreateWorkspaceBundleResponse' (Maybe WorkspaceBundle) Int
- newCreateWorkspaceBundleResponse :: Int -> CreateWorkspaceBundleResponse
- data CreateWorkspaceImage = CreateWorkspaceImage' (Maybe [Tag]) Text Text Text
- newCreateWorkspaceImage :: Text -> Text -> Text -> CreateWorkspaceImage
- data CreateWorkspaceImageResponse = CreateWorkspaceImageResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OperatingSystem) (Maybe Text) (Maybe WorkspaceImageRequiredTenancy) (Maybe WorkspaceImageState) Int
- newCreateWorkspaceImageResponse :: Int -> CreateWorkspaceImageResponse
- data CreateWorkspaces = CreateWorkspaces' (NonEmpty WorkspaceRequest)
- newCreateWorkspaces :: NonEmpty WorkspaceRequest -> CreateWorkspaces
- data CreateWorkspacesResponse = CreateWorkspacesResponse' (Maybe [FailedCreateWorkspaceRequest]) (Maybe [Workspace]) Int
- newCreateWorkspacesResponse :: Int -> CreateWorkspacesResponse
- data DeleteClientBranding = DeleteClientBranding' Text (NonEmpty ClientDeviceType)
- newDeleteClientBranding :: Text -> NonEmpty ClientDeviceType -> DeleteClientBranding
- data DeleteClientBrandingResponse = DeleteClientBrandingResponse' Int
- newDeleteClientBrandingResponse :: Int -> DeleteClientBrandingResponse
- data DeleteConnectClientAddIn = DeleteConnectClientAddIn' Text Text
- newDeleteConnectClientAddIn :: Text -> Text -> DeleteConnectClientAddIn
- data DeleteConnectClientAddInResponse = DeleteConnectClientAddInResponse' Int
- newDeleteConnectClientAddInResponse :: Int -> DeleteConnectClientAddInResponse
- data DeleteConnectionAlias = DeleteConnectionAlias' Text
- newDeleteConnectionAlias :: Text -> DeleteConnectionAlias
- data DeleteConnectionAliasResponse = DeleteConnectionAliasResponse' Int
- newDeleteConnectionAliasResponse :: Int -> DeleteConnectionAliasResponse
- data DeleteIpGroup = DeleteIpGroup' Text
- newDeleteIpGroup :: Text -> DeleteIpGroup
- data DeleteIpGroupResponse = DeleteIpGroupResponse' Int
- newDeleteIpGroupResponse :: Int -> DeleteIpGroupResponse
- data DeleteTags = DeleteTags' Text [Text]
- newDeleteTags :: Text -> DeleteTags
- data DeleteTagsResponse = DeleteTagsResponse' Int
- newDeleteTagsResponse :: Int -> DeleteTagsResponse
- data DeleteWorkspaceBundle = DeleteWorkspaceBundle' (Maybe Text)
- newDeleteWorkspaceBundle :: DeleteWorkspaceBundle
- data DeleteWorkspaceBundleResponse = DeleteWorkspaceBundleResponse' Int
- newDeleteWorkspaceBundleResponse :: Int -> DeleteWorkspaceBundleResponse
- data DeleteWorkspaceImage = DeleteWorkspaceImage' Text
- newDeleteWorkspaceImage :: Text -> DeleteWorkspaceImage
- data DeleteWorkspaceImageResponse = DeleteWorkspaceImageResponse' Int
- newDeleteWorkspaceImageResponse :: Int -> DeleteWorkspaceImageResponse
- data DeregisterWorkspaceDirectory = DeregisterWorkspaceDirectory' Text
- newDeregisterWorkspaceDirectory :: Text -> DeregisterWorkspaceDirectory
- data DeregisterWorkspaceDirectoryResponse = DeregisterWorkspaceDirectoryResponse' Int
- newDeregisterWorkspaceDirectoryResponse :: Int -> DeregisterWorkspaceDirectoryResponse
- data DescribeAccount = DescribeAccount' {
- newDescribeAccount :: DescribeAccount
- data DescribeAccountResponse = DescribeAccountResponse' (Maybe Text) (Maybe DedicatedTenancySupportResultEnum) Int
- newDescribeAccountResponse :: Int -> DescribeAccountResponse
- data DescribeAccountModifications = DescribeAccountModifications' (Maybe Text)
- newDescribeAccountModifications :: DescribeAccountModifications
- data DescribeAccountModificationsResponse = DescribeAccountModificationsResponse' (Maybe [AccountModification]) (Maybe Text) Int
- newDescribeAccountModificationsResponse :: Int -> DescribeAccountModificationsResponse
- data DescribeClientBranding = DescribeClientBranding' Text
- newDescribeClientBranding :: Text -> DescribeClientBranding
- data DescribeClientBrandingResponse = DescribeClientBrandingResponse' (Maybe DefaultClientBrandingAttributes) (Maybe IosClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) Int
- newDescribeClientBrandingResponse :: Int -> DescribeClientBrandingResponse
- data DescribeClientProperties = DescribeClientProperties' (NonEmpty Text)
- newDescribeClientProperties :: NonEmpty Text -> DescribeClientProperties
- data DescribeClientPropertiesResponse = DescribeClientPropertiesResponse' (Maybe [ClientPropertiesResult]) Int
- newDescribeClientPropertiesResponse :: Int -> DescribeClientPropertiesResponse
- data DescribeConnectClientAddIns = DescribeConnectClientAddIns' (Maybe Natural) (Maybe Text) Text
- newDescribeConnectClientAddIns :: Text -> DescribeConnectClientAddIns
- data DescribeConnectClientAddInsResponse = DescribeConnectClientAddInsResponse' (Maybe [ConnectClientAddIn]) (Maybe Text) Int
- newDescribeConnectClientAddInsResponse :: Int -> DescribeConnectClientAddInsResponse
- data DescribeConnectionAliasPermissions = DescribeConnectionAliasPermissions' (Maybe Natural) (Maybe Text) Text
- newDescribeConnectionAliasPermissions :: Text -> DescribeConnectionAliasPermissions
- data DescribeConnectionAliasPermissionsResponse = DescribeConnectionAliasPermissionsResponse' (Maybe Text) (Maybe (NonEmpty ConnectionAliasPermission)) (Maybe Text) Int
- newDescribeConnectionAliasPermissionsResponse :: Int -> DescribeConnectionAliasPermissionsResponse
- data DescribeConnectionAliases = DescribeConnectionAliases' (Maybe (NonEmpty Text)) (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeConnectionAliases :: DescribeConnectionAliases
- data DescribeConnectionAliasesResponse = DescribeConnectionAliasesResponse' (Maybe (NonEmpty ConnectionAlias)) (Maybe Text) Int
- newDescribeConnectionAliasesResponse :: Int -> DescribeConnectionAliasesResponse
- data DescribeIpGroups = DescribeIpGroups' (Maybe [Text]) (Maybe Natural) (Maybe Text)
- newDescribeIpGroups :: DescribeIpGroups
- data DescribeIpGroupsResponse = DescribeIpGroupsResponse' (Maybe Text) (Maybe [WorkspacesIpGroup]) Int
- newDescribeIpGroupsResponse :: Int -> DescribeIpGroupsResponse
- data DescribeTags = DescribeTags' Text
- newDescribeTags :: Text -> DescribeTags
- data DescribeTagsResponse = DescribeTagsResponse' (Maybe [Tag]) Int
- newDescribeTagsResponse :: Int -> DescribeTagsResponse
- data DescribeWorkspaceBundles = DescribeWorkspaceBundles' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text)
- newDescribeWorkspaceBundles :: DescribeWorkspaceBundles
- data DescribeWorkspaceBundlesResponse = DescribeWorkspaceBundlesResponse' (Maybe [WorkspaceBundle]) (Maybe Text) Int
- newDescribeWorkspaceBundlesResponse :: Int -> DescribeWorkspaceBundlesResponse
- data DescribeWorkspaceDirectories = DescribeWorkspaceDirectories' (Maybe (NonEmpty Text)) (Maybe Natural) (Maybe Text)
- newDescribeWorkspaceDirectories :: DescribeWorkspaceDirectories
- data DescribeWorkspaceDirectoriesResponse = DescribeWorkspaceDirectoriesResponse' (Maybe [WorkspaceDirectory]) (Maybe Text) Int
- newDescribeWorkspaceDirectoriesResponse :: Int -> DescribeWorkspaceDirectoriesResponse
- data DescribeWorkspaceImagePermissions = DescribeWorkspaceImagePermissions' (Maybe Natural) (Maybe Text) Text
- newDescribeWorkspaceImagePermissions :: Text -> DescribeWorkspaceImagePermissions
- data DescribeWorkspaceImagePermissionsResponse = DescribeWorkspaceImagePermissionsResponse' (Maybe Text) (Maybe [ImagePermission]) (Maybe Text) Int
- newDescribeWorkspaceImagePermissionsResponse :: Int -> DescribeWorkspaceImagePermissionsResponse
- data DescribeWorkspaceImages = DescribeWorkspaceImages' (Maybe (NonEmpty Text)) (Maybe ImageType) (Maybe Natural) (Maybe Text)
- newDescribeWorkspaceImages :: DescribeWorkspaceImages
- data DescribeWorkspaceImagesResponse = DescribeWorkspaceImagesResponse' (Maybe [WorkspaceImage]) (Maybe Text) Int
- newDescribeWorkspaceImagesResponse :: Int -> DescribeWorkspaceImagesResponse
- data DescribeWorkspaceSnapshots = DescribeWorkspaceSnapshots' Text
- newDescribeWorkspaceSnapshots :: Text -> DescribeWorkspaceSnapshots
- data DescribeWorkspaceSnapshotsResponse = DescribeWorkspaceSnapshotsResponse' (Maybe [Snapshot]) (Maybe [Snapshot]) Int
- newDescribeWorkspaceSnapshotsResponse :: Int -> DescribeWorkspaceSnapshotsResponse
- data DescribeWorkspaces = DescribeWorkspaces' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text))
- newDescribeWorkspaces :: DescribeWorkspaces
- data DescribeWorkspacesResponse = DescribeWorkspacesResponse' (Maybe Text) (Maybe [Workspace]) Int
- newDescribeWorkspacesResponse :: Int -> DescribeWorkspacesResponse
- data DescribeWorkspacesConnectionStatus = DescribeWorkspacesConnectionStatus' (Maybe Text) (Maybe (NonEmpty Text))
- newDescribeWorkspacesConnectionStatus :: DescribeWorkspacesConnectionStatus
- data DescribeWorkspacesConnectionStatusResponse = DescribeWorkspacesConnectionStatusResponse' (Maybe Text) (Maybe [WorkspaceConnectionStatus]) Int
- newDescribeWorkspacesConnectionStatusResponse :: Int -> DescribeWorkspacesConnectionStatusResponse
- data DisassociateConnectionAlias = DisassociateConnectionAlias' Text
- newDisassociateConnectionAlias :: Text -> DisassociateConnectionAlias
- data DisassociateConnectionAliasResponse = DisassociateConnectionAliasResponse' Int
- newDisassociateConnectionAliasResponse :: Int -> DisassociateConnectionAliasResponse
- data DisassociateIpGroups = DisassociateIpGroups' Text [Text]
- newDisassociateIpGroups :: Text -> DisassociateIpGroups
- data DisassociateIpGroupsResponse = DisassociateIpGroupsResponse' Int
- newDisassociateIpGroupsResponse :: Int -> DisassociateIpGroupsResponse
- data ImportClientBranding = ImportClientBranding' (Maybe DefaultImportClientBrandingAttributes) (Maybe IosImportClientBrandingAttributes) (Maybe DefaultImportClientBrandingAttributes) (Maybe DefaultImportClientBrandingAttributes) (Maybe DefaultImportClientBrandingAttributes) (Maybe DefaultImportClientBrandingAttributes) Text
- newImportClientBranding :: Text -> ImportClientBranding
- data ImportClientBrandingResponse = ImportClientBrandingResponse' (Maybe DefaultClientBrandingAttributes) (Maybe IosClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) (Maybe DefaultClientBrandingAttributes) Int
- newImportClientBrandingResponse :: Int -> ImportClientBrandingResponse
- data ImportWorkspaceImage = ImportWorkspaceImage' (Maybe (NonEmpty Application)) (Maybe [Tag]) Text WorkspaceImageIngestionProcess Text Text
- newImportWorkspaceImage :: Text -> WorkspaceImageIngestionProcess -> Text -> Text -> ImportWorkspaceImage
- data ImportWorkspaceImageResponse = ImportWorkspaceImageResponse' (Maybe Text) Int
- newImportWorkspaceImageResponse :: Int -> ImportWorkspaceImageResponse
- data ListAvailableManagementCidrRanges = ListAvailableManagementCidrRanges' (Maybe Natural) (Maybe Text) Text
- newListAvailableManagementCidrRanges :: Text -> ListAvailableManagementCidrRanges
- data ListAvailableManagementCidrRangesResponse = ListAvailableManagementCidrRangesResponse' (Maybe [Text]) (Maybe Text) Int
- newListAvailableManagementCidrRangesResponse :: Int -> ListAvailableManagementCidrRangesResponse
- data MigrateWorkspace = MigrateWorkspace' Text Text
- newMigrateWorkspace :: Text -> Text -> MigrateWorkspace
- data MigrateWorkspaceResponse = MigrateWorkspaceResponse' (Maybe Text) (Maybe Text) Int
- newMigrateWorkspaceResponse :: Int -> MigrateWorkspaceResponse
- data ModifyAccount = ModifyAccount' (Maybe Text) (Maybe DedicatedTenancySupportEnum)
- newModifyAccount :: ModifyAccount
- data ModifyAccountResponse = ModifyAccountResponse' Int
- newModifyAccountResponse :: Int -> ModifyAccountResponse
- data ModifyCertificateBasedAuthProperties = ModifyCertificateBasedAuthProperties' (Maybe CertificateBasedAuthProperties) (Maybe [DeletableCertificateBasedAuthProperty]) Text
- newModifyCertificateBasedAuthProperties :: Text -> ModifyCertificateBasedAuthProperties
- data ModifyCertificateBasedAuthPropertiesResponse = ModifyCertificateBasedAuthPropertiesResponse' Int
- newModifyCertificateBasedAuthPropertiesResponse :: Int -> ModifyCertificateBasedAuthPropertiesResponse
- data ModifyClientProperties = ModifyClientProperties' Text ClientProperties
- newModifyClientProperties :: Text -> ClientProperties -> ModifyClientProperties
- data ModifyClientPropertiesResponse = ModifyClientPropertiesResponse' Int
- newModifyClientPropertiesResponse :: Int -> ModifyClientPropertiesResponse
- data ModifySamlProperties = ModifySamlProperties' (Maybe [DeletableSamlProperty]) (Maybe SamlProperties) Text
- newModifySamlProperties :: Text -> ModifySamlProperties
- data ModifySamlPropertiesResponse = ModifySamlPropertiesResponse' Int
- newModifySamlPropertiesResponse :: Int -> ModifySamlPropertiesResponse
- data ModifySelfservicePermissions = ModifySelfservicePermissions' Text SelfservicePermissions
- newModifySelfservicePermissions :: Text -> SelfservicePermissions -> ModifySelfservicePermissions
- data ModifySelfservicePermissionsResponse = ModifySelfservicePermissionsResponse' Int
- newModifySelfservicePermissionsResponse :: Int -> ModifySelfservicePermissionsResponse
- data ModifyWorkspaceAccessProperties = ModifyWorkspaceAccessProperties' Text WorkspaceAccessProperties
- newModifyWorkspaceAccessProperties :: Text -> WorkspaceAccessProperties -> ModifyWorkspaceAccessProperties
- data ModifyWorkspaceAccessPropertiesResponse = ModifyWorkspaceAccessPropertiesResponse' Int
- newModifyWorkspaceAccessPropertiesResponse :: Int -> ModifyWorkspaceAccessPropertiesResponse
- data ModifyWorkspaceCreationProperties = ModifyWorkspaceCreationProperties' Text WorkspaceCreationProperties
- newModifyWorkspaceCreationProperties :: Text -> WorkspaceCreationProperties -> ModifyWorkspaceCreationProperties
- data ModifyWorkspaceCreationPropertiesResponse = ModifyWorkspaceCreationPropertiesResponse' Int
- newModifyWorkspaceCreationPropertiesResponse :: Int -> ModifyWorkspaceCreationPropertiesResponse
- data ModifyWorkspaceProperties = ModifyWorkspaceProperties' Text WorkspaceProperties
- newModifyWorkspaceProperties :: Text -> WorkspaceProperties -> ModifyWorkspaceProperties
- data ModifyWorkspacePropertiesResponse = ModifyWorkspacePropertiesResponse' Int
- newModifyWorkspacePropertiesResponse :: Int -> ModifyWorkspacePropertiesResponse
- data ModifyWorkspaceState = ModifyWorkspaceState' Text TargetWorkspaceState
- newModifyWorkspaceState :: Text -> TargetWorkspaceState -> ModifyWorkspaceState
- data ModifyWorkspaceStateResponse = ModifyWorkspaceStateResponse' Int
- newModifyWorkspaceStateResponse :: Int -> ModifyWorkspaceStateResponse
- data RebootWorkspaces = RebootWorkspaces' (NonEmpty RebootRequest)
- newRebootWorkspaces :: NonEmpty RebootRequest -> RebootWorkspaces
- data RebootWorkspacesResponse = RebootWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int
- newRebootWorkspacesResponse :: Int -> RebootWorkspacesResponse
- data RebuildWorkspaces = RebuildWorkspaces' (NonEmpty RebuildRequest)
- newRebuildWorkspaces :: NonEmpty RebuildRequest -> RebuildWorkspaces
- data RebuildWorkspacesResponse = RebuildWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int
- newRebuildWorkspacesResponse :: Int -> RebuildWorkspacesResponse
- data RegisterWorkspaceDirectory = RegisterWorkspaceDirectory' (Maybe Bool) (Maybe [Text]) (Maybe [Tag]) (Maybe Tenancy) Text Bool
- newRegisterWorkspaceDirectory :: Text -> Bool -> RegisterWorkspaceDirectory
- data RegisterWorkspaceDirectoryResponse = RegisterWorkspaceDirectoryResponse' Int
- newRegisterWorkspaceDirectoryResponse :: Int -> RegisterWorkspaceDirectoryResponse
- data RestoreWorkspace = RestoreWorkspace' Text
- newRestoreWorkspace :: Text -> RestoreWorkspace
- data RestoreWorkspaceResponse = RestoreWorkspaceResponse' Int
- newRestoreWorkspaceResponse :: Int -> RestoreWorkspaceResponse
- data RevokeIpRules = RevokeIpRules' Text [Text]
- newRevokeIpRules :: Text -> RevokeIpRules
- data RevokeIpRulesResponse = RevokeIpRulesResponse' Int
- newRevokeIpRulesResponse :: Int -> RevokeIpRulesResponse
- data StartWorkspaces = StartWorkspaces' (NonEmpty StartRequest)
- newStartWorkspaces :: NonEmpty StartRequest -> StartWorkspaces
- data StartWorkspacesResponse = StartWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int
- newStartWorkspacesResponse :: Int -> StartWorkspacesResponse
- data StopWorkspaces = StopWorkspaces' (NonEmpty StopRequest)
- newStopWorkspaces :: NonEmpty StopRequest -> StopWorkspaces
- data StopWorkspacesResponse = StopWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int
- newStopWorkspacesResponse :: Int -> StopWorkspacesResponse
- data TerminateWorkspaces = TerminateWorkspaces' (NonEmpty TerminateRequest)
- newTerminateWorkspaces :: NonEmpty TerminateRequest -> TerminateWorkspaces
- data TerminateWorkspacesResponse = TerminateWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int
- newTerminateWorkspacesResponse :: Int -> TerminateWorkspacesResponse
- data UpdateConnectClientAddIn = UpdateConnectClientAddIn' (Maybe Text) (Maybe Text) Text Text
- newUpdateConnectClientAddIn :: Text -> Text -> UpdateConnectClientAddIn
- data UpdateConnectClientAddInResponse = UpdateConnectClientAddInResponse' Int
- newUpdateConnectClientAddInResponse :: Int -> UpdateConnectClientAddInResponse
- data UpdateConnectionAliasPermission = UpdateConnectionAliasPermission' Text ConnectionAliasPermission
- newUpdateConnectionAliasPermission :: Text -> ConnectionAliasPermission -> UpdateConnectionAliasPermission
- data UpdateConnectionAliasPermissionResponse = UpdateConnectionAliasPermissionResponse' Int
- newUpdateConnectionAliasPermissionResponse :: Int -> UpdateConnectionAliasPermissionResponse
- data UpdateRulesOfIpGroup = UpdateRulesOfIpGroup' Text [IpRuleItem]
- newUpdateRulesOfIpGroup :: Text -> UpdateRulesOfIpGroup
- data UpdateRulesOfIpGroupResponse = UpdateRulesOfIpGroupResponse' Int
- newUpdateRulesOfIpGroupResponse :: Int -> UpdateRulesOfIpGroupResponse
- data UpdateWorkspaceBundle = UpdateWorkspaceBundle' (Maybe Text) (Maybe Text)
- newUpdateWorkspaceBundle :: UpdateWorkspaceBundle
- data UpdateWorkspaceBundleResponse = UpdateWorkspaceBundleResponse' Int
- newUpdateWorkspaceBundleResponse :: Int -> UpdateWorkspaceBundleResponse
- data UpdateWorkspaceImagePermission = UpdateWorkspaceImagePermission' Text Bool Text
- newUpdateWorkspaceImagePermission :: Text -> Bool -> Text -> UpdateWorkspaceImagePermission
- data UpdateWorkspaceImagePermissionResponse = UpdateWorkspaceImagePermissionResponse' Int
- newUpdateWorkspaceImagePermissionResponse :: Int -> UpdateWorkspaceImagePermissionResponse
- 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' (Maybe Text) (Maybe DedicatedTenancySupportResultEnum) (Maybe Text) (Maybe Text) (Maybe DedicatedTenancyModificationStateEnum) (Maybe POSIX)
- newAccountModification :: AccountModification
- data CertificateBasedAuthProperties = CertificateBasedAuthProperties' (Maybe Text) (Maybe CertificateBasedAuthStatusEnum)
- newCertificateBasedAuthProperties :: CertificateBasedAuthProperties
- data ClientProperties = ClientProperties' (Maybe LogUploadEnum) (Maybe ReconnectEnum)
- newClientProperties :: ClientProperties
- data ClientPropertiesResult = ClientPropertiesResult' (Maybe ClientProperties) (Maybe Text)
- newClientPropertiesResult :: ClientPropertiesResult
- data ComputeType = ComputeType' (Maybe Compute)
- newComputeType :: ComputeType
- data ConnectClientAddIn = ConnectClientAddIn' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newConnectClientAddIn :: ConnectClientAddIn
- data ConnectionAlias = ConnectionAlias' (Maybe Text) (Maybe (NonEmpty ConnectionAliasAssociation)) (Maybe Text) (Maybe Text) (Maybe ConnectionAliasState)
- newConnectionAlias :: ConnectionAlias
- data ConnectionAliasAssociation = ConnectionAliasAssociation' (Maybe Text) (Maybe AssociationStatus) (Maybe Text) (Maybe Text)
- newConnectionAliasAssociation :: ConnectionAliasAssociation
- data ConnectionAliasPermission = ConnectionAliasPermission' Text Bool
- newConnectionAliasPermission :: Text -> Bool -> ConnectionAliasPermission
- data DefaultClientBrandingAttributes = DefaultClientBrandingAttributes' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text)
- newDefaultClientBrandingAttributes :: DefaultClientBrandingAttributes
- data DefaultImportClientBrandingAttributes = DefaultImportClientBrandingAttributes' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Base64) (Maybe Text) (Maybe Text)
- newDefaultImportClientBrandingAttributes :: DefaultImportClientBrandingAttributes
- data DefaultWorkspaceCreationProperties = DefaultWorkspaceCreationProperties' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newDefaultWorkspaceCreationProperties :: DefaultWorkspaceCreationProperties
- data FailedCreateStandbyWorkspacesRequest = FailedCreateStandbyWorkspacesRequest' (Maybe Text) (Maybe Text) (Maybe StandbyWorkspace)
- newFailedCreateStandbyWorkspacesRequest :: FailedCreateStandbyWorkspacesRequest
- data FailedCreateWorkspaceRequest = FailedCreateWorkspaceRequest' (Maybe Text) (Maybe Text) (Maybe WorkspaceRequest)
- newFailedCreateWorkspaceRequest :: FailedCreateWorkspaceRequest
- data FailedWorkspaceChangeRequest = FailedWorkspaceChangeRequest' (Maybe Text) (Maybe Text) (Maybe Text)
- newFailedWorkspaceChangeRequest :: FailedWorkspaceChangeRequest
- data ImagePermission = ImagePermission' (Maybe Text)
- newImagePermission :: ImagePermission
- data IosClientBrandingAttributes = IosClientBrandingAttributes' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newIosClientBrandingAttributes :: IosClientBrandingAttributes
- data IosImportClientBrandingAttributes = IosImportClientBrandingAttributes' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Base64) (Maybe Base64) (Maybe Base64) (Maybe Text) (Maybe Text)
- newIosImportClientBrandingAttributes :: IosImportClientBrandingAttributes
- data IpRuleItem = IpRuleItem' (Maybe Text) (Maybe Text)
- newIpRuleItem :: IpRuleItem
- data ModificationState = ModificationState' (Maybe ModificationResourceEnum) (Maybe ModificationStateEnum)
- newModificationState :: ModificationState
- data OperatingSystem = OperatingSystem' (Maybe OperatingSystemType)
- newOperatingSystem :: OperatingSystem
- data PendingCreateStandbyWorkspacesRequest = PendingCreateStandbyWorkspacesRequest' (Maybe Text) (Maybe WorkspaceState) (Maybe Text) (Maybe Text)
- newPendingCreateStandbyWorkspacesRequest :: PendingCreateStandbyWorkspacesRequest
- data RebootRequest = RebootRequest' Text
- newRebootRequest :: Text -> RebootRequest
- data RebuildRequest = RebuildRequest' Text
- newRebuildRequest :: Text -> RebuildRequest
- data RelatedWorkspaceProperties = RelatedWorkspaceProperties' (Maybe Text) (Maybe WorkspaceState) (Maybe StandbyWorkspaceRelationshipType) (Maybe Text)
- newRelatedWorkspaceProperties :: RelatedWorkspaceProperties
- data RootStorage = RootStorage' (Maybe Text)
- newRootStorage :: RootStorage
- data SamlProperties = SamlProperties' (Maybe Text) (Maybe SamlStatusEnum) (Maybe Text)
- newSamlProperties :: SamlProperties
- data SelfservicePermissions = SelfservicePermissions' (Maybe ReconnectEnum) (Maybe ReconnectEnum) (Maybe ReconnectEnum) (Maybe ReconnectEnum) (Maybe ReconnectEnum)
- newSelfservicePermissions :: SelfservicePermissions
- data Snapshot = Snapshot' (Maybe POSIX)
- newSnapshot :: Snapshot
- data StandbyWorkspace = StandbyWorkspace' (Maybe [Tag]) (Maybe Text) Text Text
- newStandbyWorkspace :: Text -> Text -> StandbyWorkspace
- data StartRequest = StartRequest' (Maybe Text)
- newStartRequest :: StartRequest
- data StopRequest = StopRequest' (Maybe Text)
- newStopRequest :: StopRequest
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
- data TerminateRequest = TerminateRequest' Text
- newTerminateRequest :: Text -> TerminateRequest
- data UpdateResult = UpdateResult' (Maybe Text) (Maybe Bool)
- newUpdateResult :: UpdateResult
- data UserStorage = UserStorage' (Maybe Text)
- newUserStorage :: UserStorage
- data Workspace = Workspace' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ModificationState]) (Maybe [RelatedWorkspaceProperties]) (Maybe Bool) (Maybe WorkspaceState) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe WorkspaceProperties)
- newWorkspace :: Workspace
- data WorkspaceAccessProperties = WorkspaceAccessProperties' (Maybe AccessPropertyValue) (Maybe AccessPropertyValue) (Maybe AccessPropertyValue) (Maybe AccessPropertyValue) (Maybe AccessPropertyValue) (Maybe AccessPropertyValue) (Maybe AccessPropertyValue) (Maybe AccessPropertyValue)
- newWorkspaceAccessProperties :: WorkspaceAccessProperties
- data WorkspaceBundle = WorkspaceBundle' (Maybe Text) (Maybe BundleType) (Maybe ComputeType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RootStorage) (Maybe WorkspaceBundleState) (Maybe UserStorage)
- newWorkspaceBundle :: WorkspaceBundle
- data WorkspaceConnectionStatus = WorkspaceConnectionStatus' (Maybe ConnectionState) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newWorkspaceConnectionStatus :: WorkspaceConnectionStatus
- data WorkspaceCreationProperties = WorkspaceCreationProperties' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newWorkspaceCreationProperties :: WorkspaceCreationProperties
- data WorkspaceDirectory = WorkspaceDirectory' (Maybe Text) (Maybe CertificateBasedAuthProperties) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe WorkspaceDirectoryType) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe SamlProperties) (Maybe SelfservicePermissions) (Maybe WorkspaceDirectoryState) (Maybe [Text]) (Maybe Tenancy) (Maybe WorkspaceAccessProperties) (Maybe DefaultWorkspaceCreationProperties) (Maybe Text) (Maybe [Text])
- newWorkspaceDirectory :: WorkspaceDirectory
- data WorkspaceImage = WorkspaceImage' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OperatingSystem) (Maybe Text) (Maybe WorkspaceImageRequiredTenancy) (Maybe WorkspaceImageState) (Maybe UpdateResult)
- newWorkspaceImage :: WorkspaceImage
- data WorkspaceProperties = WorkspaceProperties' (Maybe Compute) (Maybe [Protocol]) (Maybe Int) (Maybe RunningMode) (Maybe Int) (Maybe Int)
- newWorkspaceProperties :: WorkspaceProperties
- data WorkspaceRequest = WorkspaceRequest' (Maybe Bool) (Maybe [Tag]) (Maybe Bool) (Maybe Text) (Maybe WorkspaceProperties) Text Text Text
- newWorkspaceRequest :: Text -> Text -> Text -> WorkspaceRequest
- data WorkspacesIpGroup = WorkspacesIpGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [IpRuleItem])
- newWorkspacesIpGroup :: WorkspacesIpGroup
Service Configuration
defaultService :: Service Source #
API version 2015-04-08
of the Amazon WorkSpaces SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by WorkSpaces
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The user is not authorized to access a resource.
InvalidParameterValuesException
_InvalidParameterValuesException :: AsError a => Fold a ServiceError Source #
One or more parameter values are not valid.
InvalidResourceStateException
_InvalidResourceStateException :: AsError a => Fold a ServiceError Source #
The state of the resource is not valid for this operation.
OperationInProgressException
_OperationInProgressException :: AsError a => Fold a ServiceError Source #
The properties of this WorkSpace are currently being modified. Try again in a moment.
OperationNotSupportedException
_OperationNotSupportedException :: AsError a => Fold a ServiceError Source #
This operation is not supported.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified resource already exists.
ResourceAssociatedException
_ResourceAssociatedException :: AsError a => Fold a ServiceError Source #
The resource is associated with a directory.
ResourceCreationFailedException
_ResourceCreationFailedException :: AsError a => Fold a ServiceError Source #
The resource could not be created.
ResourceLimitExceededException
_ResourceLimitExceededException :: AsError a => Fold a ServiceError Source #
Your resource limits have been exceeded.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource could not be found.
ResourceUnavailableException
_ResourceUnavailableException :: AsError a => Fold a ServiceError Source #
The specified resource is not available.
UnsupportedNetworkConfigurationException
_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
_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
_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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateConnectionAlias
data AssociateConnectionAlias Source #
See: newAssociateConnectionAlias
smart constructor.
Constructors
AssociateConnectionAlias' Text Text |
Instances
newAssociateConnectionAlias Source #
Create a value of AssociateConnectionAlias
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:
AssociateConnectionAlias
, associateConnectionAlias_aliasId
- The identifier of the connection alias.
AssociateConnectionAlias
, associateConnectionAlias_resourceId
- The identifier of the directory to associate the connection alias with.
data AssociateConnectionAliasResponse Source #
See: newAssociateConnectionAliasResponse
smart constructor.
Constructors
AssociateConnectionAliasResponse' (Maybe Text) Int |
Instances
newAssociateConnectionAliasResponse Source #
Create a value of AssociateConnectionAliasResponse
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:
AssociateConnectionAliasResponse
, associateConnectionAliasResponse_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:httpStatus:AssociateConnectionAliasResponse'
, associateConnectionAliasResponse_httpStatus
- The response's http status code.
AssociateIpGroups
data AssociateIpGroups Source #
See: newAssociateIpGroups
smart constructor.
Constructors
AssociateIpGroups' Text [Text] |
Instances
Arguments
:: Text | |
-> AssociateIpGroups |
Create a value of AssociateIpGroups
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:
AssociateIpGroups
, associateIpGroups_directoryId
- The identifier of the directory.
$sel:groupIds:AssociateIpGroups'
, associateIpGroups_groupIds
- The identifiers of one or more IP access control groups.
data AssociateIpGroupsResponse Source #
See: newAssociateIpGroupsResponse
smart constructor.
Constructors
AssociateIpGroupsResponse' Int |
Instances
newAssociateIpGroupsResponse Source #
Create a value of AssociateIpGroupsResponse
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:httpStatus:AssociateIpGroupsResponse'
, associateIpGroupsResponse_httpStatus
- The response's http status code.
AuthorizeIpRules
data AuthorizeIpRules Source #
See: newAuthorizeIpRules
smart constructor.
Constructors
AuthorizeIpRules' Text [IpRuleItem] |
Instances
Arguments
:: Text | |
-> AuthorizeIpRules |
Create a value of AuthorizeIpRules
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:
AuthorizeIpRules
, authorizeIpRules_groupId
- The identifier of the group.
AuthorizeIpRules
, authorizeIpRules_userRules
- The rules to add to the group.
data AuthorizeIpRulesResponse Source #
See: newAuthorizeIpRulesResponse
smart constructor.
Constructors
AuthorizeIpRulesResponse' Int |
Instances
newAuthorizeIpRulesResponse Source #
Create a value of AuthorizeIpRulesResponse
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:httpStatus:AuthorizeIpRulesResponse'
, authorizeIpRulesResponse_httpStatus
- The response's http status code.
CopyWorkspaceImage
data CopyWorkspaceImage Source #
See: newCopyWorkspaceImage
smart constructor.
Instances
newCopyWorkspaceImage Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CopyWorkspaceImage |
Create a value of CopyWorkspaceImage
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:
CopyWorkspaceImage
, copyWorkspaceImage_description
- A description of the image.
CopyWorkspaceImage
, copyWorkspaceImage_tags
- The tags for the image.
CopyWorkspaceImage
, copyWorkspaceImage_name
- The name of the image.
$sel:sourceImageId:CopyWorkspaceImage'
, copyWorkspaceImage_sourceImageId
- The identifier of the source image.
$sel:sourceRegion:CopyWorkspaceImage'
, copyWorkspaceImage_sourceRegion
- The identifier of the source Region.
data CopyWorkspaceImageResponse Source #
See: newCopyWorkspaceImageResponse
smart constructor.
Constructors
CopyWorkspaceImageResponse' (Maybe Text) Int |
Instances
newCopyWorkspaceImageResponse Source #
Create a value of CopyWorkspaceImageResponse
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:
CopyWorkspaceImageResponse
, copyWorkspaceImageResponse_imageId
- The identifier of the image.
$sel:httpStatus:CopyWorkspaceImageResponse'
, copyWorkspaceImageResponse_httpStatus
- The response's http status code.
CreateConnectClientAddIn
data CreateConnectClientAddIn Source #
See: newCreateConnectClientAddIn
smart constructor.
Constructors
CreateConnectClientAddIn' Text Text Text |
Instances
newCreateConnectClientAddIn Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateConnectClientAddIn |
Create a value of CreateConnectClientAddIn
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:
CreateConnectClientAddIn
, createConnectClientAddIn_resourceId
- The directory identifier for which to configure the client add-in.
CreateConnectClientAddIn
, createConnectClientAddIn_name
- The name of the client add-in.
CreateConnectClientAddIn
, createConnectClientAddIn_url
- The endpoint URL of the Amazon Connect client add-in.
data CreateConnectClientAddInResponse Source #
See: newCreateConnectClientAddInResponse
smart constructor.
Constructors
CreateConnectClientAddInResponse' (Maybe Text) Int |
Instances
newCreateConnectClientAddInResponse Source #
Create a value of CreateConnectClientAddInResponse
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:
CreateConnectClientAddInResponse
, createConnectClientAddInResponse_addInId
- The client add-in identifier.
$sel:httpStatus:CreateConnectClientAddInResponse'
, createConnectClientAddInResponse_httpStatus
- The response's http status code.
CreateConnectionAlias
data CreateConnectionAlias Source #
See: newCreateConnectionAlias
smart constructor.
Constructors
CreateConnectionAlias' (Maybe [Tag]) Text |
Instances
newCreateConnectionAlias Source #
Arguments
:: Text | |
-> CreateConnectionAlias |
Create a value of CreateConnectionAlias
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:
CreateConnectionAlias
, createConnectionAlias_tags
- The tags to associate with the connection alias.
CreateConnectionAlias
, createConnectionAlias_connectionString
- A connection string in the form of a fully qualified domain name (FQDN),
such as www.example.com
.
After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
data CreateConnectionAliasResponse Source #
See: newCreateConnectionAliasResponse
smart constructor.
Constructors
CreateConnectionAliasResponse' (Maybe Text) Int |
Instances
newCreateConnectionAliasResponse Source #
Create a value of CreateConnectionAliasResponse
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:
CreateConnectionAliasResponse
, createConnectionAliasResponse_aliasId
- The identifier of the connection alias.
$sel:httpStatus:CreateConnectionAliasResponse'
, createConnectionAliasResponse_httpStatus
- The response's http status code.
CreateIpGroup
data CreateIpGroup Source #
See: newCreateIpGroup
smart constructor.
Constructors
CreateIpGroup' (Maybe Text) (Maybe [Tag]) (Maybe [IpRuleItem]) Text |
Instances
Arguments
:: Text | |
-> CreateIpGroup |
Create a value of CreateIpGroup
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:
CreateIpGroup
, createIpGroup_groupDesc
- The description of the group.
CreateIpGroup
, createIpGroup_tags
- The tags. Each WorkSpaces resource can have a maximum of 50 tags.
CreateIpGroup
, createIpGroup_userRules
- The rules to add to the group.
CreateIpGroup
, createIpGroup_groupName
- The name of the group.
data CreateIpGroupResponse Source #
See: newCreateIpGroupResponse
smart constructor.
Constructors
CreateIpGroupResponse' (Maybe Text) Int |
Instances
newCreateIpGroupResponse Source #
Create a value of CreateIpGroupResponse
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:
CreateIpGroupResponse
, createIpGroupResponse_groupId
- The identifier of the group.
$sel:httpStatus:CreateIpGroupResponse'
, createIpGroupResponse_httpStatus
- The response's http status code.
CreateStandbyWorkspaces
data CreateStandbyWorkspaces Source #
See: newCreateStandbyWorkspaces
smart constructor.
Constructors
CreateStandbyWorkspaces' Text [StandbyWorkspace] |
Instances
newCreateStandbyWorkspaces Source #
Create a value of CreateStandbyWorkspaces
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:primaryRegion:CreateStandbyWorkspaces'
, createStandbyWorkspaces_primaryRegion
- The Region of the primary WorkSpace.
$sel:standbyWorkspaces:CreateStandbyWorkspaces'
, createStandbyWorkspaces_standbyWorkspaces
- Information about the Standby WorkSpace to be created.
data CreateStandbyWorkspacesResponse Source #
See: newCreateStandbyWorkspacesResponse
smart constructor.
Constructors
CreateStandbyWorkspacesResponse' (Maybe [FailedCreateStandbyWorkspacesRequest]) (Maybe [PendingCreateStandbyWorkspacesRequest]) Int |
Instances
newCreateStandbyWorkspacesResponse Source #
Create a value of CreateStandbyWorkspacesResponse
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:failedStandbyRequests:CreateStandbyWorkspacesResponse'
, createStandbyWorkspacesResponse_failedStandbyRequests
- Information about the Standby WorkSpace that could not be created.
$sel:pendingStandbyRequests:CreateStandbyWorkspacesResponse'
, createStandbyWorkspacesResponse_pendingStandbyRequests
- Information about the Standby WorkSpace that was created.
$sel:httpStatus:CreateStandbyWorkspacesResponse'
, createStandbyWorkspacesResponse_httpStatus
- The response's http status code.
CreateTags
data CreateTags Source #
See: newCreateTags
smart constructor.
Constructors
CreateTags' Text [Tag] |
Instances
Arguments
:: Text | |
-> CreateTags |
Create a value of CreateTags
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:
CreateTags
, createTags_resourceId
- The identifier of the WorkSpaces resource. The supported resource types
are WorkSpaces, registered directories, images, custom bundles, IP
access control groups, and connection aliases.
CreateTags
, createTags_tags
- The tags. Each WorkSpaces resource can have a maximum of 50 tags.
data CreateTagsResponse Source #
See: newCreateTagsResponse
smart constructor.
Constructors
CreateTagsResponse' Int |
Instances
newCreateTagsResponse Source #
Arguments
:: Int | |
-> CreateTagsResponse |
Create a value of CreateTagsResponse
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:httpStatus:CreateTagsResponse'
, createTagsResponse_httpStatus
- The response's http status code.
CreateUpdatedWorkspaceImage
data CreateUpdatedWorkspaceImage Source #
See: newCreateUpdatedWorkspaceImage
smart constructor.
Instances
newCreateUpdatedWorkspaceImage Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateUpdatedWorkspaceImage |
Create a value of CreateUpdatedWorkspaceImage
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:
CreateUpdatedWorkspaceImage
, createUpdatedWorkspaceImage_tags
- The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you're creating the updated image,
you must create an IAM policy that grants your IAM user permissions to
use workspaces:CreateTags
.
CreateUpdatedWorkspaceImage
, createUpdatedWorkspaceImage_name
- The name of the new updated WorkSpace image.
CreateUpdatedWorkspaceImage
, createUpdatedWorkspaceImage_description
- A description of whether updates for the WorkSpace image are available.
$sel:sourceImageId:CreateUpdatedWorkspaceImage'
, createUpdatedWorkspaceImage_sourceImageId
- The identifier of the source WorkSpace image.
data CreateUpdatedWorkspaceImageResponse Source #
See: newCreateUpdatedWorkspaceImageResponse
smart constructor.
Constructors
CreateUpdatedWorkspaceImageResponse' (Maybe Text) Int |
Instances
newCreateUpdatedWorkspaceImageResponse Source #
Arguments
:: Int | |
-> CreateUpdatedWorkspaceImageResponse |
Create a value of CreateUpdatedWorkspaceImageResponse
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:
CreateUpdatedWorkspaceImageResponse
, createUpdatedWorkspaceImageResponse_imageId
- The identifier of the new updated WorkSpace image.
$sel:httpStatus:CreateUpdatedWorkspaceImageResponse'
, createUpdatedWorkspaceImageResponse_httpStatus
- The response's http status code.
CreateWorkspaceBundle
data CreateWorkspaceBundle Source #
See: newCreateWorkspaceBundle
smart constructor.
Constructors
CreateWorkspaceBundle' (Maybe RootStorage) (Maybe [Tag]) Text Text Text ComputeType UserStorage |
Instances
newCreateWorkspaceBundle Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> ComputeType | |
-> UserStorage | |
-> CreateWorkspaceBundle |
Create a value of CreateWorkspaceBundle
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:
CreateWorkspaceBundle
, createWorkspaceBundle_rootStorage
- Undocumented member.
CreateWorkspaceBundle
, createWorkspaceBundle_tags
- The tags associated with the bundle.
To add tags at the same time when you're creating the bundle, you must
create an IAM policy that grants your IAM user permissions to use
workspaces:CreateTags
.
$sel:bundleName:CreateWorkspaceBundle'
, createWorkspaceBundle_bundleName
- The name of the bundle.
$sel:bundleDescription:CreateWorkspaceBundle'
, createWorkspaceBundle_bundleDescription
- The description of the bundle.
CreateWorkspaceBundle
, createWorkspaceBundle_imageId
- The identifier of the image that is used to create the bundle.
CreateWorkspaceBundle
, createWorkspaceBundle_computeType
- Undocumented member.
CreateWorkspaceBundle
, createWorkspaceBundle_userStorage
- Undocumented member.
data CreateWorkspaceBundleResponse Source #
See: newCreateWorkspaceBundleResponse
smart constructor.
Constructors
CreateWorkspaceBundleResponse' (Maybe WorkspaceBundle) Int |
Instances
newCreateWorkspaceBundleResponse Source #
Create a value of CreateWorkspaceBundleResponse
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:workspaceBundle:CreateWorkspaceBundleResponse'
, createWorkspaceBundleResponse_workspaceBundle
- Undocumented member.
$sel:httpStatus:CreateWorkspaceBundleResponse'
, createWorkspaceBundleResponse_httpStatus
- The response's http status code.
CreateWorkspaceImage
data CreateWorkspaceImage Source #
See: newCreateWorkspaceImage
smart constructor.
Instances
newCreateWorkspaceImage Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateWorkspaceImage |
Create a value of CreateWorkspaceImage
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:
CreateWorkspaceImage
, createWorkspaceImage_tags
- The tags that you want to add to the new WorkSpace image. To add tags
when you're creating the image, you must create an IAM policy that
grants your IAM user permission to use workspaces:CreateTags
.
CreateWorkspaceImage
, createWorkspaceImage_name
- The name of the new WorkSpace image.
CreateWorkspaceImage
, createWorkspaceImage_description
- The description of the new WorkSpace image.
CreateWorkspaceImage
, createWorkspaceImage_workspaceId
- The identifier of the source WorkSpace
data CreateWorkspaceImageResponse Source #
See: newCreateWorkspaceImageResponse
smart constructor.
Constructors
CreateWorkspaceImageResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OperatingSystem) (Maybe Text) (Maybe WorkspaceImageRequiredTenancy) (Maybe WorkspaceImageState) Int |
Instances
newCreateWorkspaceImageResponse Source #
Create a value of CreateWorkspaceImageResponse
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:
CreateWorkspaceImageResponse
, createWorkspaceImageResponse_created
- The date when the image was created.
CreateWorkspaceImage
, createWorkspaceImageResponse_description
- The description of the image.
CreateWorkspaceImageResponse
, createWorkspaceImageResponse_imageId
- The identifier of the new WorkSpace image.
CreateWorkspaceImage
, createWorkspaceImageResponse_name
- The name of the image.
CreateWorkspaceImageResponse
, createWorkspaceImageResponse_operatingSystem
- The operating system that the image is running.
CreateWorkspaceImageResponse
, createWorkspaceImageResponse_ownerAccountId
- The identifier of the Amazon Web Services account that owns the image.
CreateWorkspaceImageResponse
, createWorkspaceImageResponse_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..
CreateWorkspaceImageResponse
, createWorkspaceImageResponse_state
- The availability status of the image.
$sel:httpStatus:CreateWorkspaceImageResponse'
, createWorkspaceImageResponse_httpStatus
- The response's http status code.
CreateWorkspaces
data CreateWorkspaces Source #
See: newCreateWorkspaces
smart constructor.
Constructors
CreateWorkspaces' (NonEmpty WorkspaceRequest) |
Instances
Create a value of CreateWorkspaces
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:workspaces:CreateWorkspaces'
, createWorkspaces_workspaces
- The WorkSpaces to create. You can specify up to 25 WorkSpaces.
data CreateWorkspacesResponse Source #
See: newCreateWorkspacesResponse
smart constructor.
Constructors
CreateWorkspacesResponse' (Maybe [FailedCreateWorkspaceRequest]) (Maybe [Workspace]) Int |
Instances
newCreateWorkspacesResponse Source #
Create a value of CreateWorkspacesResponse
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:failedRequests:CreateWorkspacesResponse'
, createWorkspacesResponse_failedRequests
- Information about the WorkSpaces that could not be created.
$sel:pendingRequests:CreateWorkspacesResponse'
, createWorkspacesResponse_pendingRequests
- Information about the WorkSpaces that were 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:httpStatus:CreateWorkspacesResponse'
, createWorkspacesResponse_httpStatus
- The response's http status code.
DeleteClientBranding
data DeleteClientBranding Source #
See: newDeleteClientBranding
smart constructor.
Constructors
DeleteClientBranding' Text (NonEmpty ClientDeviceType) |
Instances
newDeleteClientBranding Source #
Arguments
:: Text | |
-> NonEmpty ClientDeviceType | |
-> DeleteClientBranding |
Create a value of DeleteClientBranding
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:
DeleteClientBranding
, deleteClientBranding_resourceId
- The directory identifier of the WorkSpace for which you want to delete
client branding.
$sel:platforms:DeleteClientBranding'
, deleteClientBranding_platforms
- The device type for which you want to delete client branding.
data DeleteClientBrandingResponse Source #
See: newDeleteClientBrandingResponse
smart constructor.
Constructors
DeleteClientBrandingResponse' Int |
Instances
newDeleteClientBrandingResponse Source #
Create a value of DeleteClientBrandingResponse
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:httpStatus:DeleteClientBrandingResponse'
, deleteClientBrandingResponse_httpStatus
- The response's http status code.
DeleteConnectClientAddIn
data DeleteConnectClientAddIn Source #
See: newDeleteConnectClientAddIn
smart constructor.
Constructors
DeleteConnectClientAddIn' Text Text |
Instances
newDeleteConnectClientAddIn Source #
Create a value of DeleteConnectClientAddIn
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:
DeleteConnectClientAddIn
, deleteConnectClientAddIn_addInId
- The identifier of the client add-in to delete.
DeleteConnectClientAddIn
, deleteConnectClientAddIn_resourceId
- The directory identifier for which the client add-in is configured.
data DeleteConnectClientAddInResponse Source #
See: newDeleteConnectClientAddInResponse
smart constructor.
Constructors
DeleteConnectClientAddInResponse' Int |
Instances
newDeleteConnectClientAddInResponse Source #
Create a value of DeleteConnectClientAddInResponse
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:httpStatus:DeleteConnectClientAddInResponse'
, deleteConnectClientAddInResponse_httpStatus
- The response's http status code.
DeleteConnectionAlias
data DeleteConnectionAlias Source #
See: newDeleteConnectionAlias
smart constructor.
Constructors
DeleteConnectionAlias' Text |
Instances
newDeleteConnectionAlias Source #
Arguments
:: Text | |
-> DeleteConnectionAlias |
Create a value of DeleteConnectionAlias
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:
DeleteConnectionAlias
, deleteConnectionAlias_aliasId
- The identifier of the connection alias to delete.
data DeleteConnectionAliasResponse Source #
See: newDeleteConnectionAliasResponse
smart constructor.
Constructors
DeleteConnectionAliasResponse' Int |
Instances
newDeleteConnectionAliasResponse Source #
Create a value of DeleteConnectionAliasResponse
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:httpStatus:DeleteConnectionAliasResponse'
, deleteConnectionAliasResponse_httpStatus
- The response's http status code.
DeleteIpGroup
data DeleteIpGroup Source #
See: newDeleteIpGroup
smart constructor.
Constructors
DeleteIpGroup' Text |
Instances
Arguments
:: Text | |
-> DeleteIpGroup |
Create a value of DeleteIpGroup
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:
DeleteIpGroup
, deleteIpGroup_groupId
- The identifier of the IP access control group.
data DeleteIpGroupResponse Source #
See: newDeleteIpGroupResponse
smart constructor.
Constructors
DeleteIpGroupResponse' Int |
Instances
newDeleteIpGroupResponse Source #
Create a value of DeleteIpGroupResponse
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:httpStatus:DeleteIpGroupResponse'
, deleteIpGroupResponse_httpStatus
- The response's http status code.
DeleteTags
data DeleteTags Source #
See: newDeleteTags
smart constructor.
Constructors
DeleteTags' Text [Text] |
Instances
Arguments
:: Text | |
-> DeleteTags |
Create a value of DeleteTags
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:
DeleteTags
, deleteTags_resourceId
- The identifier of the WorkSpaces resource. The supported resource types
are WorkSpaces, registered directories, images, custom bundles, IP
access control groups, and connection aliases.
$sel:tagKeys:DeleteTags'
, deleteTags_tagKeys
- The tag keys.
data DeleteTagsResponse Source #
See: newDeleteTagsResponse
smart constructor.
Constructors
DeleteTagsResponse' Int |
Instances
newDeleteTagsResponse Source #
Arguments
:: Int | |
-> DeleteTagsResponse |
Create a value of DeleteTagsResponse
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:httpStatus:DeleteTagsResponse'
, deleteTagsResponse_httpStatus
- The response's http status code.
DeleteWorkspaceBundle
data DeleteWorkspaceBundle Source #
See: newDeleteWorkspaceBundle
smart constructor.
Constructors
DeleteWorkspaceBundle' (Maybe Text) |
Instances
newDeleteWorkspaceBundle :: DeleteWorkspaceBundle Source #
Create a value of DeleteWorkspaceBundle
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:
DeleteWorkspaceBundle
, deleteWorkspaceBundle_bundleId
- The identifier of the bundle.
data DeleteWorkspaceBundleResponse Source #
See: newDeleteWorkspaceBundleResponse
smart constructor.
Constructors
DeleteWorkspaceBundleResponse' Int |
Instances
newDeleteWorkspaceBundleResponse Source #
Create a value of DeleteWorkspaceBundleResponse
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:httpStatus:DeleteWorkspaceBundleResponse'
, deleteWorkspaceBundleResponse_httpStatus
- The response's http status code.
DeleteWorkspaceImage
data DeleteWorkspaceImage Source #
See: newDeleteWorkspaceImage
smart constructor.
Constructors
DeleteWorkspaceImage' Text |
Instances
newDeleteWorkspaceImage Source #
Arguments
:: Text | |
-> DeleteWorkspaceImage |
Create a value of DeleteWorkspaceImage
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:
DeleteWorkspaceImage
, deleteWorkspaceImage_imageId
- The identifier of the image.
data DeleteWorkspaceImageResponse Source #
See: newDeleteWorkspaceImageResponse
smart constructor.
Constructors
DeleteWorkspaceImageResponse' Int |
Instances
newDeleteWorkspaceImageResponse Source #
Create a value of DeleteWorkspaceImageResponse
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:httpStatus:DeleteWorkspaceImageResponse'
, deleteWorkspaceImageResponse_httpStatus
- The response's http status code.
DeregisterWorkspaceDirectory
data DeregisterWorkspaceDirectory Source #
See: newDeregisterWorkspaceDirectory
smart constructor.
Constructors
DeregisterWorkspaceDirectory' Text |
Instances
newDeregisterWorkspaceDirectory Source #
Arguments
:: Text | |
-> DeregisterWorkspaceDirectory |
Create a value of DeregisterWorkspaceDirectory
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:
DeregisterWorkspaceDirectory
, deregisterWorkspaceDirectory_directoryId
- The identifier of the directory. If any WorkSpaces are registered to
this directory, you must remove them before you deregister the
directory, or you will receive an OperationNotSupportedException error.
data DeregisterWorkspaceDirectoryResponse Source #
See: newDeregisterWorkspaceDirectoryResponse
smart constructor.
Constructors
DeregisterWorkspaceDirectoryResponse' Int |
Instances
newDeregisterWorkspaceDirectoryResponse Source #
Arguments
:: Int | |
-> DeregisterWorkspaceDirectoryResponse |
Create a value of DeregisterWorkspaceDirectoryResponse
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:httpStatus:DeregisterWorkspaceDirectoryResponse'
, deregisterWorkspaceDirectoryResponse_httpStatus
- The response's http status code.
DescribeAccount
data DescribeAccount Source #
See: newDescribeAccount
smart constructor.
Constructors
DescribeAccount' | |
Instances
newDescribeAccount :: DescribeAccount Source #
Create a value of DescribeAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeAccountResponse Source #
See: newDescribeAccountResponse
smart constructor.
Constructors
DescribeAccountResponse' (Maybe Text) (Maybe DedicatedTenancySupportResultEnum) Int |
Instances
newDescribeAccountResponse Source #
Create a value of DescribeAccountResponse
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:
DescribeAccountResponse
, describeAccountResponse_dedicatedTenancyManagementCidrRange
- The IP address range, specified as an IPv4 CIDR block, used for the
management network interface.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
DescribeAccountResponse
, describeAccountResponse_dedicatedTenancySupport
- The status of BYOL (whether BYOL is enabled or disabled).
$sel:httpStatus:DescribeAccountResponse'
, describeAccountResponse_httpStatus
- The response's http status code.
DescribeAccountModifications (Paginated)
data DescribeAccountModifications Source #
See: newDescribeAccountModifications
smart constructor.
Constructors
DescribeAccountModifications' (Maybe Text) |
Instances
newDescribeAccountModifications :: DescribeAccountModifications Source #
Create a value of DescribeAccountModifications
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:
DescribeAccountModifications
, describeAccountModifications_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
data DescribeAccountModificationsResponse Source #
See: newDescribeAccountModificationsResponse
smart constructor.
Constructors
DescribeAccountModificationsResponse' (Maybe [AccountModification]) (Maybe Text) Int |
Instances
newDescribeAccountModificationsResponse Source #
Arguments
:: Int | |
-> DescribeAccountModificationsResponse |
Create a value of DescribeAccountModificationsResponse
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:accountModifications:DescribeAccountModificationsResponse'
, describeAccountModificationsResponse_accountModifications
- The list of modifications to the configuration of BYOL.
DescribeAccountModifications
, describeAccountModificationsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:DescribeAccountModificationsResponse'
, describeAccountModificationsResponse_httpStatus
- The response's http status code.
DescribeClientBranding
data DescribeClientBranding Source #
See: newDescribeClientBranding
smart constructor.
Constructors
DescribeClientBranding' Text |
Instances
newDescribeClientBranding Source #
Arguments
:: Text | |
-> DescribeClientBranding |
Create a value of DescribeClientBranding
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:
DescribeClientBranding
, describeClientBranding_resourceId
- The directory identifier of the WorkSpace for which you want to view
client branding information.
data DescribeClientBrandingResponse Source #
See: newDescribeClientBrandingResponse
smart constructor.
Constructors
Instances
newDescribeClientBrandingResponse Source #
Create a value of DescribeClientBrandingResponse
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:
DescribeClientBrandingResponse
, describeClientBrandingResponse_deviceTypeAndroid
- The branding information for Android devices.
DescribeClientBrandingResponse
, describeClientBrandingResponse_deviceTypeIos
- The branding information for iOS devices.
DescribeClientBrandingResponse
, describeClientBrandingResponse_deviceTypeLinux
- The branding information for Linux devices.
DescribeClientBrandingResponse
, describeClientBrandingResponse_deviceTypeOsx
- The branding information for macOS devices.
DescribeClientBrandingResponse
, describeClientBrandingResponse_deviceTypeWeb
- The branding information for Web access.
DescribeClientBrandingResponse
, describeClientBrandingResponse_deviceTypeWindows
- The branding information for Windows devices.
$sel:httpStatus:DescribeClientBrandingResponse'
, describeClientBrandingResponse_httpStatus
- The response's http status code.
DescribeClientProperties
data DescribeClientProperties Source #
See: newDescribeClientProperties
smart constructor.
Constructors
DescribeClientProperties' (NonEmpty Text) |
Instances
newDescribeClientProperties Source #
Create a value of DescribeClientProperties
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:resourceIds:DescribeClientProperties'
, describeClientProperties_resourceIds
- The resource identifier, in the form of directory IDs.
data DescribeClientPropertiesResponse Source #
See: newDescribeClientPropertiesResponse
smart constructor.
Constructors
DescribeClientPropertiesResponse' (Maybe [ClientPropertiesResult]) Int |
Instances
newDescribeClientPropertiesResponse Source #
Create a value of DescribeClientPropertiesResponse
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:clientPropertiesList:DescribeClientPropertiesResponse'
, describeClientPropertiesResponse_clientPropertiesList
- Information about the specified Amazon WorkSpaces clients.
$sel:httpStatus:DescribeClientPropertiesResponse'
, describeClientPropertiesResponse_httpStatus
- The response's http status code.
DescribeConnectClientAddIns
data DescribeConnectClientAddIns Source #
See: newDescribeConnectClientAddIns
smart constructor.
Instances
newDescribeConnectClientAddIns Source #
Arguments
:: Text | |
-> DescribeConnectClientAddIns |
Create a value of DescribeConnectClientAddIns
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:maxResults:DescribeConnectClientAddIns'
, describeConnectClientAddIns_maxResults
- The maximum number of items to return.
DescribeConnectClientAddIns
, describeConnectClientAddIns_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
DescribeConnectClientAddIns
, describeConnectClientAddIns_resourceId
- The directory identifier for which the client add-in is configured.
data DescribeConnectClientAddInsResponse Source #
See: newDescribeConnectClientAddInsResponse
smart constructor.
Constructors
DescribeConnectClientAddInsResponse' (Maybe [ConnectClientAddIn]) (Maybe Text) Int |
Instances
newDescribeConnectClientAddInsResponse Source #
Arguments
:: Int | |
-> DescribeConnectClientAddInsResponse |
Create a value of DescribeConnectClientAddInsResponse
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:addIns:DescribeConnectClientAddInsResponse'
, describeConnectClientAddInsResponse_addIns
- Information about client add-ins.
DescribeConnectClientAddIns
, describeConnectClientAddInsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:DescribeConnectClientAddInsResponse'
, describeConnectClientAddInsResponse_httpStatus
- The response's http status code.
DescribeConnectionAliasPermissions
data DescribeConnectionAliasPermissions Source #
See: newDescribeConnectionAliasPermissions
smart constructor.
Instances
newDescribeConnectionAliasPermissions Source #
Create a value of DescribeConnectionAliasPermissions
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:maxResults:DescribeConnectionAliasPermissions'
, describeConnectionAliasPermissions_maxResults
- The maximum number of results to return.
DescribeConnectionAliasPermissions
, describeConnectionAliasPermissions_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
DescribeConnectionAliasPermissions
, describeConnectionAliasPermissions_aliasId
- The identifier of the connection alias.
data DescribeConnectionAliasPermissionsResponse Source #
See: newDescribeConnectionAliasPermissionsResponse
smart constructor.
Constructors
DescribeConnectionAliasPermissionsResponse' (Maybe Text) (Maybe (NonEmpty ConnectionAliasPermission)) (Maybe Text) Int |
Instances
newDescribeConnectionAliasPermissionsResponse Source #
Arguments
:: Int | |
-> DescribeConnectionAliasPermissionsResponse |
Create a value of DescribeConnectionAliasPermissionsResponse
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:
DescribeConnectionAliasPermissions
, describeConnectionAliasPermissionsResponse_aliasId
- The identifier of the connection alias.
$sel:connectionAliasPermissions:DescribeConnectionAliasPermissionsResponse'
, describeConnectionAliasPermissionsResponse_connectionAliasPermissions
- The permissions associated with a connection alias.
DescribeConnectionAliasPermissions
, describeConnectionAliasPermissionsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:DescribeConnectionAliasPermissionsResponse'
, describeConnectionAliasPermissionsResponse_httpStatus
- The response's http status code.
DescribeConnectionAliases
data DescribeConnectionAliases Source #
See: newDescribeConnectionAliases
smart constructor.
Constructors
DescribeConnectionAliases' (Maybe (NonEmpty Text)) (Maybe Natural) (Maybe Text) (Maybe Text) |
Instances
newDescribeConnectionAliases :: DescribeConnectionAliases Source #
Create a value of DescribeConnectionAliases
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:aliasIds:DescribeConnectionAliases'
, describeConnectionAliases_aliasIds
- The identifiers of the connection aliases to describe.
$sel:limit:DescribeConnectionAliases'
, describeConnectionAliases_limit
- The maximum number of connection aliases to return.
DescribeConnectionAliases
, describeConnectionAliases_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
DescribeConnectionAliases
, describeConnectionAliases_resourceId
- The identifier of the directory associated with the connection alias.
data DescribeConnectionAliasesResponse Source #
See: newDescribeConnectionAliasesResponse
smart constructor.
Constructors
DescribeConnectionAliasesResponse' (Maybe (NonEmpty ConnectionAlias)) (Maybe Text) Int |
Instances
newDescribeConnectionAliasesResponse Source #
Arguments
:: Int | |
-> DescribeConnectionAliasesResponse |
Create a value of DescribeConnectionAliasesResponse
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:connectionAliases:DescribeConnectionAliasesResponse'
, describeConnectionAliasesResponse_connectionAliases
- Information about the specified connection aliases.
DescribeConnectionAliases
, describeConnectionAliasesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:DescribeConnectionAliasesResponse'
, describeConnectionAliasesResponse_httpStatus
- The response's http status code.
DescribeIpGroups (Paginated)
data DescribeIpGroups Source #
See: newDescribeIpGroups
smart constructor.
Instances
newDescribeIpGroups :: DescribeIpGroups Source #
Create a value of DescribeIpGroups
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:groupIds:DescribeIpGroups'
, describeIpGroups_groupIds
- The identifiers of one or more IP access control groups.
$sel:maxResults:DescribeIpGroups'
, describeIpGroups_maxResults
- The maximum number of items to return.
DescribeIpGroups
, describeIpGroups_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
data DescribeIpGroupsResponse Source #
See: newDescribeIpGroupsResponse
smart constructor.
Constructors
DescribeIpGroupsResponse' (Maybe Text) (Maybe [WorkspacesIpGroup]) Int |
Instances
newDescribeIpGroupsResponse Source #
Create a value of DescribeIpGroupsResponse
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:
DescribeIpGroups
, describeIpGroupsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:result:DescribeIpGroupsResponse'
, describeIpGroupsResponse_result
- Information about the IP access control groups.
$sel:httpStatus:DescribeIpGroupsResponse'
, describeIpGroupsResponse_httpStatus
- The response's http status code.
DescribeTags
data DescribeTags Source #
See: newDescribeTags
smart constructor.
Constructors
DescribeTags' Text |
Instances
Arguments
:: Text | |
-> DescribeTags |
Create a value of DescribeTags
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:
DescribeTags
, describeTags_resourceId
- The identifier of the WorkSpaces resource. The supported resource types
are WorkSpaces, registered directories, images, custom bundles, IP
access control groups, and connection aliases.
data DescribeTagsResponse Source #
See: newDescribeTagsResponse
smart constructor.
Constructors
DescribeTagsResponse' (Maybe [Tag]) Int |
Instances
newDescribeTagsResponse Source #
Arguments
:: Int | |
-> DescribeTagsResponse |
Create a value of DescribeTagsResponse
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:tagList:DescribeTagsResponse'
, describeTagsResponse_tagList
- The tags.
$sel:httpStatus:DescribeTagsResponse'
, describeTagsResponse_httpStatus
- The response's http status code.
DescribeWorkspaceBundles (Paginated)
data DescribeWorkspaceBundles Source #
See: newDescribeWorkspaceBundles
smart constructor.
Instances
newDescribeWorkspaceBundles :: DescribeWorkspaceBundles Source #
Create a value of DescribeWorkspaceBundles
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:bundleIds:DescribeWorkspaceBundles'
, describeWorkspaceBundles_bundleIds
- The identifiers of the bundles. You cannot combine this parameter with
any other filter.
DescribeWorkspaceBundles
, describeWorkspaceBundles_nextToken
- The token for the next set of results. (You received this token from a
previous call.)
DescribeWorkspaceBundles
, describeWorkspaceBundles_owner
- The owner of the bundles. You cannot combine this parameter with any
other filter.
To describe the bundles provided by Amazon Web Services, specify
AMAZON
. To describe the bundles that belong to your account, don't
specify a value.
data DescribeWorkspaceBundlesResponse Source #
See: newDescribeWorkspaceBundlesResponse
smart constructor.
Constructors
DescribeWorkspaceBundlesResponse' (Maybe [WorkspaceBundle]) (Maybe Text) Int |
Instances
newDescribeWorkspaceBundlesResponse Source #
Create a value of DescribeWorkspaceBundlesResponse
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:bundles:DescribeWorkspaceBundlesResponse'
, describeWorkspaceBundlesResponse_bundles
- Information about the bundles.
DescribeWorkspaceBundles
, describeWorkspaceBundlesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return. This token is valid for
one day and must be used within that time frame.
$sel:httpStatus:DescribeWorkspaceBundlesResponse'
, describeWorkspaceBundlesResponse_httpStatus
- The response's http status code.
DescribeWorkspaceDirectories (Paginated)
data DescribeWorkspaceDirectories Source #
See: newDescribeWorkspaceDirectories
smart constructor.
Instances
newDescribeWorkspaceDirectories :: DescribeWorkspaceDirectories Source #
Create a value of DescribeWorkspaceDirectories
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:directoryIds:DescribeWorkspaceDirectories'
, describeWorkspaceDirectories_directoryIds
- The identifiers of the directories. If the value is null, all
directories are retrieved.
$sel:limit:DescribeWorkspaceDirectories'
, describeWorkspaceDirectories_limit
- The maximum number of directories to return.
DescribeWorkspaceDirectories
, describeWorkspaceDirectories_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
data DescribeWorkspaceDirectoriesResponse Source #
See: newDescribeWorkspaceDirectoriesResponse
smart constructor.
Constructors
DescribeWorkspaceDirectoriesResponse' (Maybe [WorkspaceDirectory]) (Maybe Text) Int |
Instances
newDescribeWorkspaceDirectoriesResponse Source #
Arguments
:: Int | |
-> DescribeWorkspaceDirectoriesResponse |
Create a value of DescribeWorkspaceDirectoriesResponse
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:directories:DescribeWorkspaceDirectoriesResponse'
, describeWorkspaceDirectoriesResponse_directories
- Information about the directories.
DescribeWorkspaceDirectories
, describeWorkspaceDirectoriesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:DescribeWorkspaceDirectoriesResponse'
, describeWorkspaceDirectoriesResponse_httpStatus
- The response's http status code.
DescribeWorkspaceImagePermissions
data DescribeWorkspaceImagePermissions Source #
See: newDescribeWorkspaceImagePermissions
smart constructor.
Instances
newDescribeWorkspaceImagePermissions Source #
Create a value of DescribeWorkspaceImagePermissions
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:maxResults:DescribeWorkspaceImagePermissions'
, describeWorkspaceImagePermissions_maxResults
- The maximum number of items to return.
DescribeWorkspaceImagePermissions
, describeWorkspaceImagePermissions_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
DescribeWorkspaceImagePermissions
, describeWorkspaceImagePermissions_imageId
- The identifier of the image.
data DescribeWorkspaceImagePermissionsResponse Source #
See: newDescribeWorkspaceImagePermissionsResponse
smart constructor.
Constructors
DescribeWorkspaceImagePermissionsResponse' (Maybe Text) (Maybe [ImagePermission]) (Maybe Text) Int |
Instances
newDescribeWorkspaceImagePermissionsResponse Source #
Arguments
:: Int | |
-> DescribeWorkspaceImagePermissionsResponse |
Create a value of DescribeWorkspaceImagePermissionsResponse
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:
DescribeWorkspaceImagePermissions
, describeWorkspaceImagePermissionsResponse_imageId
- The identifier of the image.
$sel:imagePermissions:DescribeWorkspaceImagePermissionsResponse'
, describeWorkspaceImagePermissionsResponse_imagePermissions
- The identifiers of the Amazon Web Services accounts that the image has
been shared with.
DescribeWorkspaceImagePermissions
, describeWorkspaceImagePermissionsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:DescribeWorkspaceImagePermissionsResponse'
, describeWorkspaceImagePermissionsResponse_httpStatus
- The response's http status code.
DescribeWorkspaceImages (Paginated)
data DescribeWorkspaceImages Source #
See: newDescribeWorkspaceImages
smart constructor.
Constructors
DescribeWorkspaceImages' (Maybe (NonEmpty Text)) (Maybe ImageType) (Maybe Natural) (Maybe Text) |
Instances
newDescribeWorkspaceImages :: DescribeWorkspaceImages Source #
Create a value of DescribeWorkspaceImages
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:imageIds:DescribeWorkspaceImages'
, describeWorkspaceImages_imageIds
- The identifier of the image.
$sel:imageType:DescribeWorkspaceImages'
, describeWorkspaceImages_imageType
- The type (owned or shared) of the image.
$sel:maxResults:DescribeWorkspaceImages'
, describeWorkspaceImages_maxResults
- The maximum number of items to return.
DescribeWorkspaceImages
, describeWorkspaceImages_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
data DescribeWorkspaceImagesResponse Source #
See: newDescribeWorkspaceImagesResponse
smart constructor.
Constructors
DescribeWorkspaceImagesResponse' (Maybe [WorkspaceImage]) (Maybe Text) Int |
Instances
newDescribeWorkspaceImagesResponse Source #
Create a value of DescribeWorkspaceImagesResponse
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:images:DescribeWorkspaceImagesResponse'
, describeWorkspaceImagesResponse_images
- Information about the images.
DescribeWorkspaceImages
, describeWorkspaceImagesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:DescribeWorkspaceImagesResponse'
, describeWorkspaceImagesResponse_httpStatus
- The response's http status code.
DescribeWorkspaceSnapshots
data DescribeWorkspaceSnapshots Source #
See: newDescribeWorkspaceSnapshots
smart constructor.
Constructors
DescribeWorkspaceSnapshots' Text |
Instances
newDescribeWorkspaceSnapshots Source #
Arguments
:: Text | |
-> DescribeWorkspaceSnapshots |
Create a value of DescribeWorkspaceSnapshots
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:
DescribeWorkspaceSnapshots
, describeWorkspaceSnapshots_workspaceId
- The identifier of the WorkSpace.
data DescribeWorkspaceSnapshotsResponse Source #
See: newDescribeWorkspaceSnapshotsResponse
smart constructor.
Instances
newDescribeWorkspaceSnapshotsResponse Source #
Arguments
:: Int | |
-> DescribeWorkspaceSnapshotsResponse |
Create a value of DescribeWorkspaceSnapshotsResponse
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:rebuildSnapshots:DescribeWorkspaceSnapshotsResponse'
, describeWorkspaceSnapshotsResponse_rebuildSnapshots
- Information about the snapshots that can be used to rebuild a WorkSpace.
These snapshots include the user volume.
$sel:restoreSnapshots:DescribeWorkspaceSnapshotsResponse'
, describeWorkspaceSnapshotsResponse_restoreSnapshots
- Information about the snapshots that can be used to restore a WorkSpace.
These snapshots include both the root volume and the user volume.
$sel:httpStatus:DescribeWorkspaceSnapshotsResponse'
, describeWorkspaceSnapshotsResponse_httpStatus
- The response's http status code.
DescribeWorkspaces (Paginated)
data DescribeWorkspaces Source #
See: newDescribeWorkspaces
smart constructor.
Constructors
DescribeWorkspaces' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) |
Instances
newDescribeWorkspaces :: DescribeWorkspaces Source #
Create a value of DescribeWorkspaces
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:
DescribeWorkspaces
, describeWorkspaces_bundleId
- The identifier of the bundle. All WorkSpaces that are created from this
bundle are retrieved. You cannot combine this parameter with any other
filter.
DescribeWorkspaces
, describeWorkspaces_directoryId
- The identifier of the directory. In addition, you can optionally specify
a specific directory user (see UserName
). You cannot combine this
parameter with any other filter.
$sel:limit:DescribeWorkspaces'
, describeWorkspaces_limit
- The maximum number of items to return.
DescribeWorkspaces
, describeWorkspaces_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
DescribeWorkspaces
, describeWorkspaces_userName
- The name of the directory user. You must specify this parameter with
DirectoryId
.
$sel:workspaceIds:DescribeWorkspaces'
, describeWorkspaces_workspaceIds
- The identifiers of the WorkSpaces. You cannot combine this parameter
with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
data DescribeWorkspacesResponse Source #
See: newDescribeWorkspacesResponse
smart constructor.
Instances
newDescribeWorkspacesResponse Source #
Create a value of DescribeWorkspacesResponse
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:
DescribeWorkspaces
, describeWorkspacesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:workspaces:DescribeWorkspacesResponse'
, describeWorkspacesResponse_workspaces
- Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
$sel:httpStatus:DescribeWorkspacesResponse'
, describeWorkspacesResponse_httpStatus
- The response's http status code.
DescribeWorkspacesConnectionStatus (Paginated)
data DescribeWorkspacesConnectionStatus Source #
See: newDescribeWorkspacesConnectionStatus
smart constructor.
Instances
newDescribeWorkspacesConnectionStatus :: DescribeWorkspacesConnectionStatus Source #
Create a value of DescribeWorkspacesConnectionStatus
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:
DescribeWorkspacesConnectionStatus
, describeWorkspacesConnectionStatus_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
$sel:workspaceIds:DescribeWorkspacesConnectionStatus'
, describeWorkspacesConnectionStatus_workspaceIds
- The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
data DescribeWorkspacesConnectionStatusResponse Source #
See: newDescribeWorkspacesConnectionStatusResponse
smart constructor.
Constructors
DescribeWorkspacesConnectionStatusResponse' (Maybe Text) (Maybe [WorkspaceConnectionStatus]) Int |
Instances
newDescribeWorkspacesConnectionStatusResponse Source #
Arguments
:: Int | |
-> DescribeWorkspacesConnectionStatusResponse |
Create a value of DescribeWorkspacesConnectionStatusResponse
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:
DescribeWorkspacesConnectionStatus
, describeWorkspacesConnectionStatusResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:workspacesConnectionStatus:DescribeWorkspacesConnectionStatusResponse'
, describeWorkspacesConnectionStatusResponse_workspacesConnectionStatus
- Information about the connection status of the WorkSpace.
$sel:httpStatus:DescribeWorkspacesConnectionStatusResponse'
, describeWorkspacesConnectionStatusResponse_httpStatus
- The response's http status code.
DisassociateConnectionAlias
data DisassociateConnectionAlias Source #
See: newDisassociateConnectionAlias
smart constructor.
Constructors
DisassociateConnectionAlias' Text |
Instances
newDisassociateConnectionAlias Source #
Arguments
:: Text | |
-> DisassociateConnectionAlias |
Create a value of DisassociateConnectionAlias
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:
DisassociateConnectionAlias
, disassociateConnectionAlias_aliasId
- The identifier of the connection alias to disassociate.
data DisassociateConnectionAliasResponse Source #
See: newDisassociateConnectionAliasResponse
smart constructor.
Constructors
DisassociateConnectionAliasResponse' Int |
Instances
newDisassociateConnectionAliasResponse Source #
Arguments
:: Int | |
-> DisassociateConnectionAliasResponse |
Create a value of DisassociateConnectionAliasResponse
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:httpStatus:DisassociateConnectionAliasResponse'
, disassociateConnectionAliasResponse_httpStatus
- The response's http status code.
DisassociateIpGroups
data DisassociateIpGroups Source #
See: newDisassociateIpGroups
smart constructor.
Constructors
DisassociateIpGroups' Text [Text] |
Instances
newDisassociateIpGroups Source #
Arguments
:: Text | |
-> DisassociateIpGroups |
Create a value of DisassociateIpGroups
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:
DisassociateIpGroups
, disassociateIpGroups_directoryId
- The identifier of the directory.
$sel:groupIds:DisassociateIpGroups'
, disassociateIpGroups_groupIds
- The identifiers of one or more IP access control groups.
data DisassociateIpGroupsResponse Source #
See: newDisassociateIpGroupsResponse
smart constructor.
Constructors
DisassociateIpGroupsResponse' Int |
Instances
newDisassociateIpGroupsResponse Source #
Create a value of DisassociateIpGroupsResponse
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:httpStatus:DisassociateIpGroupsResponse'
, disassociateIpGroupsResponse_httpStatus
- The response's http status code.
ImportClientBranding
data ImportClientBranding Source #
See: newImportClientBranding
smart constructor.
Constructors
Instances
newImportClientBranding Source #
Arguments
:: Text | |
-> ImportClientBranding |
Create a value of ImportClientBranding
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:
ImportClientBranding
, importClientBranding_deviceTypeAndroid
- The branding information to import for Android devices.
ImportClientBranding
, importClientBranding_deviceTypeIos
- The branding information to import for iOS devices.
ImportClientBranding
, importClientBranding_deviceTypeLinux
- The branding information to import for Linux devices.
ImportClientBranding
, importClientBranding_deviceTypeOsx
- The branding information to import for macOS devices.
ImportClientBranding
, importClientBranding_deviceTypeWeb
- The branding information to import for web access.
ImportClientBranding
, importClientBranding_deviceTypeWindows
- The branding information to import for Windows devices.
ImportClientBranding
, importClientBranding_resourceId
- The directory identifier of the WorkSpace for which you want to import
client branding.
data ImportClientBrandingResponse Source #
See: newImportClientBrandingResponse
smart constructor.
Constructors
Instances
newImportClientBrandingResponse Source #
Create a value of ImportClientBrandingResponse
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:
ImportClientBranding
, importClientBrandingResponse_deviceTypeAndroid
- The branding information configured for Android devices.
ImportClientBranding
, importClientBrandingResponse_deviceTypeIos
- The branding information configured for iOS devices.
ImportClientBranding
, importClientBrandingResponse_deviceTypeLinux
- The branding information configured for Linux devices.
ImportClientBranding
, importClientBrandingResponse_deviceTypeOsx
- The branding information configured for macOS devices.
ImportClientBranding
, importClientBrandingResponse_deviceTypeWeb
- The branding information configured for web access.
ImportClientBranding
, importClientBrandingResponse_deviceTypeWindows
- The branding information configured for Windows devices.
$sel:httpStatus:ImportClientBrandingResponse'
, importClientBrandingResponse_httpStatus
- The response's http status code.
ImportWorkspaceImage
data ImportWorkspaceImage Source #
See: newImportWorkspaceImage
smart constructor.
Constructors
ImportWorkspaceImage' (Maybe (NonEmpty Application)) (Maybe [Tag]) Text WorkspaceImageIngestionProcess Text Text |
Instances
newImportWorkspaceImage Source #
Arguments
:: Text | |
-> WorkspaceImageIngestionProcess | |
-> Text | |
-> Text | |
-> ImportWorkspaceImage |
Create a value of ImportWorkspaceImage
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:applications:ImportWorkspaceImage'
, importWorkspaceImage_applications
- If specified, the version of Microsoft Office to subscribe to. Valid
only for Windows 10 BYOL images. For more information about subscribing
to Office for BYOL images, see
Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
ImportWorkspaceImage
, importWorkspaceImage_tags
- The tags. Each WorkSpaces resource can have a maximum of 50 tags.
$sel:ec2ImageId:ImportWorkspaceImage'
, importWorkspaceImage_ec2ImageId
- The identifier of the EC2 image.
$sel:ingestionProcess:ImportWorkspaceImage'
, importWorkspaceImage_ingestionProcess
- The ingestion process to be used when importing the image, depending on
which protocol you want to use for your BYOL Workspace image, either
PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol
(BYOP). To use WSP, specify a value that ends in _WSP
. To use PCoIP,
specify a value that does not end in _WSP
. To use BYOP, specify a
value that ends in _BYOP
.
For non-GPU-enabled bundles (bundles other than Graphics or
GraphicsPro), specify BYOL_REGULAR
, BYOL_REGULAR_WSP
, or
BYOL_REGULAR_BYOP
, depending on the protocol.
The BYOL_REGULAR_BYOP
and BYOL_GRAPHICS_G4DN_BYOP
values are only
supported by Amazon WorkSpaces Core. Contact your account team to be
allow-listed to use these values. For more information, see
Amazon WorkSpaces Core.
$sel:imageName:ImportWorkspaceImage'
, importWorkspaceImage_imageName
- The name of the WorkSpace image.
$sel:imageDescription:ImportWorkspaceImage'
, importWorkspaceImage_imageDescription
- The description of the WorkSpace image.
data ImportWorkspaceImageResponse Source #
See: newImportWorkspaceImageResponse
smart constructor.
Constructors
ImportWorkspaceImageResponse' (Maybe Text) Int |
Instances
newImportWorkspaceImageResponse Source #
Create a value of ImportWorkspaceImageResponse
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:
ImportWorkspaceImageResponse
, importWorkspaceImageResponse_imageId
- The identifier of the WorkSpace image.
$sel:httpStatus:ImportWorkspaceImageResponse'
, importWorkspaceImageResponse_httpStatus
- The response's http status code.
ListAvailableManagementCidrRanges (Paginated)
data ListAvailableManagementCidrRanges Source #
See: newListAvailableManagementCidrRanges
smart constructor.
Instances
newListAvailableManagementCidrRanges Source #
Arguments
:: Text |
|
-> ListAvailableManagementCidrRanges |
Create a value of ListAvailableManagementCidrRanges
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:maxResults:ListAvailableManagementCidrRanges'
, listAvailableManagementCidrRanges_maxResults
- The maximum number of items to return.
ListAvailableManagementCidrRanges
, listAvailableManagementCidrRanges_nextToken
- If you received a NextToken
from a previous call that was paginated,
provide this token to receive the next set of results.
$sel:managementCidrRangeConstraint:ListAvailableManagementCidrRanges'
, listAvailableManagementCidrRanges_managementCidrRangeConstraint
- The IP address range to search. Specify an IP address range that is
compatible with your network and in CIDR notation (that is, specify the
range as an IPv4 CIDR block).
data ListAvailableManagementCidrRangesResponse Source #
See: newListAvailableManagementCidrRangesResponse
smart constructor.
Instances
newListAvailableManagementCidrRangesResponse Source #
Arguments
:: Int | |
-> ListAvailableManagementCidrRangesResponse |
Create a value of ListAvailableManagementCidrRangesResponse
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:managementCidrRanges:ListAvailableManagementCidrRangesResponse'
, listAvailableManagementCidrRangesResponse_managementCidrRanges
- The list of available IP address ranges, specified as IPv4 CIDR blocks.
ListAvailableManagementCidrRanges
, listAvailableManagementCidrRangesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:ListAvailableManagementCidrRangesResponse'
, listAvailableManagementCidrRangesResponse_httpStatus
- The response's http status code.
MigrateWorkspace
data MigrateWorkspace Source #
See: newMigrateWorkspace
smart constructor.
Constructors
MigrateWorkspace' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> MigrateWorkspace |
Create a value of MigrateWorkspace
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:
MigrateWorkspace
, migrateWorkspace_sourceWorkspaceId
- The identifier of the WorkSpace to migrate from.
MigrateWorkspace
, migrateWorkspace_bundleId
- The identifier of the target bundle type to migrate the WorkSpace to.
data MigrateWorkspaceResponse Source #
See: newMigrateWorkspaceResponse
smart constructor.
Instances
newMigrateWorkspaceResponse Source #
Create a value of MigrateWorkspaceResponse
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:
MigrateWorkspace
, migrateWorkspaceResponse_sourceWorkspaceId
- The original identifier of the WorkSpace that is being migrated.
$sel:targetWorkspaceId:MigrateWorkspaceResponse'
, migrateWorkspaceResponse_targetWorkspaceId
- The new identifier of the WorkSpace that is being migrated. If the
migration does not succeed, the target WorkSpace ID will not be used,
and the WorkSpace will still have the original WorkSpace ID.
$sel:httpStatus:MigrateWorkspaceResponse'
, migrateWorkspaceResponse_httpStatus
- The response's http status code.
ModifyAccount
data ModifyAccount Source #
See: newModifyAccount
smart constructor.
Constructors
ModifyAccount' (Maybe Text) (Maybe DedicatedTenancySupportEnum) |
Instances
newModifyAccount :: ModifyAccount Source #
Create a value of ModifyAccount
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:
ModifyAccount
, modifyAccount_dedicatedTenancyManagementCidrRange
- The IP address range, specified as an IPv4 CIDR block, for the
management network interface. Specify an IP address range that is
compatible with your network and in CIDR notation (that is, specify the
range as an IPv4 CIDR block). The CIDR block size must be /16 (for
example, 203.0.113.25/16). It must also be specified as available by
the ListAvailableManagementCidrRanges
operation.
ModifyAccount
, modifyAccount_dedicatedTenancySupport
- The status of BYOL.
data ModifyAccountResponse Source #
See: newModifyAccountResponse
smart constructor.
Constructors
ModifyAccountResponse' Int |
Instances
newModifyAccountResponse Source #
Create a value of ModifyAccountResponse
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:httpStatus:ModifyAccountResponse'
, modifyAccountResponse_httpStatus
- The response's http status code.
ModifyCertificateBasedAuthProperties
data ModifyCertificateBasedAuthProperties Source #
See: newModifyCertificateBasedAuthProperties
smart constructor.
Constructors
ModifyCertificateBasedAuthProperties' (Maybe CertificateBasedAuthProperties) (Maybe [DeletableCertificateBasedAuthProperty]) Text |
Instances
newModifyCertificateBasedAuthProperties Source #
Create a value of ModifyCertificateBasedAuthProperties
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:
ModifyCertificateBasedAuthProperties
, modifyCertificateBasedAuthProperties_certificateBasedAuthProperties
- The properties of the certificate-based authentication.
$sel:propertiesToDelete:ModifyCertificateBasedAuthProperties'
, modifyCertificateBasedAuthProperties_propertiesToDelete
- The properties of the certificate-based authentication you want to
delete.
ModifyCertificateBasedAuthProperties
, modifyCertificateBasedAuthProperties_resourceId
- The resource identifiers, in the form of directory IDs.
data ModifyCertificateBasedAuthPropertiesResponse Source #
See: newModifyCertificateBasedAuthPropertiesResponse
smart constructor.
Constructors
ModifyCertificateBasedAuthPropertiesResponse' Int |
Instances
newModifyCertificateBasedAuthPropertiesResponse Source #
Arguments
:: Int |
|
-> ModifyCertificateBasedAuthPropertiesResponse |
Create a value of ModifyCertificateBasedAuthPropertiesResponse
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:httpStatus:ModifyCertificateBasedAuthPropertiesResponse'
, modifyCertificateBasedAuthPropertiesResponse_httpStatus
- The response's http status code.
ModifyClientProperties
data ModifyClientProperties Source #
See: newModifyClientProperties
smart constructor.
Constructors
ModifyClientProperties' Text ClientProperties |
Instances
newModifyClientProperties Source #
Arguments
:: Text | |
-> ClientProperties | |
-> ModifyClientProperties |
Create a value of ModifyClientProperties
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:
ModifyClientProperties
, modifyClientProperties_resourceId
- The resource identifiers, in the form of directory IDs.
ModifyClientProperties
, modifyClientProperties_clientProperties
- Information about the Amazon WorkSpaces client.
data ModifyClientPropertiesResponse Source #
See: newModifyClientPropertiesResponse
smart constructor.
Constructors
ModifyClientPropertiesResponse' Int |
Instances
newModifyClientPropertiesResponse Source #
Create a value of ModifyClientPropertiesResponse
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:httpStatus:ModifyClientPropertiesResponse'
, modifyClientPropertiesResponse_httpStatus
- The response's http status code.
ModifySamlProperties
data ModifySamlProperties Source #
See: newModifySamlProperties
smart constructor.
Constructors
ModifySamlProperties' (Maybe [DeletableSamlProperty]) (Maybe SamlProperties) Text |
Instances
newModifySamlProperties Source #
Arguments
:: Text | |
-> ModifySamlProperties |
Create a value of ModifySamlProperties
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:propertiesToDelete:ModifySamlProperties'
, modifySamlProperties_propertiesToDelete
- The SAML properties to delete as part of your request.
Specify one of the following options:
SAML_PROPERTIES_USER_ACCESS_URL
to delete the user access URL.SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
to delete the relay state parameter name.
ModifySamlProperties
, modifySamlProperties_samlProperties
- The properties for configuring SAML 2.0 authentication.
ModifySamlProperties
, modifySamlProperties_resourceId
- The directory identifier for which you want to configure SAML
properties.
data ModifySamlPropertiesResponse Source #
See: newModifySamlPropertiesResponse
smart constructor.
Constructors
ModifySamlPropertiesResponse' Int |
Instances
newModifySamlPropertiesResponse Source #
Create a value of ModifySamlPropertiesResponse
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:httpStatus:ModifySamlPropertiesResponse'
, modifySamlPropertiesResponse_httpStatus
- The response's http status code.
ModifySelfservicePermissions
data ModifySelfservicePermissions Source #
See: newModifySelfservicePermissions
smart constructor.
Constructors
ModifySelfservicePermissions' Text SelfservicePermissions |
Instances
newModifySelfservicePermissions Source #
Arguments
:: Text | |
-> SelfservicePermissions | |
-> ModifySelfservicePermissions |
Create a value of ModifySelfservicePermissions
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:
ModifySelfservicePermissions
, modifySelfservicePermissions_resourceId
- The identifier of the directory.
ModifySelfservicePermissions
, modifySelfservicePermissions_selfservicePermissions
- The permissions to enable or disable self-service capabilities.
data ModifySelfservicePermissionsResponse Source #
See: newModifySelfservicePermissionsResponse
smart constructor.
Constructors
ModifySelfservicePermissionsResponse' Int |
Instances
newModifySelfservicePermissionsResponse Source #
Arguments
:: Int | |
-> ModifySelfservicePermissionsResponse |
Create a value of ModifySelfservicePermissionsResponse
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:httpStatus:ModifySelfservicePermissionsResponse'
, modifySelfservicePermissionsResponse_httpStatus
- The response's http status code.
ModifyWorkspaceAccessProperties
data ModifyWorkspaceAccessProperties Source #
See: newModifyWorkspaceAccessProperties
smart constructor.
Instances
newModifyWorkspaceAccessProperties Source #
Arguments
:: Text | |
-> WorkspaceAccessProperties | |
-> ModifyWorkspaceAccessProperties |
Create a value of ModifyWorkspaceAccessProperties
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:
ModifyWorkspaceAccessProperties
, modifyWorkspaceAccessProperties_resourceId
- The identifier of the directory.
ModifyWorkspaceAccessProperties
, modifyWorkspaceAccessProperties_workspaceAccessProperties
- The device types and operating systems to enable or disable for access.
data ModifyWorkspaceAccessPropertiesResponse Source #
See: newModifyWorkspaceAccessPropertiesResponse
smart constructor.
Constructors
ModifyWorkspaceAccessPropertiesResponse' Int |
Instances
newModifyWorkspaceAccessPropertiesResponse Source #
Arguments
:: Int | |
-> ModifyWorkspaceAccessPropertiesResponse |
Create a value of ModifyWorkspaceAccessPropertiesResponse
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:httpStatus:ModifyWorkspaceAccessPropertiesResponse'
, modifyWorkspaceAccessPropertiesResponse_httpStatus
- The response's http status code.
ModifyWorkspaceCreationProperties
data ModifyWorkspaceCreationProperties Source #
See: newModifyWorkspaceCreationProperties
smart constructor.
Instances
newModifyWorkspaceCreationProperties Source #
Arguments
:: Text | |
-> WorkspaceCreationProperties | |
-> ModifyWorkspaceCreationProperties |
Create a value of ModifyWorkspaceCreationProperties
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:
ModifyWorkspaceCreationProperties
, modifyWorkspaceCreationProperties_resourceId
- The identifier of the directory.
ModifyWorkspaceCreationProperties
, modifyWorkspaceCreationProperties_workspaceCreationProperties
- The default properties for creating WorkSpaces.
data ModifyWorkspaceCreationPropertiesResponse Source #
See: newModifyWorkspaceCreationPropertiesResponse
smart constructor.
Constructors
ModifyWorkspaceCreationPropertiesResponse' Int |
Instances
newModifyWorkspaceCreationPropertiesResponse Source #
Arguments
:: Int | |
-> ModifyWorkspaceCreationPropertiesResponse |
Create a value of ModifyWorkspaceCreationPropertiesResponse
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:httpStatus:ModifyWorkspaceCreationPropertiesResponse'
, modifyWorkspaceCreationPropertiesResponse_httpStatus
- The response's http status code.
ModifyWorkspaceProperties
data ModifyWorkspaceProperties Source #
See: newModifyWorkspaceProperties
smart constructor.
Constructors
ModifyWorkspaceProperties' Text WorkspaceProperties |
Instances
newModifyWorkspaceProperties Source #
Arguments
:: Text | |
-> WorkspaceProperties | |
-> ModifyWorkspaceProperties |
Create a value of ModifyWorkspaceProperties
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:
ModifyWorkspaceProperties
, modifyWorkspaceProperties_workspaceId
- The identifier of the WorkSpace.
ModifyWorkspaceProperties
, modifyWorkspaceProperties_workspaceProperties
- The properties of the WorkSpace.
data ModifyWorkspacePropertiesResponse Source #
See: newModifyWorkspacePropertiesResponse
smart constructor.
Constructors
ModifyWorkspacePropertiesResponse' Int |
Instances
newModifyWorkspacePropertiesResponse Source #
Arguments
:: Int | |
-> ModifyWorkspacePropertiesResponse |
Create a value of ModifyWorkspacePropertiesResponse
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:httpStatus:ModifyWorkspacePropertiesResponse'
, modifyWorkspacePropertiesResponse_httpStatus
- The response's http status code.
ModifyWorkspaceState
data ModifyWorkspaceState Source #
See: newModifyWorkspaceState
smart constructor.
Constructors
ModifyWorkspaceState' Text TargetWorkspaceState |
Instances
newModifyWorkspaceState Source #
Arguments
:: Text | |
-> TargetWorkspaceState | |
-> ModifyWorkspaceState |
Create a value of ModifyWorkspaceState
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:
ModifyWorkspaceState
, modifyWorkspaceState_workspaceId
- The identifier of the WorkSpace.
$sel:workspaceState:ModifyWorkspaceState'
, modifyWorkspaceState_workspaceState
- The WorkSpace state.
data ModifyWorkspaceStateResponse Source #
See: newModifyWorkspaceStateResponse
smart constructor.
Constructors
ModifyWorkspaceStateResponse' Int |
Instances
newModifyWorkspaceStateResponse Source #
Create a value of ModifyWorkspaceStateResponse
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:httpStatus:ModifyWorkspaceStateResponse'
, modifyWorkspaceStateResponse_httpStatus
- The response's http status code.
RebootWorkspaces
data RebootWorkspaces Source #
See: newRebootWorkspaces
smart constructor.
Constructors
RebootWorkspaces' (NonEmpty RebootRequest) |
Instances
Create a value of RebootWorkspaces
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:rebootWorkspaceRequests:RebootWorkspaces'
, rebootWorkspaces_rebootWorkspaceRequests
- The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
data RebootWorkspacesResponse Source #
See: newRebootWorkspacesResponse
smart constructor.
Constructors
RebootWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int |
Instances
newRebootWorkspacesResponse Source #
Create a value of RebootWorkspacesResponse
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:failedRequests:RebootWorkspacesResponse'
, rebootWorkspacesResponse_failedRequests
- Information about the WorkSpaces that could not be rebooted.
$sel:httpStatus:RebootWorkspacesResponse'
, rebootWorkspacesResponse_httpStatus
- The response's http status code.
RebuildWorkspaces
data RebuildWorkspaces Source #
See: newRebuildWorkspaces
smart constructor.
Constructors
RebuildWorkspaces' (NonEmpty RebuildRequest) |
Instances
Arguments
:: NonEmpty RebuildRequest | |
-> RebuildWorkspaces |
Create a value of RebuildWorkspaces
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:rebuildWorkspaceRequests:RebuildWorkspaces'
, rebuildWorkspaces_rebuildWorkspaceRequests
- The WorkSpace to rebuild. You can specify a single WorkSpace.
data RebuildWorkspacesResponse Source #
See: newRebuildWorkspacesResponse
smart constructor.
Constructors
RebuildWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int |
Instances
newRebuildWorkspacesResponse Source #
Create a value of RebuildWorkspacesResponse
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:failedRequests:RebuildWorkspacesResponse'
, rebuildWorkspacesResponse_failedRequests
- Information about the WorkSpace that could not be rebuilt.
$sel:httpStatus:RebuildWorkspacesResponse'
, rebuildWorkspacesResponse_httpStatus
- The response's http status code.
RegisterWorkspaceDirectory
data RegisterWorkspaceDirectory Source #
See: newRegisterWorkspaceDirectory
smart constructor.
Constructors
RegisterWorkspaceDirectory' (Maybe Bool) (Maybe [Text]) (Maybe [Tag]) (Maybe Tenancy) Text Bool |
Instances
newRegisterWorkspaceDirectory Source #
Arguments
:: Text | |
-> Bool | |
-> RegisterWorkspaceDirectory |
Create a value of RegisterWorkspaceDirectory
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:enableSelfService:RegisterWorkspaceDirectory'
, registerWorkspaceDirectory_enableSelfService
- Indicates whether self-service capabilities are enabled or disabled.
RegisterWorkspaceDirectory
, registerWorkspaceDirectory_subnetIds
- The identifiers of the subnets for your virtual private cloud (VPC).
Make sure that the subnets are in supported Availability Zones. The
subnets must also be in separate Availability Zones. If these conditions
are not met, you will receive an OperationNotSupportedException error.
RegisterWorkspaceDirectory
, registerWorkspaceDirectory_tags
- The tags associated with the directory.
RegisterWorkspaceDirectory
, registerWorkspaceDirectory_tenancy
- Indicates whether your WorkSpace directory is dedicated or shared. To
use Bring Your Own License (BYOL) images, this value must be set to
DEDICATED
and your Amazon Web Services account must be enabled for
BYOL. If your account has not been enabled for BYOL, you will receive an
InvalidParameterValuesException error. For more information about BYOL
images, see
Bring Your Own Windows Desktop Images.
RegisterWorkspaceDirectory
, registerWorkspaceDirectory_directoryId
- The identifier of the directory. You cannot register a directory if it
does not have a status of Active. If the directory does not have a
status of Active, you will receive an InvalidResourceStateException
error. If you have already registered the maximum number of directories
that you can register with Amazon WorkSpaces, you will receive a
ResourceLimitExceededException error. Deregister directories that you
are not using for WorkSpaces, and try again.
RegisterWorkspaceDirectory
, registerWorkspaceDirectory_enableWorkDocs
- Indicates whether Amazon WorkDocs is enabled or disabled. If you have
enabled this parameter and WorkDocs is not available in the Region, you
will receive an OperationNotSupportedException error. Set
EnableWorkDocs
to disabled, and try again.
data RegisterWorkspaceDirectoryResponse Source #
See: newRegisterWorkspaceDirectoryResponse
smart constructor.
Constructors
RegisterWorkspaceDirectoryResponse' Int |
Instances
newRegisterWorkspaceDirectoryResponse Source #
Arguments
:: Int | |
-> RegisterWorkspaceDirectoryResponse |
Create a value of RegisterWorkspaceDirectoryResponse
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:httpStatus:RegisterWorkspaceDirectoryResponse'
, registerWorkspaceDirectoryResponse_httpStatus
- The response's http status code.
RestoreWorkspace
data RestoreWorkspace Source #
See: newRestoreWorkspace
smart constructor.
Constructors
RestoreWorkspace' Text |
Instances
Arguments
:: Text | |
-> RestoreWorkspace |
Create a value of RestoreWorkspace
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:
RestoreWorkspace
, restoreWorkspace_workspaceId
- The identifier of the WorkSpace.
data RestoreWorkspaceResponse Source #
See: newRestoreWorkspaceResponse
smart constructor.
Constructors
RestoreWorkspaceResponse' Int |
Instances
newRestoreWorkspaceResponse Source #
Create a value of RestoreWorkspaceResponse
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:httpStatus:RestoreWorkspaceResponse'
, restoreWorkspaceResponse_httpStatus
- The response's http status code.
RevokeIpRules
data RevokeIpRules Source #
See: newRevokeIpRules
smart constructor.
Constructors
RevokeIpRules' Text [Text] |
Instances
Arguments
:: Text | |
-> RevokeIpRules |
Create a value of RevokeIpRules
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:
RevokeIpRules
, revokeIpRules_groupId
- The identifier of the group.
RevokeIpRules
, revokeIpRules_userRules
- The rules to remove from the group.
data RevokeIpRulesResponse Source #
See: newRevokeIpRulesResponse
smart constructor.
Constructors
RevokeIpRulesResponse' Int |
Instances
newRevokeIpRulesResponse Source #
Create a value of RevokeIpRulesResponse
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:httpStatus:RevokeIpRulesResponse'
, revokeIpRulesResponse_httpStatus
- The response's http status code.
StartWorkspaces
data StartWorkspaces Source #
See: newStartWorkspaces
smart constructor.
Constructors
StartWorkspaces' (NonEmpty StartRequest) |
Instances
Create a value of StartWorkspaces
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:startWorkspaceRequests:StartWorkspaces'
, startWorkspaces_startWorkspaceRequests
- The WorkSpaces to start. You can specify up to 25 WorkSpaces.
data StartWorkspacesResponse Source #
See: newStartWorkspacesResponse
smart constructor.
Constructors
StartWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int |
Instances
newStartWorkspacesResponse Source #
Create a value of StartWorkspacesResponse
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:failedRequests:StartWorkspacesResponse'
, startWorkspacesResponse_failedRequests
- Information about the WorkSpaces that could not be started.
$sel:httpStatus:StartWorkspacesResponse'
, startWorkspacesResponse_httpStatus
- The response's http status code.
StopWorkspaces
data StopWorkspaces Source #
See: newStopWorkspaces
smart constructor.
Constructors
StopWorkspaces' (NonEmpty StopRequest) |
Instances
Create a value of StopWorkspaces
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:stopWorkspaceRequests:StopWorkspaces'
, stopWorkspaces_stopWorkspaceRequests
- The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
data StopWorkspacesResponse Source #
See: newStopWorkspacesResponse
smart constructor.
Constructors
StopWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int |
Instances
newStopWorkspacesResponse Source #
Create a value of StopWorkspacesResponse
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:failedRequests:StopWorkspacesResponse'
, stopWorkspacesResponse_failedRequests
- Information about the WorkSpaces that could not be stopped.
$sel:httpStatus:StopWorkspacesResponse'
, stopWorkspacesResponse_httpStatus
- The response's http status code.
TerminateWorkspaces
data TerminateWorkspaces Source #
See: newTerminateWorkspaces
smart constructor.
Constructors
TerminateWorkspaces' (NonEmpty TerminateRequest) |
Instances
newTerminateWorkspaces Source #
Arguments
:: NonEmpty TerminateRequest | |
-> TerminateWorkspaces |
Create a value of TerminateWorkspaces
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:terminateWorkspaceRequests:TerminateWorkspaces'
, terminateWorkspaces_terminateWorkspaceRequests
- The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
data TerminateWorkspacesResponse Source #
See: newTerminateWorkspacesResponse
smart constructor.
Constructors
TerminateWorkspacesResponse' (Maybe [FailedWorkspaceChangeRequest]) Int |
Instances
newTerminateWorkspacesResponse Source #
Create a value of TerminateWorkspacesResponse
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:failedRequests:TerminateWorkspacesResponse'
, terminateWorkspacesResponse_failedRequests
- Information about the WorkSpaces that could not be terminated.
$sel:httpStatus:TerminateWorkspacesResponse'
, terminateWorkspacesResponse_httpStatus
- The response's http status code.
UpdateConnectClientAddIn
data UpdateConnectClientAddIn Source #
See: newUpdateConnectClientAddIn
smart constructor.
Instances
newUpdateConnectClientAddIn Source #
Create a value of UpdateConnectClientAddIn
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:
UpdateConnectClientAddIn
, updateConnectClientAddIn_name
- The name of the client add-in.
UpdateConnectClientAddIn
, updateConnectClientAddIn_url
- The endpoint URL of the Amazon Connect client add-in.
UpdateConnectClientAddIn
, updateConnectClientAddIn_addInId
- The identifier of the client add-in to update.
UpdateConnectClientAddIn
, updateConnectClientAddIn_resourceId
- The directory identifier for which the client add-in is configured.
data UpdateConnectClientAddInResponse Source #
See: newUpdateConnectClientAddInResponse
smart constructor.
Constructors
UpdateConnectClientAddInResponse' Int |
Instances
newUpdateConnectClientAddInResponse Source #
Create a value of UpdateConnectClientAddInResponse
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:httpStatus:UpdateConnectClientAddInResponse'
, updateConnectClientAddInResponse_httpStatus
- The response's http status code.
UpdateConnectionAliasPermission
data UpdateConnectionAliasPermission Source #
See: newUpdateConnectionAliasPermission
smart constructor.
Instances
newUpdateConnectionAliasPermission Source #
Arguments
:: Text | |
-> ConnectionAliasPermission |
|
-> UpdateConnectionAliasPermission |
Create a value of UpdateConnectionAliasPermission
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:
UpdateConnectionAliasPermission
, updateConnectionAliasPermission_aliasId
- The identifier of the connection alias that you want to update
permissions for.
$sel:connectionAliasPermission:UpdateConnectionAliasPermission'
, updateConnectionAliasPermission_connectionAliasPermission
- Indicates whether to share or unshare the connection alias with the
specified Amazon Web Services account.
data UpdateConnectionAliasPermissionResponse Source #
See: newUpdateConnectionAliasPermissionResponse
smart constructor.
Constructors
UpdateConnectionAliasPermissionResponse' Int |
Instances
newUpdateConnectionAliasPermissionResponse Source #
Arguments
:: Int | |
-> UpdateConnectionAliasPermissionResponse |
Create a value of UpdateConnectionAliasPermissionResponse
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:httpStatus:UpdateConnectionAliasPermissionResponse'
, updateConnectionAliasPermissionResponse_httpStatus
- The response's http status code.
UpdateRulesOfIpGroup
data UpdateRulesOfIpGroup Source #
See: newUpdateRulesOfIpGroup
smart constructor.
Constructors
UpdateRulesOfIpGroup' Text [IpRuleItem] |
Instances
newUpdateRulesOfIpGroup Source #
Arguments
:: Text | |
-> UpdateRulesOfIpGroup |
Create a value of UpdateRulesOfIpGroup
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:
UpdateRulesOfIpGroup
, updateRulesOfIpGroup_groupId
- The identifier of the group.
UpdateRulesOfIpGroup
, updateRulesOfIpGroup_userRules
- One or more rules.
data UpdateRulesOfIpGroupResponse Source #
See: newUpdateRulesOfIpGroupResponse
smart constructor.
Constructors
UpdateRulesOfIpGroupResponse' Int |
Instances
newUpdateRulesOfIpGroupResponse Source #
Create a value of UpdateRulesOfIpGroupResponse
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:httpStatus:UpdateRulesOfIpGroupResponse'
, updateRulesOfIpGroupResponse_httpStatus
- The response's http status code.
UpdateWorkspaceBundle
data UpdateWorkspaceBundle Source #
See: newUpdateWorkspaceBundle
smart constructor.
Constructors
UpdateWorkspaceBundle' (Maybe Text) (Maybe Text) |
Instances
newUpdateWorkspaceBundle :: UpdateWorkspaceBundle Source #
Create a value of UpdateWorkspaceBundle
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:
UpdateWorkspaceBundle
, updateWorkspaceBundle_bundleId
- The identifier of the bundle.
UpdateWorkspaceBundle
, updateWorkspaceBundle_imageId
- The identifier of the image.
data UpdateWorkspaceBundleResponse Source #
See: newUpdateWorkspaceBundleResponse
smart constructor.
Constructors
UpdateWorkspaceBundleResponse' Int |
Instances
newUpdateWorkspaceBundleResponse Source #
Create a value of UpdateWorkspaceBundleResponse
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:httpStatus:UpdateWorkspaceBundleResponse'
, updateWorkspaceBundleResponse_httpStatus
- The response's http status code.
UpdateWorkspaceImagePermission
data UpdateWorkspaceImagePermission Source #
See: newUpdateWorkspaceImagePermission
smart constructor.
Constructors
UpdateWorkspaceImagePermission' Text Bool Text |
Instances
newUpdateWorkspaceImagePermission Source #
Arguments
:: Text | |
-> Bool | |
-> Text | |
-> UpdateWorkspaceImagePermission |
Create a value of UpdateWorkspaceImagePermission
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:
UpdateWorkspaceImagePermission
, updateWorkspaceImagePermission_imageId
- The identifier of the image.
$sel:allowCopyImage:UpdateWorkspaceImagePermission'
, updateWorkspaceImagePermission_allowCopyImage
- The permission to copy the image. This permission can be revoked only
after an image has been shared.
UpdateWorkspaceImagePermission
, updateWorkspaceImagePermission_sharedAccountId
- The identifier of the Amazon Web Services account to share or unshare
the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
data UpdateWorkspaceImagePermissionResponse Source #
See: newUpdateWorkspaceImagePermissionResponse
smart constructor.
Constructors
UpdateWorkspaceImagePermissionResponse' Int |
Instances
newUpdateWorkspaceImagePermissionResponse Source #
Arguments
:: Int | |
-> UpdateWorkspaceImagePermissionResponse |
Create a value of UpdateWorkspaceImagePermissionResponse
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:httpStatus:UpdateWorkspaceImagePermissionResponse'
, updateWorkspaceImagePermissionResponse_httpStatus
- The response's http status code.
Types
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' (Maybe Text) (Maybe DedicatedTenancySupportResultEnum) (Maybe Text) (Maybe Text) (Maybe DedicatedTenancyModificationStateEnum) (Maybe POSIX) |
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.
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' (Maybe Text) (Maybe CertificateBasedAuthStatusEnum) |
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.
ClientProperties
data ClientProperties Source #
Describes an Amazon WorkSpaces client.
See: newClientProperties
smart constructor.
Constructors
ClientProperties' (Maybe LogUploadEnum) (Maybe ReconnectEnum) |
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.
ClientPropertiesResult
data ClientPropertiesResult Source #
Information about the Amazon WorkSpaces client.
See: newClientPropertiesResult
smart constructor.
Constructors
ClientPropertiesResult' (Maybe ClientProperties) (Maybe Text) |
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.
ComputeType
data ComputeType Source #
Describes the compute type of the bundle.
See: newComputeType
smart constructor.
Constructors
ComputeType' (Maybe Compute) |
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.
ConnectClientAddIn
data ConnectClientAddIn Source #
Describes an Amazon Connect client add-in.
See: newConnectClientAddIn
smart constructor.
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.
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' (Maybe Text) (Maybe (NonEmpty ConnectionAliasAssociation)) (Maybe Text) (Maybe Text) (Maybe ConnectionAliasState) |
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.
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' (Maybe Text) (Maybe AssociationStatus) (Maybe Text) (Maybe Text) |
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.
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' Text Bool |
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.
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' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) |
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
SupportEmail
andSupportLink
parameters 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
SupportEmail
andSupportLink
parameters 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' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Base64) (Maybe Text) (Maybe Text) |
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
SupportEmail
andSupportLink
parameters 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
SupportEmail
andSupportLink
parameters 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' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
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.
FailedCreateStandbyWorkspacesRequest
data FailedCreateStandbyWorkspacesRequest Source #
Describes the Standby WorkSpace that could not be created.
See: newFailedCreateStandbyWorkspacesRequest
smart constructor.
Constructors
FailedCreateStandbyWorkspacesRequest' (Maybe Text) (Maybe Text) (Maybe StandbyWorkspace) |
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.
FailedCreateWorkspaceRequest
data FailedCreateWorkspaceRequest Source #
Describes a WorkSpace that cannot be created.
See: newFailedCreateWorkspaceRequest
smart constructor.
Constructors
FailedCreateWorkspaceRequest' (Maybe Text) (Maybe Text) (Maybe WorkspaceRequest) |
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.
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.
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.
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' (Maybe Text) |
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.
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' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
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
SupportEmail
andSupportLink
parameters 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
SupportEmail
andSupportLink
parameters 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' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Base64) (Maybe Base64) (Maybe Base64) (Maybe Text) (Maybe Text) |
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
SupportEmail
andSupportLink
parameters 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
SupportEmail
andSupportLink
parameters 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' (Maybe Text) (Maybe Text) |
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.
ModificationState
data ModificationState Source #
Describes a WorkSpace modification.
See: newModificationState
smart constructor.
Constructors
ModificationState' (Maybe ModificationResourceEnum) (Maybe ModificationStateEnum) |
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.
OperatingSystem
data OperatingSystem Source #
The operating system that the image is running.
See: newOperatingSystem
smart constructor.
Constructors
OperatingSystem' (Maybe OperatingSystemType) |
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.
PendingCreateStandbyWorkspacesRequest
data PendingCreateStandbyWorkspacesRequest Source #
Information about the Standby WorkSpace.
See: newPendingCreateStandbyWorkspacesRequest
smart constructor.
Constructors
PendingCreateStandbyWorkspacesRequest' (Maybe Text) (Maybe WorkspaceState) (Maybe Text) (Maybe Text) |
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.
RebootRequest
data RebootRequest Source #
Describes the information used to reboot a WorkSpace.
See: newRebootRequest
smart constructor.
Constructors
RebootRequest' Text |
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.
RebuildRequest
data RebuildRequest Source #
Describes the information used to rebuild a WorkSpace.
See: newRebuildRequest
smart constructor.
Constructors
RebuildRequest' Text |
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.
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' (Maybe Text) (Maybe WorkspaceState) (Maybe StandbyWorkspaceRelationshipType) (Maybe Text) |
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.
RootStorage
data RootStorage Source #
Describes the root volume for a WorkSpace bundle.
See: newRootStorage
smart constructor.
Constructors
RootStorage' (Maybe Text) |
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.
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' (Maybe Text) (Maybe SamlStatusEnum) (Maybe Text) |
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.
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' (Maybe ReconnectEnum) (Maybe ReconnectEnum) (Maybe ReconnectEnum) (Maybe ReconnectEnum) (Maybe ReconnectEnum) |
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.
Snapshot
Describes a snapshot.
See: newSnapshot
smart constructor.
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.
StandbyWorkspace
data StandbyWorkspace Source #
Describes a Standby WorkSpace.
See: newStandbyWorkspace
smart constructor.
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.
StartRequest
data StartRequest Source #
Information used to start a WorkSpace.
See: newStartRequest
smart constructor.
Constructors
StartRequest' (Maybe Text) |
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.
StopRequest
data StopRequest Source #
Describes the information used to stop a WorkSpace.
See: newStopRequest
smart constructor.
Constructors
StopRequest' (Maybe Text) |
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.
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' Text |
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.
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' (Maybe Text) (Maybe Bool) |
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.
UserStorage
data UserStorage Source #
Describes the user volume for a WorkSpace bundle.
See: newUserStorage
smart constructor.
Constructors
UserStorage' (Maybe Text) |
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.
Workspace
Describes a WorkSpace.
See: newWorkspace
smart constructor.
Constructors
Workspace' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ModificationState]) (Maybe [RelatedWorkspaceProperties]) (Maybe Bool) (Maybe WorkspaceState) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe WorkspaceProperties) |
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.
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
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.
WorkspaceBundle
data WorkspaceBundle Source #
Describes a WorkSpace bundle.
See: newWorkspaceBundle
smart constructor.
Constructors
WorkspaceBundle' (Maybe Text) (Maybe BundleType) (Maybe ComputeType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RootStorage) (Maybe WorkspaceBundleState) (Maybe UserStorage) |
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.
WorkspaceConnectionStatus
data WorkspaceConnectionStatus Source #
Describes the connection status of a WorkSpace.
See: newWorkspaceConnectionStatus
smart constructor.
Constructors
WorkspaceConnectionStatus' (Maybe ConnectionState) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
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.
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' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
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.
WorkspaceDirectory
data WorkspaceDirectory Source #
Describes a directory that is used with Amazon WorkSpaces.
See: newWorkspaceDirectory
smart constructor.
Constructors
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.
WorkspaceImage
data WorkspaceImage Source #
Describes a WorkSpace image.
See: newWorkspaceImage
smart constructor.
Constructors
WorkspaceImage' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OperatingSystem) (Maybe Text) (Maybe WorkspaceImageRequiredTenancy) (Maybe WorkspaceImageState) (Maybe UpdateResult) |
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.
WorkspaceProperties
data WorkspaceProperties Source #
Describes a WorkSpace.
See: newWorkspaceProperties
smart constructor.
Constructors
WorkspaceProperties' (Maybe Compute) (Maybe [Protocol]) (Maybe Int) (Maybe RunningMode) (Maybe Int) (Maybe Int) |
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
Protocols
property is case sensitive. Ensure you usePCOIP
orWSP
. - 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.
WorkspaceRequest
data WorkspaceRequest Source #
Describes the information used to create a WorkSpace.
See: newWorkspaceRequest
smart constructor.
Constructors
WorkspaceRequest' (Maybe Bool) (Maybe [Tag]) (Maybe Bool) (Maybe Text) (Maybe WorkspaceProperties) Text Text Text |
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.
WorkspacesIpGroup
data WorkspacesIpGroup Source #
Describes an IP access control group.
See: newWorkspacesIpGroup
smart constructor.
Constructors
WorkspacesIpGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [IpRuleItem]) |
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.