Values (p.awso.0.9.0.doc.awso.appstream.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 AgentAction : sig ... end

Sourcemodule Permission : sig ... end

Sourcemodule UrlPattern : sig ... end

A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: *, *.example.com, github.com/myorg/*, api?.example.com Invalid examples: https://example.com (no protocol), empty string

Sourcemodule Domain : sig ... end

GSuite domain for GDrive integration.

Sourcemodule String_ : sig ... end

Sourcemodule PlatformType : sig ... end

Sourcemodule S3Bucket : sig ... end

Sourcemodule S3Key : sig ... end

Sourcemodule UsageReportExecutionErrorCode : sig ... end

Sourcemodule AccessEndpointType : sig ... end

Sourcemodule AgentAccessSetting : sig ... end

A permission setting for an agent action. Each setting specifies an agent action and whether it is enabled or disabled.

Sourcemodule BooleanObject : sig ... end

Sourcemodule UrlPatternList : sig ... end

Sourcemodule StackErrorCode : sig ... end

Sourcemodule DomainList : sig ... end

Sourcemodule ResourceIdentifier : sig ... end

The ARN of the resource.

Sourcemodule StorageConnectorType : sig ... end

Sourcemodule Action : sig ... end

Sourcemodule Integer : sig ... end

Sourcemodule Arn : sig ... end

Sourcemodule Boolean : sig ... end

Sourcemodule Metadata : sig ... end

Sourcemodule Platforms : sig ... end

Sourcemodule S3Location : sig ... end

Describes the S3 location.

Sourcemodule StringList : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule FleetErrorCode : sig ... end

Sourcemodule ThemeFooterLinkDisplayName : sig ... end

Sourcemodule ThemeFooterLinkURL : sig ... end

Sourcemodule ErrorDetails : sig ... end

The error details.

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule FilterValue : sig ... end

Sourcemodule LastReportGenerationExecutionError : sig ... end

Describes the error that is returned when a usage report can't be generated.

Sourcemodule AccessEndpoint : sig ... end

Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.

Sourcemodule AgentAccessSettingList : sig ... end

Sourcemodule S3BucketArn : sig ... end

Sourcemodule ScreenImageFormat : sig ... end

Sourcemodule ScreenResolution : sig ... end

Sourcemodule SettingsGroup : sig ... end

Sourcemodule UrlRedirectionConfig : sig ... end

Configuration for URL redirection in a specific direction (host-to-client or client-to-host). When enabled, URLs matching the allowed or denied patterns are redirected accordingly. The denied list takes precedence over the allowed list.

Sourcemodule EmbedHostDomain : sig ... end

Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]

Sourcemodule StackError : sig ... end

Describes a stack error.

Sourcemodule StorageConnector : sig ... end

Describes a connector that enables persistent storage for users.

Sourcemodule PreferredProtocol : sig ... end

Sourcemodule UserSetting : sig ... end

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

Sourcemodule Application : sig ... end

Describes an application in the application catalog.

Sourcemodule ImageStateChangeReasonCode : sig ... end

Sourcemodule ResourceError : sig ... end

Describes a resource error.

Sourcemodule DirectoryName : sig ... end

Sourcemodule OrganizationalUnitDistinguishedName : sig ... end

Sourcemodule ImageBuilderStateChangeReasonCode : sig ... end

Sourcemodule SecurityGroupIdList : sig ... end

Sourcemodule SubnetIdList : sig ... end

Sourcemodule FleetError : sig ... end

Describes a fleet error.

Sourcemodule UsbDeviceFilterString : sig ... end

Sourcemodule EntitlementAttribute : sig ... end

An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to a WorkSpaces Applications SAML application.

Sourcemodule CertificateBasedAuthStatus : sig ... end

Sourcemodule AccountName : sig ... end

Sourcemodule AccountPassword : sig ... end

Sourcemodule AppBlockBuilderStateChangeReasonCode : sig ... end

Sourcemodule AuthenticationType : sig ... end

Sourcemodule Username : sig ... end

Sourcemodule ThemeFooterLink : sig ... end

The website links that display in the catalog page footer.

Sourcemodule AmiName : sig ... end

Sourcemodule Description : sig ... end

Sourcemodule ErrorDetailsList : sig ... end

Sourcemodule ExportImageTaskState : sig ... end

Sourcemodule PhotonAmiId : sig ... end

Sourcemodule Tags : sig ... end

Sourcemodule UUID : sig ... end

Sourcemodule FilterName : sig ... end

Sourcemodule FilterValues : sig ... end

Sourcemodule UserAttributeValue : sig ... end

Sourcemodule LastReportGenerationExecutionErrors : sig ... end

Sourcemodule UsageReportSchedule : sig ... end

Sourcemodule AccessEndpointList : sig ... end

Sourcemodule AgentAccessConfig : sig ... end

The configuration for agent access on a stack. Agent access enables AI agents to interact with desktop applications during streaming sessions.

Sourcemodule ApplicationSettingsResponse : sig ... end

Describes the persistent application settings for users of a stack.

Sourcemodule ContentRedirection : sig ... end

Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.

Sourcemodule EmbedHostDomains : sig ... end

Sourcemodule FeedbackURL : sig ... end

Sourcemodule RedirectURL : sig ... end

Sourcemodule StackErrors : sig ... end

Sourcemodule StorageConnectorList : sig ... end

Sourcemodule StreamingExperienceSettings : sig ... end

The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

Sourcemodule UserSettingList : sig ... end

Sourcemodule SoftwareDeploymentStatus : sig ... end

Sourcemodule InstanceDrainStatus : sig ... end

Sourcemodule NetworkAccessConfiguration : sig ... end

Describes the network details of the fleet or image builder instance.

Sourcemodule SessionConnectionState : sig ... end

Sourcemodule SessionState : sig ... end

Sourcemodule UserId : sig ... end

Sourcemodule Applications : sig ... end

Sourcemodule AppstreamAgentVersion : sig ... end

Sourcemodule DynamicAppProvidersEnabled : sig ... end

Sourcemodule ImagePermissions : sig ... end

Describes the permissions for an image.

Sourcemodule ImageSharedWithOthers : sig ... end

Sourcemodule ImageState : sig ... end

Sourcemodule ImageStateChangeReason : sig ... end

Describes the reason why the last image state change occurred.

Sourcemodule ImageType : sig ... end

Sourcemodule LatestAppstreamAgentVersion : sig ... end

Sourcemodule ResourceErrors : sig ... end

Sourcemodule VisibilityType : sig ... end

Sourcemodule AwsAccountId : sig ... end

Sourcemodule DomainJoinInfo : sig ... end

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Sourcemodule ImageBuilderState : sig ... end

Sourcemodule ImageBuilderStateChangeReason : sig ... end

Describes the reason why the last image builder state change occurred.

Sourcemodule VolumeConfig : sig ... end

Configuration for the root volume of fleet instances and image builders. This allows you to customize the storage capacity beyond the default 200 GB.

Sourcemodule VpcConfig : sig ... end

Describes VPC configuration information for fleets and image builders.

Sourcemodule ComputeCapacityStatus : sig ... end

Describes the capacity status for a fleet.

Sourcemodule FleetErrors : sig ... end

Sourcemodule FleetState : sig ... end

Sourcemodule FleetType : sig ... end

Sourcemodule StreamView : sig ... end

Sourcemodule UsbDeviceFilterStrings : sig ... end

Sourcemodule AppVisibility : sig ... end

Sourcemodule EntitlementAttributeList : sig ... end

Sourcemodule Name : sig ... end

Sourcemodule CertificateBasedAuthProperties : sig ... end

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

Sourcemodule OrganizationalUnitDistinguishedNamesList : sig ... end

Sourcemodule ServiceAccountCredentials : sig ... end

Describes the credentials for the service account used by the fleet or image builder to connect to the directory.

Sourcemodule AppBlockState : sig ... end

Sourcemodule PackagingType : sig ... end

Sourcemodule ScriptDetails : sig ... end

Describes the details of the script.

Sourcemodule AppBlockBuilderPlatformType : sig ... end

Sourcemodule AppBlockBuilderState : sig ... end

Sourcemodule AppBlockBuilderStateChangeReason : sig ... end

Describes the reason why the last app block builder state change occurred.

Sourcemodule AppDisplayName : sig ... end

Sourcemodule AppName : sig ... end

Sourcemodule FilePath : sig ... end

Sourcemodule LaunchParameters : sig ... end

Sourcemodule UserStackAssociation : sig ... end

Describes a user in the user pool and the associated stack.

Sourcemodule UserStackAssociationErrorCode : sig ... end

Sourcemodule ErrorMessage : sig ... end

The error message in the exception.

Sourcemodule ThemeFooterLinks : sig ... end

Sourcemodule ThemeState : sig ... end

Sourcemodule ThemeStyling : sig ... end

Sourcemodule ThemeTitleText : sig ... end

Sourcemodule ThemeAttribute : sig ... end

Sourcemodule StackAttribute : sig ... end

Sourcemodule FleetAttribute : sig ... end

Sourcemodule ApplicationAttribute : sig ... end

Sourcemodule AppBlockBuilderAttribute : sig ... end

Sourcemodule ExportImageTask : sig ... end

Information about an export image task, including its current state, timestamps, and any error details.

Sourcemodule Filter : sig ... end

A filter for narrowing down the results when listing export image tasks. Filters allow you to specify criteria such as task state or creation date.

Sourcemodule EntitledApplication : sig ... end

The application associated to an entitlement. Access is controlled based on user attributes.

Sourcemodule User : sig ... end

Describes a user in the user pool.

Sourcemodule UsageReportSubscription : sig ... end

Describes information about the usage report subscription.

Sourcemodule Stack : sig ... end

Describes a stack.

Sourcemodule SoftwareAssociations : sig ... end

The association between a license-included application and a resource.

Sourcemodule Session : sig ... end

Describes a streaming session.

Sourcemodule Image : sig ... end

Describes an image.

Sourcemodule SharedImagePermissions : sig ... end

Describes the permissions that are available to the specified AWS account for a shared image.

Sourcemodule ImageBuilder : sig ... end

Describes a virtual machine that is used to create an image.

Sourcemodule Fleet : sig ... end

Describes a fleet.

Sourcemodule Entitlement : sig ... end

Specifies an entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. WorkSpaces Applications user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

Sourcemodule DirectoryConfig : sig ... end

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Sourcemodule ApplicationFleetAssociation : sig ... end

Describes the application fleet association.

Sourcemodule AdminAppLicenseUsageRecord : sig ... end

The collection of license usage records.

Sourcemodule AppBlock : sig ... end

Describes an app block. App blocks are a WorkSpaces Applications resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets.

Sourcemodule AppBlockBuilder : sig ... end

Describes an app block builder.

Sourcemodule AppBlockBuilderAppBlockAssociation : sig ... end

Describes an association between an app block builder and app block.

Sourcemodule ApplicationConfig : sig ... end

Configuration for an application in the imported image's application catalog. This structure defines how applications appear and launch for users.

Sourcemodule InstanceType : sig ... end

Sourcemodule UserStackAssociationError : sig ... end

Describes the error that is returned when a user can’t be associated with or disassociated from a stack.

Sourcemodule ConcurrentModificationException : sig ... end

An API error occurred. Wait a few minutes and try again.

Sourcemodule InvalidAccountStatusException : sig ... end

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

Sourcemodule InvalidParameterCombinationException : sig ... end

Indicates an incorrect combination of parameters, or a missing parameter.

Sourcemodule LimitExceededException : sig ... end

The requested limit exceeds the permitted limit for an account.

Sourcemodule OperationNotPermittedException : sig ... end

The attempted operation is not permitted.

Sourcemodule ResourceNotFoundException : sig ... end

The specified resource was not found.

Sourcemodule Theme : sig ... end

The custom branding theme, which might include a custom logo, website links, and other branding to display to users.

Sourcemodule ThemeAttributes : sig ... end

Sourcemodule IncompatibleImageException : sig ... end

The image can't be updated because it's not compatible for updates.

Sourcemodule InvalidRoleException : sig ... end

The specified role is invalid.

Sourcemodule ResourceInUseException : sig ... end

The specified resource is in use.

Sourcemodule AgentAccessConfigForUpdate : sig ... end

The configuration for updating agent access on a stack. This type supports partial updates, so you only need to specify the fields you want to change.

Sourcemodule ApplicationSettings : sig ... end

The persistent application settings for users of a stack.

Sourcemodule DisplayName : sig ... end

Sourcemodule StackAttributes : sig ... end

Sourcemodule ResourceNotAvailableException : sig ... end

The specified resource exists and is not in use, but isn't available.

Sourcemodule RequestLimitExceededException : sig ... end

WorkSpaces Applications can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

Sourcemodule ComputeCapacity : sig ... end

Describes the capacity for a fleet.

Sourcemodule FleetAttributes : sig ... end

Sourcemodule EntitlementNotFoundException : sig ... end

The entitlement can't be found.

Sourcemodule ApplicationAttributes : sig ... end

Sourcemodule AppBlockBuilderAttributes : sig ... end

Sourcemodule TagKeyList : sig ... end

Sourcemodule ExportImageTasks : sig ... end

Sourcemodule Filters : sig ... end

Sourcemodule MaxResults : sig ... end

Sourcemodule EntitledApplicationList : sig ... end

Sourcemodule UserList : sig ... end

Sourcemodule UserStackAssociationList : sig ... end

Sourcemodule UsageReportSubscriptionList : sig ... end

Sourcemodule StackList : sig ... end

Sourcemodule SoftwareAssociationsList : sig ... end

Sourcemodule SessionList : sig ... end

Sourcemodule ImageList : sig ... end

Sourcemodule ArnList : sig ... end

Sourcemodule DescribeImagesMaxResults : sig ... end

Sourcemodule SharedImagePermissionsList : sig ... end

Sourcemodule AwsAccountIdList : sig ... end

Sourcemodule ImageBuilderList : sig ... end

Sourcemodule FleetList : sig ... end

Sourcemodule EntitlementList : sig ... end

Sourcemodule DirectoryConfigList : sig ... end

Sourcemodule DirectoryNameList : sig ... end

Sourcemodule ApplicationFleetAssociationList : sig ... end

Sourcemodule AdminAppLicenseUsageList : sig ... end

Sourcemodule AppBlocks : sig ... end

Sourcemodule AppBlockBuilderList : sig ... end

Sourcemodule AppBlockBuilderAppBlockAssociationsList : sig ... end

Sourcemodule ResourceAlreadyExistsException : sig ... end

The specified resource already exists.

Sourcemodule MessageAction : sig ... end

Sourcemodule Long : sig ... end

Sourcemodule StreamingUrlUserId : sig ... end

Sourcemodule DryRunOperationException : sig ... end

The exception that is thrown when a dry run operation is requested. This indicates that the validation checks have been performed successfully, but no actual resources were created or modified.

Sourcemodule AgentSoftwareVersion : sig ... end

Sourcemodule AppCatalogConfig : sig ... end

Sourcemodule ImageImportDescription : sig ... end

Sourcemodule ImageImportDisplayName : sig ... end

Sourcemodule RuntimeValidationConfig : sig ... end

Configuration for runtime validation of imported images. This structure specifies the instance type to use for testing the imported image's streaming capabilities.

Sourcemodule EntitlementAlreadyExistsException : sig ... end

The entitlement already exists.

Sourcemodule RegionName : sig ... end

Sourcemodule UserStackAssociationErrorList : sig ... end

Sourcemodule UpdateThemeForStackResult : sig ... end

Updates custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule UpdateThemeForStackRequest : sig ... end

Updates custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule UpdateStackResult : sig ... end

Updates the specified fields for the specified stack.

Sourcemodule UpdateStackRequest : sig ... end

Updates the specified fields for the specified stack.

Sourcemodule UpdateImagePermissionsResult : sig ... end

Adds or updates permissions for the specified private image.

Sourcemodule UpdateImagePermissionsRequest : sig ... end

Adds or updates permissions for the specified private image.

Sourcemodule UpdateFleetResult : sig ... end

Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the following based on the fleet type: Always-On and On-Demand fleet types You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. Elastic fleet type You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes. If the fleet is in the STARTING or STOPPED state, you can't update it.

Sourcemodule UpdateFleetRequest : sig ... end

Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the following based on the fleet type: Always-On and On-Demand fleet types You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. Elastic fleet type You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes. If the fleet is in the STARTING or STOPPED state, you can't update it.

Sourcemodule UpdateEntitlementResult : sig ... end

Updates the specified entitlement.

Sourcemodule UpdateEntitlementRequest : sig ... end

Updates the specified entitlement.

Sourcemodule UpdateDirectoryConfigResult : sig ... end

Updates the specified Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Sourcemodule UpdateDirectoryConfigRequest : sig ... end

Updates the specified Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Sourcemodule UpdateApplicationResult : sig ... end

Updates the specified application.

Sourcemodule UpdateApplicationRequest : sig ... end

Updates the specified application.

Sourcemodule UpdateAppBlockBuilderResult : sig ... end

Updates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.

Sourcemodule UpdateAppBlockBuilderRequest : sig ... end

Updates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.

Sourcemodule UntagResourceResponse : sig ... end

Disassociates one or more specified tags from the specified WorkSpaces Applications resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule UntagResourceRequest : sig ... end

Disassociates one or more specified tags from the specified WorkSpaces Applications resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule TagResourceResponse : sig ... end

Adds or overwrites one or more tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule TagResourceRequest : sig ... end

Adds or overwrites one or more tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule StopImageBuilderResult : sig ... end

Stops the specified image builder.

Sourcemodule StopImageBuilderRequest : sig ... end

Stops the specified image builder.

Sourcemodule StopFleetResult : sig ... end

Stops the specified fleet.

Sourcemodule StopFleetRequest : sig ... end

Stops the specified fleet.

Sourcemodule StopAppBlockBuilderResult : sig ... end

Stops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted.

Sourcemodule StopAppBlockBuilderRequest : sig ... end

Stops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted.

Sourcemodule StartSoftwareDeploymentToImageBuilderResult : sig ... end

Initiates license included applications deployment to an image builder instance.

Sourcemodule StartSoftwareDeploymentToImageBuilderRequest : sig ... end

Initiates license included applications deployment to an image builder instance.

Sourcemodule StartImageBuilderResult : sig ... end

Starts the specified image builder.

Sourcemodule StartImageBuilderRequest : sig ... end

Starts the specified image builder.

Sourcemodule StartFleetResult : sig ... end

Starts the specified fleet.

Sourcemodule StartFleetRequest : sig ... end

Starts the specified fleet.

Sourcemodule StartAppBlockBuilderResult : sig ... end

Starts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.

Sourcemodule StartAppBlockBuilderRequest : sig ... end

Starts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.

Sourcemodule ListTagsForResourceResponse : sig ... end

Retrieves a list of all tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule ListTagsForResourceRequest : sig ... end

Retrieves a list of all tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule ListExportImageTasksResult : sig ... end

Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.

Sourcemodule ListExportImageTasksRequest : sig ... end

Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.

Sourcemodule ListEntitledApplicationsResult : sig ... end

Retrieves a list of entitled applications.

Sourcemodule ListEntitledApplicationsRequest : sig ... end

Retrieves a list of entitled applications.

Sourcemodule ListAssociatedStacksResult : sig ... end

Retrieves the name of the stack with which the specified fleet is associated.

Sourcemodule ListAssociatedStacksRequest : sig ... end

Retrieves the name of the stack with which the specified fleet is associated.

Sourcemodule ListAssociatedFleetsResult : sig ... end

Retrieves the name of the fleet that is associated with the specified stack.

Sourcemodule ListAssociatedFleetsRequest : sig ... end

Retrieves the name of the fleet that is associated with the specified stack.

Sourcemodule GetExportImageTaskResult : sig ... end

Retrieves information about an export image task, including its current state, progress, and any error details.

Sourcemodule GetExportImageTaskRequest : sig ... end

Retrieves information about an export image task, including its current state, progress, and any error details.

Sourcemodule ExpireSessionResult : sig ... end

Immediately stops the specified streaming session.

Sourcemodule ExpireSessionRequest : sig ... end

Immediately stops the specified streaming session.

Sourcemodule EnableUserResult : sig ... end

Enables a user in the user pool. After being enabled, users can sign in to WorkSpaces Applications and open applications from the stacks to which they are assigned.

Sourcemodule EnableUserRequest : sig ... end

Enables a user in the user pool. After being enabled, users can sign in to WorkSpaces Applications and open applications from the stacks to which they are assigned.

Sourcemodule DrainSessionInstanceResult : sig ... end

Drains the instance hosting the specified streaming session. The instance stops accepting new sessions while existing sessions continue uninterrupted. Once all sessions end, the instance is reclaimed and replaced. This only applies to multi-session fleets.

Sourcemodule DrainSessionInstanceRequest : sig ... end

Drains the instance hosting the specified streaming session. The instance stops accepting new sessions while existing sessions continue uninterrupted. Once all sessions end, the instance is reclaimed and replaced. This only applies to multi-session fleets.

Sourcemodule DisassociateSoftwareFromImageBuilderResult : sig ... end

Removes license included application(s) association(s) from an image builder instance.

Sourcemodule DisassociateSoftwareFromImageBuilderRequest : sig ... end

Removes license included application(s) association(s) from an image builder instance.

Sourcemodule DisassociateFleetResult : sig ... end

Disassociates the specified fleet from the specified stack.

Sourcemodule DisassociateFleetRequest : sig ... end

Disassociates the specified fleet from the specified stack.

Sourcemodule DisassociateApplicationFromEntitlementResult : sig ... end

Deletes the specified application from the specified entitlement.

Sourcemodule DisassociateApplicationFromEntitlementRequest : sig ... end

Deletes the specified application from the specified entitlement.

Sourcemodule DisassociateApplicationFleetResult : sig ... end

Disassociates the specified application from the fleet.

Sourcemodule DisassociateApplicationFleetRequest : sig ... end

Disassociates the specified application from the fleet.

Sourcemodule DisassociateAppBlockBuilderAppBlockResult : sig ... end

Disassociates a specified app block builder from a specified app block.

Sourcemodule DisassociateAppBlockBuilderAppBlockRequest : sig ... end

Disassociates a specified app block builder from a specified app block.

Sourcemodule DisableUserResult : sig ... end

Disables the specified user in the user pool. Users can't sign in to WorkSpaces Applications until they are re-enabled. This action does not delete the user.

Sourcemodule DisableUserRequest : sig ... end

Disables the specified user in the user pool. Users can't sign in to WorkSpaces Applications until they are re-enabled. This action does not delete the user.

Sourcemodule DescribeUsersResult : sig ... end

Retrieves a list that describes one or more specified users in the user pool.

Sourcemodule DescribeUsersRequest : sig ... end

Retrieves a list that describes one or more specified users in the user pool.

Sourcemodule DescribeUserStackAssociationsResult : sig ... end

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user

Sourcemodule DescribeUserStackAssociationsRequest : sig ... end

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user

Sourcemodule DescribeUsageReportSubscriptionsResult : sig ... end

Retrieves a list that describes one or more usage report subscriptions.

Sourcemodule DescribeUsageReportSubscriptionsRequest : sig ... end

Retrieves a list that describes one or more usage report subscriptions.

Sourcemodule DescribeThemeForStackResult : sig ... end

Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule DescribeThemeForStackRequest : sig ... end

Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule DescribeStacksResult : sig ... end

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

Sourcemodule DescribeStacksRequest : sig ... end

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

Sourcemodule DescribeSoftwareAssociationsResult : sig ... end

Retrieves license included application associations for a specified resource.

Sourcemodule DescribeSoftwareAssociationsRequest : sig ... end

Retrieves license included application associations for a specified resource.

Sourcemodule DescribeSessionsResult : sig ... end

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Sourcemodule DescribeSessionsRequest : sig ... end

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Sourcemodule DescribeImagesResult : sig ... end

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

Sourcemodule DescribeImagesRequest : sig ... end

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

Sourcemodule DescribeImagePermissionsResult : sig ... end

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

Sourcemodule DescribeImagePermissionsRequest : sig ... end

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

Sourcemodule DescribeImageBuildersResult : sig ... end

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

Sourcemodule DescribeImageBuildersRequest : sig ... end

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

Sourcemodule DescribeFleetsResult : sig ... end

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

Sourcemodule DescribeFleetsRequest : sig ... end

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

Sourcemodule DescribeEntitlementsResult : sig ... end

Retrieves a list that describes one of more entitlements.

Sourcemodule DescribeEntitlementsRequest : sig ... end

Retrieves a list that describes one of more entitlements.

Sourcemodule DescribeDirectoryConfigsResult : sig ... end

Retrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

Sourcemodule DescribeDirectoryConfigsRequest : sig ... end

Retrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

Sourcemodule DescribeApplicationsResult : sig ... end

Retrieves a list that describes one or more applications.

Sourcemodule DescribeApplicationsRequest : sig ... end

Retrieves a list that describes one or more applications.

Sourcemodule DescribeApplicationFleetAssociationsResult : sig ... end

Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.

Sourcemodule DescribeApplicationFleetAssociationsRequest : sig ... end

Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.

Sourcemodule DescribeAppLicenseUsageResult : sig ... end

Retrieves license included application usage information.

Sourcemodule DescribeAppLicenseUsageRequest : sig ... end

Retrieves license included application usage information.

Sourcemodule DescribeAppBlocksResult : sig ... end

Retrieves a list that describes one or more app blocks.

Sourcemodule DescribeAppBlocksRequest : sig ... end

Retrieves a list that describes one or more app blocks.

Sourcemodule DescribeAppBlockBuildersResult : sig ... end

Retrieves a list that describes one or more app block builders.

Sourcemodule DescribeAppBlockBuildersRequest : sig ... end

Retrieves a list that describes one or more app block builders.

Sourcemodule DescribeAppBlockBuilderAppBlockAssociationsResult : sig ... end

Retrieves a list that describes one or more app block builder associations.

Sourcemodule DescribeAppBlockBuilderAppBlockAssociationsRequest : sig ... end

Retrieves a list that describes one or more app block builder associations.

Sourcemodule DeleteUserResult : sig ... end

Deletes a user from the user pool.

Sourcemodule DeleteUserRequest : sig ... end

Deletes a user from the user pool.

Sourcemodule DeleteUsageReportSubscriptionResult : sig ... end

Disables usage report generation.

Sourcemodule DeleteUsageReportSubscriptionRequest : sig ... end

Disables usage report generation.

Sourcemodule DeleteThemeForStackResult : sig ... end

Deletes custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule DeleteThemeForStackRequest : sig ... end

Deletes custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule DeleteStackResult : sig ... end

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

Sourcemodule DeleteStackRequest : sig ... end

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

Sourcemodule DeleteImageResult : sig ... end

Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.

Sourcemodule DeleteImageRequest : sig ... end

Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.

Sourcemodule DeleteImagePermissionsResult : sig ... end

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

Sourcemodule DeleteImagePermissionsRequest : sig ... end

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

Sourcemodule DeleteImageBuilderResult : sig ... end

Deletes the specified image builder and releases the capacity.

Sourcemodule DeleteImageBuilderRequest : sig ... end

Deletes the specified image builder and releases the capacity.

Sourcemodule DeleteFleetResult : sig ... end

Deletes the specified fleet.

Sourcemodule DeleteFleetRequest : sig ... end

Deletes the specified fleet.

Sourcemodule DeleteEntitlementResult : sig ... end

Deletes the specified entitlement.

Sourcemodule DeleteEntitlementRequest : sig ... end

Deletes the specified entitlement.

Sourcemodule DeleteDirectoryConfigResult : sig ... end

Deletes the specified Directory Config object from WorkSpaces Applications. This object includes the information required to join streaming instances to an Active Directory domain.

Sourcemodule DeleteDirectoryConfigRequest : sig ... end

Deletes the specified Directory Config object from WorkSpaces Applications. This object includes the information required to join streaming instances to an Active Directory domain.

Sourcemodule DeleteApplicationResult : sig ... end

Deletes an application.

Sourcemodule DeleteApplicationRequest : sig ... end

Deletes an application.

Sourcemodule DeleteAppBlockResult : sig ... end

Deletes an app block.

Sourcemodule DeleteAppBlockRequest : sig ... end

Deletes an app block.

Sourcemodule DeleteAppBlockBuilderResult : sig ... end

Deletes an app block builder. An app block builder can only be deleted when it has no association with an app block.

Sourcemodule DeleteAppBlockBuilderRequest : sig ... end

Deletes an app block builder. An app block builder can only be deleted when it has no association with an app block.

Sourcemodule CreateUserResult : sig ... end

Creates a new user in the user pool.

Sourcemodule CreateUserRequest : sig ... end

Creates a new user in the user pool.

Sourcemodule CreateUsageReportSubscriptionResult : sig ... end

Creates a usage report subscription. Usage reports are generated daily.

Sourcemodule CreateUsageReportSubscriptionRequest : sig ... end

Creates a usage report subscription. Usage reports are generated daily.

Sourcemodule CreateUpdatedImageResult : sig ... end

Creates a new image with the latest Windows operating system updates, driver updates, and WorkSpaces Applications agent software. For more information, see the "Update an Image by Using Managed WorkSpaces Applications Image Updates" section in Administer Your WorkSpaces Applications Images, in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule CreateUpdatedImageRequest : sig ... end

Creates a new image with the latest Windows operating system updates, driver updates, and WorkSpaces Applications agent software. For more information, see the "Update an Image by Using Managed WorkSpaces Applications Image Updates" section in Administer Your WorkSpaces Applications Images, in the Amazon WorkSpaces Applications Administration Guide.

Sourcemodule CreateThemeForStackResult : sig ... end

Creates custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule CreateThemeForStackRequest : sig ... end

Creates custom branding that customizes the appearance of the streaming application catalog page.

Sourcemodule CreateStreamingURLResult : sig ... end

Creates a temporary URL to start an WorkSpaces Applications streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.

Sourcemodule CreateStreamingURLRequest : sig ... end

Creates a temporary URL to start an WorkSpaces Applications streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.

Sourcemodule CreateStackResult : sig ... end

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Sourcemodule CreateStackRequest : sig ... end

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Sourcemodule CreateImportedImageResult : sig ... end

Creates a custom WorkSpaces Applications image by importing an EC2 AMI. This allows you to use your own customized AMI to create WorkSpaces Applications images that support additional instance types beyond the standard stream.* instances.

Sourcemodule CreateImportedImageRequest : sig ... end

Creates a custom WorkSpaces Applications image by importing an EC2 AMI. This allows you to use your own customized AMI to create WorkSpaces Applications images that support additional instance types beyond the standard stream.* instances.

Sourcemodule CreateImageBuilderStreamingURLResult : sig ... end

Creates a URL to start an image builder streaming session.

Sourcemodule CreateImageBuilderStreamingURLRequest : sig ... end

Creates a URL to start an image builder streaming session.

Sourcemodule CreateImageBuilderResult : sig ... end

Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Sourcemodule CreateImageBuilderRequest : sig ... end

Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Sourcemodule CreateFleetResult : sig ... end

Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.

Sourcemodule CreateFleetRequest : sig ... end

Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.

Sourcemodule CreateExportImageTaskResult : sig ... end

Creates a task to export a WorkSpaces Applications image to an EC2 AMI. This allows you to use your customized WorkSpaces Applications images with other AWS services or for backup purposes.

Sourcemodule CreateExportImageTaskRequest : sig ... end

Creates a task to export a WorkSpaces Applications image to an EC2 AMI. This allows you to use your customized WorkSpaces Applications images with other AWS services or for backup purposes.

Sourcemodule CreateEntitlementResult : sig ... end

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. WorkSpaces Applications user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

Sourcemodule CreateEntitlementRequest : sig ... end

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. WorkSpaces Applications user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

Sourcemodule CreateDirectoryConfigResult : sig ... end

Creates a Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Sourcemodule CreateDirectoryConfigRequest : sig ... end

Creates a Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Sourcemodule CreateApplicationResult : sig ... end

Creates an application. Applications are a WorkSpaces Applications resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch. This is only supported for Elastic fleets.

Sourcemodule CreateApplicationRequest : sig ... end

Creates an application. Applications are a WorkSpaces Applications resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch. This is only supported for Elastic fleets.

Sourcemodule CreateAppBlockResult : sig ... end

Creates an app block. App blocks are a WorkSpaces Applications resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets.

Sourcemodule CreateAppBlockRequest : sig ... end

Creates an app block. App blocks are a WorkSpaces Applications resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets.

Sourcemodule CreateAppBlockBuilderStreamingURLResult : sig ... end

Creates a URL to start a create app block builder streaming session.

Sourcemodule CreateAppBlockBuilderStreamingURLRequest : sig ... end

Creates a URL to start a create app block builder streaming session.

Sourcemodule CreateAppBlockBuilderResult : sig ... end

Creates an app block builder.

Sourcemodule CreateAppBlockBuilderRequest : sig ... end

Creates an app block builder.

Sourcemodule CopyImageResponse : sig ... end

Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

Sourcemodule CopyImageRequest : sig ... end

Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

Sourcemodule BatchDisassociateUserStackResult : sig ... end

Disassociates the specified users from the specified stacks.

Sourcemodule BatchDisassociateUserStackRequest : sig ... end

Disassociates the specified users from the specified stacks.

Sourcemodule BatchAssociateUserStackResult : sig ... end

Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.

Sourcemodule BatchAssociateUserStackRequest : sig ... end

Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.

Sourcemodule AssociateSoftwareToImageBuilderResult : sig ... end

Associates license included application(s) with an existing image builder instance.

Sourcemodule AssociateSoftwareToImageBuilderRequest : sig ... end

Associates license included application(s) with an existing image builder instance.

Sourcemodule AssociateFleetResult : sig ... end

Associates the specified fleet with the specified stack.

Sourcemodule AssociateFleetRequest : sig ... end

Associates the specified fleet with the specified stack.

Sourcemodule AssociateApplicationToEntitlementResult : sig ... end

Associates an application to entitle.

Sourcemodule AssociateApplicationToEntitlementRequest : sig ... end

Associates an application to entitle.

Sourcemodule AssociateApplicationFleetResult : sig ... end

Associates the specified application with the specified fleet. This is only supported for Elastic fleets.

Sourcemodule AssociateApplicationFleetRequest : sig ... end

Associates the specified application with the specified fleet. This is only supported for Elastic fleets.

Sourcemodule AssociateAppBlockBuilderAppBlockResult : sig ... end

Associates the specified app block builder with the specified app block.

Sourcemodule AssociateAppBlockBuilderAppBlockRequest : sig ... end

Associates the specified app block builder with the specified app block.