Smaws_Client_AppStream.Typestype nonrec subnet_id_list = string_ listtype nonrec security_group_id_list = string_ listtype nonrec vpc_config = {security_group_ids : security_group_id_list option;The identifiers of the security groups for the fleet or image builder.
*)subnet_ids : subnet_id_list option;The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
*)}Describes VPC configuration information for fleets and image builders.
type nonrec volume_config = {volume_size_in_gb : integer option;The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
*)}Configuration for the root volume of fleet instances and image builders. This allows you to customize the storage capacity beyond the default 200 GB.
type nonrec user_stack_association = {send_email_notification : boolean_ option;Specifies whether a welcome email is sent to a user after the user is created in the user pool.
*)authentication_type : authentication_type;The authentication type for the user.
*)user_name : username;The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
*)stack_name : string_;The name of the stack that is associated with the user.
*)}Describes a user in the user pool and the associated stack.
type nonrec user_stack_association_list = user_stack_association listtype nonrec user_stack_association_error = {error_message : string_ option;The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
*)error_code : user_stack_association_error_code option;The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
*)user_stack_association : user_stack_association option;Information about the user and associated stack.
*)}Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
type nonrec user_stack_association_error_list =
user_stack_association_error listtype nonrec user_setting = {maximum_length : integer option;Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.
This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.
The value can be between 1 and 20,971,520 (20 MB).
*)permission : permission;Indicates whether the action is enabled or disabled.
*)action : action;The action that is enabled or disabled.
*)}Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
type nonrec user_setting_list = user_setting listtype nonrec user = {authentication_type : authentication_type;The authentication type for the user.
*)created_time : timestamp option;The date and time the user was created in the user pool.
*)last_name : user_attribute_value option;The last name, or surname, of the user.
*)first_name : user_attribute_value option;The first name, or given name, of the user.
*)status : string_ option;The status of the user in the user pool. The status can be one of the following:
enabled : boolean_ option;Specifies whether the user in the user pool is enabled.
*)user_name : username option;The email address of the user.
Users' email addresses are case-sensitive.
*)arn : arn option;The ARN of the user.
*)}Describes a user in the user pool.
type nonrec user_list = user listThe user control mode for agent sessions.
type nonrec usb_device_filter_strings = usb_device_filter_string listtype nonrec last_report_generation_execution_error = {error_message : string_ option;The error message for the error that is returned when a usage report can't be generated.
*)error_code : usage_report_execution_error_code option;The error code for the error that is returned when a usage report can't be generated.
*)}Describes the error that is returned when a usage report can't be generated.
type nonrec last_report_generation_execution_errors =
last_report_generation_execution_error listtype nonrec usage_report_subscription = {subscription_errors : last_report_generation_execution_errors option;The errors that were returned if usage reports couldn't be generated.
*)last_generated_report_date : timestamp option;The time when the last usage report was generated.
*)schedule : usage_report_schedule option;The schedule for generating usage reports.
*)s3_bucket_name : string_ option;The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, WorkSpaces Applications created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, WorkSpaces Applications uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, WorkSpaces Applications creates a new S3 bucket.
*)}Describes information about the usage report subscription.
type nonrec usage_report_subscription_list = usage_report_subscription listtype nonrec url_pattern_list = url_pattern listtype nonrec url_redirection_config = {denied_urls : url_pattern_list option;List of URL patterns that are denied from redirection. This list takes precedence over the allowed list.
*)allowed_urls : url_pattern_list option;List of URL patterns that are allowed to be redirected. URLs matching these patterns will be redirected unless they also match a pattern in the denied list.
*)enabled : boolean_object;Whether URL redirection is enabled for this direction.
*)}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.
The website links that display in the catalog page footer.
type nonrec theme = {created_time : timestamp option;The time the theme was created.
*)theme_favicon_ur_l : string_ option;The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
*)theme_organization_logo_ur_l : string_ option;The URL of the logo that displays in the catalog page header.
*)theme_styling : theme_styling option;The color that is used for the website links, text, buttons, and catalog page background.
*)theme_title_text : theme_title_text option;The browser tab page title.
*)state : theme_state option;The state of the theme.
*)stack_name : name option;The stack that has the custom branding theme.
*)}The custom branding theme, which might include a custom logo, website links, and other branding to display to users.
type nonrec update_theme_for_stack_result = {theme : theme option;The theme object that contains the metadata of the custom branding.
*)}type nonrec s3_location = {s3_key : s3_key option;The S3 key of the S3 object.
This is required when used for the following:
CUSTOM PackagingType (Actions: CreateAppBlock)APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)s3_bucket : s3_bucket;The S3 bucket of the S3 object.
*)}Describes the S3 location.
type nonrec theme_attributes = theme_attribute listtype nonrec update_theme_for_stack_request = {attributes_to_delete : theme_attributes option;The attributes to delete.
*)state : theme_state option;Specifies whether custom branding should be applied to catalog page or not.
*)favicon_s3_location : s3_location option;The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.
*)organization_logo_s3_location : s3_location option;The organization logo that appears on the streaming application catalog page.
*)theme_styling : theme_styling option;The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.
*)title_text : theme_title_text option;The title that is displayed at the top of the browser tab during users' application streaming sessions.
*)stack_name : name;The name of the stack for the theme.
*)}The specified resource was not found.
The attempted operation is not permitted.
The requested limit exceeds the permitted limit for an account.
Indicates an incorrect combination of parameters, or a missing parameter.
The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
An API error occurred. Wait a few minutes and try again.
The type of storage connector.
type nonrec domain_list = domain listtype nonrec storage_connector = {domains_require_admin_consent : domain_list option;The OneDrive for Business domains where you require admin consent when users try to link their OneDrive account to WorkSpaces Applications. The attribute can only be specified when ConnectorType=ONE_DRIVE.
*)domains : domain_list option;The names of the domains for the account.
*)resource_identifier : resource_identifier option;The ARN of the storage connector.
*)connector_type : storage_connector_type;The type of storage connector.
*)}Describes a connector that enables persistent storage for users.
type nonrec storage_connector_list = storage_connector listtype nonrec stack_error = {error_message : string_ option;The error message.
*)error_code : stack_error_code option;The error code.
*)}Describes a stack error.
type nonrec stack_errors = stack_error listtype nonrec application_settings_response = {s3_bucket_name : string_ option;The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
*)settings_group : settings_group option;The path prefix for the S3 bucket where users’ persistent application settings are stored.
*)enabled : boolean_ option;Specifies whether persistent application settings are enabled for users during their streaming sessions.
*)}Describes the persistent application settings for users of a stack.
type nonrec access_endpoint = {vpce_id : string_ option;The identifier (ID) of the VPC in which the interface endpoint is used.
*)endpoint_type : access_endpoint_type;The type of interface endpoint.
*)}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.
type nonrec access_endpoint_list = access_endpoint listtype nonrec embed_host_domains = embed_host_domain listtype nonrec streaming_experience_settings = {preferred_protocol : preferred_protocol option;The preferred protocol that you want to use while streaming your application.
*)}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.
type nonrec content_redirection = {host_to_client : url_redirection_config option;Configuration for redirecting URLs from the remote desktop to the local client browser.
*)}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.
The type of agent action.
type nonrec agent_access_setting = {permission : permission;Whether the agent action is enabled or disabled.
*)agent_action : agent_action;The agent action to configure. Valid values are COMPUTER_VISION, COMPUTER_INPUT, and FORWARD_MCP_TOOLS. If you enable COMPUTER_INPUT, you must also enable COMPUTER_VISION.
*)}A permission setting for an agent action. Each setting specifies an agent action and whether it is enabled or disabled.
type nonrec agent_access_setting_list = agent_access_setting listThe screen resolution for the agent streaming environment.
The image format for agent screen captures.
type nonrec agent_access_config = {user_control_mode : user_control_mode option;The user control mode for agent sessions. This setting determines how users can interact with agent sessions.
*)screen_image_format : screen_image_format;The image format for agent screen captures.
*)screen_resolution : screen_resolution;The screen resolution for the agent streaming environment.
*)screenshots_upload_enabled : boolean_object option;Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
*)s3_bucket_arn : s3_bucket_arn option;The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.
*)settings : agent_access_setting_list;The list of agent access settings that define permissions for each agent action. You must specify at least one setting.
*)}The configuration for agent access on a stack. Agent access enables AI agents to interact with desktop applications during streaming sessions.
type nonrec stack = {agent_access_config : agent_access_config option;The agent access configuration of the stack, if agent access is enabled.
*)content_redirection : content_redirection option;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.
*)streaming_experience_settings : streaming_experience_settings option;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.
*)embed_host_domains : embed_host_domains option;The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
*)access_endpoints : access_endpoint_list option;The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
*)application_settings : application_settings_response option;The persistent application settings for users of the stack.
*)user_settings : user_setting_list option;The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
*)stack_errors : stack_errors option;The errors for the stack.
*)feedback_ur_l : feedback_ur_l option;The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
*)redirect_ur_l : redirect_ur_l option;The URL that users are redirected to after their streaming session ends.
*)storage_connectors : storage_connector_list option;The storage connectors to enable.
*)created_time : timestamp option;The time the stack was created.
*)display_name : string_ option;The stack name to display.
*)description : string_ option;The description to display.
*)name : string_;The name of the stack.
*)arn : arn option;The ARN of the stack.
*)}Describes a stack.
The stack attributes to delete.
type nonrec stack_attributes = stack_attribute listtype nonrec application_settings = {settings_group : settings_group option;The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
*)enabled : boolean_;Enables or disables persistent application settings for users during their streaming sessions.
*)}The persistent application settings for users of a stack.
type nonrec agent_access_config_for_update = {user_control_mode : user_control_mode option;The user control mode for agent sessions. This setting determines how users can interact with agent sessions.
*)screen_image_format : screen_image_format option;The image format for agent screen captures.
*)screen_resolution : screen_resolution option;The screen resolution for the agent streaming environment.
*)screenshots_upload_enabled : boolean_object option;Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
*)s3_bucket_arn : s3_bucket_arn option;The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.
*)settings : agent_access_setting_list option;The list of agent access settings that define permissions for each agent action.
*)}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.
type nonrec update_stack_request = {agent_access_config : agent_access_config_for_update option;The configuration for agent access on the stack. Specify this to update agent access settings. To remove agent access, use AttributesToDelete with the AGENT_ACCESS_CONFIG value.
*)content_redirection : content_redirection option;streaming_experience_settings : streaming_experience_settings option;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.
*)embed_host_domains : embed_host_domains option;The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
*)access_endpoints : access_endpoint_list option;The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
*)application_settings : application_settings option;The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
*)user_settings : user_setting_list option;The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
*)attributes_to_delete : stack_attributes option;The stack attributes to delete.
*)feedback_ur_l : feedback_ur_l option;The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
*)redirect_ur_l : redirect_ur_l option;The URL that users are redirected to after their streaming session ends.
*)delete_storage_connectors : boolean_ option;Deletes the storage connectors currently enabled for the stack.
*)storage_connectors : storage_connector_list option;The storage connectors to enable.
*)name : string_;The name of the stack.
*)description : description option;The description to display.
*)display_name : display_name option;The stack name to display.
*)}The specified resource is in use.
The specified role is invalid.
The image can't be updated because it's not compatible for updates.
type nonrec image_permissions = {allow_image_builder : boolean_object option;Indicates whether the image can be used for an image builder.
*)allow_fleet : boolean_object option;Indicates whether the image can be used for a fleet.
*)}Describes the permissions for an image.
type nonrec update_image_permissions_request = {image_permissions : image_permissions;The permissions for the image.
*)name : name;The name of the private image.
*)}The specified resource exists and is not in use, but isn't available.
type nonrec compute_capacity_status = {drain_mode_unused_user_sessions : integer option;The number of unused session slots on instances in drain mode that cannot be used for user session provisioning. This only applies to multi-session fleets.
*)drain_mode_active_user_sessions : integer option;The number of active user sessions on instances in drain mode. This only applies to multi-session fleets.
*)draining : integer option;The number of instances in drain mode. This only applies to multi-session fleets.
*)actual_user_sessions : integer option;The total number of session slots that are available for streaming or are currently streaming.
ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
This only applies to multi-session fleets.
*)active_user_sessions : integer option;The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
*)available_user_sessions : integer option;The number of idle session slots currently available for user sessions.
AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
This only applies to multi-session fleets.
*)desired_user_sessions : integer option;The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
This only applies to multi-session fleets.
*)available : integer option;The number of currently available instances that can be used to stream sessions.
*)in_use : integer option;The number of instances in use for streaming.
*)running : integer option;The total number of simultaneous streaming instances that are running.
*)desired : integer;The desired number of streaming instances.
*)}Describes the capacity status for a fleet.
type nonrec fleet_error_code = | VALIDATION_ERROR| DOMAIN_JOIN_INTERNAL_SERVICE_ERROR| DOMAIN_JOIN_NERR_PASSWORD_EXPIRED| DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED| DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED| DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME| DOMAIN_JOIN_ERROR_NOT_SUPPORTED| DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN| DOMAIN_JOIN_ERROR_MORE_DATA| DOMAIN_JOIN_ERROR_INVALID_PARAMETER| DOMAIN_JOIN_ERROR_LOGON_FAILURE| DOMAIN_JOIN_ERROR_ACCESS_DENIED| DOMAIN_JOIN_ERROR_FILE_NOT_FOUND| FLEET_INSTANCE_PROVISIONING_FAILURE| FLEET_STOPPED| IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION| IGW_NOT_ATTACHED| SECURITY_GROUPS_NOT_FOUND| INVALID_SUBNET_CONFIGURATION| IMAGE_NOT_FOUND| SUBNET_NOT_FOUND| IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION| SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES| STS_DISABLED_IN_REGION| MACHINE_ROLE_IS_MISSING| IAM_SERVICE_ROLE_IS_MISSING| INTERNAL_SERVICE_ERROR| NETWORK_INTERFACE_LIMIT_EXCEEDED| IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION| IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION| IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTIONtype nonrec fleet_error = {error_message : string_ option;The error message.
*)error_code : fleet_error_code option;The error code.
*)}Describes a fleet error.
type nonrec fleet_errors = fleet_error listtype nonrec domain_join_info = {organizational_unit_distinguished_name : organizational_unit_distinguished_name
option;The distinguished name of the organizational unit for computer accounts.
*)directory_name : directory_name option;The fully qualified name of the directory (for example, corp.example.com).
*)}Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
type nonrec fleet = {disable_imds_v1 : boolean_object option;Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the fleet.
*)root_volume_config : volume_config option;The current configuration of the root volume for fleet instances, including the storage size in GB.
*)max_sessions_per_instance : integer option;The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*)session_script_s3_location : s3_location option;The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*)usb_device_filter_strings : usb_device_filter_strings option;The USB device filter strings associated with the fleet.
*)max_concurrent_sessions : integer option;The maximum number of concurrent sessions for the fleet.
*)platform : platform_type option;The platform of the fleet.
*)stream_view : stream_view option;The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
iam_role_arn : arn option;The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
*)idle_disconnect_timeout_in_seconds : integer option;The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
*)domain_join_info : domain_join_info option;The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*)enable_default_internet_access : boolean_object option;Indicates whether default internet access is enabled for the fleet.
*)fleet_errors : fleet_errors option;The fleet errors.
*)created_time : timestamp option;The time the fleet was created.
*)vpc_config : vpc_config option;The VPC configuration for the fleet.
*)state : fleet_state;The current state for the fleet.
*)disconnect_timeout_in_seconds : integer option;The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
*)max_user_duration_in_seconds : integer option;The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 360000.
*)compute_capacity_status : compute_capacity_status;The capacity status for the fleet.
*)fleet_type : fleet_type option;The fleet type.
ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
*)instance_type : string_;The instance type to use when launching fleet instances. The following instance types are available:
image_arn : arn option;The ARN for the public, private, or shared image.
*)image_name : string_ option;The name of the image used to create the fleet.
*)description : string_ option;The description to display.
*)display_name : string_ option;The fleet name to display.
*)name : string_;The name of the fleet.
*)arn : arn;The Amazon Resource Name (ARN) for the fleet.
*)}Describes a fleet.
type nonrec compute_capacity = {desired_sessions : integer option;The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.
*)desired_instances : integer option;The desired number of streaming instances.
*)}Describes the capacity for a fleet.
type nonrec fleet_attributes = fleet_attribute listtype nonrec update_fleet_request = {disable_imds_v1 : boolean_object option;Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.
Before disabling IMDSv1, ensure your WorkSpaces Applications images are running the agent version or managed image update released on or after January 16, 2024 to support IMDSv2 enforcement.
*)root_volume_config : volume_config option;The updated configuration for the root volume of fleet instances. Note that volume size cannot be decreased below the image volume size.
*)max_sessions_per_instance : integer option;The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*)session_script_s3_location : s3_location option;The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*)usb_device_filter_strings : usb_device_filter_strings option;The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
*)max_concurrent_sessions : integer option;The maximum number of concurrent sessions for a fleet.
*)platform : platform_type option;The platform of the fleet. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.
*)stream_view : stream_view option;The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
iam_role_arn : arn option;The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
*)attributes_to_delete : fleet_attributes option;The fleet attributes to delete.
*)idle_disconnect_timeout_in_seconds : integer option;The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
*)domain_join_info : domain_join_info option;The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*)enable_default_internet_access : boolean_object option;Enables or disables default internet access for the fleet.
*)display_name : display_name option;The fleet name to display.
*)description : description option;The description to display.
*)delete_vpc_config : boolean_ option;Deletes the VPC association for the specified fleet.
*)disconnect_timeout_in_seconds : integer option;The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
*)max_user_duration_in_seconds : integer option;The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 432000.
*)vpc_config : vpc_config option;The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
*)compute_capacity : compute_capacity option;The desired capacity for the fleet. This is not allowed for Elastic fleets.
*)instance_type : string_ option;The instance type to use when launching fleet instances. The following instance types are available:
The following instance types are available for Elastic fleets:
name : name option;A unique name for the fleet.
*)image_arn : arn option;The ARN of the public, private, or shared image to use.
*)image_name : string_ option;The name of the image used to create the fleet.
*)}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.
type nonrec entitlement_attribute = {value : string_;A value that is matched to a supported SAML attribute name when a user identity federates into a WorkSpaces Applications SAML application.
*)name : string_;A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into a WorkSpaces Applications SAML application.
The following are valid values:
}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.
type nonrec entitlement_attribute_list = entitlement_attribute listtype nonrec entitlement = {last_modified_time : timestamp option;The time when the entitlement was last modified.
*)created_time : timestamp option;The time when the entitlement was created.
*)attributes : entitlement_attribute_list;The attributes of the entitlement.
*)app_visibility : app_visibility;Specifies whether all or selected apps are entitled.
*)description : description option;The description of the entitlement.
*)stack_name : name;The name of the stack with which the entitlement is associated.
*)name : name;The name of the entitlement.
*)}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.
type nonrec update_entitlement_request = {attributes : entitlement_attribute_list option;The attributes of the entitlement.
*)app_visibility : app_visibility option;Specifies whether all or only selected apps are entitled.
*)description : description option;The description of the entitlement.
*)stack_name : name;The name of the stack with which the entitlement is associated.
*)name : name;The name of the entitlement.
*)}The entitlement can't be found.
type nonrec organizational_unit_distinguished_names_list =
organizational_unit_distinguished_name listtype nonrec service_account_credentials = {account_password : account_password;The password for the account.
*)account_name : account_name;The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
*)}Describes the credentials for the service account used by the fleet or image builder to connect to the directory.
type nonrec certificate_based_auth_properties = {status : certificate_based_auth_status option;The status of the certificate-based authentication properties.
*)}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.
type nonrec directory_config = {certificate_based_auth_properties : certificate_based_auth_properties option;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.
*)created_time : timestamp option;The time the directory configuration was created.
*)service_account_credentials : service_account_credentials option;The credentials for the service account used by the fleet or image builder to connect to the directory.
*)organizational_unit_distinguished_names : organizational_unit_distinguished_names_list
option;The distinguished names of the organizational units for computer accounts.
*)directory_name : directory_name;The fully qualified name of the directory (for example, corp.example.com).
*)}Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
type nonrec update_directory_config_result = {directory_config : directory_config option;Information about the Directory Config object.
*)}type nonrec update_directory_config_request = {certificate_based_auth_properties : certificate_based_auth_properties option;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.
*)service_account_credentials : service_account_credentials option;The credentials for the service account used by the fleet or image builder to connect to the directory.
*)organizational_unit_distinguished_names : organizational_unit_distinguished_names_list
option;The distinguished names of the organizational units for computer accounts.
*)directory_name : directory_name;The name of the Directory Config object.
*)}type nonrec platforms = platform_type listtype nonrec string_list = string_ listtype nonrec application = {created_time : timestamp option;The time at which the application was created within the app block.
*)instance_families : string_list option;The instance families for the application.
*)platforms : platforms option;The platforms on which the application can run.
*)icon_s3_location : s3_location option;The S3 location of the application icon.
*)app_block_arn : arn option;The app block ARN of the application.
*)arn : arn option;The ARN of the application.
*)description : string_ option;The description of the application.
*)working_directory : string_ option;The working directory for the application.
*)metadata : metadata option;Additional attributes that describe the application.
*)enabled : boolean_ option;If there is a problem, the application can be disabled after image creation.
*)launch_parameters : string_ option;The arguments that are passed to the application at launch.
*)launch_path : string_ option;The path to the application executable in the instance.
*)icon_ur_l : string_ option;The URL for the application icon. This URL might be time-limited.
*)display_name : string_ option;The application name to display.
*)name : string_ option;The name of the application.
*)}Describes an application in the application catalog.
type nonrec application_attributes = application_attribute listtype nonrec update_application_request = {attributes_to_delete : application_attributes option;The attributes to delete for an application.
*)app_block_arn : arn option;The ARN of the app block.
*)launch_parameters : string_ option;The launch parameters of the application.
*)working_directory : string_ option;The working directory of the application.
*)launch_path : string_ option;The launch path of the application.
*)icon_s3_location : s3_location option;The icon S3 location of the application.
*)description : description option;The description of the application.
*)display_name : display_name option;The display name of the application. This name is visible to users in the application catalog.
*)name : name;The name of the application. This name is visible to users when display name is not specified.
*)}type nonrec resource_error = {error_timestamp : timestamp option;The time the error occurred.
*)error_message : string_ option;The error message.
*)error_code : fleet_error_code option;The error code.
*)}Describes a resource error.
type nonrec resource_errors = resource_error listtype nonrec app_block_builder_state_change_reason = {message : string_ option;The state change reason message.
*)code : app_block_builder_state_change_reason_code option;The state change reason code.
*)}Describes the reason why the last app block builder state change occurred.
type nonrec app_block_builder = {disable_imds_v1 : boolean_object option;Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the app block builder.
*)access_endpoints : access_endpoint_list option;The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
*)state_change_reason : app_block_builder_state_change_reason option;The state change reason.
*)app_block_builder_errors : resource_errors option;The app block builder errors.
*)created_time : timestamp option;The creation time of the app block builder.
*)state : app_block_builder_state;The state of the app block builder.
*)vpc_config : vpc_config;The VPC configuration for the app block builder.
*)iam_role_arn : arn option;The ARN of the IAM role that is applied to the app block builder.
*)enable_default_internet_access : boolean_object option;Indicates whether default internet access is enabled for the app block builder.
*)instance_type : string_;The instance type of the app block builder.
*)platform : app_block_builder_platform_type;The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
description : string_ option;The description of the app block builder.
*)display_name : string_ option;The display name of the app block builder.
*)name : string_;The name of the app block builder.
*)arn : arn;The ARN of the app block builder.
*)}Describes an app block builder.
type nonrec app_block_builder_attributes = app_block_builder_attribute listtype nonrec update_app_block_builder_request = {disable_imds_v1 : boolean_object option;Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.
*)attributes_to_delete : app_block_builder_attributes option;The attributes to delete from the app block builder.
*)access_endpoints : access_endpoint_list option;The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
*)iam_role_arn : arn option;The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
*)enable_default_internet_access : boolean_object option;Enables or disables default internet access for the app block builder.
*)vpc_config : vpc_config option;The VPC configuration for the app block builder.
App block builders require that you specify at least two subnets in different availability zones.
*)instance_type : string_ option;The instance type to use when launching the app block builder. The following instance types are available:
platform : platform_type option;The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
display_name : display_name option;The display name of the app block builder.
*)description : description option;The description of the app block builder.
*)name : name;The unique name for the app block builder.
*)}type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The tag keys for the tags to disassociate.
*)resource_arn : arn;The Amazon Resource Name (ARN) of the resource.
*)}type nonrec tag_resource_request = {resource_arn : arn;The Amazon Resource Name (ARN) of the resource.
*)}type nonrec image_builder_state_change_reason = {message : string_ option;The state change reason message.
*)code : image_builder_state_change_reason_code option;The state change reason code.
*)}Describes the reason why the last image builder state change occurred.
type nonrec network_access_configuration = {eni_id : string_ option;The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
*)eni_ipv6_addresses : string_list option;The IPv6 addresses assigned to the elastic network interface. This field supports IPv6 connectivity for WorkSpaces Applications instances.
*)eni_private_ip_address : string_ option;The private IP address of the elastic network interface that is attached to instances in your VPC.
*)}Describes the network details of the fleet or image builder instance.
type nonrec image_builder = {disable_imds_v1 : boolean_object option;Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the image builder.
*)latest_appstream_agent_version : latest_appstream_agent_version option;Indicates whether the image builder is using the latest WorkSpaces Applications agent version or not.
*)root_volume_config : volume_config option;The current configuration of the root volume for the image builder, including the storage size in GB.
*)access_endpoints : access_endpoint_list option;The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
*)appstream_agent_version : appstream_agent_version option;The version of the WorkSpaces Applications agent that is currently being used by the image builder.
*)image_builder_errors : resource_errors option;The image builder errors.
*)network_access_configuration : network_access_configuration option;domain_join_info : domain_join_info option;The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
*)enable_default_internet_access : boolean_object option;Enables or disables default internet access for the image builder.
*)created_time : timestamp option;The time stamp when the image builder was created.
*)state_change_reason : image_builder_state_change_reason option;The reason why the last state change occurred.
*)state : image_builder_state option;The state of the image builder.
*)iam_role_arn : arn option;The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
*)platform : platform_type option;The operating system platform of the image builder.
*)instance_type : string_ option;The instance type for the image builder. The following instance types are available:
vpc_config : vpc_config option;The VPC configuration of the image builder.
*)display_name : string_ option;The image builder name to display.
*)description : string_ option;The description to display.
*)image_arn : arn option;The ARN of the image from which this builder was created.
*)arn : arn option;The ARN for the image builder.
*)name : string_;The name of the image builder.
*)}Describes a virtual machine that is used to create an image.
type nonrec stop_image_builder_result = {image_builder : image_builder option;Information about the image builder.
*)}type nonrec start_image_builder_result = {image_builder : image_builder option;Information about the image builder.
*)}type nonrec start_image_builder_request = {appstream_agent_version : appstream_agent_version option;The version of the WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications agent, specify [LATEST].
*)name : string_;The name of the image builder.
*)}type nonrec stack_list = stack listtype nonrec error_details = {error_message : string_ option;The error message.
*)error_code : string_ option;The error code.
*)}The error details.
type nonrec error_details_list = error_details listtype nonrec software_associations = {deployment_error : error_details_list option;The error details for failed deployments of the license-included application.
*)status : software_deployment_status option;The deployment status of the license-included application.
*)software_name : string_ option;The name of the license-included application.
Possible values include the following:
}The association between a license-included application and a resource.
type nonrec software_associations_list = software_associations listDescribes the permissions that are available to the specified AWS account for a shared image.
Possible values for the state of a streaming session.
Possible values for the drain status of a streaming instance.
type nonrec session = {instance_drain_status : instance_drain_status option;The drain status of the instance hosting the streaming session. This only applies to multi-session fleets.
*)instance_id : string_ option;The identifier for the instance hosting the session.
*)network_access_configuration : network_access_configuration option;The network details for the streaming session.
*)authentication_type : authentication_type option;The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
max_expiration_time : timestamp option;The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
start_time : timestamp option;The time when a streaming instance is dedicated for the user.
*)connection_state : session_connection_state option;Specifies whether a user is connected to the streaming session.
*)state : session_state;The current state of the streaming session.
*)fleet_name : string_;The name of the fleet for the streaming session.
*)stack_name : string_;The name of the stack for the streaming session.
*)user_id : user_id;The identifier of the user for whom the session was created.
*)id : string_;The identifier of the streaming session.
*)}Describes a streaming session.
type nonrec session_list = session listtype nonrec script_details = {timeout_in_seconds : integer;The run timeout, in seconds, for the script.
*)executable_parameters : string_ option;The runtime parameters passed to the run path for the script.
*)executable_path : string_;The run path for the script.
*)script_s3_location : s3_location;The S3 object location for the script.
*)}Describes the details of the script.
type nonrec runtime_validation_config = {intended_instance_type : instance_type option;The instance type to use for runtime validation testing. It's recommended to use the same instance type you plan to use for your fleet to ensure accurate validation results.
*)}Configuration for runtime validation of imported images. This structure specifies the instance type to use for testing the imported image's streaming capabilities.
The specified resource already exists.
type nonrec export_image_task = {error_details : error_details_list option;Details about any errors that occurred during the export process. This field is only populated when the task fails.
*)tag_specifications : tags option;The tags that will be applied to the exported EC2 AMI.
*)ami_id : photon_ami_id option;The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.
*)state : export_image_task_state option;The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
*)ami_description : description option;The description that will be applied to the exported EC2 AMI.
*)created_date : timestamp;The date and time when the export image task was created.
*)ami_name : ami_name;The name of the EC2 AMI that will be created by this export task.
*)image_arn : arn;The ARN of the WorkSpaces Applications image being exported.
*)task_id : uui_d;The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.
*)}Information about an export image task, including its current state, timestamps, and any error details.
type nonrec export_image_tasks = export_image_task listtype nonrec list_export_image_tasks_result = {next_token : string_ option;The pagination token to use for retrieving the next page of results. This field is only present when there are more results available.
*)export_image_tasks : export_image_tasks option;The list of export image tasks that match the specified criteria.
*)}type nonrec filter_values = filter_value listtype nonrec filter = {values : filter_values;The values for the filter. Multiple values can be specified for a single filter name.
*)name : filter_name;The name of the filter. Valid filter names depend on the operation being performed.
*)}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.
type nonrec filters = filter listtype nonrec list_export_image_tasks_request = {next_token : string_ option;The pagination token from a previous request. Use this to retrieve the next page of results when there are more tasks than the MaxResults limit.
*)max_results : max_results option;The maximum number of export image tasks to return in a single request. The valid range is 1-500, with a default of 50.
*)filters : filters option;Optional filters to apply when listing export image tasks. Filters help you narrow down the results based on specific criteria.
*)}type nonrec entitled_application = {application_identifier : string_;The identifier of the application.
*)}The application associated to an entitlement. Access is controlled based on user attributes.
type nonrec entitled_application_list = entitled_application listtype nonrec list_entitled_applications_result = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)entitled_applications : entitled_application_list option;The entitled applications.
*)}type nonrec list_entitled_applications_request = {max_results : integer option;The maximum size of each page of results.
*)next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)entitlement_name : name;The name of the entitlement.
*)stack_name : name;The name of the stack with which the entitlement is associated.
*)}type nonrec list_associated_stacks_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)names : string_list option;The name of the stack.
*)}type nonrec list_associated_fleets_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)names : string_list option;The name of the fleet.
*)}type nonrec get_export_image_task_result = {export_image_task : export_image_task option;Information about the export image task, including its current state, created date, and any error details.
*)}type nonrec get_export_image_task_request = {task_id : uui_d option;The unique identifier of the export image task to retrieve information about.
*)}type nonrec expire_session_request = {session_id : string_;The identifier of the streaming session.
*)}type nonrec enable_user_request = {authentication_type : authentication_type;The authentication type for the user. You must specify USERPOOL.
*)user_name : username;The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
*)}type nonrec drain_session_instance_request = {session_id : string_;The identifier of the streaming session.
*)}type nonrec disassociate_software_from_image_builder_request = {software_names : string_list;The list of license included applications to disassociate from the image builder.
Possible values include the following:
image_builder_name : name;The name of the target image builder instance.
*)}type nonrec disassociate_application_from_entitlement_request = {application_identifier : string_;The identifier of the application to remove from the entitlement.
*)entitlement_name : name;The name of the entitlement.
*)stack_name : name;The name of the stack with which the entitlement is associated.
*)}type nonrec disable_user_request = {authentication_type : authentication_type;The authentication type for the user. You must specify USERPOOL.
*)user_name : username;The email address of the user.
Users' email addresses are case-sensitive.
*)}type nonrec describe_user_stack_associations_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)user_stack_associations : user_stack_association_list option;The UserStackAssociation objects.
*)}type nonrec describe_user_stack_associations_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)max_results : max_results option;The maximum size of each page of results.
*)authentication_type : authentication_type option;The authentication type for the user who is associated with the stack. You must specify USERPOOL.
*)user_name : username option;The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
*)stack_name : string_ option;The name of the stack that is associated with the user.
*)}type nonrec describe_users_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)max_results : integer option;The maximum size of each page of results.
*)authentication_type : authentication_type;The authentication type for the users in the user pool to describe. You must specify USERPOOL.
*)}type nonrec describe_usage_report_subscriptions_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)usage_report_subscriptions : usage_report_subscription_list option;Information about the usage report subscription.
*)}type nonrec describe_usage_report_subscriptions_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)max_results : integer option;The maximum size of each page of results.
*)}type nonrec describe_theme_for_stack_result = {theme : theme option;The theme object that contains the metadata of the custom branding.
*)}type nonrec describe_theme_for_stack_request = {stack_name : name;The name of the stack for the theme.
*)}type nonrec describe_stacks_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)stacks : stack_list option;Information about the stacks.
*)}type nonrec describe_stacks_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)names : string_list option;The names of the stacks to describe.
*)}type nonrec describe_software_associations_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation.
*)software_associations : software_associations_list option;Collection of license included applications association details including:
associated_resource : arn option;The ARN of the resource to describe software associations.
*)}type nonrec describe_software_associations_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation.
*)max_results : integer option;The maximum number of results to return.
*)associated_resource : arn;The ARN of the resource to describe software associations. Possible resources are Image and ImageBuilder.
*)}type nonrec describe_sessions_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)sessions : session_list option;Information about the streaming sessions.
*)}type nonrec describe_sessions_request = {instance_id : string_ option;The identifier for the instance hosting the session.
*)authentication_type : authentication_type option;The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.
limit : integer option;The size of each page of results. The default value is 20 and the maximum value is 50.
*)next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)user_id : user_id option;The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
*)fleet_name : name;The name of the fleet. This value is case-sensitive.
*)stack_name : name;The name of the stack. This value is case-sensitive.
*)}type nonrec image_state_change_reason = {message : string_ option;The state change reason message.
*)code : image_state_change_reason_code option;The state change reason code.
*)}Describes the reason why the last image state change occurred.
type nonrec applications = application listThe image type is the type of AppStream image resource.
type nonrec image = {image_type : image_type option;The type of the image. Images created through AMI import have type "custom", while WorkSpaces Applications provided images have type "native". Custom images support additional instance types including GeneralPurpose, MemoryOptimized, ComputeOptimized, and Accelerated instance families.
*)managed_software_included : boolean_ option;Indicates whether the image includes license-included applications.
*)dynamic_app_providers_enabled : dynamic_app_providers_enabled option;Indicates whether dynamic app providers are enabled within an WorkSpaces Applications image or not.
*)supported_instance_families : string_list option;The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:
latest_appstream_agent_version : latest_appstream_agent_version option;Indicates whether the image is using the latest WorkSpaces Applications agent version or not.
*)image_errors : resource_errors option;Describes the errors that are returned when a new image can't be created.
*)image_permissions : image_permissions option;The permissions to provide to the destination AWS account for the specified image.
*)appstream_agent_version : appstream_agent_version option;The version of the WorkSpaces Applications agent to use for instances that are launched from this image.
*)public_base_image_released_date : timestamp option;The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
*)created_time : timestamp option;The time the image was created.
*)applications : applications option;The applications associated with the image.
*)state_change_reason : image_state_change_reason option;The reason why the last state change occurred.
*)description : string_ option;The description to display.
*)platform : platform_type option;The operating system platform of the image.
*)image_builder_name : string_ option;The name of the image builder that was used to create the private image. If the image is shared, copied, or updated by using Managed Image Updates, this value is null.
*)image_builder_supported : boolean_ option;Indicates whether an image builder can be launched from this image.
*)visibility : visibility_type option;Indicates whether the image is public or private.
*)state : image_state option;The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
display_name : string_ option;The image name to display.
*)base_image_arn : arn option;The ARN of the image from which this image was created.
*)arn : arn option;The ARN of the image.
*)name : string_;The name of the image.
*)}Describes an image.
type nonrec image_list = image listtype nonrec describe_images_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)images : image_list option;Information about the images.
*)}type nonrec arn_list = arn listtype nonrec describe_images_request = {max_results : describe_images_max_results option;The maximum size of each page of results.
*)next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)type_ : visibility_type option;The type of image (public, private, or shared) to describe.
*)arns : arn_list option;The ARNs of the public, private, and shared images to describe.
*)names : string_list option;The names of the public or private images to describe.
*)}type nonrec aws_account_id_list = aws_account_id listtype nonrec describe_image_permissions_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)max_results : max_results option;The maximum size of each page of results.
*)name : name;The name of the private image for which to describe permissions. The image must be one that you own.
*)}type nonrec image_builder_list = image_builder listtype nonrec describe_image_builders_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)image_builders : image_builder_list option;Information about the image builders.
*)}type nonrec describe_image_builders_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)max_results : integer option;The maximum size of each page of results.
*)names : string_list option;The names of the image builders to describe.
*)}type nonrec fleet_list = fleet listtype nonrec describe_fleets_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)fleets : fleet_list option;Information about the fleets.
*)}type nonrec describe_fleets_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)names : string_list option;The names of the fleets to describe.
*)}type nonrec entitlement_list = entitlement listtype nonrec describe_entitlements_result = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)entitlements : entitlement_list option;The entitlements.
*)}type nonrec describe_entitlements_request = {max_results : integer option;The maximum size of each page of results.
*)next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)stack_name : name;The name of the stack with which the entitlement is associated.
*)name : name option;The name of the entitlement.
*)}type nonrec directory_config_list = directory_config listtype nonrec describe_directory_configs_result = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*)directory_configs : directory_config_list option;Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
*)}type nonrec directory_name_list = directory_name listtype nonrec describe_directory_configs_request = {next_token : string_ option;The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*)max_results : integer option;The maximum size of each page of results.
*)directory_names : directory_name_list option;The directory names.
*)}type nonrec admin_app_license_usage_record = {user_id : string_;The ID of the user who used the license-included application.
*)license_type : string_;The type of license (for example, Microsoft Office).
*)subscription_last_used_date : timestamp;The date and time when the license was last used.
*)subscription_first_used_date : timestamp;The date and time when the license was first used.
*)owner_aws_account_id : aws_account_id;The account ID of the owner of the license.
*)billing_period : string_;The billing period for the license usage record.
*)user_arn : string_;The ARN of the user who used the license-included application.
*)}The collection of license usage records.
type nonrec admin_app_license_usage_list = admin_app_license_usage_record listtype nonrec describe_app_license_usage_result = {next_token : string_ option;Token for pagination of results.
*)app_license_usages : admin_app_license_usage_list option;Collection of license usage records.
*)}type nonrec describe_app_license_usage_request = {next_token : string_ option;Token for pagination of results.
*)max_results : integer option;The maximum number of results to return.
*)billing_period : string_;Billing period for the usage record.
Specify the value in yyyy-mm format. For example, for August 2025, use 2025-08.
*)}type nonrec describe_applications_result = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)applications : applications option;The applications in the list.
*)}type nonrec application_fleet_association = {application_arn : arn;The ARN of the application associated with the fleet.
*)fleet_name : string_;The name of the fleet associated with the application.
*)}Describes the application fleet association.
type nonrec application_fleet_association_list =
application_fleet_association listtype nonrec describe_application_fleet_associations_result = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)application_fleet_associations : application_fleet_association_list option;The application fleet associations in the list.
*)}type nonrec describe_application_fleet_associations_request = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)max_results : integer option;The maximum size of each page of results.
*)application_arn : arn option;The ARN of the application.
*)fleet_name : name option;The name of the fleet.
*)}type nonrec app_block = {app_block_errors : error_details_list option;The errors of the app block.
*)state : app_block_state option;The state of the app block.
An app block with WorkSpaces Applications packaging will be in the INACTIVE state if no application package (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block, it becomes ACTIVE.
Custom app blocks are always in the ACTIVE state and no action is required to use them.
packaging_type : packaging_type option;The packaging type of the app block.
*)post_setup_script_details : script_details option;The post setup script details of the app block.
This only applies to app blocks with PackagingType APPSTREAM2.
created_time : timestamp option;The created time of the app block.
*)setup_script_details : script_details option;The setup script details of the app block.
This only applies to app blocks with PackagingType CUSTOM.
source_s3_location : s3_location option;The source S3 location of the app block.
*)display_name : string_ option;The display name of the app block.
*)description : string_ option;The description of the app block.
*)arn : arn;The ARN of the app block.
*)name : string_;The name of the app block.
*)}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.
type nonrec app_blocks = app_block listtype nonrec describe_app_blocks_result = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)app_blocks : app_blocks option;The app blocks in the list.
*)}type nonrec app_block_builder_list = app_block_builder listtype nonrec describe_app_block_builders_result = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)app_block_builders : app_block_builder_list option;The list that describes one or more app block builders.
*)}type nonrec describe_app_block_builders_request = {max_results : integer option;The maximum size of each page of results. The maximum value is 25.
*)next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)names : string_list option;The names of the app block builders.
*)}type nonrec app_block_builder_app_block_association = {app_block_builder_name : name;The name of the app block builder.
*)app_block_arn : arn;The ARN of the app block.
*)}Describes an association between an app block builder and app block.
type nonrec app_block_builder_app_block_associations_list =
app_block_builder_app_block_association listtype nonrec describe_app_block_builder_app_block_associations_result = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)app_block_builder_app_block_associations : app_block_builder_app_block_associations_list
option;This list of app block builders associated with app blocks.
*)}type nonrec describe_app_block_builder_app_block_associations_request = {next_token : string_ option;The pagination token used to retrieve the next page of results for this operation.
*)max_results : integer option;The maximum size of each page of results.
*)app_block_builder_name : name option;The name of the app block builder.
*)app_block_arn : arn option;The ARN of the app block.
*)}type nonrec delete_user_request = {authentication_type : authentication_type;The authentication type for the user. You must specify USERPOOL.
*)user_name : username;The email address of the user.
Users' email addresses are case-sensitive.
*)}type nonrec delete_theme_for_stack_request = {stack_name : name;The name of the stack for the theme.
*)}type nonrec delete_image_builder_result = {image_builder : image_builder option;Information about the image builder.
*)}type nonrec delete_directory_config_request = {directory_name : directory_name;The name of the directory configuration.
*)}type nonrec create_user_request = {authentication_type : authentication_type;The authentication type for the user. You must specify USERPOOL.
*)last_name : user_attribute_value option;The last name, or surname, of the user.
*)first_name : user_attribute_value option;The first name, or given name, of the user.
*)message_action : message_action option;The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
*)user_name : username;The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
*)}type nonrec create_usage_report_subscription_result = {schedule : usage_report_schedule option;The schedule for generating usage reports.
*)s3_bucket_name : string_ option;The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, WorkSpaces Applications created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, WorkSpaces Applications uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, WorkSpaces Applications creates a new S3 bucket.
*)}type nonrec create_updated_image_request = {dry_run : boolean_ option;Indicates whether to display the status of image update availability before WorkSpaces Applications initiates the process of creating a new updated image. If this value is set to true, WorkSpaces Applications displays whether image updates are available. If this value is set to false, WorkSpaces Applications initiates the process of creating a new updated image without displaying whether image updates are available.
new_image_display_name : display_name option;The name to display for the new image.
*)new_image_description : description option;The description to display for the new image.
*)new_image_name : name;The name of the new image. The name must be unique within the AWS account and Region.
*)existing_image_name : name;The name of the image to update.
*)}type nonrec create_theme_for_stack_result = {theme : theme option;The theme object that contains the metadata of the custom branding.
*)}type nonrec create_theme_for_stack_request = {favicon_s3_location : s3_location;The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.
*)organization_logo_s3_location : s3_location;The organization logo that appears on the streaming application catalog page.
*)theme_styling : theme_styling;The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.
*)title_text : theme_title_text;The title that is displayed at the top of the browser tab during users' application streaming sessions.
*)stack_name : name;The name of the stack for the theme.
*)}type nonrec long = Smaws_Lib.CoreTypes.Int64.ttype nonrec create_streaming_url_request = {session_context : string_ option;The session context. For more information, see Session Context in the Amazon WorkSpaces Applications Administration Guide.
*)validity : long option;The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.
*)application_id : string_ option;The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.
*)user_id : streaming_url_user_id;The identifier of the user.
*)fleet_name : string_;The name of the fleet.
*)stack_name : string_;The name of the stack.
*)}type nonrec create_stack_request = {agent_access_config : agent_access_config option;The configuration for agent access on the stack. If specified, agent access is enabled for the stack.
*)content_redirection : content_redirection option;streaming_experience_settings : streaming_experience_settings option;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.
*)embed_host_domains : embed_host_domains option;The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
*)access_endpoints : access_endpoint_list option;The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
*)application_settings : application_settings option;The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
*)user_settings : user_setting_list option;The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
*)feedback_ur_l : feedback_ur_l option;The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
*)redirect_ur_l : redirect_ur_l option;The URL that users are redirected to after their streaming session ends.
*)storage_connectors : storage_connector_list option;The storage connectors to enable.
*)display_name : display_name option;The stack name to display.
*)description : description option;The description to display.
*)name : name;The name of the stack.
*)}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.
The image type is the type of AppStream image resource.
type nonrec application_config = {launch_parameters : launch_parameters option;The launch parameters to pass to the application executable. This field is optional and can be 0-1024 characters. Use escaped strings with the full list of required parameters, such as PowerShell script paths or command-line arguments.
*)working_directory : file_path option;The working directory to use when launching the application. This field is optional and can be 0-32767 characters. Use escaped file path strings like "C:\\\\Path\\\\To\\\\Working\\\\Directory".
*)absolute_manifest_path : file_path option;The absolute path to the prewarm manifest file for this application. This field is optional and only applicable when using application-specific manifests. The path can be 1-32767 characters and should point to a text file containing file paths to prewarm.
*)absolute_icon_path : file_path option;The absolute path to the icon file for the application. This field is optional and can be 1-32767 characters. If not provided, the icon is derived from the executable. Use PNG images with proper transparency for the best user experience.
*)absolute_app_path : file_path;The absolute path to the executable file that launches the application. This is a required field that can be 1-32767 characters to support Windows extended file paths. Use escaped file path strings like "C:\\\\Windows\\\\System32\\\\notepad.exe".
*)display_name : app_display_name option;The display name shown to users for this application. This field is optional and can be 0-100 characters, matching the pattern ^[a-zA-Z0-9][a-zA-Z0-9_. -]{0,99}$.
*)name : app_name;The name of the application. This is a required field that must be unique within the application catalog and between 1-100 characters, matching the pattern ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,99}$.
*)}Configuration for an application in the imported image's application catalog. This structure defines how applications appear and launch for users.
type nonrec app_catalog_config = application_config listtype nonrec create_imported_image_request = {dry_run : boolean_ option;When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.
*)app_catalog_config : app_catalog_config option;Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.
*)agent_software_version : agent_software_version option;The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.
*)runtime_validation_config : runtime_validation_config option;Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.
*)display_name : image_import_display_name option;An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.
*)description : image_import_description option;An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.
*)iam_role_arn : arn option;The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.
*)workspace_image_id : workspace_image_id option;The ID of the Workspaces Image to import.
*)source_ami_id : photon_ami_id option;The ID of the EC2 AMI to import.
*)name : name;A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.
*)}type nonrec create_image_builder_result = {image_builder : image_builder option;Information about the image builder.
*)}type nonrec create_image_builder_request = {disable_imds_v1 : boolean_object option;Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.
Before disabling IMDSv1, ensure your WorkSpaces Applications images are running the agent version or managed image update released on or after January 16, 2024 to support IMDSv2 enforcement.
*)softwares_to_uninstall : string_list option;The list of license included applications to uninstall from the image builder during creation.
Possible values include the following:
softwares_to_install : string_list option;The list of license included applications to install on the image builder during creation.
Possible values include the following:
root_volume_config : volume_config option;The configuration for the root volume of the image builder. Use this to customize storage capacity from 200 GB up to 500 GB based on your application installation requirements.
*)access_endpoints : access_endpoint_list option;The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
*)appstream_agent_version : appstream_agent_version option;The version of the WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications agent, specify [LATEST].
*)domain_join_info : domain_join_info option;The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
*)enable_default_internet_access : boolean_object option;Enables or disables default internet access for the image builder.
*)iam_role_arn : arn option;The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
*)vpc_config : vpc_config option;The VPC configuration for the image builder. You can specify only one subnet.
*)display_name : display_name option;The image builder name to display.
*)description : description option;The description to display.
*)instance_type : string_;The instance type to use when launching the image builder. The following instance types are available:
image_arn : arn option;The ARN of the public, private, or shared image to use.
*)image_name : string_ option;The name of the image used to create the image builder.
*)name : name;A unique name for the image builder.
*)}type nonrec create_fleet_request = {disable_imds_v1 : boolean_object option;Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.
Before disabling IMDSv1, ensure your WorkSpaces Applications images are running the agent version or managed image update released on or after January 16, 2024 to support IMDSv2 enforcement.
*)root_volume_config : volume_config option;The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.
*)max_sessions_per_instance : integer option;The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*)session_script_s3_location : s3_location option;The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*)usb_device_filter_strings : usb_device_filter_strings option;The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
*)max_concurrent_sessions : integer option;The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
*)platform : platform_type option;The fleet platform. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.
*)stream_view : stream_view option;The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
iam_role_arn : arn option;The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
*)idle_disconnect_timeout_in_seconds : integer option;The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
*)domain_join_info : domain_join_info option;The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
*)enable_default_internet_access : boolean_object option;Enables or disables default internet access for the fleet.
*)display_name : display_name option;The fleet name to display.
*)description : description option;The description to display.
*)disconnect_timeout_in_seconds : integer option;The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
*)max_user_duration_in_seconds : integer option;The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 432000.
*)vpc_config : vpc_config option;The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
*)compute_capacity : compute_capacity option;The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
*)fleet_type : fleet_type option;The fleet type.
ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
*)instance_type : string_;The instance type to use when launching fleet instances. The following instance types are available:
The following instance types are available for Elastic fleets:
image_arn : arn option;The ARN of the public, private, or shared image to use.
*)image_name : name option;The name of the image used to create the fleet.
*)name : name;A unique name for the fleet.
*)}type nonrec create_export_image_task_result = {export_image_task : export_image_task option;Information about the export image task that was created, including the task ID and initial state.
*)}type nonrec create_export_image_task_request = {ami_description : description option;An optional description for the exported AMI. This description will be applied to the resulting EC2 AMI.
*)tag_specifications : tags option;The tags to apply to the exported AMI. These tags help you organize and manage your EC2 AMIs.
*)iam_role_arn : arn;The ARN of the IAM role that allows WorkSpaces Applications to create the AMI. The role must have permissions to copy images, describe images, and create tags, with a trust relationship allowing appstream.amazonaws.com to assume the role.
*)ami_name : ami_name;The name for the exported EC2 AMI. This is a required field that must be unique within your account and region.
*)image_name : name;The name of the WorkSpaces Applications image to export. The image must be in an available state and owned by your account.
*)}The entitlement already exists.
type nonrec create_entitlement_request = {attributes : entitlement_attribute_list;The attributes of the entitlement.
*)app_visibility : app_visibility;Specifies whether all or selected apps are entitled.
*)description : description option;The description of the entitlement.
*)stack_name : name;The name of the stack with which the entitlement is associated.
*)name : name;The name of the entitlement.
*)}type nonrec create_directory_config_result = {directory_config : directory_config option;Information about the directory configuration.
*)}type nonrec create_directory_config_request = {certificate_based_auth_properties : certificate_based_auth_properties option;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.
*)service_account_credentials : service_account_credentials option;The credentials for the service account used by the fleet or image builder to connect to the directory.
*)organizational_unit_distinguished_names : organizational_unit_distinguished_names_list;The distinguished names of the organizational units for computer accounts.
*)directory_name : directory_name;The fully qualified name of the directory (for example, corp.example.com).
*)}type nonrec create_application_request = {app_block_arn : arn;The app block ARN to which the application should be associated
*)instance_families : string_list;The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
*)platforms : platforms;The platforms the application supports. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.
*)launch_parameters : string_ option;The launch parameters of the application.
*)working_directory : string_ option;The working directory of the application.
*)launch_path : string_;The launch path of the application.
*)icon_s3_location : s3_location;The location in S3 of the application icon.
*)description : description option;The description of the application.
*)display_name : display_name option;The display name of the application. This name is visible to users in the application catalog.
*)name : name;The name of the application. This name is visible to users when display name is not specified.
*)}type nonrec create_app_block_builder_request = {disable_imds_v1 : boolean_object option;Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.
*)access_endpoints : access_endpoint_list option;The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
*)iam_role_arn : arn option;The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
*)enable_default_internet_access : boolean_object option;Enables or disables default internet access for the app block builder.
*)vpc_config : vpc_config;The VPC configuration for the app block builder.
App block builders require that you specify at least two subnets in different availability zones.
*)instance_type : string_;The instance type to use when launching the app block builder. The following instance types are available:
platform : app_block_builder_platform_type;The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
display_name : display_name option;The display name of the app block builder.
*)description : description option;The description of the app block builder.
*)name : name;The unique name for the app block builder.
*)}type nonrec create_app_block_request = {packaging_type : packaging_type option;The packaging type of the app block.
*)post_setup_script_details : script_details option;The post setup script details of the app block. This can only be provided for the APPSTREAM2 PackagingType.
setup_script_details : script_details option;The setup script details of the app block. This must be provided for the CUSTOM PackagingType.
source_s3_location : s3_location;The source S3 location of the app block.
*)display_name : display_name option;The display name of the app block. This is not displayed to the user.
*)description : description option;The description of the app block.
*)name : name;The name of the app block.
*)}type nonrec copy_image_response = {destination_image_name : name option;The name of the destination image.
*)}type nonrec copy_image_request = {destination_image_description : description option;The description that the image will have when it is copied to the destination.
*)destination_region : region_name;The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
*)destination_image_name : name;The name that the image will have when it is copied to the destination.
*)source_image_name : name;The name of the image to copy.
*)}type nonrec batch_disassociate_user_stack_result = {errors : user_stack_association_error_list option;The list of UserStackAssociationError objects.
*)}type nonrec batch_disassociate_user_stack_request = {user_stack_associations : user_stack_association_list;The list of UserStackAssociation objects.
*)}type nonrec batch_associate_user_stack_result = {errors : user_stack_association_error_list option;The list of UserStackAssociationError objects.
*)}type nonrec batch_associate_user_stack_request = {user_stack_associations : user_stack_association_list;The list of UserStackAssociation objects.
*)}type nonrec associate_software_to_image_builder_request = {software_names : string_list;The list of license included applications to associate with the image builder.
Possible values include the following:
image_builder_name : name;The name of the target image builder instance.
*)}type nonrec associate_application_fleet_result = {application_fleet_association : application_fleet_association option;If fleet name is specified, this returns the list of applications that are associated to it. If application ARN is specified, this returns the list of fleets to which it is associated.
*)}type nonrec associate_app_block_builder_app_block_result = {app_block_builder_app_block_association : app_block_builder_app_block_association
option;The list of app block builders associated with app blocks.
*)}