Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkSpaces.Lens

Contents

Operations
Types

Description

Synopsis

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.

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.

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.

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.

CreateConnectClientAddIn

createConnectClientAddIn_resourceId :: Lens' CreateConnectClientAddIn Text Source #

The directory identifier for which to configure the client add-in.

createConnectClientAddIn_name :: Lens' CreateConnectClientAddIn Text Source #

The name of the client add-in.

createConnectClientAddIn_url :: Lens' CreateConnectClientAddIn Text Source #

The endpoint URL of the Amazon Connect client add-in.

createConnectClientAddInResponse_addInId :: Lens' CreateConnectClientAddInResponse (Maybe Text) Source #

The client add-in identifier.

createConnectClientAddInResponse_httpStatus :: Lens' CreateConnectClientAddInResponse 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.

CreateIpGroup

createIpGroup_groupDesc :: Lens' CreateIpGroup (Maybe Text) Source #

The description of the group.

createIpGroup_tags :: Lens' CreateIpGroup (Maybe [Tag]) Source #

The tags. Each WorkSpaces resource can have a maximum of 50 tags.

createIpGroup_userRules :: Lens' CreateIpGroup (Maybe [IpRuleItem]) Source #

The rules to add to the group.

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.

CreateStandbyWorkspaces

createStandbyWorkspaces_primaryRegion :: Lens' CreateStandbyWorkspaces Text Source #

The Region of the primary WorkSpace.

createStandbyWorkspaces_standbyWorkspaces :: Lens' CreateStandbyWorkspaces [StandbyWorkspace] Source #

Information about the Standby WorkSpace to be created.

createStandbyWorkspacesResponse_failedStandbyRequests :: Lens' CreateStandbyWorkspacesResponse (Maybe [FailedCreateStandbyWorkspacesRequest]) Source #

Information about the Standby WorkSpace that could not be created.

createStandbyWorkspacesResponse_pendingStandbyRequests :: Lens' CreateStandbyWorkspacesResponse (Maybe [PendingCreateStandbyWorkspacesRequest]) Source #

Information about the Standby WorkSpace that was created.

createStandbyWorkspacesResponse_httpStatus :: Lens' CreateStandbyWorkspacesResponse 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.

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.

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.

CreateWorkspaceImage

createWorkspaceImage_tags :: Lens' CreateWorkspaceImage (Maybe [Tag]) Source #

The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.

createWorkspaceImage_name :: Lens' CreateWorkspaceImage Text Source #

The name of the new WorkSpace image.

createWorkspaceImage_description :: Lens' CreateWorkspaceImage Text Source #

The description of the new WorkSpace image.

createWorkspaceImage_workspaceId :: Lens' CreateWorkspaceImage Text Source #

The identifier of the source WorkSpace

createWorkspaceImageResponse_created :: Lens' CreateWorkspaceImageResponse (Maybe UTCTime) Source #

The date when the image was created.

createWorkspaceImageResponse_description :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

The description of the image.

createWorkspaceImageResponse_imageId :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

The identifier of the new WorkSpace image.

createWorkspaceImageResponse_name :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

The name of the image.

createWorkspaceImageResponse_operatingSystem :: Lens' CreateWorkspaceImageResponse (Maybe OperatingSystem) Source #

The operating system that the image is running.

createWorkspaceImageResponse_ownerAccountId :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

The identifier of the Amazon Web Services account that owns the image.

createWorkspaceImageResponse_requiredTenancy :: Lens' CreateWorkspaceImageResponse (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..

createWorkspaceImageResponse_state :: Lens' CreateWorkspaceImageResponse (Maybe WorkspaceImageState) Source #

The availability status of the image.

createWorkspaceImageResponse_httpStatus :: Lens' CreateWorkspaceImageResponse 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.

DeleteClientBranding

deleteClientBranding_resourceId :: Lens' DeleteClientBranding Text Source #

The directory identifier of the WorkSpace for which you want to delete client branding.

deleteClientBranding_platforms :: Lens' DeleteClientBranding (NonEmpty ClientDeviceType) Source #

The device type for which you want to delete client branding.

deleteClientBrandingResponse_httpStatus :: Lens' DeleteClientBrandingResponse Int Source #

The response's http status code.

DeleteConnectClientAddIn

deleteConnectClientAddIn_addInId :: Lens' DeleteConnectClientAddIn Text Source #

The identifier of the client add-in to delete.

deleteConnectClientAddIn_resourceId :: Lens' DeleteConnectClientAddIn Text Source #

The directory identifier for which the client add-in is configured.

deleteConnectClientAddInResponse_httpStatus :: Lens' DeleteConnectClientAddInResponse 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.

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.

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.

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.

DeleteWorkspaceImage

deleteWorkspaceImage_imageId :: Lens' DeleteWorkspaceImage Text Source #

The identifier of the image.

deleteWorkspaceImageResponse_httpStatus :: Lens' DeleteWorkspaceImageResponse 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.

DescribeAccount

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_dedicatedTenancySupport :: Lens' DescribeAccountResponse (Maybe DedicatedTenancySupportResultEnum) Source #

The status of BYOL (whether BYOL is enabled or disabled).

describeAccountResponse_httpStatus :: Lens' DescribeAccountResponse 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.

DescribeClientBranding

describeClientBranding_resourceId :: Lens' DescribeClientBranding Text Source #

The directory identifier of the WorkSpace for which you want to view client branding information.

describeClientBrandingResponse_deviceTypeAndroid :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Android devices.

describeClientBrandingResponse_deviceTypeIos :: Lens' DescribeClientBrandingResponse (Maybe IosClientBrandingAttributes) Source #

The branding information for iOS devices.

describeClientBrandingResponse_deviceTypeLinux :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Linux devices.

describeClientBrandingResponse_deviceTypeOsx :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for macOS devices.

describeClientBrandingResponse_deviceTypeWeb :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Web access.

describeClientBrandingResponse_deviceTypeWindows :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Windows devices.

describeClientBrandingResponse_httpStatus :: Lens' DescribeClientBrandingResponse 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.

DescribeConnectClientAddIns

describeConnectClientAddIns_maxResults :: Lens' DescribeConnectClientAddIns (Maybe Natural) Source #

The maximum number of items to return.

describeConnectClientAddIns_nextToken :: Lens' DescribeConnectClientAddIns (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.

describeConnectClientAddIns_resourceId :: Lens' DescribeConnectClientAddIns Text Source #

The directory identifier for which the client add-in is configured.

describeConnectClientAddInsResponse_addIns :: Lens' DescribeConnectClientAddInsResponse (Maybe [ConnectClientAddIn]) Source #

Information about client add-ins.

describeConnectClientAddInsResponse_nextToken :: Lens' DescribeConnectClientAddInsResponse (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.

describeConnectClientAddInsResponse_httpStatus :: Lens' DescribeConnectClientAddInsResponse Int Source #

The response's http status code.

DescribeConnectionAliasPermissions

describeConnectionAliasPermissions_maxResults :: Lens' DescribeConnectionAliasPermissions (Maybe Natural) Source #

The maximum number of results to return.

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_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_connectionAliasPermissions :: Lens' DescribeConnectionAliasPermissionsResponse (Maybe (NonEmpty ConnectionAliasPermission)) Source #

The permissions associated with a 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_httpStatus :: Lens' DescribeConnectionAliasPermissionsResponse Int Source #

The response's http status code.

DescribeConnectionAliases

describeConnectionAliases_aliasIds :: Lens' DescribeConnectionAliases (Maybe (NonEmpty Text)) Source #

The identifiers of the connection aliases to describe.

describeConnectionAliases_limit :: Lens' DescribeConnectionAliases (Maybe Natural) Source #

The maximum number of connection aliases to return.

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_resourceId :: Lens' DescribeConnectionAliases (Maybe Text) Source #

The identifier of the directory associated with the connection alias.

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.

DescribeIpGroups

describeIpGroups_groupIds :: Lens' DescribeIpGroups (Maybe [Text]) Source #

The identifiers of one or more IP access control groups.

describeIpGroups_maxResults :: Lens' DescribeIpGroups (Maybe Natural) Source #

The maximum number of items to return.

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.

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_result :: Lens' DescribeIpGroupsResponse (Maybe [WorkspacesIpGroup]) Source #

Information about the IP access control groups.

describeIpGroupsResponse_httpStatus :: Lens' DescribeIpGroupsResponse 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.

DescribeWorkspaceBundles

describeWorkspaceBundles_bundleIds :: Lens' DescribeWorkspaceBundles (Maybe (NonEmpty Text)) Source #

The identifiers of the bundles. You cannot combine this parameter with any other filter.

describeWorkspaceBundles_nextToken :: Lens' DescribeWorkspaceBundles (Maybe Text) Source #

The token for the next set of results. (You received this token from a previous call.)

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.

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.

DescribeWorkspaceDirectories

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.

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.

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.

DescribeWorkspaceImagePermissions

describeWorkspaceImagePermissions_maxResults :: Lens' DescribeWorkspaceImagePermissions (Maybe Natural) Source #

The maximum number of items to return.

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_imageId :: Lens' DescribeWorkspaceImagePermissions Text Source #

The identifier of the image.

describeWorkspaceImagePermissionsResponse_imageId :: Lens' DescribeWorkspaceImagePermissionsResponse (Maybe 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_httpStatus :: Lens' DescribeWorkspaceImagePermissionsResponse Int Source #

The response's http status code.

DescribeWorkspaceImages

describeWorkspaceImages_imageIds :: Lens' DescribeWorkspaceImages (Maybe (NonEmpty Text)) Source #

The identifier of the image.

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.

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.

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.

DescribeWorkspaceSnapshots

describeWorkspaceSnapshots_workspaceId :: Lens' DescribeWorkspaceSnapshots Text Source #

The identifier of the WorkSpace.

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_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_httpStatus :: Lens' DescribeWorkspaceSnapshotsResponse Int Source #

The response's http status code.

DescribeWorkspaces

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_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_limit :: Lens' DescribeWorkspaces (Maybe Natural) Source #

The maximum number of items to return.

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_userName :: Lens' DescribeWorkspaces (Maybe Text) Source #

The name of the directory user. You must specify this parameter with DirectoryId.

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.

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.

DescribeWorkspacesConnectionStatus

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.

describeWorkspacesConnectionStatus_workspaceIds :: Lens' DescribeWorkspacesConnectionStatus (Maybe (NonEmpty Text)) Source #

The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

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.

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.

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.

ImportClientBranding

importClientBranding_deviceTypeAndroid :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for Android devices.

importClientBranding_deviceTypeIos :: Lens' ImportClientBranding (Maybe IosImportClientBrandingAttributes) Source #

The branding information to import for iOS devices.

importClientBranding_deviceTypeLinux :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for Linux devices.

importClientBranding_deviceTypeOsx :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for macOS devices.

importClientBranding_deviceTypeWeb :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for web access.

importClientBranding_deviceTypeWindows :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for Windows devices.

importClientBranding_resourceId :: Lens' ImportClientBranding Text Source #

The directory identifier of the WorkSpace for which you want to import client branding.

importClientBrandingResponse_deviceTypeAndroid :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for Android devices.

importClientBrandingResponse_deviceTypeIos :: Lens' ImportClientBrandingResponse (Maybe IosClientBrandingAttributes) Source #

The branding information configured for iOS devices.

importClientBrandingResponse_deviceTypeLinux :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for Linux devices.

importClientBrandingResponse_deviceTypeOsx :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for macOS devices.

importClientBrandingResponse_deviceTypeWeb :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for web access.

importClientBrandingResponse_deviceTypeWindows :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for Windows devices.

importClientBrandingResponse_httpStatus :: Lens' ImportClientBrandingResponse 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, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

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.

ListAvailableManagementCidrRanges

listAvailableManagementCidrRanges_maxResults :: Lens' ListAvailableManagementCidrRanges (Maybe Natural) Source #

The maximum number of items to return.

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_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.

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.

ModifyAccount

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.

modifyAccount_dedicatedTenancySupport :: Lens' ModifyAccount (Maybe DedicatedTenancySupportEnum) Source #

The status of BYOL.

modifyAccountResponse_httpStatus :: Lens' ModifyAccountResponse Int Source #

The response's http status code.

ModifyCertificateBasedAuthProperties

modifyCertificateBasedAuthProperties_certificateBasedAuthProperties :: Lens' ModifyCertificateBasedAuthProperties (Maybe CertificateBasedAuthProperties) Source #

The properties of the certificate-based authentication.

modifyCertificateBasedAuthProperties_propertiesToDelete :: Lens' ModifyCertificateBasedAuthProperties (Maybe [DeletableCertificateBasedAuthProperty]) Source #

The properties of the certificate-based authentication you want to delete.

modifyCertificateBasedAuthProperties_resourceId :: Lens' ModifyCertificateBasedAuthProperties Text Source #

The resource identifiers, in the form of directory IDs.

modifyCertificateBasedAuthPropertiesResponse_httpStatus :: Lens' ModifyCertificateBasedAuthPropertiesResponse 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.

ModifySamlProperties

modifySamlProperties_propertiesToDelete :: Lens' ModifySamlProperties (Maybe [DeletableSamlProperty]) Source #

The SAML properties to delete as part of your request.

Specify one of the following options:

SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

modifySamlProperties_samlProperties :: Lens' ModifySamlProperties (Maybe SamlProperties) Source #

The properties for configuring SAML 2.0 authentication.

modifySamlProperties_resourceId :: Lens' ModifySamlProperties Text Source #

The directory identifier for which you want to configure SAML properties.

modifySamlPropertiesResponse_httpStatus :: Lens' ModifySamlPropertiesResponse 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.

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.

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.

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.

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.

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.

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.

RegisterWorkspaceDirectory

registerWorkspaceDirectory_enableSelfService :: Lens' RegisterWorkspaceDirectory (Maybe Bool) Source #

Indicates whether self-service capabilities are enabled or disabled.

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_tags :: Lens' RegisterWorkspaceDirectory (Maybe [Tag]) Source #

The tags associated with the directory.

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_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.

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.

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.

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.

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.

UpdateConnectClientAddIn

updateConnectClientAddIn_name :: Lens' UpdateConnectClientAddIn (Maybe Text) Source #

The name of the client add-in.

updateConnectClientAddIn_url :: Lens' UpdateConnectClientAddIn (Maybe Text) Source #

The endpoint URL of the Amazon Connect client add-in.

updateConnectClientAddIn_addInId :: Lens' UpdateConnectClientAddIn Text Source #

The identifier of the client add-in to update.

updateConnectClientAddIn_resourceId :: Lens' UpdateConnectClientAddIn Text Source #

The directory identifier for which the client add-in is configured.

updateConnectClientAddInResponse_httpStatus :: Lens' UpdateConnectClientAddInResponse 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.

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.

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.

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.

Types

AccountModification

accountModification_dedicatedTenancyManagementCidrRange :: Lens' AccountModification (Maybe Text) Source #

The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.

accountModification_dedicatedTenancySupport :: Lens' AccountModification (Maybe DedicatedTenancySupportResultEnum) Source #

The status of BYOL (whether BYOL is being enabled or disabled).

accountModification_errorCode :: Lens' AccountModification (Maybe Text) Source #

The error code that is returned if the configuration of BYOL cannot be modified.

accountModification_errorMessage :: Lens' AccountModification (Maybe Text) Source #

The text of the error message that is returned if the configuration of BYOL cannot be modified.

accountModification_modificationState :: Lens' AccountModification (Maybe DedicatedTenancyModificationStateEnum) Source #

The state of the modification to the configuration of BYOL.

accountModification_startTime :: Lens' AccountModification (Maybe UTCTime) Source #

The timestamp when the modification of the BYOL configuration was started.

CertificateBasedAuthProperties

certificateBasedAuthProperties_certificateAuthorityArn :: Lens' CertificateBasedAuthProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.

certificateBasedAuthProperties_status :: Lens' CertificateBasedAuthProperties (Maybe CertificateBasedAuthStatusEnum) Source #

The status of the certificate-based authentication properties.

ClientProperties

clientProperties_logUploadEnabled :: Lens' ClientProperties (Maybe LogUploadEnum) Source #

Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.

clientProperties_reconnectEnabled :: Lens' ClientProperties (Maybe ReconnectEnum) Source #

Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.

ClientPropertiesResult

clientPropertiesResult_clientProperties :: Lens' ClientPropertiesResult (Maybe ClientProperties) Source #

Information about the Amazon WorkSpaces client.

clientPropertiesResult_resourceId :: Lens' ClientPropertiesResult (Maybe Text) Source #

The resource identifier, in the form of a directory ID.

ComputeType

computeType_name :: Lens' ComputeType (Maybe Compute) Source #

The compute type.

ConnectClientAddIn

connectClientAddIn_addInId :: Lens' ConnectClientAddIn (Maybe Text) Source #

The client add-in identifier.

connectClientAddIn_name :: Lens' ConnectClientAddIn (Maybe Text) Source #

The name of the client add in.

connectClientAddIn_resourceId :: Lens' ConnectClientAddIn (Maybe Text) Source #

The directory identifier for which the client add-in is configured.

connectClientAddIn_url :: Lens' ConnectClientAddIn (Maybe Text) Source #

The endpoint URL of the client add-in.

ConnectionAlias

connectionAlias_aliasId :: Lens' ConnectionAlias (Maybe Text) Source #

The identifier of the connection alias.

connectionAlias_associations :: Lens' ConnectionAlias (Maybe (NonEmpty ConnectionAliasAssociation)) Source #

The association status of the connection alias.

connectionAlias_connectionString :: Lens' ConnectionAlias (Maybe Text) Source #

The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.

connectionAlias_ownerAccountId :: Lens' ConnectionAlias (Maybe Text) Source #

The identifier of the Amazon Web Services account that owns the connection alias.

connectionAlias_state :: Lens' ConnectionAlias (Maybe ConnectionAliasState) Source #

The current state of the connection alias.

ConnectionAliasAssociation

connectionAliasAssociation_associatedAccountId :: Lens' ConnectionAliasAssociation (Maybe Text) Source #

The identifier of the Amazon Web Services account that associated the connection alias with a directory.

connectionAliasAssociation_associationStatus :: Lens' ConnectionAliasAssociation (Maybe AssociationStatus) Source #

The association status of the connection alias.

connectionAliasAssociation_connectionIdentifier :: Lens' ConnectionAliasAssociation (Maybe Text) Source #

The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.

connectionAliasAssociation_resourceId :: Lens' ConnectionAliasAssociation (Maybe Text) Source #

The identifier of the directory associated with a connection alias.

ConnectionAliasPermission

connectionAliasPermission_sharedAccountId :: Lens' ConnectionAliasPermission Text Source #

The identifier of the Amazon Web Services account that the connection alias is shared with.

connectionAliasPermission_allowAssociation :: Lens' ConnectionAliasPermission Bool Source #

Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.

DefaultClientBrandingAttributes

defaultClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

defaultClientBrandingAttributes_loginMessage :: Lens' DefaultClientBrandingAttributes (Maybe (HashMap Text Text)) Source #

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

defaultClientBrandingAttributes_logoUrl :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #

The logo. The only image format accepted is a binary data object that is converted from a .png file.

defaultClientBrandingAttributes_supportEmail :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #

The support email. The company's customer support email address.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.

defaultClientBrandingAttributes_supportLink :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #

The support link. The link for the company's customer support page for their WorkSpace.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.

DefaultImportClientBrandingAttributes

defaultImportClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

defaultImportClientBrandingAttributes_loginMessage :: Lens' DefaultImportClientBrandingAttributes (Maybe (HashMap Text Text)) Source #

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

defaultImportClientBrandingAttributes_logo :: Lens' DefaultImportClientBrandingAttributes (Maybe ByteString) Source #

The logo. The only image format accepted is a binary data object that is converted from a .png file.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

defaultImportClientBrandingAttributes_supportEmail :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #

The support email. The company's customer support email address.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.

defaultImportClientBrandingAttributes_supportLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #

The support link. The link for the company's customer support page for their WorkSpace.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.

DefaultWorkspaceCreationProperties

defaultWorkspaceCreationProperties_customSecurityGroupId :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #

The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

defaultWorkspaceCreationProperties_defaultOu :: Lens' DefaultWorkspaceCreationProperties (Maybe Text) Source #

The organizational unit (OU) in the directory for the WorkSpace machine accounts.

defaultWorkspaceCreationProperties_enableInternetAccess :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #

Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

defaultWorkspaceCreationProperties_enableMaintenanceMode :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #

Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.

defaultWorkspaceCreationProperties_enableWorkDocs :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #

Specifies whether the directory is enabled for Amazon WorkDocs.

defaultWorkspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' DefaultWorkspaceCreationProperties (Maybe Bool) Source #

Specifies whether WorkSpace users are local administrators on their WorkSpaces.

FailedCreateStandbyWorkspacesRequest

failedCreateStandbyWorkspacesRequest_errorCode :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe Text) Source #

The error code that is returned if the Standby WorkSpace could not be created.

failedCreateStandbyWorkspacesRequest_errorMessage :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe Text) Source #

The text of the error message that is returned if the Standby WorkSpace could not be created.

failedCreateStandbyWorkspacesRequest_standbyWorkspaceRequest :: Lens' FailedCreateStandbyWorkspacesRequest (Maybe StandbyWorkspace) Source #

Information about the Standby WorkSpace that could not be created.

FailedCreateWorkspaceRequest

failedCreateWorkspaceRequest_errorCode :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #

The error code that is returned if the WorkSpace cannot be created.

failedCreateWorkspaceRequest_errorMessage :: Lens' FailedCreateWorkspaceRequest (Maybe Text) Source #

The text of the error message that is returned if the WorkSpace cannot be created.

failedCreateWorkspaceRequest_workspaceRequest :: Lens' FailedCreateWorkspaceRequest (Maybe WorkspaceRequest) Source #

Information about the WorkSpace.

FailedWorkspaceChangeRequest

failedWorkspaceChangeRequest_errorCode :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #

The error code that is returned if the WorkSpace cannot be rebooted.

failedWorkspaceChangeRequest_errorMessage :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #

The text of the error message that is returned if the WorkSpace cannot be rebooted.

failedWorkspaceChangeRequest_workspaceId :: Lens' FailedWorkspaceChangeRequest (Maybe Text) Source #

The identifier of the WorkSpace.

ImagePermission

imagePermission_sharedAccountId :: Lens' ImagePermission (Maybe Text) Source #

The identifier of the Amazon Web Services account that an image has been shared with.

IosClientBrandingAttributes

iosClientBrandingAttributes_forgotPasswordLink :: Lens' IosClientBrandingAttributes (Maybe Text) Source #

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

iosClientBrandingAttributes_loginMessage :: Lens' IosClientBrandingAttributes (Maybe (HashMap Text Text)) Source #

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

iosClientBrandingAttributes_logo2xUrl :: Lens' IosClientBrandingAttributes (Maybe Text) Source #

The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

iosClientBrandingAttributes_logo3xUrl :: Lens' IosClientBrandingAttributes (Maybe Text) Source #

The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

iosClientBrandingAttributes_logoUrl :: Lens' IosClientBrandingAttributes (Maybe Text) Source #

The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.

iosClientBrandingAttributes_supportEmail :: Lens' IosClientBrandingAttributes (Maybe Text) Source #

The support email. The company's customer support email address.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.

iosClientBrandingAttributes_supportLink :: Lens' IosClientBrandingAttributes (Maybe Text) Source #

The support link. The link for the company's customer support page for their WorkSpace.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.

IosImportClientBrandingAttributes

iosImportClientBrandingAttributes_forgotPasswordLink :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

iosImportClientBrandingAttributes_loginMessage :: Lens' IosImportClientBrandingAttributes (Maybe (HashMap Text Text)) Source #

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

iosImportClientBrandingAttributes_logo :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #

The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

iosImportClientBrandingAttributes_logo2x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #

The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

iosImportClientBrandingAttributes_logo3x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #

The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

iosImportClientBrandingAttributes_supportEmail :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #

The support email. The company's customer support email address.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.

iosImportClientBrandingAttributes_supportLink :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #

The support link. The link for the company's customer support page for their WorkSpace.

In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.

IpRuleItem

ipRuleItem_ipRule :: Lens' IpRuleItem (Maybe Text) Source #

The IP address range, in CIDR notation.

ipRuleItem_ruleDesc :: Lens' IpRuleItem (Maybe Text) Source #

The description.

ModificationState

modificationState_resource :: Lens' ModificationState (Maybe ModificationResourceEnum) Source #

The resource.

modificationState_state :: Lens' ModificationState (Maybe ModificationStateEnum) Source #

The modification state.

OperatingSystem

operatingSystem_type :: Lens' OperatingSystem (Maybe OperatingSystemType) Source #

The operating system.

PendingCreateStandbyWorkspacesRequest

pendingCreateStandbyWorkspacesRequest_directoryId :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text) Source #

The identifier of the directory for the Standby WorkSpace.

pendingCreateStandbyWorkspacesRequest_state :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe WorkspaceState) Source #

The operational state of the Standby WorkSpace.

pendingCreateStandbyWorkspacesRequest_userName :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text) Source #

Describes the Standby WorkSpace that was created.

Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.

pendingCreateStandbyWorkspacesRequest_workspaceId :: Lens' PendingCreateStandbyWorkspacesRequest (Maybe Text) Source #

The identifier of the Standby WorkSpace.

RebootRequest

rebootRequest_workspaceId :: Lens' RebootRequest Text Source #

The identifier of the WorkSpace.

RebuildRequest

rebuildRequest_workspaceId :: Lens' RebuildRequest Text Source #

The identifier of the WorkSpace.

RelatedWorkspaceProperties

The Region of the related WorkSpace.

Indicates the state of the WorkSpace.

Indicates the type of WorkSpace.

The identifier of the related WorkSpace.

RootStorage

rootStorage_capacity :: Lens' RootStorage (Maybe Text) Source #

The size of the root volume.

SamlProperties

samlProperties_relayStateParameterName :: Lens' SamlProperties (Maybe Text) Source #

The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.

To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.

samlProperties_status :: Lens' SamlProperties (Maybe SamlStatusEnum) Source #

Indicates the status of SAML 2.0 authentication. These statuses include the following.

If the setting is DISABLED, end users will be directed to login with their directory credentials.
If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

samlProperties_userAccessUrl :: Lens' SamlProperties (Maybe Text) Source #

The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

SelfservicePermissions

selfservicePermissions_changeComputeType :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #

Specifies whether users can change the compute type (bundle) for their WorkSpace.

selfservicePermissions_increaseVolumeSize :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #

Specifies whether users can increase the volume size of the drives on their WorkSpace.

selfservicePermissions_rebuildWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #

Specifies whether users can rebuild the operating system of a WorkSpace to its original state.

selfservicePermissions_restartWorkspace :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #

Specifies whether users can restart their WorkSpace.

selfservicePermissions_switchRunningMode :: Lens' SelfservicePermissions (Maybe ReconnectEnum) Source #

Specifies whether users can switch the running mode of their WorkSpace.

Snapshot

snapshot_snapshotTime :: Lens' Snapshot (Maybe UTCTime) Source #

The time when the snapshot was created.

StandbyWorkspace

standbyWorkspace_tags :: Lens' StandbyWorkspace (Maybe [Tag]) Source #

The tags associated with the Standby WorkSpace.

standbyWorkspace_volumeEncryptionKey :: Lens' StandbyWorkspace (Maybe Text) Source #

The volume encryption key of the Standby WorkSpace.

standbyWorkspace_primaryWorkspaceId :: Lens' StandbyWorkspace Text Source #

The identifier of the Standby WorkSpace.

standbyWorkspace_directoryId :: Lens' StandbyWorkspace Text Source #

The identifier of the directory for the Standby WorkSpace.

StartRequest

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

tag_value :: Lens' Tag (Maybe Text) Source #

The value of the tag.

tag_key :: Lens' Tag Text Source #

The key of the tag.

TerminateRequest

terminateRequest_workspaceId :: Lens' TerminateRequest Text Source #

The identifier of the WorkSpace.

UpdateResult

updateResult_description :: Lens' UpdateResult (Maybe Text) Source #

A description of whether updates for the WorkSpace image are pending or available.

updateResult_updateAvailable :: Lens' UpdateResult (Maybe Bool) Source #

Indicates whether updated drivers or other components are available for the specified WorkSpace image.

UserStorage

userStorage_capacity :: Lens' UserStorage (Maybe Text) Source #

The size of the user volume.

Workspace

workspace_bundleId :: Lens' Workspace (Maybe Text) Source #

The identifier of the bundle used to create the WorkSpace.

workspace_computerName :: Lens' Workspace (Maybe Text) Source #

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

workspace_directoryId :: Lens' Workspace (Maybe Text) Source #

The identifier of the Directory Service directory for the WorkSpace.

workspace_errorCode :: Lens' Workspace (Maybe Text) Source #

The error code that is returned if the WorkSpace cannot be created.

workspace_errorMessage :: Lens' Workspace (Maybe Text) Source #

The text of the error message that is returned if the WorkSpace cannot be created.

workspace_ipAddress :: Lens' Workspace (Maybe Text) Source #

The IP address of the WorkSpace.

workspace_modificationStates :: Lens' Workspace (Maybe [ModificationState]) Source #

The modification states of the WorkSpace.

The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.

workspace_rootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #

Indicates whether the data stored on the root volume is encrypted.

workspace_state :: Lens' Workspace (Maybe WorkspaceState) Source #

The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

workspace_subnetId :: Lens' Workspace (Maybe Text) Source #

The identifier of the subnet for the WorkSpace.

workspace_userName :: Lens' Workspace (Maybe Text) Source #

The user for the WorkSpace.

workspace_userVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #

Indicates whether the data stored on the user volume is encrypted.

workspace_volumeEncryptionKey :: Lens' Workspace (Maybe Text) Source #

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

workspace_workspaceId :: Lens' Workspace (Maybe Text) Source #

The identifier of the WorkSpace.

workspace_workspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties) Source #

The properties of the WorkSpace.

WorkspaceAccessProperties

workspaceAccessProperties_deviceTypeAndroid :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.

workspaceAccessProperties_deviceTypeChromeOs :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can use Chromebooks to access their WorkSpaces.

workspaceAccessProperties_deviceTypeIos :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can use iOS devices to access their WorkSpaces.

workspaceAccessProperties_deviceTypeLinux :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can use Linux clients to access their WorkSpaces.

workspaceAccessProperties_deviceTypeOsx :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can use macOS clients to access their WorkSpaces.

workspaceAccessProperties_deviceTypeWeb :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can access their WorkSpaces through a web browser.

workspaceAccessProperties_deviceTypeWindows :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can use Windows clients to access their WorkSpaces.

workspaceAccessProperties_deviceTypeZeroClient :: Lens' WorkspaceAccessProperties (Maybe AccessPropertyValue) Source #

Indicates whether users can use zero client devices to access their WorkSpaces.

WorkspaceBundle

workspaceBundle_bundleId :: Lens' WorkspaceBundle (Maybe Text) Source #

The identifier of the bundle.

workspaceBundle_bundleType :: Lens' WorkspaceBundle (Maybe BundleType) Source #

The type of WorkSpace bundle.

workspaceBundle_computeType :: Lens' WorkspaceBundle (Maybe ComputeType) Source #

The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.

workspaceBundle_creationTime :: Lens' WorkspaceBundle (Maybe UTCTime) Source #

The time when the bundle was created.

workspaceBundle_description :: Lens' WorkspaceBundle (Maybe Text) Source #

The description of the bundle.

workspaceBundle_imageId :: Lens' WorkspaceBundle (Maybe Text) Source #

The identifier of the image that was used to create the bundle.

workspaceBundle_lastUpdatedTime :: Lens' WorkspaceBundle (Maybe UTCTime) Source #

The last time that the bundle was updated.

workspaceBundle_name :: Lens' WorkspaceBundle (Maybe Text) Source #

The name of the bundle.

workspaceBundle_owner :: Lens' WorkspaceBundle (Maybe Text) Source #

The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.

workspaceBundle_rootStorage :: Lens' WorkspaceBundle (Maybe RootStorage) Source #

The size of the root volume.

workspaceBundle_state :: Lens' WorkspaceBundle (Maybe WorkspaceBundleState) Source #

The state of the WorkSpace bundle.

workspaceBundle_userStorage :: Lens' WorkspaceBundle (Maybe UserStorage) Source #

The size of the user volume.

WorkspaceConnectionStatus

workspaceConnectionStatus_connectionState :: Lens' WorkspaceConnectionStatus (Maybe ConnectionState) Source #

The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

workspaceConnectionStatus_connectionStateCheckTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #

The timestamp of the connection status check.

workspaceConnectionStatus_lastKnownUserConnectionTimestamp :: Lens' WorkspaceConnectionStatus (Maybe UTCTime) Source #

The timestamp of the last known user connection.

workspaceConnectionStatus_workspaceId :: Lens' WorkspaceConnectionStatus (Maybe Text) Source #

The identifier of the WorkSpace.

WorkspaceCreationProperties

workspaceCreationProperties_customSecurityGroupId :: Lens' WorkspaceCreationProperties (Maybe Text) Source #

The identifier of your custom security group.

workspaceCreationProperties_defaultOu :: Lens' WorkspaceCreationProperties (Maybe Text) Source #

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn't validate whether the OU exists.

workspaceCreationProperties_enableInternetAccess :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether internet access is enabled for your WorkSpaces.

workspaceCreationProperties_enableMaintenanceMode :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

workspaceCreationProperties_enableWorkDocs :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

workspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether users are local administrators of their WorkSpaces.

WorkspaceDirectory

workspaceDirectory_alias :: Lens' WorkspaceDirectory (Maybe Text) Source #

The directory alias.

workspaceDirectory_certificateBasedAuthProperties :: Lens' WorkspaceDirectory (Maybe CertificateBasedAuthProperties) Source #

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

workspaceDirectory_customerUserName :: Lens' WorkspaceDirectory (Maybe Text) Source #

The user name for the service account.

workspaceDirectory_directoryId :: Lens' WorkspaceDirectory (Maybe Text) Source #

The directory identifier.

workspaceDirectory_directoryName :: Lens' WorkspaceDirectory (Maybe Text) Source #

The name of the directory.

workspaceDirectory_directoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType) Source #

The directory type.

workspaceDirectory_dnsIpAddresses :: Lens' WorkspaceDirectory (Maybe [Text]) Source #

The IP addresses of the DNS servers for the directory.

workspaceDirectory_iamRoleId :: Lens' WorkspaceDirectory (Maybe Text) Source #

The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

workspaceDirectory_registrationCode :: Lens' WorkspaceDirectory (Maybe Text) Source #

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

workspaceDirectory_samlProperties :: Lens' WorkspaceDirectory (Maybe SamlProperties) Source #

Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

workspaceDirectory_selfservicePermissions :: Lens' WorkspaceDirectory (Maybe SelfservicePermissions) Source #

The default self-service permissions for WorkSpaces in the directory.

workspaceDirectory_state :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState) Source #

The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.

workspaceDirectory_subnetIds :: Lens' WorkspaceDirectory (Maybe [Text]) Source #

The identifiers of the subnets used with the directory.

workspaceDirectory_tenancy :: Lens' WorkspaceDirectory (Maybe Tenancy) Source #

Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

workspaceDirectory_workspaceAccessProperties :: Lens' WorkspaceDirectory (Maybe WorkspaceAccessProperties) Source #

The devices and operating systems that users can use to access WorkSpaces.

workspaceDirectory_workspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties) Source #

The default creation properties for all WorkSpaces in the directory.

workspaceDirectory_workspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text) Source #

The identifier of the security group that is assigned to new WorkSpaces.

workspaceDirectory_ipGroupIds :: Lens' WorkspaceDirectory (Maybe [Text]) Source #

The identifiers of the IP access control groups associated with the directory.

WorkspaceImage

workspaceImage_created :: Lens' WorkspaceImage (Maybe UTCTime) Source #

The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

workspaceImage_description :: Lens' WorkspaceImage (Maybe Text) Source #

The description of the image.

workspaceImage_errorCode :: Lens' WorkspaceImage (Maybe Text) Source #

The error code that is returned for the image.

workspaceImage_errorMessage :: Lens' WorkspaceImage (Maybe Text) Source #

The text of the error message that is returned for the image.

workspaceImage_imageId :: Lens' WorkspaceImage (Maybe Text) Source #

The identifier of the image.

workspaceImage_name :: Lens' WorkspaceImage (Maybe Text) Source #

The name of the image.

workspaceImage_operatingSystem :: Lens' WorkspaceImage (Maybe OperatingSystem) Source #

The operating system that the image is running.

workspaceImage_ownerAccountId :: Lens' WorkspaceImage (Maybe Text) Source #

The identifier of the Amazon Web Services account that owns the image.

workspaceImage_requiredTenancy :: Lens' WorkspaceImage (Maybe WorkspaceImageRequiredTenancy) Source #

Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

workspaceImage_state :: Lens' WorkspaceImage (Maybe WorkspaceImageState) Source #

The status of the image.

workspaceImage_updates :: Lens' WorkspaceImage (Maybe UpdateResult) Source #

The updates (if any) that are available for the specified image.

WorkspaceProperties

workspaceProperties_computeTypeName :: Lens' WorkspaceProperties (Maybe Compute) Source #

The compute type. For more information, see Amazon WorkSpaces Bundles.

workspaceProperties_protocols :: Lens' WorkspaceProperties (Maybe [Protocol]) Source #

The protocol. For more information, see Protocols for Amazon WorkSpaces.

Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

workspaceProperties_rootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #

The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

workspaceProperties_runningMode :: Lens' WorkspaceProperties (Maybe RunningMode) Source #

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

workspaceProperties_runningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int) Source #

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

workspaceProperties_userVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int) Source #

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

WorkspaceRequest

workspaceRequest_rootVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source #

Indicates whether the data stored on the root volume is encrypted.

workspaceRequest_tags :: Lens' WorkspaceRequest (Maybe [Tag]) Source #

The tags for the WorkSpace.

workspaceRequest_userVolumeEncryptionEnabled :: Lens' WorkspaceRequest (Maybe Bool) Source #

Indicates whether the data stored on the user volume is encrypted.

workspaceRequest_volumeEncryptionKey :: Lens' WorkspaceRequest (Maybe Text) Source #

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

workspaceRequest_workspaceProperties :: Lens' WorkspaceRequest (Maybe WorkspaceProperties) Source #

The WorkSpace properties.

workspaceRequest_directoryId :: Lens' WorkspaceRequest Text Source #

The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

workspaceRequest_userName :: Lens' WorkspaceRequest Text Source #

The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

workspaceRequest_bundleId :: Lens' WorkspaceRequest Text Source #

The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

WorkspacesIpGroup

workspacesIpGroup_groupDesc :: Lens' WorkspacesIpGroup (Maybe Text) Source #

The description of the group.

workspacesIpGroup_groupId :: Lens' WorkspacesIpGroup (Maybe Text) Source #

The identifier of the group.

workspacesIpGroup_groupName :: Lens' WorkspacesIpGroup (Maybe Text) Source #

The name of the group.

workspacesIpGroup_userRules :: Lens' WorkspacesIpGroup (Maybe [IpRuleItem]) Source #

The rules.