Values (p.awso.0.9.0.doc.awso.workspaces.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval targetPrefix : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule AccessEndpointType : sig ... end

Sourcemodule AlphanumericDashUnderscoreNonEmptyString : sig ... end

Sourcemodule StorageConnectorStatusEnum : sig ... end

Sourcemodule StorageConnectorTypeEnum : sig ... end

Sourcemodule MaximumLength : sig ... end

Sourcemodule UserSettingActionEnum : sig ... end

Sourcemodule UserSettingPermissionEnum : sig ... end

Sourcemodule AccessEndpoint : sig ... end

Describes the access type and endpoint for a WorkSpace.

Sourcemodule InternetFallbackProtocol : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule AGAModeForWorkSpaceEnum : sig ... end

Sourcemodule AGAPreferredProtocolForWorkSpace : sig ... end

Sourcemodule Protocol : sig ... end

Sourcemodule ModificationResourceEnum : sig ... end

Sourcemodule ModificationStateEnum : sig ... end

Sourcemodule Region : sig ... end

Sourcemodule StandbyWorkspaceRelationshipType : sig ... end

Sourcemodule WorkspaceId : sig ... end

Sourcemodule WorkspaceState : sig ... end

Sourcemodule DataReplication : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule ErrorMessage : sig ... end

Sourcemodule WorkspacesPoolErrorCode : sig ... end

Sourcemodule Description : sig ... end

Sourcemodule WorkspaceImageErrorDetailCode : sig ... end

Sourcemodule AGAModeForDirectoryEnum : sig ... end

Sourcemodule AGAPreferredProtocolForDirectory : sig ... end

Sourcemodule StorageConnector : sig ... end

Describes the storage connector.

Sourcemodule UserSetting : sig ... end

Information about the user's permission settings.

Sourcemodule AccessEndpointList : sig ... end

Sourcemodule InternetFallbackProtocolList : sig ... end

Sourcemodule IpRule : sig ... end

Sourcemodule IpRuleDesc : sig ... end

Sourcemodule AssociationStatus : sig ... end

Sourcemodule AwsAccount : sig ... end

Sourcemodule ConnectionIdentifier : sig ... end

Sourcemodule NonEmptyString : sig ... end

Sourcemodule AssociationErrorCode : sig ... end

Sourcemodule String2048 : sig ... end

Sourcemodule Tag : sig ... end

Describes a tag.

Sourcemodule Compute : sig ... end

Sourcemodule GlobalAcceleratorForWorkSpace : sig ... end

Describes the Global Accelerator for WorkSpaces.

Sourcemodule OperatingSystemName : sig ... end

Sourcemodule ProtocolList : sig ... end

Sourcemodule RootVolumeSizeGib : sig ... end

Sourcemodule RunningMode : sig ... end

Sourcemodule RunningModeAutoStopTimeoutInMinutes : sig ... end

Sourcemodule UserVolumeSizeGib : sig ... end

Sourcemodule ModificationState : sig ... end

Describes a WorkSpace modification.

Sourcemodule RelatedWorkspaceProperties : sig ... end

Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

Sourcemodule StandbyWorkspacesProperties : sig ... end

Describes the properties of the related standby WorkSpaces.

Sourcemodule ApplicationSettingsStatusEnum : sig ... end

Sourcemodule S3BucketName : sig ... end

Sourcemodule SettingsGroup : sig ... end

Sourcemodule ActiveUserSessions : sig ... end

Sourcemodule ActualUserSessions : sig ... end

Sourcemodule AvailableUserSessions : sig ... end

Sourcemodule DesiredUserSessions : sig ... end

Sourcemodule DisconnectTimeoutInSeconds : sig ... end

Sourcemodule IdleDisconnectTimeoutInSeconds : sig ... end

Sourcemodule MaxUserDurationInSeconds : sig ... end

Sourcemodule WorkspacesPoolError : sig ... end

Describes a pool error.

Sourcemodule DescribeWorkspacesPoolsFilterValue : sig ... end

Sourcemodule ErrorDetails : sig ... end

Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.

Sourcemodule OperatingSystemType : sig ... end

Sourcemodule BooleanObject : sig ... end

Sourcemodule UpdateDescription : sig ... end

Sourcemodule DomainName : sig ... end

Sourcemodule SecretsManagerArn : sig ... end

Sourcemodule CertificateAuthorityArn : sig ... end

Sourcemodule CertificateBasedAuthStatusEnum : sig ... end

Sourcemodule ARN : sig ... end

Sourcemodule DefaultOu : sig ... end

Sourcemodule SecurityGroupId : sig ... end

Sourcemodule IpAddress : sig ... end

Sourcemodule Ipv6Address : sig ... end

Sourcemodule IpGroupId : sig ... end

Sourcemodule MicrosoftEntraConfigTenantId : sig ... end

Sourcemodule SamlStatusEnum : sig ... end

Sourcemodule SamlUserAccessUrl : sig ... end

Sourcemodule ReconnectEnum : sig ... end

Sourcemodule GlobalAcceleratorForDirectory : sig ... end

Describes the Global Accelerator for directory

Sourcemodule StorageConnectors : sig ... end

Sourcemodule StreamingExperiencePreferredProtocolEnum : sig ... end

Sourcemodule UserSettings : sig ... end

Sourcemodule SubnetId : sig ... end

Sourcemodule AccessEndpointConfig : sig ... end

Describes the access endpoint configuration for a WorkSpace.

Sourcemodule AccessPropertyValue : sig ... end

Sourcemodule DescribeWorkspaceDirectoriesFilterValue : sig ... end

Sourcemodule IpRuleItem : sig ... end

Describes a rule for an IP access control group.

Sourcemodule ConnectionAliasAssociation : sig ... end

Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule LogUploadEnum : sig ... end

Sourcemodule AssociationState : sig ... end

Sourcemodule AssociationStateReason : sig ... end

Indicates the reason that the association deployment failed, including the error code and error message.

Sourcemodule WorkSpaceAssociatedResourceType : sig ... end

Sourcemodule BundleId : sig ... end

Sourcemodule DirectoryId : sig ... end

Sourcemodule TagList : sig ... end

Sourcemodule UserName : sig ... end

Sourcemodule VolumeEncryptionKey : sig ... end

Sourcemodule WorkspaceName : sig ... end

Sourcemodule WorkspaceProperties : sig ... end

Describes a WorkSpace.

Sourcemodule ErrorType : sig ... end

Sourcemodule AccountLinkStatusEnum : sig ... end

Sourcemodule LinkId : sig ... end

Sourcemodule ClientLocale : sig ... end

Sourcemodule ClientLoginMessage : sig ... end

Sourcemodule ComputerName : sig ... end

Sourcemodule DataReplicationSettings : sig ... end

Describes the data replication settings.

Sourcemodule ModificationStateList : sig ... end

Sourcemodule RelatedWorkspaces : sig ... end

Sourcemodule StandbyWorkspacesPropertiesList : sig ... end

Sourcemodule WorkspaceErrorCode : sig ... end

Sourcemodule ApplicationSettingsResponse : sig ... end

Describes the persistent application settings for WorkSpaces Pools users.

Sourcemodule CapacityStatus : sig ... end

Describes the capacity status for a pool of WorkSpaces.

Sourcemodule PoolsRunningMode : sig ... end

Sourcemodule TimeoutSettings : sig ... end

Describes the timeout settings for a pool of WorkSpaces.

Sourcemodule WorkspacesPoolErrors : sig ... end

Sourcemodule WorkspacesPoolId : sig ... end

Sourcemodule WorkspacesPoolName : sig ... end

Sourcemodule WorkspacesPoolState : sig ... end

Sourcemodule DescribeWorkspacesPoolsFilterName : sig ... end

Sourcemodule DescribeWorkspacesPoolsFilterOperator : sig ... end

Sourcemodule DescribeWorkspacesPoolsFilterValues : sig ... end

Sourcemodule AmazonUuid : sig ... end

Sourcemodule AuthenticationType : sig ... end

Sourcemodule NetworkAccessConfiguration : sig ... end

Describes the network details of a WorkSpaces Pool.

Sourcemodule SessionConnectionState : sig ... end

Sourcemodule SessionInstanceId : sig ... end

Sourcemodule WorkspacesPoolUserId : sig ... end

Sourcemodule ConnectionState : sig ... end

Sourcemodule ErrorDetailsList : sig ... end

Sourcemodule OperatingSystem : sig ... end

The operating system that the image is running.

Sourcemodule UpdateResult : sig ... end

Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces. Only Windows 10 WorkSpace images can be programmatically updated at this time.

Sourcemodule WorkspaceImageDescription : sig ... end

Sourcemodule WorkspaceImageErrorCode : sig ... end

Sourcemodule WorkspaceImageId : sig ... end

Sourcemodule WorkspaceImageName : sig ... end

Sourcemodule WorkspaceImageRequiredTenancy : sig ... end

Sourcemodule WorkspaceImageState : sig ... end

Sourcemodule ActiveDirectoryConfig : sig ... end

Information about the Active Directory config.

Sourcemodule Alias : sig ... end

Sourcemodule CertificateBasedAuthProperties : sig ... end

Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.

Sourcemodule DefaultWorkspaceCreationProperties : sig ... end

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

Sourcemodule DirectoryName : sig ... end

Sourcemodule DnsIpAddresses : sig ... end

Sourcemodule DnsIpv6Addresses : sig ... end

Sourcemodule EndpointEncryptionMode : sig ... end

Sourcemodule IDCConfig : sig ... end

Specifies the configurations of the identity center.

Sourcemodule IpGroupIdList : sig ... end

Sourcemodule MicrosoftEntraConfig : sig ... end

Specifies the configurations of the Microsoft Entra.

Sourcemodule RegistrationCode : sig ... end

Sourcemodule SamlProperties : sig ... end

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.

Sourcemodule SelfservicePermissions : sig ... end

Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

Sourcemodule StreamingProperties : sig ... end

Describes the streaming properties.

Sourcemodule SubnetIds : sig ... end

Sourcemodule Tenancy : sig ... end

Sourcemodule UserIdentityType : sig ... end

Sourcemodule WorkspaceAccessProperties : sig ... end

The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.

Sourcemodule WorkspaceDirectoryDescription : sig ... end

Sourcemodule WorkspaceDirectoryName : sig ... end

Sourcemodule WorkspaceDirectoryState : sig ... end

Sourcemodule WorkspaceDirectoryType : sig ... end

Sourcemodule WorkspaceType : sig ... end

Sourcemodule DescribeWorkspaceDirectoriesFilterName : sig ... end

Sourcemodule DescribeWorkspaceDirectoriesFilterValues : sig ... end

Sourcemodule BundleOwner : sig ... end

Sourcemodule BundleType : sig ... end

Sourcemodule ComputeType : sig ... end

Describes the compute type of the bundle.

Sourcemodule RootStorage : sig ... end

Describes the root volume for a WorkSpace bundle.

Sourcemodule UserStorage : sig ... end

Describes the user volume for a WorkSpace bundle.

Sourcemodule WorkspaceBundleState : sig ... end

Sourcemodule IpGroupDesc : sig ... end

Sourcemodule IpGroupName : sig ... end

Sourcemodule IpRuleList : sig ... end

Sourcemodule ImageAssociatedResourceType : sig ... end

Sourcemodule ErrorCode : sig ... end

Sourcemodule ImageErrorMessage : sig ... end

Sourcemodule ConnectionAliasAssociationList : sig ... end

Sourcemodule ConnectionAliasId : sig ... end

Sourcemodule ConnectionAliasState : sig ... end

Sourcemodule ConnectionString : sig ... end

Sourcemodule AddInName : sig ... end

Sourcemodule AddInUrl : sig ... end

Sourcemodule ClientProperties : sig ... end

Describes an Amazon WorkSpaces client.

Sourcemodule BundleAssociatedResourceType : sig ... end

Sourcemodule ComputeList : sig ... end

Sourcemodule OperatingSystemNameList : sig ... end

Sourcemodule WorkSpaceApplicationId : sig ... end

Sourcemodule WorkSpaceApplicationLicenseType : sig ... end

Sourcemodule WorkSpaceApplicationOwner : sig ... end

Sourcemodule WorkSpaceApplicationState : sig ... end

Sourcemodule ApplicationAssociatedResourceType : sig ... end

Sourcemodule DedicatedTenancyManagementCidrRange : sig ... end

Sourcemodule DedicatedTenancyModificationStateEnum : sig ... end

Sourcemodule DedicatedTenancySupportResultEnum : sig ... end

Sourcemodule WorkspaceResourceAssociation : sig ... end

Describes the association between an application and a WorkSpace resource.

Sourcemodule WorkspaceRequest : sig ... end

Describes the information used to create a WorkSpace.

Sourcemodule StandbyWorkspace : sig ... end

Describes a standby WorkSpace.

Sourcemodule ExceptionMessage : sig ... end

Sourcemodule ExceptionErrorCode : sig ... end

Sourcemodule FailedWorkspaceChangeRequest : sig ... end

Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

Sourcemodule TerminateRequest : sig ... end

Describes the information used to terminate a WorkSpace.

Sourcemodule StopRequest : sig ... end

Describes the information used to stop a WorkSpace.

Sourcemodule StartRequest : sig ... end

Information used to start a WorkSpace.

Sourcemodule RebuildRequest : sig ... end

Describes the information used to rebuild a WorkSpace.

Sourcemodule RebootRequest : sig ... end

Describes the information used to reboot a WorkSpace.

Sourcemodule DeletableSamlProperty : sig ... end

Sourcemodule DeletableCertificateBasedAuthProperty : sig ... end

Sourcemodule AccountLink : sig ... end

Information about about the account link.

Sourcemodule Application : sig ... end

Sourcemodule Ec2ImageId : sig ... end

Sourcemodule Ec2ImportTaskId : sig ... end

Sourcemodule ImageBuildVersionArn : sig ... end

Sourcemodule ClientEmail : sig ... end

Sourcemodule ClientUrl : sig ... end

Sourcemodule LoginMessage : sig ... end

Sourcemodule DefaultLogo : sig ... end

Sourcemodule Ios2XLogo : sig ... end

Sourcemodule Ios3XLogo : sig ... end

Sourcemodule IosLogo : sig ... end

Sourcemodule Workspace : sig ... end

Describes a WorkSpace.

Sourcemodule WorkspacesPool : sig ... end

Describes a pool of WorkSpaces.

Sourcemodule DescribeWorkspacesPoolsFilter : sig ... end

Describes the filter conditions for WorkSpaces Pools to return.

Sourcemodule WorkspacesPoolSession : sig ... end

Describes a pool session.

Sourcemodule WorkspaceConnectionStatus : sig ... end

Describes the connection status of a WorkSpace.

Sourcemodule Snapshot : sig ... end

Describes a snapshot.

Sourcemodule WorkspaceImage : sig ... end

Describes a WorkSpace image.

Sourcemodule ImagePermission : sig ... end

Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

Sourcemodule WorkspaceDirectory : sig ... end

Describes a directory that is used with Amazon WorkSpaces.

Sourcemodule DescribeWorkspaceDirectoriesFilter : sig ... end

Describes the filter conditions for the WorkSpaces to return.

Sourcemodule WorkspaceBundle : sig ... end

Describes a WorkSpace bundle.

Sourcemodule WorkspacesIpGroup : sig ... end

Describes an IP access control group.

Sourcemodule ImageResourceAssociation : sig ... end

Describes the association between an application and an image resource.

Sourcemodule CustomWorkspaceImageImportErrorDetails : sig ... end

Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.

Sourcemodule ConnectionAlias : sig ... end

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule ConnectionAliasPermission : sig ... end

Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule ConnectClientAddIn : sig ... end

Describes an Amazon Connect client add-in.

Sourcemodule ClientPropertiesResult : sig ... end

Information about the Amazon WorkSpaces client.

Sourcemodule BundleResourceAssociation : sig ... end

Describes the association between an application and a bundle resource.

Sourcemodule WorkSpaceApplication : sig ... end

Describes the WorkSpace application.

Sourcemodule ApplicationResourceAssociation : sig ... end

Describes the association between an application and an application resource.

Sourcemodule AccountModification : sig ... end

Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.

Sourcemodule WorkspaceResourceAssociationList : sig ... end

Sourcemodule ClientDeviceType : sig ... end

Sourcemodule FailedCreateWorkspaceRequest : sig ... end

Describes a WorkSpace that cannot be created.

Sourcemodule FailedCreateStandbyWorkspacesRequest : sig ... end

Describes the standby WorkSpace that could not be created.

Sourcemodule PendingCreateStandbyWorkspacesRequest : sig ... end

Information about the standby WorkSpace.

Sourcemodule AccessDeniedException : sig ... end

The user is not authorized to access a resource.

Sourcemodule InvalidParameterValuesException : sig ... end

One or more parameter values are not valid.

Sourcemodule InvalidResourceStateException : sig ... end

The state of the resource is not valid for this operation.

Sourcemodule OperationInProgressException : sig ... end

The properties of this WorkSpace are currently being modified. Try again in a moment.

Sourcemodule OperationNotSupportedException : sig ... end

This operation is not supported.

Sourcemodule ResourceLimitExceededException : sig ... end

Your resource limits have been exceeded.

Sourcemodule ResourceNotFoundException : sig ... end

The resource could not be found.

Sourcemodule ApplicationSettingsRequest : sig ... end

The persistent application settings for WorkSpaces Pools users.

Sourcemodule Capacity : sig ... end

Describes the user capacity for a pool of WorkSpaces.

Sourcemodule ResourceUnavailableException : sig ... end

The specified resource is not available.

Sourcemodule ResourceAssociatedException : sig ... end

The resource is associated with a directory.

Sourcemodule FailedTerminateWorkspaceRequests : sig ... end

Sourcemodule TerminateWorkspaceRequests : sig ... end

Sourcemodule FailedStopWorkspaceRequests : sig ... end

Sourcemodule StopWorkspaceRequests : sig ... end

Sourcemodule FailedStartWorkspaceRequests : sig ... end

Sourcemodule StartWorkspaceRequests : sig ... end

Sourcemodule IpRevokedRuleList : sig ... end

Sourcemodule ConflictException : sig ... end

The TargetAccountId is already linked or invited.

Sourcemodule InternalServerException : sig ... end

Unexpected server error occured.

Sourcemodule ValidationException : sig ... end

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

Sourcemodule ClientToken : sig ... end

Sourcemodule ResourceAlreadyExistsException : sig ... end

The specified resource already exists.

Sourcemodule UnsupportedNetworkConfigurationException : sig ... end

The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.

Sourcemodule WorkspacesDefaultRoleNotFoundException : sig ... end

The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

Sourcemodule FailedRebuildWorkspaceRequests : sig ... end

Sourcemodule RebuildWorkspaceRequests : sig ... end

Sourcemodule FailedRebootWorkspaceRequests : sig ... end

Sourcemodule RebootWorkspaceRequests : sig ... end

Sourcemodule TargetWorkspaceState : sig ... end

Sourcemodule UnsupportedWorkspaceConfigurationException : sig ... end

The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .

Sourcemodule WorkspaceCreationProperties : sig ... end

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

Sourcemodule InvalidParameterCombinationException : sig ... end

Two or more of the selected parameter values cannot be used together.

Sourcemodule DeletableSamlPropertiesList : sig ... end

Sourcemodule DeletableCertificateBasedAuthPropertiesList : sig ... end

Sourcemodule Message : sig ... end

Sourcemodule DedicatedTenancySupportEnum : sig ... end

Sourcemodule DedicatedTenancyCidrRangeList : sig ... end

Sourcemodule PaginationToken : sig ... end

Sourcemodule ManagementCidrRangeConstraint : sig ... end

Sourcemodule ManagementCidrRangeMaxResults : sig ... end

Sourcemodule AccountLinkList : sig ... end

Sourcemodule Limit : sig ... end

Sourcemodule LinkStatusFilterList : sig ... end

Sourcemodule ApplicationList : sig ... end

Sourcemodule WorkspaceImageIngestionProcess : sig ... end

Sourcemodule CustomWorkspaceImageImportState : sig ... end

Sourcemodule CustomImageProtocol : sig ... end

Sourcemodule ImageComputeType : sig ... end

Sourcemodule ImageSourceIdentifier : sig ... end

Describes the image import source.

Sourcemodule InfrastructureConfigurationArn : sig ... end

Sourcemodule OSVersion : sig ... end

Sourcemodule Platform : sig ... end

Sourcemodule DefaultClientBrandingAttributes : sig ... end

Returns default client branding attributes that were imported. These attributes display on the client login screen. Client branding attributes are public facing. Ensure that you don't include sensitive information.

Sourcemodule IosClientBrandingAttributes : sig ... end

The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only. Client branding attributes are public facing. Ensure you do not include sensitive information.

Sourcemodule DefaultImportClientBrandingAttributes : sig ... end

The default client branding attributes to be imported. These attributes display on the client login screen. Client branding attributes are public facing. Ensure that you do not include sensitive information.

Sourcemodule IosImportClientBrandingAttributes : sig ... end

The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen. Client branding attributes are public facing. Ensure you do not include sensitive information.

Sourcemodule ResourceInUseException : sig ... end

The specified resource is currently in use.

Sourcemodule WorkspaceList : sig ... end

Sourcemodule WorkspaceIdList : sig ... end

Sourcemodule WorkspacesPools : sig ... end

Sourcemodule DescribeWorkspacesPoolsFilters : sig ... end

Sourcemodule WorkspacesPoolIds : sig ... end

Sourcemodule WorkspacesPoolSessions : sig ... end

Sourcemodule Limit50 : sig ... end

Sourcemodule WorkspaceConnectionStatusList : sig ... end

Sourcemodule SnapshotList : sig ... end

Sourcemodule WorkspaceImageList : sig ... end

Sourcemodule ImageType : sig ... end

Sourcemodule WorkspaceImageIdList : sig ... end

Sourcemodule ImagePermissions : sig ... end

Sourcemodule DirectoryList : sig ... end

Sourcemodule DescribeWorkspaceDirectoriesFilterList : sig ... end

Sourcemodule DirectoryIdList : sig ... end

Sourcemodule WorkspaceDirectoryNameList : sig ... end

Sourcemodule BundleList : sig ... end

Sourcemodule BundleIdList : sig ... end

Sourcemodule WorkSpaceAssociatedResourceTypeList : sig ... end

Sourcemodule WorkspacesIpGroupsList : sig ... end

Sourcemodule ImageResourceAssociationList : sig ... end

Sourcemodule ImageAssociatedResourceTypeList : sig ... end

Sourcemodule CustomWorkspaceImageImportErrorDetailsList : sig ... end

Sourcemodule Percentage : sig ... end

Sourcemodule WorkflowStateMessage : sig ... end

Sourcemodule ConnectionAliasList : sig ... end

Sourcemodule ConnectionAliasIdList : sig ... end

Sourcemodule ConnectionAliasPermissions : sig ... end

Sourcemodule ConnectClientAddInList : sig ... end

Sourcemodule ClientPropertiesList : sig ... end

Sourcemodule ResourceIdList : sig ... end

Sourcemodule BundleResourceAssociationList : sig ... end

Sourcemodule BundleAssociatedResourceTypeList : sig ... end

Sourcemodule WorkSpaceApplicationList : sig ... end

Sourcemodule WorkSpaceApplicationIdList : sig ... end

Sourcemodule ApplicationResourceAssociationList : sig ... end

Sourcemodule ApplicationAssociatedResourceTypeList : sig ... end

Sourcemodule DedicatedTenancyAccountType : sig ... end

Sourcemodule AccountModificationList : sig ... end

Sourcemodule IncompatibleApplicationsException : sig ... end

The specified application is not compatible with the resource.

Sourcemodule WorkSpaceApplicationDeployment : sig ... end

Describes the WorkSpace application deployment.

Sourcemodule TagKeyList : sig ... end

Sourcemodule ClientDeviceTypeList : sig ... end

Sourcemodule FailedCreateWorkspaceRequests : sig ... end

Sourcemodule WorkspaceRequestList : sig ... end

Sourcemodule WorkspaceBundleDescription : sig ... end

Sourcemodule WorkspaceBundleName : sig ... end

Sourcemodule FailedCreateStandbyWorkspacesRequestList : sig ... end

Sourcemodule PendingCreateStandbyWorkspacesRequestList : sig ... end

Sourcemodule StandbyWorkspacesList : sig ... end

Sourcemodule ResourceCreationFailedException : sig ... end

The resource could not be created.

Sourcemodule ApplicationNotSupportedException : sig ... end

The specified application is not supported.

Sourcemodule ComputeNotCompatibleException : sig ... end

The compute type of the WorkSpace is not compatible with the application.

Sourcemodule OperatingSystemNotCompatibleException : sig ... end

The operating system of the WorkSpace is not compatible with the application.

Sourcemodule UpdateWorkspacesPoolResult : sig ... end

Updates the specified pool.

Sourcemodule UpdateWorkspacesPoolRequest : sig ... end

Updates the specified pool.

Sourcemodule UpdateWorkspaceImagePermissionResult : sig ... end

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. After an image has been shared, the recipient account can copy the image to other Regions as needed. In the China (Ningxia) Region, you can copy images only within the same Region. In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image. To delete an image that has been shared, you must unshare the image before you delete it. Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

Sourcemodule UpdateWorkspaceImagePermissionRequest : sig ... end

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. After an image has been shared, the recipient account can copy the image to other Regions as needed. In the China (Ningxia) Region, you can copy images only within the same Region. In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image. To delete an image that has been shared, you must unshare the image before you delete it. Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

Sourcemodule UpdateWorkspaceBundleResult : sig ... end

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle. Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

Sourcemodule UpdateWorkspaceBundleRequest : sig ... end

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle. Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

Sourcemodule UpdateRulesOfIpGroupResult : sig ... end

Replaces the current rules of the specified IP access control group with the specified rules.

Sourcemodule UpdateRulesOfIpGroupRequest : sig ... end

Replaces the current rules of the specified IP access control group with the specified rules.

Sourcemodule UpdateConnectionAliasPermissionResult : sig ... end

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Sourcemodule UpdateConnectionAliasPermissionRequest : sig ... end

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Sourcemodule UpdateConnectClientAddInResult : sig ... end

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

Sourcemodule UpdateConnectClientAddInRequest : sig ... end

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

Sourcemodule TerminateWorkspacesResult : sig ... end

Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. 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. Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Sourcemodule TerminateWorkspacesRequest : sig ... end

Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. 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. Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Sourcemodule TerminateWorkspacesPoolSessionResult : sig ... end

Terminates the pool session.

Sourcemodule TerminateWorkspacesPoolSessionRequest : sig ... end

Terminates the pool session.

Sourcemodule TerminateWorkspacesPoolResult : sig ... end

Terminates the specified pool.

Sourcemodule TerminateWorkspacesPoolRequest : sig ... end

Terminates the specified pool.

Sourcemodule StopWorkspacesResult : sig ... end

Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Sourcemodule StopWorkspacesRequest : sig ... end

Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Sourcemodule StopWorkspacesPoolResult : sig ... end

Stops the specified pool. You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Sourcemodule StopWorkspacesPoolRequest : sig ... end

Stops the specified pool. You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Sourcemodule StartWorkspacesResult : sig ... end

Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED.

Sourcemodule StartWorkspacesRequest : sig ... end

Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED.

Sourcemodule StartWorkspacesPoolResult : sig ... end

Starts the specified pool. You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.

Sourcemodule StartWorkspacesPoolRequest : sig ... end

Starts the specified pool. You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.

Sourcemodule RevokeIpRulesResult : sig ... end

Removes one or more rules from the specified IP access control group.

Sourcemodule RevokeIpRulesRequest : sig ... end

Removes one or more rules from the specified IP access control group.

Sourcemodule RestoreWorkspaceResult : sig ... end

Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace. This operation is asynchronous and returns before the WorkSpace is completely restored.

Sourcemodule RestoreWorkspaceRequest : sig ... end

Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace. This operation is asynchronous and returns before the WorkSpace is completely restored.

Sourcemodule RejectAccountLinkInvitationResult : sig ... end

Rejects the account link invitation.

Sourcemodule RejectAccountLinkInvitationRequest : sig ... end

Rejects the account link invitation.

Sourcemodule RegisterWorkspaceDirectoryResult : sig ... end

Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

Sourcemodule RegisterWorkspaceDirectoryRequest : sig ... end

Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

Sourcemodule RebuildWorkspacesResult : sig ... end

Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

Sourcemodule RebuildWorkspacesRequest : sig ... end

Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

Sourcemodule RebootWorkspacesResult : sig ... end

Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes. This operation is asynchronous and returns before the WorkSpaces have rebooted.

Sourcemodule RebootWorkspacesRequest : sig ... end

Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes. This operation is asynchronous and returns before the WorkSpaces have rebooted.

Sourcemodule ModifyWorkspaceStateResult : sig ... end

Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

Sourcemodule ModifyWorkspaceStateRequest : sig ... end

Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

Sourcemodule ModifyWorkspacePropertiesResult : sig ... end

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace. The MANUAL running mode 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.

Sourcemodule ModifyWorkspacePropertiesRequest : sig ... end

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace. The MANUAL running mode 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.

Sourcemodule ModifyWorkspaceCreationPropertiesResult : sig ... end

Modify the default properties used to create WorkSpaces.

Sourcemodule ModifyWorkspaceCreationPropertiesRequest : sig ... end

Modify the default properties used to create WorkSpaces.

Sourcemodule ModifyWorkspaceAccessPropertiesResult : sig ... end

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

Sourcemodule ModifyWorkspaceAccessPropertiesRequest : sig ... end

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

Sourcemodule ModifyStreamingPropertiesResult : sig ... end

Modifies the specified streaming properties.

Sourcemodule ModifyStreamingPropertiesRequest : sig ... end

Modifies the specified streaming properties.

Sourcemodule ModifySelfservicePermissionsResult : sig ... end

Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

Sourcemodule ModifySelfservicePermissionsRequest : sig ... end

Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

Sourcemodule ModifySamlPropertiesResult : sig ... end

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Sourcemodule ModifySamlPropertiesRequest : sig ... end

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Sourcemodule ModifyEndpointEncryptionModeResponse : sig ... end

Modifies the endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.

Sourcemodule ModifyEndpointEncryptionModeRequest : sig ... end

Modifies the endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.

Sourcemodule ModifyClientPropertiesResult : sig ... end

Modifies the properties of the specified Amazon WorkSpaces clients.

Sourcemodule ModifyClientPropertiesRequest : sig ... end

Modifies the properties of the specified Amazon WorkSpaces clients.

Sourcemodule ModifyCertificateBasedAuthPropertiesResult : sig ... end

Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

Sourcemodule ModifyCertificateBasedAuthPropertiesRequest : sig ... end

Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

Sourcemodule ModifyAccountResult : sig ... end

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

Sourcemodule ModifyAccountRequest : sig ... end

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

Sourcemodule MigrateWorkspaceResult : sig ... end

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.

Sourcemodule MigrateWorkspaceRequest : sig ... end

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.

Sourcemodule ListAvailableManagementCidrRangesResult : sig ... end

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error. 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.

Sourcemodule ListAvailableManagementCidrRangesRequest : sig ... end

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error. 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.

Sourcemodule ListAccountLinksResult : sig ... end

Lists all account links.

Sourcemodule ListAccountLinksRequest : sig ... end

Lists all account links.

Sourcemodule ImportWorkspaceImageResult : sig ... end

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Sourcemodule ImportWorkspaceImageRequest : sig ... end

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Sourcemodule ImportCustomWorkspaceImageResult : sig ... end

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Sourcemodule ImportCustomWorkspaceImageRequest : sig ... end

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Sourcemodule ImportClientBrandingResult : sig ... end

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience You must specify at least one platform type when importing client branding. You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. Imported data can take up to a minute to appear in the WorkSpaces client.

Sourcemodule ImportClientBrandingRequest : sig ... end

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience You must specify at least one platform type when importing client branding. You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. Imported data can take up to a minute to appear in the WorkSpaces client.

Sourcemodule GetAccountLinkResult : sig ... end

Retrieves account link information.

Sourcemodule GetAccountLinkRequest : sig ... end

Retrieves account link information.

Sourcemodule DisassociateWorkspaceApplicationResult : sig ... end

Disassociates the specified application from a WorkSpace.

Sourcemodule DisassociateWorkspaceApplicationRequest : sig ... end

Disassociates the specified application from a WorkSpace.

Sourcemodule DisassociateIpGroupsResult : sig ... end

Disassociates the specified IP access control group from the specified directory.

Sourcemodule DisassociateIpGroupsRequest : sig ... end

Disassociates the specified IP access control group from the specified directory.

Sourcemodule DisassociateConnectionAliasResult : sig ... end

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Sourcemodule DisassociateConnectionAliasRequest : sig ... end

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Sourcemodule DescribeWorkspacesResult : sig ... end

Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

Sourcemodule DescribeWorkspacesRequest : sig ... end

Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

Sourcemodule DescribeWorkspacesPoolsResult : sig ... end

Describes the specified WorkSpaces Pools.

Sourcemodule DescribeWorkspacesPoolsRequest : sig ... end

Describes the specified WorkSpaces Pools.

Sourcemodule DescribeWorkspacesPoolSessionsResult : sig ... end

Retrieves a list that describes the streaming sessions for a specified pool.

Sourcemodule DescribeWorkspacesPoolSessionsRequest : sig ... end

Retrieves a list that describes the streaming sessions for a specified pool.

Sourcemodule DescribeWorkspacesConnectionStatusResult : sig ... end

Describes the connection status of the specified WorkSpaces.

Sourcemodule DescribeWorkspacesConnectionStatusRequest : sig ... end

Describes the connection status of the specified WorkSpaces.

Sourcemodule DescribeWorkspaceSnapshotsResult : sig ... end

Describes the snapshots for the specified WorkSpace.

Sourcemodule DescribeWorkspaceSnapshotsRequest : sig ... end

Describes the snapshots for the specified WorkSpace.

Sourcemodule DescribeWorkspaceImagesResult : sig ... end

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

Sourcemodule DescribeWorkspaceImagesRequest : sig ... end

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

Sourcemodule DescribeWorkspaceImagePermissionsResult : sig ... end

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

Sourcemodule DescribeWorkspaceImagePermissionsRequest : sig ... end

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

Sourcemodule DescribeWorkspaceDirectoriesResult : sig ... end

Describes the available directories that are registered with Amazon WorkSpaces.

Sourcemodule DescribeWorkspaceDirectoriesRequest : sig ... end

Describes the available directories that are registered with Amazon WorkSpaces.

Sourcemodule DescribeWorkspaceBundlesResult : sig ... end

Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.

Sourcemodule DescribeWorkspaceBundlesRequest : sig ... end

Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.

Sourcemodule DescribeWorkspaceAssociationsResult : sig ... end

Describes the associations betweens applications and the specified WorkSpace.

Sourcemodule DescribeWorkspaceAssociationsRequest : sig ... end

Describes the associations betweens applications and the specified WorkSpace.

Sourcemodule DescribeTagsResult : sig ... end

Describes the specified tags for the specified WorkSpaces resource.

Sourcemodule DescribeTagsRequest : sig ... end

Describes the specified tags for the specified WorkSpaces resource.

Sourcemodule DescribeIpGroupsResult : sig ... end

Describes one or more of your IP access control groups.

Sourcemodule DescribeIpGroupsRequest : sig ... end

Describes one or more of your IP access control groups.

Sourcemodule DescribeImageAssociationsResult : sig ... end

Describes the associations between the applications and the specified image.

Sourcemodule DescribeImageAssociationsRequest : sig ... end

Describes the associations between the applications and the specified image.

Sourcemodule DescribeCustomWorkspaceImageImportResult : sig ... end

Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.

Sourcemodule DescribeCustomWorkspaceImageImportRequest : sig ... end

Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.

Sourcemodule DescribeConnectionAliasesResult : sig ... end

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule DescribeConnectionAliasesRequest : sig ... end

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule DescribeConnectionAliasPermissionsResult : sig ... end

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule DescribeConnectionAliasPermissionsRequest : sig ... end

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule DescribeConnectClientAddInsResult : sig ... end

Retrieves a list of Amazon Connect client add-ins that have been created.

Sourcemodule DescribeConnectClientAddInsRequest : sig ... end

Retrieves a list of Amazon Connect client add-ins that have been created.

Sourcemodule DescribeClientPropertiesResult : sig ... end

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Sourcemodule DescribeClientPropertiesRequest : sig ... end

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Sourcemodule DescribeClientBrandingResult : sig ... end

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response.

Sourcemodule DescribeClientBrandingRequest : sig ... end

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response.

Sourcemodule DescribeBundleAssociationsResult : sig ... end

Describes the associations between the applications and the specified bundle.

Sourcemodule DescribeBundleAssociationsRequest : sig ... end

Describes the associations between the applications and the specified bundle.

Sourcemodule DescribeApplicationsResult : sig ... end

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Sourcemodule DescribeApplicationsRequest : sig ... end

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Sourcemodule DescribeApplicationAssociationsResult : sig ... end

Describes the associations between the application and the specified associated resources.

Sourcemodule DescribeApplicationAssociationsRequest : sig ... end

Describes the associations between the application and the specified associated resources.

Sourcemodule DescribeAccountResult : sig ... end

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

Sourcemodule DescribeAccountRequest : sig ... end

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

Sourcemodule DescribeAccountModificationsResult : sig ... end

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

Sourcemodule DescribeAccountModificationsRequest : sig ... end

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

Sourcemodule DeregisterWorkspaceDirectoryResult : sig ... end

Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory. Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Sourcemodule DeregisterWorkspaceDirectoryRequest : sig ... end

Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory. Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Sourcemodule DeployWorkspaceApplicationsResult : sig ... end

Deploys associated applications to the specified WorkSpace

Sourcemodule DeployWorkspaceApplicationsRequest : sig ... end

Deploys associated applications to the specified WorkSpace

Sourcemodule DeleteWorkspaceImageResult : sig ... end

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

Sourcemodule DeleteWorkspaceImageRequest : sig ... end

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

Sourcemodule DeleteWorkspaceBundleResult : sig ... end

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Sourcemodule DeleteWorkspaceBundleRequest : sig ... end

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Sourcemodule DeleteTagsResult : sig ... end

Deletes the specified tags from the specified WorkSpaces resource.

Sourcemodule DeleteTagsRequest : sig ... end

Deletes the specified tags from the specified WorkSpaces resource.

Sourcemodule DeleteIpGroupResult : sig ... end

Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.

Sourcemodule DeleteIpGroupRequest : sig ... end

Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.

Sourcemodule DeleteConnectionAliasResult : sig ... end

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Sourcemodule DeleteConnectionAliasRequest : sig ... end

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Sourcemodule DeleteConnectClientAddInResult : sig ... end

Deletes a client-add-in for Amazon Connect that is configured within a directory.

Sourcemodule DeleteConnectClientAddInRequest : sig ... end

Deletes a client-add-in for Amazon Connect that is configured within a directory.

Sourcemodule DeleteClientBrandingResult : sig ... end

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding.

Sourcemodule DeleteClientBrandingRequest : sig ... end

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding.

Sourcemodule DeleteAccountLinkInvitationResult : sig ... end

Deletes the account link invitation.

Sourcemodule DeleteAccountLinkInvitationRequest : sig ... end

Deletes the account link invitation.

Sourcemodule CreateWorkspacesResult : sig ... end

Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. The MANUAL running mode 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. You don't need to specify the PCOIP protocol for Linux bundles because DCV (formerly WSP) is the default protocol for those bundles. User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core. Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Sourcemodule CreateWorkspacesRequest : sig ... end

Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. The MANUAL running mode 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. You don't need to specify the PCOIP protocol for Linux bundles because DCV (formerly WSP) is the default protocol for those bundles. User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core. Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Sourcemodule CreateWorkspacesPoolResult : sig ... end

Creates a pool of WorkSpaces.

Sourcemodule CreateWorkspacesPoolRequest : sig ... end

Creates a pool of WorkSpaces.

Sourcemodule CreateWorkspaceImageResult : sig ... end

Creates a new WorkSpace image from an existing WorkSpace.

Sourcemodule CreateWorkspaceImageRequest : sig ... end

Creates a new WorkSpace image from an existing WorkSpace.

Sourcemodule CreateWorkspaceBundleResult : sig ... end

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

Sourcemodule CreateWorkspaceBundleRequest : sig ... end

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

Sourcemodule CreateUpdatedWorkspaceImageResult : sig ... end

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components. To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages. Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time. Microsoft Windows updates and other application updates are not included in the update process. The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

Sourcemodule CreateUpdatedWorkspaceImageRequest : sig ... end

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components. To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages. Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time. Microsoft Windows updates and other application updates are not included in the update process. The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

Sourcemodule CreateTagsResult : sig ... end

Creates the specified tags for the specified WorkSpaces resource.

Sourcemodule CreateTagsRequest : sig ... end

Creates the specified tags for the specified WorkSpaces resource.

Sourcemodule CreateStandbyWorkspacesResult : sig ... end

Creates a standby WorkSpace in a secondary Region.

Sourcemodule CreateStandbyWorkspacesRequest : sig ... end

Creates a standby WorkSpace in a secondary Region.

Sourcemodule CreateIpGroupResult : sig ... end

Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

Sourcemodule CreateIpGroupRequest : sig ... end

Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

Sourcemodule CreateConnectionAliasResult : sig ... end

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule CreateConnectionAliasRequest : sig ... end

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Sourcemodule CreateConnectClientAddInResult : sig ... end

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

Sourcemodule CreateConnectClientAddInRequest : sig ... end

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

Sourcemodule CreateAccountLinkInvitationResult : sig ... end

Creates the account link invitation.

Sourcemodule CreateAccountLinkInvitationRequest : sig ... end

Creates the account link invitation.

Sourcemodule CopyWorkspaceImageResult : sig ... end

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image. In the China (Ningxia) Region, you can copy images only within the same Region. In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

Sourcemodule CopyWorkspaceImageRequest : sig ... end

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image. In the China (Ningxia) Region, you can copy images only within the same Region. In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

Sourcemodule AuthorizeIpRulesResult : sig ... end

Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

Sourcemodule AuthorizeIpRulesRequest : sig ... end

Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

Sourcemodule AssociateWorkspaceApplicationResult : sig ... end

Associates the specified application to the specified WorkSpace.

Sourcemodule AssociateWorkspaceApplicationRequest : sig ... end

Associates the specified application to the specified WorkSpace.

Sourcemodule AssociateIpGroupsResult : sig ... end

Associates the specified IP access control group with the specified directory.

Sourcemodule AssociateIpGroupsRequest : sig ... end

Associates the specified IP access control group with the specified directory.

Sourcemodule AssociateConnectionAliasResult : sig ... end

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Sourcemodule AssociateConnectionAliasRequest : sig ... end

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Sourcemodule AcceptAccountLinkInvitationResult : sig ... end

Accepts the account link invitation. There's currently no unlinking capability after you accept the account linking invitation.

Sourcemodule AcceptAccountLinkInvitationRequest : sig ... end

Accepts the account link invitation. There's currently no unlinking capability after you accept the account linking invitation.