| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.WorkSpaces.Lens
Contents
- Operations
- AssociateConnectionAlias
- DescribeAccount
- RevokeIpRules
- DescribeWorkspaceImages
- ModifyWorkspaceProperties
- DeregisterWorkspaceDirectory
- MigrateWorkspace
- DescribeTags
- DescribeWorkspaceDirectories
- DisassociateIpGroups
- DescribeWorkspaceBundles
- AuthorizeIpRules
- DescribeWorkspaceImagePermissions
- RebuildWorkspaces
- ImportWorkspaceImage
- ModifyWorkspaceState
- CreateIpGroup
- DisassociateConnectionAlias
- ModifyWorkspaceCreationProperties
- RegisterWorkspaceDirectory
- RestoreWorkspace
- DescribeConnectionAliasPermissions
- CreateTags
- CreateWorkspaceBundle
- DeleteTags
- ModifyWorkspaceAccessProperties
- UpdateRulesOfIpGroup
- DeleteWorkspaceImage
- StopWorkspaces
- AssociateIpGroups
- ModifySelfservicePermissions
- DeleteConnectionAlias
- DescribeWorkspacesConnectionStatus
- CreateConnectionAlias
- RebootWorkspaces
- DeleteIpGroup
- CopyWorkspaceImage
- DescribeWorkspaceSnapshots
- TerminateWorkspaces
- UpdateConnectionAliasPermission
- CreateWorkspaces
- DescribeClientProperties
- ModifyClientProperties
- DescribeIpGroups
- DeleteWorkspaceBundle
- UpdateWorkspaceBundle
- ListAvailableManagementCidrRanges
- UpdateWorkspaceImagePermission
- CreateUpdatedWorkspaceImage
- DescribeWorkspaces
- DescribeConnectionAliases
- StartWorkspaces
- DescribeAccountModifications
- ModifyAccount
- Types
- AccountModification
- ClientProperties
- ClientPropertiesResult
- ComputeType
- ConnectionAlias
- ConnectionAliasAssociation
- ConnectionAliasPermission
- DefaultWorkspaceCreationProperties
- FailedCreateWorkspaceRequest
- FailedWorkspaceChangeRequest
- ImagePermission
- IpRuleItem
- ModificationState
- OperatingSystem
- RebootRequest
- RebuildRequest
- RootStorage
- SelfservicePermissions
- Snapshot
- StartRequest
- StopRequest
- Tag
- TerminateRequest
- UpdateResult
- UserStorage
- Workspace
- WorkspaceAccessProperties
- WorkspaceBundle
- WorkspaceConnectionStatus
- WorkspaceCreationProperties
- WorkspaceDirectory
- WorkspaceImage
- WorkspaceProperties
- WorkspaceRequest
- WorkspacesIpGroup
Description
Synopsis
- associateConnectionAlias_aliasId :: Lens' AssociateConnectionAlias Text
- associateConnectionAlias_resourceId :: Lens' AssociateConnectionAlias Text
- associateConnectionAliasResponse_connectionIdentifier :: Lens' AssociateConnectionAliasResponse (Maybe Text)
- associateConnectionAliasResponse_httpStatus :: Lens' AssociateConnectionAliasResponse Int
- describeAccountResponse_dedicatedTenancySupport :: Lens' DescribeAccountResponse (Maybe DedicatedTenancySupportResultEnum)
- describeAccountResponse_dedicatedTenancyManagementCidrRange :: Lens' DescribeAccountResponse (Maybe Text)
- describeAccountResponse_httpStatus :: Lens' DescribeAccountResponse Int
- revokeIpRules_groupId :: Lens' RevokeIpRules Text
- revokeIpRules_userRules :: Lens' RevokeIpRules [Text]
- revokeIpRulesResponse_httpStatus :: Lens' RevokeIpRulesResponse Int
- describeWorkspaceImages_imageIds :: Lens' DescribeWorkspaceImages (Maybe (NonEmpty Text))
- describeWorkspaceImages_nextToken :: Lens' DescribeWorkspaceImages (Maybe Text)
- describeWorkspaceImages_imageType :: Lens' DescribeWorkspaceImages (Maybe ImageType)
- describeWorkspaceImages_maxResults :: Lens' DescribeWorkspaceImages (Maybe Natural)
- describeWorkspaceImagesResponse_images :: Lens' DescribeWorkspaceImagesResponse (Maybe [WorkspaceImage])
- describeWorkspaceImagesResponse_nextToken :: Lens' DescribeWorkspaceImagesResponse (Maybe Text)
- describeWorkspaceImagesResponse_httpStatus :: Lens' DescribeWorkspaceImagesResponse Int
- modifyWorkspaceProperties_workspaceId :: Lens' ModifyWorkspaceProperties Text
- modifyWorkspaceProperties_workspaceProperties :: Lens' ModifyWorkspaceProperties WorkspaceProperties
- modifyWorkspacePropertiesResponse_httpStatus :: Lens' ModifyWorkspacePropertiesResponse Int
- deregisterWorkspaceDirectory_directoryId :: Lens' DeregisterWorkspaceDirectory Text
- deregisterWorkspaceDirectoryResponse_httpStatus :: Lens' DeregisterWorkspaceDirectoryResponse Int
- migrateWorkspace_sourceWorkspaceId :: Lens' MigrateWorkspace Text
- migrateWorkspace_bundleId :: Lens' MigrateWorkspace Text
- migrateWorkspaceResponse_sourceWorkspaceId :: Lens' MigrateWorkspaceResponse (Maybe Text)
- migrateWorkspaceResponse_targetWorkspaceId :: Lens' MigrateWorkspaceResponse (Maybe Text)
- migrateWorkspaceResponse_httpStatus :: Lens' MigrateWorkspaceResponse Int
- describeTags_resourceId :: Lens' DescribeTags Text
- describeTagsResponse_tagList :: Lens' DescribeTagsResponse (Maybe [Tag])
- describeTagsResponse_httpStatus :: Lens' DescribeTagsResponse Int
- describeWorkspaceDirectories_nextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text)
- describeWorkspaceDirectories_directoryIds :: Lens' DescribeWorkspaceDirectories (Maybe (NonEmpty Text))
- describeWorkspaceDirectories_limit :: Lens' DescribeWorkspaceDirectories (Maybe Natural)
- describeWorkspaceDirectoriesResponse_directories :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe [WorkspaceDirectory])
- describeWorkspaceDirectoriesResponse_nextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text)
- describeWorkspaceDirectoriesResponse_httpStatus :: Lens' DescribeWorkspaceDirectoriesResponse Int
- disassociateIpGroups_directoryId :: Lens' DisassociateIpGroups Text
- disassociateIpGroups_groupIds :: Lens' DisassociateIpGroups [Text]
- disassociateIpGroupsResponse_httpStatus :: Lens' DisassociateIpGroupsResponse Int
- describeWorkspaceBundles_bundleIds :: Lens' DescribeWorkspaceBundles (Maybe (NonEmpty Text))
- describeWorkspaceBundles_owner :: Lens' DescribeWorkspaceBundles (Maybe Text)
- describeWorkspaceBundles_nextToken :: Lens' DescribeWorkspaceBundles (Maybe Text)
- describeWorkspaceBundlesResponse_bundles :: Lens' DescribeWorkspaceBundlesResponse (Maybe [WorkspaceBundle])
- describeWorkspaceBundlesResponse_nextToken :: Lens' DescribeWorkspaceBundlesResponse (Maybe Text)
- describeWorkspaceBundlesResponse_httpStatus :: Lens' DescribeWorkspaceBundlesResponse Int
- authorizeIpRules_groupId :: Lens' AuthorizeIpRules Text
- authorizeIpRules_userRules :: Lens' AuthorizeIpRules [IpRuleItem]
- authorizeIpRulesResponse_httpStatus :: Lens' AuthorizeIpRulesResponse Int
- describeWorkspaceImagePermissions_nextToken :: Lens' DescribeWorkspaceImagePermissions (Maybe Text)
- describeWorkspaceImagePermissions_maxResults :: Lens' DescribeWorkspaceImagePermissions (Maybe Natural)
- describeWorkspaceImagePermissions_imageId :: Lens' DescribeWorkspaceImagePermissions Text
- describeWorkspaceImagePermissionsResponse_imagePermissions :: Lens' DescribeWorkspaceImagePermissionsResponse (Maybe [ImagePermission])
- describeWorkspaceImagePermissionsResponse_nextToken :: Lens' DescribeWorkspaceImagePermissionsResponse (Maybe Text)
- describeWorkspaceImagePermissionsResponse_imageId :: Lens' DescribeWorkspaceImagePermissionsResponse (Maybe Text)
- describeWorkspaceImagePermissionsResponse_httpStatus :: Lens' DescribeWorkspaceImagePermissionsResponse Int
- rebuildWorkspaces_rebuildWorkspaceRequests :: Lens' RebuildWorkspaces (NonEmpty RebuildRequest)
- rebuildWorkspacesResponse_failedRequests :: Lens' RebuildWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest])
- rebuildWorkspacesResponse_httpStatus :: Lens' RebuildWorkspacesResponse Int
- importWorkspaceImage_applications :: Lens' ImportWorkspaceImage (Maybe (NonEmpty Application))
- importWorkspaceImage_tags :: Lens' ImportWorkspaceImage (Maybe [Tag])
- importWorkspaceImage_ec2ImageId :: Lens' ImportWorkspaceImage Text
- importWorkspaceImage_ingestionProcess :: Lens' ImportWorkspaceImage WorkspaceImageIngestionProcess
- importWorkspaceImage_imageName :: Lens' ImportWorkspaceImage Text
- importWorkspaceImage_imageDescription :: Lens' ImportWorkspaceImage Text
- importWorkspaceImageResponse_imageId :: Lens' ImportWorkspaceImageResponse (Maybe Text)
- importWorkspaceImageResponse_httpStatus :: Lens' ImportWorkspaceImageResponse Int
- modifyWorkspaceState_workspaceId :: Lens' ModifyWorkspaceState Text
- modifyWorkspaceState_workspaceState :: Lens' ModifyWorkspaceState TargetWorkspaceState
- modifyWorkspaceStateResponse_httpStatus :: Lens' ModifyWorkspaceStateResponse Int
- createIpGroup_groupDesc :: Lens' CreateIpGroup (Maybe Text)
- createIpGroup_userRules :: Lens' CreateIpGroup (Maybe [IpRuleItem])
- createIpGroup_tags :: Lens' CreateIpGroup (Maybe [Tag])
- createIpGroup_groupName :: Lens' CreateIpGroup Text
- createIpGroupResponse_groupId :: Lens' CreateIpGroupResponse (Maybe Text)
- createIpGroupResponse_httpStatus :: Lens' CreateIpGroupResponse Int
- disassociateConnectionAlias_aliasId :: Lens' DisassociateConnectionAlias Text
- disassociateConnectionAliasResponse_httpStatus :: Lens' DisassociateConnectionAliasResponse Int
- modifyWorkspaceCreationProperties_resourceId :: Lens' ModifyWorkspaceCreationProperties Text
- modifyWorkspaceCreationProperties_workspaceCreationProperties :: Lens' ModifyWorkspaceCreationProperties WorkspaceCreationProperties
- modifyWorkspaceCreationPropertiesResponse_httpStatus :: Lens' ModifyWorkspaceCreationPropertiesResponse Int
- registerWorkspaceDirectory_subnetIds :: Lens' RegisterWorkspaceDirectory (Maybe [Text])
- registerWorkspaceDirectory_enableSelfService :: Lens' RegisterWorkspaceDirectory (Maybe Bool)
- registerWorkspaceDirectory_tenancy :: Lens' RegisterWorkspaceDirectory (Maybe Tenancy)
- registerWorkspaceDirectory_tags :: Lens' RegisterWorkspaceDirectory (Maybe [Tag])
- registerWorkspaceDirectory_directoryId :: Lens' RegisterWorkspaceDirectory Text
- registerWorkspaceDirectory_enableWorkDocs :: Lens' RegisterWorkspaceDirectory Bool
- registerWorkspaceDirectoryResponse_httpStatus :: Lens' RegisterWorkspaceDirectoryResponse Int
- restoreWorkspace_workspaceId :: Lens' RestoreWorkspace Text
- restoreWorkspaceResponse_httpStatus :: Lens' RestoreWorkspaceResponse Int
- describeConnectionAliasPermissions_nextToken :: Lens' DescribeConnectionAliasPermissions (Maybe Text)
- describeConnectionAliasPermissions_maxResults :: Lens' DescribeConnectionAliasPermissions (Maybe Natural)
- describeConnectionAliasPermissions_aliasId :: Lens' DescribeConnectionAliasPermissions Text
- describeConnectionAliasPermissionsResponse_aliasId :: Lens' DescribeConnectionAliasPermissionsResponse (Maybe Text)
- describeConnectionAliasPermissionsResponse_nextToken :: Lens' DescribeConnectionAliasPermissionsResponse (Maybe Text)
- describeConnectionAliasPermissionsResponse_connectionAliasPermissions :: Lens' DescribeConnectionAliasPermissionsResponse (Maybe (NonEmpty ConnectionAliasPermission))
- describeConnectionAliasPermissionsResponse_httpStatus :: Lens' DescribeConnectionAliasPermissionsResponse Int
- createTags_resourceId :: Lens' CreateTags Text
- createTags_tags :: Lens' CreateTags [Tag]
- createTagsResponse_httpStatus :: Lens' CreateTagsResponse Int
- createWorkspaceBundle_rootStorage :: Lens' CreateWorkspaceBundle (Maybe RootStorage)
- createWorkspaceBundle_tags :: Lens' CreateWorkspaceBundle (Maybe [Tag])
- createWorkspaceBundle_bundleName :: Lens' CreateWorkspaceBundle Text
- createWorkspaceBundle_bundleDescription :: Lens' CreateWorkspaceBundle Text
- createWorkspaceBundle_imageId :: Lens' CreateWorkspaceBundle Text
- createWorkspaceBundle_computeType :: Lens' CreateWorkspaceBundle ComputeType
- createWorkspaceBundle_userStorage :: Lens' CreateWorkspaceBundle UserStorage
- createWorkspaceBundleResponse_workspaceBundle :: Lens' CreateWorkspaceBundleResponse (Maybe WorkspaceBundle)
- createWorkspaceBundleResponse_httpStatus :: Lens' CreateWorkspaceBundleResponse Int
- deleteTags_resourceId :: Lens' DeleteTags Text
- deleteTags_tagKeys :: Lens' DeleteTags [Text]
- deleteTagsResponse_httpStatus :: Lens' DeleteTagsResponse Int
- modifyWorkspaceAccessProperties_resourceId :: Lens' ModifyWorkspaceAccessProperties Text
- modifyWorkspaceAccessProperties_workspaceAccessProperties :: Lens' ModifyWorkspaceAccessProperties WorkspaceAccessProperties
- modifyWorkspaceAccessPropertiesResponse_httpStatus :: Lens' ModifyWorkspaceAccessPropertiesResponse Int
- updateRulesOfIpGroup_groupId :: Lens' UpdateRulesOfIpGroup Text
- updateRulesOfIpGroup_userRules :: Lens' UpdateRulesOfIpGroup [IpRuleItem]
- updateRulesOfIpGroupResponse_httpStatus :: Lens' UpdateRulesOfIpGroupResponse Int
- deleteWorkspaceImage_imageId :: Lens' DeleteWorkspaceImage Text
- deleteWorkspaceImageResponse_httpStatus :: Lens' DeleteWorkspaceImageResponse Int
- stopWorkspaces_stopWorkspaceRequests :: Lens' StopWorkspaces (NonEmpty StopRequest)
- stopWorkspacesResponse_failedRequests :: Lens' StopWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest])
- stopWorkspacesResponse_httpStatus :: Lens' StopWorkspacesResponse Int
- associateIpGroups_directoryId :: Lens' AssociateIpGroups Text
- associateIpGroups_groupIds :: Lens' AssociateIpGroups [Text]
- associateIpGroupsResponse_httpStatus :: Lens' AssociateIpGroupsResponse Int
- modifySelfservicePermissions_resourceId :: Lens' ModifySelfservicePermissions Text
- modifySelfservicePermissions_selfservicePermissions :: Lens' ModifySelfservicePermissions SelfservicePermissions
- modifySelfservicePermissionsResponse_httpStatus :: Lens' ModifySelfservicePermissionsResponse Int
- deleteConnectionAlias_aliasId :: Lens' DeleteConnectionAlias Text
- deleteConnectionAliasResponse_httpStatus :: Lens' DeleteConnectionAliasResponse Int
- describeWorkspacesConnectionStatus_workspaceIds :: Lens' DescribeWorkspacesConnectionStatus (Maybe (NonEmpty Text))
- describeWorkspacesConnectionStatus_nextToken :: Lens' DescribeWorkspacesConnectionStatus (Maybe Text)
- describeWorkspacesConnectionStatusResponse_nextToken :: Lens' DescribeWorkspacesConnectionStatusResponse (Maybe Text)
- describeWorkspacesConnectionStatusResponse_workspacesConnectionStatus :: Lens' DescribeWorkspacesConnectionStatusResponse (Maybe [WorkspaceConnectionStatus])
- describeWorkspacesConnectionStatusResponse_httpStatus :: Lens' DescribeWorkspacesConnectionStatusResponse Int
- createConnectionAlias_tags :: Lens' CreateConnectionAlias (Maybe [Tag])
- createConnectionAlias_connectionString :: Lens' CreateConnectionAlias Text
- createConnectionAliasResponse_aliasId :: Lens' CreateConnectionAliasResponse (Maybe Text)
- createConnectionAliasResponse_httpStatus :: Lens' CreateConnectionAliasResponse Int
- rebootWorkspaces_rebootWorkspaceRequests :: Lens' RebootWorkspaces (NonEmpty RebootRequest)
- rebootWorkspacesResponse_failedRequests :: Lens' RebootWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest])
- rebootWorkspacesResponse_httpStatus :: Lens' RebootWorkspacesResponse Int
- deleteIpGroup_groupId :: Lens' DeleteIpGroup Text
- deleteIpGroupResponse_httpStatus :: Lens' DeleteIpGroupResponse Int
- copyWorkspaceImage_description :: Lens' CopyWorkspaceImage (Maybe Text)
- copyWorkspaceImage_tags :: Lens' CopyWorkspaceImage (Maybe [Tag])
- copyWorkspaceImage_name :: Lens' CopyWorkspaceImage Text
- copyWorkspaceImage_sourceImageId :: Lens' CopyWorkspaceImage Text
- copyWorkspaceImage_sourceRegion :: Lens' CopyWorkspaceImage Text
- copyWorkspaceImageResponse_imageId :: Lens' CopyWorkspaceImageResponse (Maybe Text)
- copyWorkspaceImageResponse_httpStatus :: Lens' CopyWorkspaceImageResponse Int
- describeWorkspaceSnapshots_workspaceId :: Lens' DescribeWorkspaceSnapshots Text
- describeWorkspaceSnapshotsResponse_restoreSnapshots :: Lens' DescribeWorkspaceSnapshotsResponse (Maybe [Snapshot])
- describeWorkspaceSnapshotsResponse_rebuildSnapshots :: Lens' DescribeWorkspaceSnapshotsResponse (Maybe [Snapshot])
- describeWorkspaceSnapshotsResponse_httpStatus :: Lens' DescribeWorkspaceSnapshotsResponse Int
- terminateWorkspaces_terminateWorkspaceRequests :: Lens' TerminateWorkspaces (NonEmpty TerminateRequest)
- terminateWorkspacesResponse_failedRequests :: Lens' TerminateWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest])
- terminateWorkspacesResponse_httpStatus :: Lens' TerminateWorkspacesResponse Int
- updateConnectionAliasPermission_aliasId :: Lens' UpdateConnectionAliasPermission Text
- updateConnectionAliasPermission_connectionAliasPermission :: Lens' UpdateConnectionAliasPermission ConnectionAliasPermission
- updateConnectionAliasPermissionResponse_httpStatus :: Lens' UpdateConnectionAliasPermissionResponse Int
- createWorkspaces_workspaces :: Lens' CreateWorkspaces (NonEmpty WorkspaceRequest)
- createWorkspacesResponse_failedRequests :: Lens' CreateWorkspacesResponse (Maybe [FailedCreateWorkspaceRequest])
- createWorkspacesResponse_pendingRequests :: Lens' CreateWorkspacesResponse (Maybe [Workspace])
- createWorkspacesResponse_httpStatus :: Lens' CreateWorkspacesResponse Int
- describeClientProperties_resourceIds :: Lens' DescribeClientProperties (NonEmpty Text)
- describeClientPropertiesResponse_clientPropertiesList :: Lens' DescribeClientPropertiesResponse (Maybe [ClientPropertiesResult])
- describeClientPropertiesResponse_httpStatus :: Lens' DescribeClientPropertiesResponse Int
- modifyClientProperties_resourceId :: Lens' ModifyClientProperties Text
- modifyClientProperties_clientProperties :: Lens' ModifyClientProperties ClientProperties
- modifyClientPropertiesResponse_httpStatus :: Lens' ModifyClientPropertiesResponse Int
- describeIpGroups_groupIds :: Lens' DescribeIpGroups (Maybe [Text])
- describeIpGroups_nextToken :: Lens' DescribeIpGroups (Maybe Text)
- describeIpGroups_maxResults :: Lens' DescribeIpGroups (Maybe Natural)
- describeIpGroupsResponse_result :: Lens' DescribeIpGroupsResponse (Maybe [WorkspacesIpGroup])
- describeIpGroupsResponse_nextToken :: Lens' DescribeIpGroupsResponse (Maybe Text)
- describeIpGroupsResponse_httpStatus :: Lens' DescribeIpGroupsResponse Int
- deleteWorkspaceBundle_bundleId :: Lens' DeleteWorkspaceBundle (Maybe Text)
- deleteWorkspaceBundleResponse_httpStatus :: Lens' DeleteWorkspaceBundleResponse Int
- updateWorkspaceBundle_bundleId :: Lens' UpdateWorkspaceBundle (Maybe Text)
- updateWorkspaceBundle_imageId :: Lens' UpdateWorkspaceBundle (Maybe Text)
- updateWorkspaceBundleResponse_httpStatus :: Lens' UpdateWorkspaceBundleResponse Int
- listAvailableManagementCidrRanges_nextToken :: Lens' ListAvailableManagementCidrRanges (Maybe Text)
- listAvailableManagementCidrRanges_maxResults :: Lens' ListAvailableManagementCidrRanges (Maybe Natural)
- listAvailableManagementCidrRanges_managementCidrRangeConstraint :: Lens' ListAvailableManagementCidrRanges Text
- listAvailableManagementCidrRangesResponse_managementCidrRanges :: Lens' ListAvailableManagementCidrRangesResponse (Maybe [Text])
- listAvailableManagementCidrRangesResponse_nextToken :: Lens' ListAvailableManagementCidrRangesResponse (Maybe Text)
- listAvailableManagementCidrRangesResponse_httpStatus :: Lens' ListAvailableManagementCidrRangesResponse Int
- updateWorkspaceImagePermission_imageId :: Lens' UpdateWorkspaceImagePermission Text
- updateWorkspaceImagePermission_allowCopyImage :: Lens' UpdateWorkspaceImagePermission Bool
- updateWorkspaceImagePermission_sharedAccountId :: Lens' UpdateWorkspaceImagePermission Text
- updateWorkspaceImagePermissionResponse_httpStatus :: Lens' UpdateWorkspaceImagePermissionResponse Int
- createUpdatedWorkspaceImage_tags :: Lens' CreateUpdatedWorkspaceImage (Maybe [Tag])
- createUpdatedWorkspaceImage_name :: Lens' CreateUpdatedWorkspaceImage Text
- createUpdatedWorkspaceImage_description :: Lens' CreateUpdatedWorkspaceImage Text
- createUpdatedWorkspaceImage_sourceImageId :: Lens' CreateUpdatedWorkspaceImage Text
- createUpdatedWorkspaceImageResponse_imageId :: Lens' CreateUpdatedWorkspaceImageResponse (Maybe Text)
- createUpdatedWorkspaceImageResponse_httpStatus :: Lens' CreateUpdatedWorkspaceImageResponse Int
- describeWorkspaces_directoryId :: Lens' DescribeWorkspaces (Maybe Text)
- describeWorkspaces_workspaceIds :: Lens' DescribeWorkspaces (Maybe (NonEmpty Text))
- describeWorkspaces_userName :: Lens' DescribeWorkspaces (Maybe Text)
- describeWorkspaces_bundleId :: Lens' DescribeWorkspaces (Maybe Text)
- describeWorkspaces_nextToken :: Lens' DescribeWorkspaces (Maybe Text)
- describeWorkspaces_limit :: Lens' DescribeWorkspaces (Maybe Natural)
- describeWorkspacesResponse_nextToken :: Lens' DescribeWorkspacesResponse (Maybe Text)
- describeWorkspacesResponse_workspaces :: Lens' DescribeWorkspacesResponse (Maybe [Workspace])
- describeWorkspacesResponse_httpStatus :: Lens' DescribeWorkspacesResponse Int
- describeConnectionAliases_resourceId :: Lens' DescribeConnectionAliases (Maybe Text)
- describeConnectionAliases_aliasIds :: Lens' DescribeConnectionAliases (Maybe (NonEmpty Text))
- describeConnectionAliases_nextToken :: Lens' DescribeConnectionAliases (Maybe Text)
- describeConnectionAliases_limit :: Lens' DescribeConnectionAliases (Maybe Natural)
- describeConnectionAliasesResponse_connectionAliases :: Lens' DescribeConnectionAliasesResponse (Maybe (NonEmpty ConnectionAlias))
- describeConnectionAliasesResponse_nextToken :: Lens' DescribeConnectionAliasesResponse (Maybe Text)
- describeConnectionAliasesResponse_httpStatus :: Lens' DescribeConnectionAliasesResponse Int
- startWorkspaces_startWorkspaceRequests :: Lens' StartWorkspaces (NonEmpty StartRequest)
- startWorkspacesResponse_failedRequests :: Lens' StartWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest])
- startWorkspacesResponse_httpStatus :: Lens' StartWorkspacesResponse Int
- describeAccountModifications_nextToken :: Lens' DescribeAccountModifications (Maybe Text)
- describeAccountModificationsResponse_accountModifications :: Lens' DescribeAccountModificationsResponse (Maybe [AccountModification])
- describeAccountModificationsResponse_nextToken :: Lens' DescribeAccountModificationsResponse (Maybe Text)
- describeAccountModificationsResponse_httpStatus :: Lens' DescribeAccountModificationsResponse Int
- modifyAccount_dedicatedTenancySupport :: Lens' ModifyAccount (Maybe DedicatedTenancySupportEnum)
- modifyAccount_dedicatedTenancyManagementCidrRange :: Lens' ModifyAccount (Maybe Text)
- modifyAccountResponse_httpStatus :: Lens' ModifyAccountResponse Int
- accountModification_startTime :: Lens' AccountModification (Maybe UTCTime)
- accountModification_dedicatedTenancySupport :: Lens' AccountModification (Maybe DedicatedTenancySupportResultEnum)
- accountModification_modificationState :: Lens' AccountModification (Maybe DedicatedTenancyModificationStateEnum)
- accountModification_dedicatedTenancyManagementCidrRange :: Lens' AccountModification (Maybe Text)
- accountModification_errorCode :: Lens' AccountModification (Maybe Text)
- accountModification_errorMessage :: Lens' AccountModification (Maybe Text)
- clientProperties_reconnectEnabled :: Lens' ClientProperties (Maybe ReconnectEnum)
- clientPropertiesResult_resourceId :: Lens' ClientPropertiesResult (Maybe Text)
- clientPropertiesResult_clientProperties :: Lens' ClientPropertiesResult (Maybe ClientProperties)
- computeType_name :: Lens' ComputeType (Maybe Compute)
- connectionAlias_state :: Lens' ConnectionAlias (Maybe ConnectionAliasState)
- connectionAlias_ownerAccountId :: Lens' ConnectionAlias (Maybe Text)
- connectionAlias_aliasId :: Lens' ConnectionAlias (Maybe Text)
- connectionAlias_associations :: Lens' ConnectionAlias (Maybe (NonEmpty ConnectionAliasAssociation))
- connectionAlias_connectionString :: Lens' ConnectionAlias (Maybe Text)
- connectionAliasAssociation_associatedAccountId :: Lens' ConnectionAliasAssociation (Maybe Text)
- connectionAliasAssociation_resourceId :: Lens' ConnectionAliasAssociation (Maybe Text)
- connectionAliasAssociation_associationStatus :: Lens' ConnectionAliasAssociation (Maybe AssociationStatus)
- connectionAliasAssociation_connectionIdentifier :: Lens' ConnectionAliasAssociation (Maybe Text)
- connectionAliasPermission_sharedAccountId :: Lens' ConnectionAliasPermission Text
- connectionAliasPermission_allowAssociation :: Lens' ConnectionAliasPermission Bool
- defaultWorkspaceCreationProperties_customSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
- defaultWorkspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- defaultWorkspaceCreationProperties_enableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- defaultWorkspaceCreationProperties_enableMaintenanceMode :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- defaultWorkspaceCreationProperties_enableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool)
- defaultWorkspaceCreationProperties_defaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text)
- failedCreateWorkspaceRequest_workspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest)
- failedCreateWorkspaceRequest_errorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
- failedCreateWorkspaceRequest_errorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text)
- failedWorkspaceChangeRequest_errorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- failedWorkspaceChangeRequest_workspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- failedWorkspaceChangeRequest_errorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text)
- imagePermission_sharedAccountId :: Lens' ImagePermission (Maybe Text)
- ipRuleItem_ruleDesc :: Lens' IpRuleItem (Maybe Text)
- ipRuleItem_ipRule :: Lens' IpRuleItem (Maybe Text)
- modificationState_state :: Lens' ModificationState (Maybe ModificationStateEnum)
- modificationState_resource :: Lens' ModificationState (Maybe ModificationResourceEnum)
- operatingSystem_type :: Lens' OperatingSystem (Maybe OperatingSystemType)
- rebootRequest_workspaceId :: Lens' RebootRequest Text
- rebuildRequest_workspaceId :: Lens' RebuildRequest Text
- rootStorage_capacity :: Lens' RootStorage (Maybe Text)
- selfservicePermissions_restartWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_changeComputeType :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_switchRunningMode :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_rebuildWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- selfservicePermissions_increaseVolumeSize :: Lens' SelfservicePermissions (Maybe ReconnectEnum)
- snapshot_snapshotTime :: Lens' Snapshot (Maybe UTCTime)
- startRequest_workspaceId :: Lens' StartRequest (Maybe Text)
- stopRequest_workspaceId :: Lens' StopRequest (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- terminateRequest_workspaceId :: Lens' TerminateRequest Text
- updateResult_updateAvailable :: Lens' UpdateResult (Maybe Bool)
- updateResult_description :: Lens' UpdateResult (Maybe Text)
- userStorage_capacity :: Lens' UserStorage (Maybe Text)
- workspace_directoryId :: Lens' Workspace (Maybe Text)
- workspace_state :: Lens' Workspace (Maybe WorkspaceState)
- workspace_ipAddress :: Lens' Workspace (Maybe Text)
- workspace_modificationStates :: Lens' Workspace (Maybe [ModificationState])
- workspace_userName :: Lens' Workspace (Maybe Text)
- workspace_subnetId :: Lens' Workspace (Maybe Text)
- workspace_bundleId :: Lens' Workspace (Maybe Text)
- workspace_workspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties)
- workspace_rootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
- workspace_errorCode :: Lens' Workspace (Maybe Text)
- workspace_volumeEncryptionKey :: Lens' Workspace (Maybe Text)
- workspace_computerName :: Lens' Workspace (Maybe Text)
- workspace_workspaceId :: Lens' Workspace (Maybe Text)
- workspace_userVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
- workspace_errorMessage :: Lens' Workspace (Maybe Text)
- workspaceAccessProperties_deviceTypeWindows :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeWeb :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeAndroid :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeLinux :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeOsx :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeChromeOs :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeIos :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceAccessProperties_deviceTypeZeroClient :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue)
- workspaceBundle_creationTime :: Lens' WorkspaceBundle (Maybe UTCTime)
- workspaceBundle_lastUpdatedTime :: Lens' WorkspaceBundle (Maybe UTCTime)
- workspaceBundle_bundleId :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_owner :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_rootStorage :: Lens' WorkspaceBundle (Maybe RootStorage)
- workspaceBundle_name :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_imageId :: Lens' WorkspaceBundle (Maybe Text)
- workspaceBundle_computeType :: Lens' WorkspaceBundle (Maybe ComputeType)
- workspaceBundle_userStorage :: Lens' WorkspaceBundle (Maybe UserStorage)
- workspaceBundle_description :: Lens' WorkspaceBundle (Maybe Text)
- workspaceConnectionStatus_lastKnownUserConnectionTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime)
- workspaceConnectionStatus_connectionStateCheckTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime)
- workspaceConnectionStatus_workspaceId :: Lens' WorkspaceConnectionStatus (Maybe Text)
- workspaceConnectionStatus_connectionState :: Lens' WorkspaceConnectionStatus (Maybe ConnectionState)
- workspaceCreationProperties_customSecurityGroupId :: Lens' WorkspaceCreationProperties (Maybe Text)
- workspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' WorkspaceCreationProperties (Maybe Bool)
- workspaceCreationProperties_enableWorkDocs :: Lens' WorkspaceCreationProperties (Maybe Bool)
- workspaceCreationProperties_enableMaintenanceMode :: Lens' WorkspaceCreationProperties (Maybe Bool)
- workspaceCreationProperties_enableInternetAccess :: Lens' WorkspaceCreationProperties (Maybe Bool)
- workspaceCreationProperties_defaultOu :: Lens' WorkspaceCreationProperties (Maybe Text)
- workspaceDirectory_registrationCode :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_iamRoleId :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_directoryId :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_state :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState)
- workspaceDirectory_customerUserName :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_subnetIds :: Lens' WorkspaceDirectory (Maybe [Text])
- workspaceDirectory_ipGroupIds :: Lens' WorkspaceDirectory (Maybe [Text])
- workspaceDirectory_alias :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_workspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_directoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType)
- workspaceDirectory_tenancy :: Lens' WorkspaceDirectory (Maybe Tenancy)
- workspaceDirectory_workspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties)
- workspaceDirectory_dnsIpAddresses :: Lens' WorkspaceDirectory (Maybe [Text])
- workspaceDirectory_workspaceAccessProperties :: Lens' WorkspaceDirectory (Maybe WorkspaceAccessProperties)
- workspaceDirectory_directoryName :: Lens' WorkspaceDirectory (Maybe Text)
- workspaceDirectory_selfservicePermissions :: Lens' WorkspaceDirectory (Maybe SelfservicePermissions)
- workspaceImage_state :: Lens' WorkspaceImage (Maybe WorkspaceImageState)
- workspaceImage_ownerAccountId :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_operatingSystem :: Lens' WorkspaceImage (Maybe OperatingSystem)
- workspaceImage_created :: Lens' WorkspaceImage (Maybe UTCTime)
- workspaceImage_requiredTenancy :: Lens' WorkspaceImage (Maybe WorkspaceImageRequiredTenancy)
- workspaceImage_name :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_updates :: Lens' WorkspaceImage (Maybe UpdateResult)
- workspaceImage_imageId :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_errorCode :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_errorMessage :: Lens' WorkspaceImage (Maybe Text)
- workspaceImage_description :: Lens' WorkspaceImage (Maybe Text)
- workspaceProperties_computeTypeName :: Lens' WorkspaceProperties (Maybe Compute)
- workspaceProperties_runningMode :: Lens' WorkspaceProperties (Maybe RunningMode)
- workspaceProperties_rootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)
- workspaceProperties_runningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int)
- workspaceProperties_userVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)
- workspaceRequest_workspaceProperties :: Lens' WorkspaceRequest (Maybe WorkspaceProperties)
- workspaceRequest_rootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- workspaceRequest_volumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text)
- workspaceRequest_userVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool)
- workspaceRequest_tags :: Lens' WorkspaceRequest (Maybe [Tag])
- workspaceRequest_directoryId :: Lens' WorkspaceRequest Text
- workspaceRequest_userName :: Lens' WorkspaceRequest Text
- workspaceRequest_bundleId :: Lens' WorkspaceRequest Text
- workspacesIpGroup_groupDesc :: Lens' WorkspacesIpGroup (Maybe Text)
- workspacesIpGroup_userRules :: Lens' WorkspacesIpGroup (Maybe [IpRuleItem])
- workspacesIpGroup_groupId :: Lens' WorkspacesIpGroup (Maybe Text)
- workspacesIpGroup_groupName :: Lens' WorkspacesIpGroup (Maybe Text)
Operations
AssociateConnectionAlias
associateConnectionAlias_aliasId :: Lens' AssociateConnectionAlias Text Source #
The identifier of the connection alias.
associateConnectionAlias_resourceId :: Lens' AssociateConnectionAlias Text Source #
The identifier of the directory to associate the connection alias with.
associateConnectionAliasResponse_connectionIdentifier :: Lens' AssociateConnectionAliasResponse (Maybe Text) Source #
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
associateConnectionAliasResponse_httpStatus :: Lens' AssociateConnectionAliasResponse Int Source #
The response's http status code.
DescribeAccount
describeAccountResponse_dedicatedTenancySupport :: Lens' DescribeAccountResponse (Maybe DedicatedTenancySupportResultEnum) Source #
The status of BYOL (whether BYOL is enabled or disabled).
describeAccountResponse_dedicatedTenancyManagementCidrRange :: Lens' DescribeAccountResponse (Maybe Text) Source #
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_httpStatus :: Lens' DescribeAccountResponse Int Source #
The response's http status code.
RevokeIpRules
revokeIpRules_groupId :: Lens' RevokeIpRules Text Source #
The identifier of the group.
revokeIpRules_userRules :: Lens' RevokeIpRules [Text] Source #
The rules to remove from the group.
revokeIpRulesResponse_httpStatus :: Lens' RevokeIpRulesResponse Int Source #
The response's http status code.
DescribeWorkspaceImages
describeWorkspaceImages_imageIds :: Lens' DescribeWorkspaceImages (Maybe (NonEmpty Text)) Source #
The identifier of the image.
describeWorkspaceImages_nextToken :: Lens' DescribeWorkspaceImages (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeWorkspaceImages_imageType :: Lens' DescribeWorkspaceImages (Maybe ImageType) Source #
The type (owned or shared) of the image.
describeWorkspaceImages_maxResults :: Lens' DescribeWorkspaceImages (Maybe Natural) Source #
The maximum number of items to return.
describeWorkspaceImagesResponse_images :: Lens' DescribeWorkspaceImagesResponse (Maybe [WorkspaceImage]) Source #
Information about the images.
describeWorkspaceImagesResponse_nextToken :: Lens' DescribeWorkspaceImagesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeWorkspaceImagesResponse_httpStatus :: Lens' DescribeWorkspaceImagesResponse Int Source #
The response's http status code.
ModifyWorkspaceProperties
modifyWorkspaceProperties_workspaceId :: Lens' ModifyWorkspaceProperties Text Source #
The identifier of the WorkSpace.
modifyWorkspaceProperties_workspaceProperties :: Lens' ModifyWorkspaceProperties WorkspaceProperties Source #
The properties of the WorkSpace.
modifyWorkspacePropertiesResponse_httpStatus :: Lens' ModifyWorkspacePropertiesResponse Int Source #
The response's http status code.
DeregisterWorkspaceDirectory
deregisterWorkspaceDirectory_directoryId :: Lens' DeregisterWorkspaceDirectory Text Source #
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.
deregisterWorkspaceDirectoryResponse_httpStatus :: Lens' DeregisterWorkspaceDirectoryResponse Int Source #
The response's http status code.
MigrateWorkspace
migrateWorkspace_sourceWorkspaceId :: Lens' MigrateWorkspace Text Source #
The identifier of the WorkSpace to migrate from.
migrateWorkspace_bundleId :: Lens' MigrateWorkspace Text Source #
The identifier of the target bundle type to migrate the WorkSpace to.
migrateWorkspaceResponse_sourceWorkspaceId :: Lens' MigrateWorkspaceResponse (Maybe Text) Source #
The original identifier of the WorkSpace that is being migrated.
migrateWorkspaceResponse_targetWorkspaceId :: Lens' MigrateWorkspaceResponse (Maybe Text) Source #
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.
migrateWorkspaceResponse_httpStatus :: Lens' MigrateWorkspaceResponse Int Source #
The response's http status code.
DescribeTags
describeTags_resourceId :: Lens' DescribeTags Text Source #
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
describeTagsResponse_tagList :: Lens' DescribeTagsResponse (Maybe [Tag]) Source #
The tags.
describeTagsResponse_httpStatus :: Lens' DescribeTagsResponse Int Source #
The response's http status code.
DescribeWorkspaceDirectories
describeWorkspaceDirectories_nextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeWorkspaceDirectories_directoryIds :: Lens' DescribeWorkspaceDirectories (Maybe (NonEmpty Text)) Source #
The identifiers of the directories. If the value is null, all directories are retrieved.
describeWorkspaceDirectories_limit :: Lens' DescribeWorkspaceDirectories (Maybe Natural) Source #
The maximum number of directories to return.
describeWorkspaceDirectoriesResponse_directories :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe [WorkspaceDirectory]) Source #
Information about the directories.
describeWorkspaceDirectoriesResponse_nextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeWorkspaceDirectoriesResponse_httpStatus :: Lens' DescribeWorkspaceDirectoriesResponse Int Source #
The response's http status code.
DisassociateIpGroups
disassociateIpGroups_directoryId :: Lens' DisassociateIpGroups Text Source #
The identifier of the directory.
disassociateIpGroups_groupIds :: Lens' DisassociateIpGroups [Text] Source #
The identifiers of one or more IP access control groups.
disassociateIpGroupsResponse_httpStatus :: Lens' DisassociateIpGroupsResponse Int Source #
The response's http status code.
DescribeWorkspaceBundles
describeWorkspaceBundles_bundleIds :: Lens' DescribeWorkspaceBundles (Maybe (NonEmpty Text)) Source #
The identifiers of the bundles. You cannot combine this parameter with any other filter.
describeWorkspaceBundles_owner :: Lens' DescribeWorkspaceBundles (Maybe Text) Source #
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.
describeWorkspaceBundles_nextToken :: Lens' DescribeWorkspaceBundles (Maybe Text) Source #
The token for the next set of results. (You received this token from a previous call.)
describeWorkspaceBundlesResponse_bundles :: Lens' DescribeWorkspaceBundlesResponse (Maybe [WorkspaceBundle]) Source #
Information about the bundles.
describeWorkspaceBundlesResponse_nextToken :: Lens' DescribeWorkspaceBundlesResponse (Maybe Text) Source #
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.
describeWorkspaceBundlesResponse_httpStatus :: Lens' DescribeWorkspaceBundlesResponse Int Source #
The response's http status code.
AuthorizeIpRules
authorizeIpRules_groupId :: Lens' AuthorizeIpRules Text Source #
The identifier of the group.
authorizeIpRules_userRules :: Lens' AuthorizeIpRules [IpRuleItem] Source #
The rules to add to the group.
authorizeIpRulesResponse_httpStatus :: Lens' AuthorizeIpRulesResponse Int Source #
The response's http status code.
DescribeWorkspaceImagePermissions
describeWorkspaceImagePermissions_nextToken :: Lens' DescribeWorkspaceImagePermissions (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeWorkspaceImagePermissions_maxResults :: Lens' DescribeWorkspaceImagePermissions (Maybe Natural) Source #
The maximum number of items to return.
describeWorkspaceImagePermissions_imageId :: Lens' DescribeWorkspaceImagePermissions Text Source #
The identifier of the image.
describeWorkspaceImagePermissionsResponse_imagePermissions :: Lens' DescribeWorkspaceImagePermissionsResponse (Maybe [ImagePermission]) Source #
The identifiers of the Amazon Web Services accounts that the image has been shared with.
describeWorkspaceImagePermissionsResponse_nextToken :: Lens' DescribeWorkspaceImagePermissionsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeWorkspaceImagePermissionsResponse_imageId :: Lens' DescribeWorkspaceImagePermissionsResponse (Maybe Text) Source #
The identifier of the image.
describeWorkspaceImagePermissionsResponse_httpStatus :: Lens' DescribeWorkspaceImagePermissionsResponse Int Source #
The response's http status code.
RebuildWorkspaces
rebuildWorkspaces_rebuildWorkspaceRequests :: Lens' RebuildWorkspaces (NonEmpty RebuildRequest) Source #
The WorkSpace to rebuild. You can specify a single WorkSpace.
rebuildWorkspacesResponse_failedRequests :: Lens' RebuildWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest]) Source #
Information about the WorkSpace that could not be rebuilt.
rebuildWorkspacesResponse_httpStatus :: Lens' RebuildWorkspacesResponse Int Source #
The response's http status code.
ImportWorkspaceImage
importWorkspaceImage_applications :: Lens' ImportWorkspaceImage (Maybe (NonEmpty Application)) Source #
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_tags :: Lens' ImportWorkspaceImage (Maybe [Tag]) Source #
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
importWorkspaceImage_ec2ImageId :: Lens' ImportWorkspaceImage Text Source #
The identifier of the EC2 image.
importWorkspaceImage_ingestionProcess :: Lens' ImportWorkspaceImage WorkspaceImageIngestionProcess Source #
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 or WorkSpaces Streaming Protocol (WSP). To use WSP, specify a
value that ends in _WSP. To use PCoIP, specify a value that does not
end in _WSP.
For non-GPU-enabled bundles (bundles other than Graphics or
GraphicsPro), specify BYOL_REGULAR or BYOL_REGULAR_WSP, depending on
the protocol.
importWorkspaceImage_imageName :: Lens' ImportWorkspaceImage Text Source #
The name of the WorkSpace image.
importWorkspaceImage_imageDescription :: Lens' ImportWorkspaceImage Text Source #
The description of the WorkSpace image.
importWorkspaceImageResponse_imageId :: Lens' ImportWorkspaceImageResponse (Maybe Text) Source #
The identifier of the WorkSpace image.
importWorkspaceImageResponse_httpStatus :: Lens' ImportWorkspaceImageResponse Int Source #
The response's http status code.
ModifyWorkspaceState
modifyWorkspaceState_workspaceId :: Lens' ModifyWorkspaceState Text Source #
The identifier of the WorkSpace.
modifyWorkspaceState_workspaceState :: Lens' ModifyWorkspaceState TargetWorkspaceState Source #
The WorkSpace state.
modifyWorkspaceStateResponse_httpStatus :: Lens' ModifyWorkspaceStateResponse Int Source #
The response's http status code.
CreateIpGroup
createIpGroup_groupDesc :: Lens' CreateIpGroup (Maybe Text) Source #
The description of the group.
createIpGroup_userRules :: Lens' CreateIpGroup (Maybe [IpRuleItem]) Source #
The rules to add to the group.
createIpGroup_tags :: Lens' CreateIpGroup (Maybe [Tag]) Source #
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
createIpGroup_groupName :: Lens' CreateIpGroup Text Source #
The name of the group.
createIpGroupResponse_groupId :: Lens' CreateIpGroupResponse (Maybe Text) Source #
The identifier of the group.
createIpGroupResponse_httpStatus :: Lens' CreateIpGroupResponse Int Source #
The response's http status code.
DisassociateConnectionAlias
disassociateConnectionAlias_aliasId :: Lens' DisassociateConnectionAlias Text Source #
The identifier of the connection alias to disassociate.
disassociateConnectionAliasResponse_httpStatus :: Lens' DisassociateConnectionAliasResponse Int Source #
The response's http status code.
ModifyWorkspaceCreationProperties
modifyWorkspaceCreationProperties_resourceId :: Lens' ModifyWorkspaceCreationProperties Text Source #
The identifier of the directory.
modifyWorkspaceCreationProperties_workspaceCreationProperties :: Lens' ModifyWorkspaceCreationProperties WorkspaceCreationProperties Source #
The default properties for creating WorkSpaces.
modifyWorkspaceCreationPropertiesResponse_httpStatus :: Lens' ModifyWorkspaceCreationPropertiesResponse Int Source #
The response's http status code.
RegisterWorkspaceDirectory
registerWorkspaceDirectory_subnetIds :: Lens' RegisterWorkspaceDirectory (Maybe [Text]) Source #
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_enableSelfService :: Lens' RegisterWorkspaceDirectory (Maybe Bool) Source #
Indicates whether self-service capabilities are enabled or disabled.
registerWorkspaceDirectory_tenancy :: Lens' RegisterWorkspaceDirectory (Maybe Tenancy) Source #
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_tags :: Lens' RegisterWorkspaceDirectory (Maybe [Tag]) Source #
The tags associated with the directory.
registerWorkspaceDirectory_directoryId :: Lens' RegisterWorkspaceDirectory Text Source #
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_enableWorkDocs :: Lens' RegisterWorkspaceDirectory Bool Source #
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.
registerWorkspaceDirectoryResponse_httpStatus :: Lens' RegisterWorkspaceDirectoryResponse Int Source #
The response's http status code.
RestoreWorkspace
restoreWorkspace_workspaceId :: Lens' RestoreWorkspace Text Source #
The identifier of the WorkSpace.
restoreWorkspaceResponse_httpStatus :: Lens' RestoreWorkspaceResponse Int Source #
The response's http status code.
DescribeConnectionAliasPermissions
describeConnectionAliasPermissions_nextToken :: Lens' DescribeConnectionAliasPermissions (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeConnectionAliasPermissions_maxResults :: Lens' DescribeConnectionAliasPermissions (Maybe Natural) Source #
The maximum number of results to return.
describeConnectionAliasPermissions_aliasId :: Lens' DescribeConnectionAliasPermissions Text Source #
The identifier of the connection alias.
describeConnectionAliasPermissionsResponse_aliasId :: Lens' DescribeConnectionAliasPermissionsResponse (Maybe Text) Source #
The identifier of the connection alias.
describeConnectionAliasPermissionsResponse_nextToken :: Lens' DescribeConnectionAliasPermissionsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeConnectionAliasPermissionsResponse_connectionAliasPermissions :: Lens' DescribeConnectionAliasPermissionsResponse (Maybe (NonEmpty ConnectionAliasPermission)) Source #
The permissions associated with a connection alias.
describeConnectionAliasPermissionsResponse_httpStatus :: Lens' DescribeConnectionAliasPermissionsResponse Int Source #
The response's http status code.
CreateTags
createTags_resourceId :: Lens' CreateTags Text Source #
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_tags :: Lens' CreateTags [Tag] Source #
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
createTagsResponse_httpStatus :: Lens' CreateTagsResponse Int Source #
The response's http status code.
CreateWorkspaceBundle
createWorkspaceBundle_rootStorage :: Lens' CreateWorkspaceBundle (Maybe RootStorage) Source #
Undocumented member.
createWorkspaceBundle_tags :: Lens' CreateWorkspaceBundle (Maybe [Tag]) Source #
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.
createWorkspaceBundle_bundleName :: Lens' CreateWorkspaceBundle Text Source #
The name of the bundle.
createWorkspaceBundle_bundleDescription :: Lens' CreateWorkspaceBundle Text Source #
The description of the bundle.
createWorkspaceBundle_imageId :: Lens' CreateWorkspaceBundle Text Source #
The identifier of the image that is used to create the bundle.
createWorkspaceBundle_computeType :: Lens' CreateWorkspaceBundle ComputeType Source #
Undocumented member.
createWorkspaceBundle_userStorage :: Lens' CreateWorkspaceBundle UserStorage Source #
Undocumented member.
createWorkspaceBundleResponse_workspaceBundle :: Lens' CreateWorkspaceBundleResponse (Maybe WorkspaceBundle) Source #
Undocumented member.
createWorkspaceBundleResponse_httpStatus :: Lens' CreateWorkspaceBundleResponse Int Source #
The response's http status code.
DeleteTags
deleteTags_resourceId :: Lens' DeleteTags Text Source #
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
deleteTags_tagKeys :: Lens' DeleteTags [Text] Source #
The tag keys.
deleteTagsResponse_httpStatus :: Lens' DeleteTagsResponse Int Source #
The response's http status code.
ModifyWorkspaceAccessProperties
modifyWorkspaceAccessProperties_resourceId :: Lens' ModifyWorkspaceAccessProperties Text Source #
The identifier of the directory.
modifyWorkspaceAccessProperties_workspaceAccessProperties :: Lens' ModifyWorkspaceAccessProperties WorkspaceAccessProperties Source #
The device types and operating systems to enable or disable for access.
modifyWorkspaceAccessPropertiesResponse_httpStatus :: Lens' ModifyWorkspaceAccessPropertiesResponse Int Source #
The response's http status code.
UpdateRulesOfIpGroup
updateRulesOfIpGroup_groupId :: Lens' UpdateRulesOfIpGroup Text Source #
The identifier of the group.
updateRulesOfIpGroup_userRules :: Lens' UpdateRulesOfIpGroup [IpRuleItem] Source #
One or more rules.
updateRulesOfIpGroupResponse_httpStatus :: Lens' UpdateRulesOfIpGroupResponse Int Source #
The response's http status code.
DeleteWorkspaceImage
deleteWorkspaceImage_imageId :: Lens' DeleteWorkspaceImage Text Source #
The identifier of the image.
deleteWorkspaceImageResponse_httpStatus :: Lens' DeleteWorkspaceImageResponse Int Source #
The response's http status code.
StopWorkspaces
stopWorkspaces_stopWorkspaceRequests :: Lens' StopWorkspaces (NonEmpty StopRequest) Source #
The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
stopWorkspacesResponse_failedRequests :: Lens' StopWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest]) Source #
Information about the WorkSpaces that could not be stopped.
stopWorkspacesResponse_httpStatus :: Lens' StopWorkspacesResponse Int Source #
The response's http status code.
AssociateIpGroups
associateIpGroups_directoryId :: Lens' AssociateIpGroups Text Source #
The identifier of the directory.
associateIpGroups_groupIds :: Lens' AssociateIpGroups [Text] Source #
The identifiers of one or more IP access control groups.
associateIpGroupsResponse_httpStatus :: Lens' AssociateIpGroupsResponse Int Source #
The response's http status code.
ModifySelfservicePermissions
modifySelfservicePermissions_resourceId :: Lens' ModifySelfservicePermissions Text Source #
The identifier of the directory.
modifySelfservicePermissions_selfservicePermissions :: Lens' ModifySelfservicePermissions SelfservicePermissions Source #
The permissions to enable or disable self-service capabilities.
modifySelfservicePermissionsResponse_httpStatus :: Lens' ModifySelfservicePermissionsResponse Int Source #
The response's http status code.
DeleteConnectionAlias
deleteConnectionAlias_aliasId :: Lens' DeleteConnectionAlias Text Source #
The identifier of the connection alias to delete.
deleteConnectionAliasResponse_httpStatus :: Lens' DeleteConnectionAliasResponse Int Source #
The response's http status code.
DescribeWorkspacesConnectionStatus
describeWorkspacesConnectionStatus_workspaceIds :: Lens' DescribeWorkspacesConnectionStatus (Maybe (NonEmpty Text)) Source #
The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
describeWorkspacesConnectionStatus_nextToken :: Lens' DescribeWorkspacesConnectionStatus (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeWorkspacesConnectionStatusResponse_nextToken :: Lens' DescribeWorkspacesConnectionStatusResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeWorkspacesConnectionStatusResponse_workspacesConnectionStatus :: Lens' DescribeWorkspacesConnectionStatusResponse (Maybe [WorkspaceConnectionStatus]) Source #
Information about the connection status of the WorkSpace.
describeWorkspacesConnectionStatusResponse_httpStatus :: Lens' DescribeWorkspacesConnectionStatusResponse Int Source #
The response's http status code.
CreateConnectionAlias
createConnectionAlias_tags :: Lens' CreateConnectionAlias (Maybe [Tag]) Source #
The tags to associate with the connection alias.
createConnectionAlias_connectionString :: Lens' CreateConnectionAlias Text Source #
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.
createConnectionAliasResponse_aliasId :: Lens' CreateConnectionAliasResponse (Maybe Text) Source #
The identifier of the connection alias.
createConnectionAliasResponse_httpStatus :: Lens' CreateConnectionAliasResponse Int Source #
The response's http status code.
RebootWorkspaces
rebootWorkspaces_rebootWorkspaceRequests :: Lens' RebootWorkspaces (NonEmpty RebootRequest) Source #
The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
rebootWorkspacesResponse_failedRequests :: Lens' RebootWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest]) Source #
Information about the WorkSpaces that could not be rebooted.
rebootWorkspacesResponse_httpStatus :: Lens' RebootWorkspacesResponse Int Source #
The response's http status code.
DeleteIpGroup
deleteIpGroup_groupId :: Lens' DeleteIpGroup Text Source #
The identifier of the IP access control group.
deleteIpGroupResponse_httpStatus :: Lens' DeleteIpGroupResponse Int Source #
The response's http status code.
CopyWorkspaceImage
copyWorkspaceImage_description :: Lens' CopyWorkspaceImage (Maybe Text) Source #
A description of the image.
copyWorkspaceImage_tags :: Lens' CopyWorkspaceImage (Maybe [Tag]) Source #
The tags for the image.
copyWorkspaceImage_name :: Lens' CopyWorkspaceImage Text Source #
The name of the image.
copyWorkspaceImage_sourceImageId :: Lens' CopyWorkspaceImage Text Source #
The identifier of the source image.
copyWorkspaceImage_sourceRegion :: Lens' CopyWorkspaceImage Text Source #
The identifier of the source Region.
copyWorkspaceImageResponse_imageId :: Lens' CopyWorkspaceImageResponse (Maybe Text) Source #
The identifier of the image.
copyWorkspaceImageResponse_httpStatus :: Lens' CopyWorkspaceImageResponse Int Source #
The response's http status code.
DescribeWorkspaceSnapshots
describeWorkspaceSnapshots_workspaceId :: Lens' DescribeWorkspaceSnapshots Text Source #
The identifier of the WorkSpace.
describeWorkspaceSnapshotsResponse_restoreSnapshots :: Lens' DescribeWorkspaceSnapshotsResponse (Maybe [Snapshot]) Source #
Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
describeWorkspaceSnapshotsResponse_rebuildSnapshots :: Lens' DescribeWorkspaceSnapshotsResponse (Maybe [Snapshot]) Source #
Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
describeWorkspaceSnapshotsResponse_httpStatus :: Lens' DescribeWorkspaceSnapshotsResponse Int Source #
The response's http status code.
TerminateWorkspaces
terminateWorkspaces_terminateWorkspaceRequests :: Lens' TerminateWorkspaces (NonEmpty TerminateRequest) Source #
The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
terminateWorkspacesResponse_failedRequests :: Lens' TerminateWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest]) Source #
Information about the WorkSpaces that could not be terminated.
terminateWorkspacesResponse_httpStatus :: Lens' TerminateWorkspacesResponse Int Source #
The response's http status code.
UpdateConnectionAliasPermission
updateConnectionAliasPermission_aliasId :: Lens' UpdateConnectionAliasPermission Text Source #
The identifier of the connection alias that you want to update permissions for.
updateConnectionAliasPermission_connectionAliasPermission :: Lens' UpdateConnectionAliasPermission ConnectionAliasPermission Source #
Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
updateConnectionAliasPermissionResponse_httpStatus :: Lens' UpdateConnectionAliasPermissionResponse Int Source #
The response's http status code.
CreateWorkspaces
createWorkspaces_workspaces :: Lens' CreateWorkspaces (NonEmpty WorkspaceRequest) Source #
The WorkSpaces to create. You can specify up to 25 WorkSpaces.
createWorkspacesResponse_failedRequests :: Lens' CreateWorkspacesResponse (Maybe [FailedCreateWorkspaceRequest]) Source #
Information about the WorkSpaces that could not be created.
createWorkspacesResponse_pendingRequests :: Lens' CreateWorkspacesResponse (Maybe [Workspace]) Source #
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.
createWorkspacesResponse_httpStatus :: Lens' CreateWorkspacesResponse Int Source #
The response's http status code.
DescribeClientProperties
describeClientProperties_resourceIds :: Lens' DescribeClientProperties (NonEmpty Text) Source #
The resource identifier, in the form of directory IDs.
describeClientPropertiesResponse_clientPropertiesList :: Lens' DescribeClientPropertiesResponse (Maybe [ClientPropertiesResult]) Source #
Information about the specified Amazon WorkSpaces clients.
describeClientPropertiesResponse_httpStatus :: Lens' DescribeClientPropertiesResponse Int Source #
The response's http status code.
ModifyClientProperties
modifyClientProperties_resourceId :: Lens' ModifyClientProperties Text Source #
The resource identifiers, in the form of directory IDs.
modifyClientProperties_clientProperties :: Lens' ModifyClientProperties ClientProperties Source #
Information about the Amazon WorkSpaces client.
modifyClientPropertiesResponse_httpStatus :: Lens' ModifyClientPropertiesResponse Int Source #
The response's http status code.
DescribeIpGroups
describeIpGroups_groupIds :: Lens' DescribeIpGroups (Maybe [Text]) Source #
The identifiers of one or more IP access control groups.
describeIpGroups_nextToken :: Lens' DescribeIpGroups (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeIpGroups_maxResults :: Lens' DescribeIpGroups (Maybe Natural) Source #
The maximum number of items to return.
describeIpGroupsResponse_result :: Lens' DescribeIpGroupsResponse (Maybe [WorkspacesIpGroup]) Source #
Information about the IP access control groups.
describeIpGroupsResponse_nextToken :: Lens' DescribeIpGroupsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeIpGroupsResponse_httpStatus :: Lens' DescribeIpGroupsResponse Int Source #
The response's http status code.
DeleteWorkspaceBundle
deleteWorkspaceBundle_bundleId :: Lens' DeleteWorkspaceBundle (Maybe Text) Source #
The identifier of the bundle.
deleteWorkspaceBundleResponse_httpStatus :: Lens' DeleteWorkspaceBundleResponse Int Source #
The response's http status code.
UpdateWorkspaceBundle
updateWorkspaceBundle_bundleId :: Lens' UpdateWorkspaceBundle (Maybe Text) Source #
The identifier of the bundle.
updateWorkspaceBundle_imageId :: Lens' UpdateWorkspaceBundle (Maybe Text) Source #
The identifier of the image.
updateWorkspaceBundleResponse_httpStatus :: Lens' UpdateWorkspaceBundleResponse Int Source #
The response's http status code.
ListAvailableManagementCidrRanges
listAvailableManagementCidrRanges_nextToken :: Lens' ListAvailableManagementCidrRanges (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
listAvailableManagementCidrRanges_maxResults :: Lens' ListAvailableManagementCidrRanges (Maybe Natural) Source #
The maximum number of items to return.
listAvailableManagementCidrRanges_managementCidrRangeConstraint :: Lens' ListAvailableManagementCidrRanges Text Source #
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).
listAvailableManagementCidrRangesResponse_managementCidrRanges :: Lens' ListAvailableManagementCidrRangesResponse (Maybe [Text]) Source #
The list of available IP address ranges, specified as IPv4 CIDR blocks.
listAvailableManagementCidrRangesResponse_nextToken :: Lens' ListAvailableManagementCidrRangesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
listAvailableManagementCidrRangesResponse_httpStatus :: Lens' ListAvailableManagementCidrRangesResponse Int Source #
The response's http status code.
UpdateWorkspaceImagePermission
updateWorkspaceImagePermission_imageId :: Lens' UpdateWorkspaceImagePermission Text Source #
The identifier of the image.
updateWorkspaceImagePermission_allowCopyImage :: Lens' UpdateWorkspaceImagePermission Bool Source #
The permission to copy the image. This permission can be revoked only after an image has been shared.
updateWorkspaceImagePermission_sharedAccountId :: Lens' UpdateWorkspaceImagePermission Text Source #
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.
updateWorkspaceImagePermissionResponse_httpStatus :: Lens' UpdateWorkspaceImagePermissionResponse Int Source #
The response's http status code.
CreateUpdatedWorkspaceImage
createUpdatedWorkspaceImage_tags :: Lens' CreateUpdatedWorkspaceImage (Maybe [Tag]) Source #
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_name :: Lens' CreateUpdatedWorkspaceImage Text Source #
The name of the new updated WorkSpace image.
createUpdatedWorkspaceImage_description :: Lens' CreateUpdatedWorkspaceImage Text Source #
A description of whether updates for the WorkSpace image are available.
createUpdatedWorkspaceImage_sourceImageId :: Lens' CreateUpdatedWorkspaceImage Text Source #
The identifier of the source WorkSpace image.
createUpdatedWorkspaceImageResponse_imageId :: Lens' CreateUpdatedWorkspaceImageResponse (Maybe Text) Source #
The identifier of the new updated WorkSpace image.
createUpdatedWorkspaceImageResponse_httpStatus :: Lens' CreateUpdatedWorkspaceImageResponse Int Source #
The response's http status code.
DescribeWorkspaces
describeWorkspaces_directoryId :: Lens' DescribeWorkspaces (Maybe Text) Source #
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.
describeWorkspaces_workspaceIds :: Lens' DescribeWorkspaces (Maybe (NonEmpty Text)) Source #
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.
describeWorkspaces_userName :: Lens' DescribeWorkspaces (Maybe Text) Source #
The name of the directory user. You must specify this parameter with
DirectoryId.
describeWorkspaces_bundleId :: Lens' DescribeWorkspaces (Maybe Text) Source #
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_nextToken :: Lens' DescribeWorkspaces (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeWorkspaces_limit :: Lens' DescribeWorkspaces (Maybe Natural) Source #
The maximum number of items to return.
describeWorkspacesResponse_nextToken :: Lens' DescribeWorkspacesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeWorkspacesResponse_workspaces :: Lens' DescribeWorkspacesResponse (Maybe [Workspace]) Source #
Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
describeWorkspacesResponse_httpStatus :: Lens' DescribeWorkspacesResponse Int Source #
The response's http status code.
DescribeConnectionAliases
describeConnectionAliases_resourceId :: Lens' DescribeConnectionAliases (Maybe Text) Source #
The identifier of the directory associated with the connection alias.
describeConnectionAliases_aliasIds :: Lens' DescribeConnectionAliases (Maybe (NonEmpty Text)) Source #
The identifiers of the connection aliases to describe.
describeConnectionAliases_nextToken :: Lens' DescribeConnectionAliases (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeConnectionAliases_limit :: Lens' DescribeConnectionAliases (Maybe Natural) Source #
The maximum number of connection aliases to return.
describeConnectionAliasesResponse_connectionAliases :: Lens' DescribeConnectionAliasesResponse (Maybe (NonEmpty ConnectionAlias)) Source #
Information about the specified connection aliases.
describeConnectionAliasesResponse_nextToken :: Lens' DescribeConnectionAliasesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeConnectionAliasesResponse_httpStatus :: Lens' DescribeConnectionAliasesResponse Int Source #
The response's http status code.
StartWorkspaces
startWorkspaces_startWorkspaceRequests :: Lens' StartWorkspaces (NonEmpty StartRequest) Source #
The WorkSpaces to start. You can specify up to 25 WorkSpaces.
startWorkspacesResponse_failedRequests :: Lens' StartWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest]) Source #
Information about the WorkSpaces that could not be started.
startWorkspacesResponse_httpStatus :: Lens' StartWorkspacesResponse Int Source #
The response's http status code.
DescribeAccountModifications
describeAccountModifications_nextToken :: Lens' DescribeAccountModifications (Maybe Text) Source #
If you received a NextToken from a previous call that was paginated,
provide this token to receive the next set of results.
describeAccountModificationsResponse_accountModifications :: Lens' DescribeAccountModificationsResponse (Maybe [AccountModification]) Source #
The list of modifications to the configuration of BYOL.
describeAccountModificationsResponse_nextToken :: Lens' DescribeAccountModificationsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describeAccountModificationsResponse_httpStatus :: Lens' DescribeAccountModificationsResponse Int Source #
The response's http status code.
ModifyAccount
modifyAccount_dedicatedTenancySupport :: Lens' ModifyAccount (Maybe DedicatedTenancySupportEnum) Source #
The status of BYOL.
modifyAccount_dedicatedTenancyManagementCidrRange :: Lens' ModifyAccount (Maybe Text) Source #
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.
modifyAccountResponse_httpStatus :: Lens' ModifyAccountResponse Int Source #
The response's http status code.
Types
AccountModification
accountModification_startTime :: Lens' AccountModification (Maybe UTCTime) Source #
The timestamp when the modification of the BYOL configuration was started.
accountModification_dedicatedTenancySupport :: Lens' AccountModification (Maybe DedicatedTenancySupportResultEnum) Source #
The status of BYOL (whether BYOL is being enabled or disabled).
accountModification_modificationState :: Lens' AccountModification (Maybe DedicatedTenancyModificationStateEnum) Source #
The state of the modification to the configuration of BYOL.
accountModification_dedicatedTenancyManagementCidrRange :: Lens' AccountModification (Maybe Text) Source #
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
accountModification_errorCode :: Lens' AccountModification (Maybe Text) Source #
The error code that is returned if the configuration of BYOL cannot be modified.
accountModification_errorMessage :: Lens' AccountModification (Maybe Text) Source #
The text of the error message that is returned if the configuration of BYOL cannot be modified.
ClientProperties
clientProperties_reconnectEnabled :: Lens' ClientProperties (Maybe ReconnectEnum) Source #
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
ClientPropertiesResult
clientPropertiesResult_resourceId :: Lens' ClientPropertiesResult (Maybe Text) Source #
The resource identifier, in the form of a directory ID.
clientPropertiesResult_clientProperties :: Lens' ClientPropertiesResult (Maybe ClientProperties) Source #
Information about the Amazon WorkSpaces client.
ComputeType
computeType_name :: Lens' ComputeType (Maybe Compute) Source #
The compute type.
ConnectionAlias
connectionAlias_state :: Lens' ConnectionAlias (Maybe ConnectionAliasState) Source #
The current state of the connection alias.
connectionAlias_ownerAccountId :: Lens' ConnectionAlias (Maybe Text) Source #
The identifier of the Amazon Web Services account that owns the connection alias.
connectionAlias_aliasId :: Lens' ConnectionAlias (Maybe Text) Source #
The identifier of the connection alias.
connectionAlias_associations :: Lens' ConnectionAlias (Maybe (NonEmpty ConnectionAliasAssociation)) Source #
The association status of the connection alias.
connectionAlias_connectionString :: Lens' ConnectionAlias (Maybe Text) Source #
The connection string specified for the connection alias. The connection
string must be in the form of a fully qualified domain name (FQDN), such
as www.example.com.
ConnectionAliasAssociation
connectionAliasAssociation_associatedAccountId :: Lens' ConnectionAliasAssociation (Maybe Text) Source #
The identifier of the Amazon Web Services account that associated the connection alias with a directory.
connectionAliasAssociation_resourceId :: Lens' ConnectionAliasAssociation (Maybe Text) Source #
The identifier of the directory associated with a connection alias.
connectionAliasAssociation_associationStatus :: Lens' ConnectionAliasAssociation (Maybe AssociationStatus) Source #
The association status of the connection alias.
connectionAliasAssociation_connectionIdentifier :: Lens' ConnectionAliasAssociation (Maybe Text) Source #
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
ConnectionAliasPermission
connectionAliasPermission_sharedAccountId :: Lens' ConnectionAliasPermission Text Source #
The identifier of the Amazon Web Services account that the connection alias is shared with.
connectionAliasPermission_allowAssociation :: Lens' ConnectionAliasPermission Bool Source #
Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
DefaultWorkspaceCreationProperties
defaultWorkspaceCreationProperties_customSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
defaultWorkspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether WorkSpace users are local administrators on their WorkSpaces.
defaultWorkspaceCreationProperties_enableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether the directory is enabled for Amazon WorkDocs.
defaultWorkspaceCreationProperties_enableMaintenanceMode :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
defaultWorkspaceCreationProperties_enableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #
Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
defaultWorkspaceCreationProperties_defaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
FailedCreateWorkspaceRequest
failedCreateWorkspaceRequest_workspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest) Source #
Information about the WorkSpace.
failedCreateWorkspaceRequest_errorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #
The error code that is returned if the WorkSpace cannot be created.
failedCreateWorkspaceRequest_errorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #
The text of the error message that is returned if the WorkSpace cannot be created.
FailedWorkspaceChangeRequest
failedWorkspaceChangeRequest_errorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #
The error code that is returned if the WorkSpace cannot be rebooted.
failedWorkspaceChangeRequest_workspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #
The identifier of the WorkSpace.
failedWorkspaceChangeRequest_errorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #
The text of the error message that is returned if the WorkSpace cannot be rebooted.
ImagePermission
imagePermission_sharedAccountId :: Lens' ImagePermission (Maybe Text) Source #
The identifier of the Amazon Web Services account that an image has been shared with.
IpRuleItem
ipRuleItem_ruleDesc :: Lens' IpRuleItem (Maybe Text) Source #
The description.
ipRuleItem_ipRule :: Lens' IpRuleItem (Maybe Text) Source #
The IP address range, in CIDR notation.
ModificationState
modificationState_state :: Lens' ModificationState (Maybe ModificationStateEnum) Source #
The modification state.
modificationState_resource :: Lens' ModificationState (Maybe ModificationResourceEnum) Source #
The resource.
OperatingSystem
operatingSystem_type :: Lens' OperatingSystem (Maybe OperatingSystemType) Source #
The operating system.
RebootRequest
rebootRequest_workspaceId :: Lens' RebootRequest Text Source #
The identifier of the WorkSpace.
RebuildRequest
rebuildRequest_workspaceId :: Lens' RebuildRequest Text Source #
The identifier of the WorkSpace.
RootStorage
rootStorage_capacity :: Lens' RootStorage (Maybe Text) Source #
The size of the root volume.
SelfservicePermissions
selfservicePermissions_restartWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can restart their WorkSpace.
selfservicePermissions_changeComputeType :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can change the compute type (bundle) for their WorkSpace.
selfservicePermissions_switchRunningMode :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can switch the running mode of their WorkSpace.
selfservicePermissions_rebuildWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
selfservicePermissions_increaseVolumeSize :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #
Specifies whether users can increase the volume size of the drives on their WorkSpace.
Snapshot
snapshot_snapshotTime :: Lens' Snapshot (Maybe UTCTime) Source #
The time when the snapshot was created.
StartRequest
startRequest_workspaceId :: Lens' StartRequest (Maybe Text) Source #
The identifier of the WorkSpace.
StopRequest
stopRequest_workspaceId :: Lens' StopRequest (Maybe Text) Source #
The identifier of the WorkSpace.
Tag
TerminateRequest
terminateRequest_workspaceId :: Lens' TerminateRequest Text Source #
The identifier of the WorkSpace.
UpdateResult
updateResult_updateAvailable :: Lens' UpdateResult (Maybe Bool) Source #
Indicates whether updated drivers or other components are available for the specified WorkSpace image.
updateResult_description :: Lens' UpdateResult (Maybe Text) Source #
A description of whether updates for the WorkSpace image are pending or available.
UserStorage
userStorage_capacity :: Lens' UserStorage (Maybe Text) Source #
The size of the user volume.
Workspace
workspace_directoryId :: Lens' Workspace (Maybe Text) Source #
The identifier of the Directory Service directory for the WorkSpace.
workspace_state :: Lens' Workspace (Maybe WorkspaceState) Source #
The operational state of the WorkSpace.
After a WorkSpace is terminated, the TERMINATED state is returned only
briefly before the WorkSpace directory metadata is cleaned up, so this
state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using
DescribeWorkSpaces.
If the WorkSpace ID isn't returned, then the WorkSpace has been
successfully terminated.
workspace_modificationStates :: Lens' Workspace (Maybe [ModificationState]) Source #
The modification states of the WorkSpace.
workspace_subnetId :: Lens' Workspace (Maybe Text) Source #
The identifier of the subnet for the WorkSpace.
workspace_bundleId :: Lens' Workspace (Maybe Text) Source #
The identifier of the bundle used to create the WorkSpace.
workspace_workspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties) Source #
The properties of the WorkSpace.
workspace_rootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #
Indicates whether the data stored on the root volume is encrypted.
workspace_errorCode :: Lens' Workspace (Maybe Text) Source #
The error code that is returned if the WorkSpace cannot be created.
workspace_volumeEncryptionKey :: Lens' Workspace (Maybe Text) Source #
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspace_computerName :: Lens' Workspace (Maybe Text) Source #
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
workspace_userVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #
Indicates whether the data stored on the user volume is encrypted.
workspace_errorMessage :: Lens' Workspace (Maybe Text) Source #
The text of the error message that is returned if the WorkSpace cannot be created.
WorkspaceAccessProperties
workspaceAccessProperties_deviceTypeWindows :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Windows clients to access their WorkSpaces.
workspaceAccessProperties_deviceTypeWeb :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can access their WorkSpaces through a web browser.
workspaceAccessProperties_deviceTypeAndroid :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
workspaceAccessProperties_deviceTypeLinux :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Linux clients to access their WorkSpaces.
workspaceAccessProperties_deviceTypeOsx :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use macOS clients to access their WorkSpaces.
workspaceAccessProperties_deviceTypeChromeOs :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use Chromebooks to access their WorkSpaces.
workspaceAccessProperties_deviceTypeIos :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use iOS devices to access their WorkSpaces.
workspaceAccessProperties_deviceTypeZeroClient :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #
Indicates whether users can use zero client devices to access their WorkSpaces.
WorkspaceBundle
workspaceBundle_creationTime :: Lens' WorkspaceBundle (Maybe UTCTime) Source #
The time when the bundle was created.
workspaceBundle_lastUpdatedTime :: Lens' WorkspaceBundle (Maybe UTCTime) Source #
The last time that the bundle was updated.
workspaceBundle_bundleId :: Lens' WorkspaceBundle (Maybe Text) Source #
The identifier of the bundle.
workspaceBundle_owner :: Lens' WorkspaceBundle (Maybe Text) Source #
The owner of the bundle. This is the account identifier of the owner, or
AMAZON if the bundle is provided by Amazon Web Services.
workspaceBundle_rootStorage :: Lens' WorkspaceBundle (Maybe RootStorage) Source #
The size of the root volume.
workspaceBundle_name :: Lens' WorkspaceBundle (Maybe Text) Source #
The name of the bundle.
workspaceBundle_imageId :: Lens' WorkspaceBundle (Maybe Text) Source #
The identifier of the image that was used to create the bundle.
workspaceBundle_computeType :: Lens' WorkspaceBundle (Maybe ComputeType) Source #
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
workspaceBundle_userStorage :: Lens' WorkspaceBundle (Maybe UserStorage) Source #
The size of the user volume.
workspaceBundle_description :: Lens' WorkspaceBundle (Maybe Text) Source #
The description of the bundle.
WorkspaceConnectionStatus
workspaceConnectionStatus_lastKnownUserConnectionTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #
The timestamp of the last known user connection.
workspaceConnectionStatus_connectionStateCheckTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #
The timestamp of the connection status check.
workspaceConnectionStatus_workspaceId :: Lens' WorkspaceConnectionStatus (Maybe Text) Source #
The identifier of the WorkSpace.
workspaceConnectionStatus_connectionState :: Lens' WorkspaceConnectionStatus (Maybe ConnectionState) Source #
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
WorkspaceCreationProperties
workspaceCreationProperties_customSecurityGroupId :: Lens' WorkspaceCreationProperties (Maybe Text) Source #
The identifier of your custom security group.
workspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether users are local administrators of their WorkSpaces.
workspaceCreationProperties_enableWorkDocs :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
workspaceCreationProperties_enableMaintenanceMode :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
workspaceCreationProperties_enableInternetAccess :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #
Indicates whether internet access is enabled for your WorkSpaces.
workspaceCreationProperties_defaultOu :: Lens' WorkspaceCreationProperties (Maybe Text) Source #
The default organizational unit (OU) for your WorkSpaces directories.
This string must be the full Lightweight Directory Access Protocol
(LDAP) distinguished name for the target domain and OU. It must be in
the form "OU=value,DC=value,DC=value", where value is any string
of characters, and the number of domain components (DCs) is two or more.
For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
- To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
- The API doesn't validate whether the OU exists.
WorkspaceDirectory
workspaceDirectory_registrationCode :: Lens' WorkspaceDirectory (Maybe Text) Source #
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
workspaceDirectory_iamRoleId :: Lens' WorkspaceDirectory (Maybe Text) Source #
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
workspaceDirectory_directoryId :: Lens' WorkspaceDirectory (Maybe Text) Source #
The directory identifier.
workspaceDirectory_state :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState) Source #
The state of the directory's registration with Amazon WorkSpaces. After
a directory is deregistered, the DEREGISTERED state is returned very
briefly before the directory metadata is cleaned up, so this state is
rarely returned. To confirm that a directory is deregistered, check for
the directory ID by using
DescribeWorkspaceDirectories.
If the directory ID isn't returned, then the directory has been
successfully deregistered.
workspaceDirectory_customerUserName :: Lens' WorkspaceDirectory (Maybe Text) Source #
The user name for the service account.
workspaceDirectory_subnetIds :: Lens' WorkspaceDirectory (Maybe [Text]) Source #
The identifiers of the subnets used with the directory.
workspaceDirectory_ipGroupIds :: Lens' WorkspaceDirectory (Maybe [Text]) Source #
The identifiers of the IP access control groups associated with the directory.
workspaceDirectory_alias :: Lens' WorkspaceDirectory (Maybe Text) Source #
The directory alias.
workspaceDirectory_workspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text) Source #
The identifier of the security group that is assigned to new WorkSpaces.
workspaceDirectory_directoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType) Source #
The directory type.
workspaceDirectory_tenancy :: Lens' WorkspaceDirectory (Maybe Tenancy) Source #
Specifies whether the directory is dedicated or shared. To use Bring
Your Own License (BYOL), this value must be set to DEDICATED. For more
information, see
Bring Your Own Windows Desktop Images.
workspaceDirectory_workspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties) Source #
The default creation properties for all WorkSpaces in the directory.
workspaceDirectory_dnsIpAddresses :: Lens' WorkspaceDirectory (Maybe [Text]) Source #
The IP addresses of the DNS servers for the directory.
workspaceDirectory_workspaceAccessProperties :: Lens' WorkspaceDirectory (Maybe WorkspaceAccessProperties) Source #
The devices and operating systems that users can use to access WorkSpaces.
workspaceDirectory_directoryName :: Lens' WorkspaceDirectory (Maybe Text) Source #
The name of the directory.
workspaceDirectory_selfservicePermissions :: Lens' WorkspaceDirectory (Maybe SelfservicePermissions) Source #
The default self-service permissions for WorkSpaces in the directory.
WorkspaceImage
workspaceImage_state :: Lens' WorkspaceImage (Maybe WorkspaceImageState) Source #
The status of the image.
workspaceImage_ownerAccountId :: Lens' WorkspaceImage (Maybe Text) Source #
The identifier of the Amazon Web Services account that owns the image.
workspaceImage_operatingSystem :: Lens' WorkspaceImage (Maybe OperatingSystem) Source #
The operating system that the image is running.
workspaceImage_created :: Lens' WorkspaceImage (Maybe UTCTime) Source #
The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
workspaceImage_requiredTenancy :: Lens' WorkspaceImage (Maybe WorkspaceImageRequiredTenancy) Source #
Specifies whether the image is running on dedicated hardware. When Bring
Your Own License (BYOL) is enabled, this value is set to DEDICATED.
For more information, see
Bring Your Own Windows Desktop Images.
workspaceImage_name :: Lens' WorkspaceImage (Maybe Text) Source #
The name of the image.
workspaceImage_updates :: Lens' WorkspaceImage (Maybe UpdateResult) Source #
The updates (if any) that are available for the specified image.
workspaceImage_imageId :: Lens' WorkspaceImage (Maybe Text) Source #
The identifier of the image.
workspaceImage_errorCode :: Lens' WorkspaceImage (Maybe Text) Source #
The error code that is returned for the image.
workspaceImage_errorMessage :: Lens' WorkspaceImage (Maybe Text) Source #
The text of the error message that is returned for the image.
workspaceImage_description :: Lens' WorkspaceImage (Maybe Text) Source #
The description of the image.
WorkspaceProperties
workspaceProperties_computeTypeName :: Lens' WorkspaceProperties (Maybe Compute) Source #
The compute type. For more information, see Amazon WorkSpaces Bundles.
workspaceProperties_runningMode :: Lens' WorkspaceProperties (Maybe RunningMode) Source #
The running mode. For more information, see Manage the WorkSpace Running Mode.
workspaceProperties_rootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
workspaceProperties_runningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int) Source #
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
workspaceProperties_userVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
WorkspaceRequest
workspaceRequest_workspaceProperties :: Lens' WorkspaceRequest (Maybe WorkspaceProperties) Source #
The WorkSpace properties.
workspaceRequest_rootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source #
Indicates whether the data stored on the root volume is encrypted.
workspaceRequest_volumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text) Source #
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceRequest_userVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source #
Indicates whether the data stored on the user volume is encrypted.
workspaceRequest_tags :: Lens' WorkspaceRequest (Maybe [Tag]) Source #
The tags for the WorkSpace.
workspaceRequest_directoryId :: Lens' WorkspaceRequest Text Source #
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
workspaceRequest_userName :: Lens' WorkspaceRequest Text Source #
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
workspaceRequest_bundleId :: Lens' WorkspaceRequest Text Source #
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
WorkspacesIpGroup
workspacesIpGroup_groupDesc :: Lens' WorkspacesIpGroup (Maybe Text) Source #
The description of the group.
workspacesIpGroup_userRules :: Lens' WorkspacesIpGroup (Maybe [IpRuleItem]) Source #
The rules.
workspacesIpGroup_groupId :: Lens' WorkspacesIpGroup (Maybe Text) Source #
The identifier of the group.
workspacesIpGroup_groupName :: Lens' WorkspacesIpGroup (Maybe Text) Source #
The name of the group.