Amazonka.AppStream.Lens

Operations

AssociateApplicationFleet

associateApplicationFleet_fleetName :: Lens' AssociateApplicationFleet Text

The name of the fleet.

associateApplicationFleet_applicationArn :: Lens' AssociateApplicationFleet Text

The ARN of the application.

associateApplicationFleetResponse_applicationFleetAssociation :: Lens' AssociateApplicationFleetResponse (Maybe ApplicationFleetAssociation)

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.

associateApplicationFleetResponse_httpStatus :: Lens' AssociateApplicationFleetResponse Int

The response's http status code.

AssociateApplicationToEntitlement

associateApplicationToEntitlement_stackName :: Lens' AssociateApplicationToEntitlement Text

The name of the stack.

associateApplicationToEntitlement_entitlementName :: Lens' AssociateApplicationToEntitlement Text

The name of the entitlement.

associateApplicationToEntitlement_applicationIdentifier :: Lens' AssociateApplicationToEntitlement Text

The identifier of the application.

associateApplicationToEntitlementResponse_httpStatus :: Lens' AssociateApplicationToEntitlementResponse Int

The response's http status code.

AssociateFleet

associateFleet_fleetName :: Lens' AssociateFleet Text

The name of the fleet.

associateFleet_stackName :: Lens' AssociateFleet Text

The name of the stack.

associateFleetResponse_httpStatus :: Lens' AssociateFleetResponse Int

The response's http status code.

BatchAssociateUserStack

batchAssociateUserStack_userStackAssociations :: Lens' BatchAssociateUserStack (NonEmpty UserStackAssociation)

The list of UserStackAssociation objects.

batchAssociateUserStackResponse_errors :: Lens' BatchAssociateUserStackResponse (Maybe [UserStackAssociationError])

The list of UserStackAssociationError objects.

batchAssociateUserStackResponse_httpStatus :: Lens' BatchAssociateUserStackResponse Int

The response's http status code.

BatchDisassociateUserStack

batchDisassociateUserStack_userStackAssociations :: Lens' BatchDisassociateUserStack (NonEmpty UserStackAssociation)

The list of UserStackAssociation objects.

batchDisassociateUserStackResponse_errors :: Lens' BatchDisassociateUserStackResponse (Maybe [UserStackAssociationError])

The list of UserStackAssociationError objects.

batchDisassociateUserStackResponse_httpStatus :: Lens' BatchDisassociateUserStackResponse Int

The response's http status code.

CopyImage

copyImage_destinationImageDescription :: Lens' CopyImage (Maybe Text)

The description that the image will have when it is copied to the destination.

copyImage_sourceImageName :: Lens' CopyImage Text

The name of the image to copy.

copyImage_destinationImageName :: Lens' CopyImage Text

The name that the image will have when it is copied to the destination.

copyImage_destinationRegion :: Lens' CopyImage Text

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.

copyImageResponse_destinationImageName :: Lens' CopyImageResponse (Maybe Text)

The name of the destination image.

copyImageResponse_httpStatus :: Lens' CopyImageResponse Int

The response's http status code.

CreateAppBlock

createAppBlock_description :: Lens' CreateAppBlock (Maybe Text)

The description of the app block.

createAppBlock_displayName :: Lens' CreateAppBlock (Maybe Text)

The display name of the app block. This is not displayed to the user.

createAppBlock_tags :: Lens' CreateAppBlock (Maybe (HashMap Text Text))

The tags assigned to the app block.

createAppBlock_name :: Lens' CreateAppBlock Text

The name of the app block.

createAppBlock_sourceS3Location :: Lens' CreateAppBlock S3Location

The source S3 location of the app block.

createAppBlock_setupScriptDetails :: Lens' CreateAppBlock ScriptDetails

The setup script details of the app block.

createAppBlockResponse_appBlock :: Lens' CreateAppBlockResponse (Maybe AppBlock)

The app block.

createAppBlockResponse_httpStatus :: Lens' CreateAppBlockResponse Int

The response's http status code.

CreateApplication

createApplication_description :: Lens' CreateApplication (Maybe Text)

The description of the application.

createApplication_displayName :: Lens' CreateApplication (Maybe Text)

The display name of the application. This name is visible to users in the application catalog.

createApplication_launchParameters :: Lens' CreateApplication (Maybe Text)

The launch parameters of the application.

createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text))

The tags assigned to the application.

createApplication_workingDirectory :: Lens' CreateApplication (Maybe Text)

The working directory of the application.

createApplication_name :: Lens' CreateApplication Text

The name of the application. This name is visible to users when display name is not specified.

createApplication_iconS3Location :: Lens' CreateApplication S3Location

The location in S3 of the application icon.

createApplication_launchPath :: Lens' CreateApplication Text

The launch path of the application.

createApplication_platforms :: Lens' CreateApplication [PlatformType]

The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

createApplication_instanceFamilies :: Lens' CreateApplication [Text]

The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.

createApplication_appBlockArn :: Lens' CreateApplication Text

The app block ARN to which the application should be associated

createApplicationResponse_application :: Lens' CreateApplicationResponse (Maybe Application)

Undocumented member.

createApplicationResponse_httpStatus :: Lens' CreateApplicationResponse Int

The response's http status code.

CreateDirectoryConfig

createDirectoryConfig_certificateBasedAuthProperties :: Lens' CreateDirectoryConfig (Maybe CertificateBasedAuthProperties)

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.

createDirectoryConfig_serviceAccountCredentials :: Lens' CreateDirectoryConfig (Maybe ServiceAccountCredentials)

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

createDirectoryConfig_directoryName :: Lens' CreateDirectoryConfig Text

The fully qualified name of the directory (for example, corp.example.com).

createDirectoryConfig_organizationalUnitDistinguishedNames :: Lens' CreateDirectoryConfig [Text]

The distinguished names of the organizational units for computer accounts.

createDirectoryConfigResponse_directoryConfig :: Lens' CreateDirectoryConfigResponse (Maybe DirectoryConfig)

Information about the directory configuration.

createDirectoryConfigResponse_httpStatus :: Lens' CreateDirectoryConfigResponse Int

The response's http status code.

CreateEntitlement

createEntitlement_description :: Lens' CreateEntitlement (Maybe Text)

The description of the entitlement.

createEntitlement_name :: Lens' CreateEntitlement Text

The name of the entitlement.

createEntitlement_stackName :: Lens' CreateEntitlement Text

The name of the stack with which the entitlement is associated.

createEntitlement_appVisibility :: Lens' CreateEntitlement AppVisibility

Specifies whether all or selected apps are entitled.

createEntitlement_attributes :: Lens' CreateEntitlement (NonEmpty EntitlementAttribute)

The attributes of the entitlement.

createEntitlementResponse_entitlement :: Lens' CreateEntitlementResponse (Maybe Entitlement)

The entitlement.

createEntitlementResponse_httpStatus :: Lens' CreateEntitlementResponse Int

The response's http status code.

CreateFleet

createFleet_computeCapacity :: Lens' CreateFleet (Maybe ComputeCapacity)

The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.

createFleet_description :: Lens' CreateFleet (Maybe Text)

The description to display.

createFleet_disconnectTimeoutInSeconds :: Lens' CreateFleet (Maybe Int)

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

createFleet_displayName :: Lens' CreateFleet (Maybe Text)

The fleet name to display.

createFleet_domainJoinInfo :: Lens' CreateFleet (Maybe DomainJoinInfo)

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.

createFleet_enableDefaultInternetAccess :: Lens' CreateFleet (Maybe Bool)

Enables or disables default internet access for the fleet.

createFleet_fleetType :: Lens' CreateFleet (Maybe FleetType)

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.

createFleet_iamRoleArn :: Lens' CreateFleet (Maybe Text)

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. AppStream 2.0 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 AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

createFleet_idleDisconnectTimeoutInSeconds :: Lens' CreateFleet (Maybe Int)

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

createFleet_imageArn :: Lens' CreateFleet (Maybe Text)

The ARN of the public, private, or shared image to use.

createFleet_imageName :: Lens' CreateFleet (Maybe Text)

The name of the image used to create the fleet.

createFleet_maxConcurrentSessions :: Lens' CreateFleet (Maybe Int)

The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.

createFleet_maxUserDurationInSeconds :: Lens' CreateFleet (Maybe Int)

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.

createFleet_platform :: Lens' CreateFleet (Maybe PlatformType)

The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

createFleet_sessionScriptS3Location :: Lens' CreateFleet (Maybe S3Location)

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

createFleet_streamView :: Lens' CreateFleet (Maybe StreamView)

The AppStream 2.0 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.

createFleet_tags :: Lens' CreateFleet (Maybe (HashMap Text Text))

The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

createFleet_usbDeviceFilterStrings :: Lens' CreateFleet (Maybe [Text])

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.

createFleet_vpcConfig :: Lens' CreateFleet (Maybe VpcConfig)

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.

createFleet_name :: Lens' CreateFleet Text

A unique name for the fleet.

createFleet_instanceType :: Lens' CreateFleet Text

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.standard.xlarge
• stream.standard.2xlarge
• stream.compute.large
• stream.compute.xlarge
• stream.compute.2xlarge
• stream.compute.4xlarge
• stream.compute.8xlarge
• stream.memory.large
• stream.memory.xlarge
• stream.memory.2xlarge
• stream.memory.4xlarge
• stream.memory.8xlarge
• stream.memory.z1d.large
• stream.memory.z1d.xlarge
• stream.memory.z1d.2xlarge
• stream.memory.z1d.3xlarge
• stream.memory.z1d.6xlarge
• stream.memory.z1d.12xlarge
• stream.graphics-design.large
• stream.graphics-design.xlarge
• stream.graphics-design.2xlarge
• stream.graphics-design.4xlarge
• stream.graphics-desktop.2xlarge
• stream.graphics.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics-pro.4xlarge
• stream.graphics-pro.8xlarge
• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.standard.xlarge
• stream.standard.2xlarge

createFleetResponse_fleet :: Lens' CreateFleetResponse (Maybe Fleet)

Information about the fleet.

createFleetResponse_httpStatus :: Lens' CreateFleetResponse Int

The response's http status code.

CreateImageBuilder

createImageBuilder_accessEndpoints :: Lens' CreateImageBuilder (Maybe (NonEmpty AccessEndpoint))

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

createImageBuilder_appstreamAgentVersion :: Lens' CreateImageBuilder (Maybe Text)

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

createImageBuilder_description :: Lens' CreateImageBuilder (Maybe Text)

The description to display.

createImageBuilder_displayName :: Lens' CreateImageBuilder (Maybe Text)

The image builder name to display.

createImageBuilder_domainJoinInfo :: Lens' CreateImageBuilder (Maybe DomainJoinInfo)

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

createImageBuilder_enableDefaultInternetAccess :: Lens' CreateImageBuilder (Maybe Bool)

Enables or disables default internet access for the image builder.

createImageBuilder_iamRoleArn :: Lens' CreateImageBuilder (Maybe Text)

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. AppStream 2.0 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 AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

createImageBuilder_imageArn :: Lens' CreateImageBuilder (Maybe Text)

The ARN of the public, private, or shared image to use.

createImageBuilder_imageName :: Lens' CreateImageBuilder (Maybe Text)

The name of the image used to create the image builder.

createImageBuilder_tags :: Lens' CreateImageBuilder (Maybe (HashMap Text Text))

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

createImageBuilder_vpcConfig :: Lens' CreateImageBuilder (Maybe VpcConfig)

The VPC configuration for the image builder. You can specify only one subnet.

createImageBuilder_name :: Lens' CreateImageBuilder Text

A unique name for the image builder.

createImageBuilder_instanceType :: Lens' CreateImageBuilder Text

The instance type to use when launching the image builder. The following instance types are available:

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.compute.large
• stream.compute.xlarge
• stream.compute.2xlarge
• stream.compute.4xlarge
• stream.compute.8xlarge
• stream.memory.large
• stream.memory.xlarge
• stream.memory.2xlarge
• stream.memory.4xlarge
• stream.memory.8xlarge
• stream.memory.z1d.large
• stream.memory.z1d.xlarge
• stream.memory.z1d.2xlarge
• stream.memory.z1d.3xlarge
• stream.memory.z1d.6xlarge
• stream.memory.z1d.12xlarge
• stream.graphics-design.large
• stream.graphics-design.xlarge
• stream.graphics-design.2xlarge
• stream.graphics-design.4xlarge
• stream.graphics-desktop.2xlarge
• stream.graphics.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics-pro.4xlarge
• stream.graphics-pro.8xlarge
• stream.graphics-pro.16xlarge

createImageBuilderResponse_imageBuilder :: Lens' CreateImageBuilderResponse (Maybe ImageBuilder)

Information about the image builder.

createImageBuilderResponse_httpStatus :: Lens' CreateImageBuilderResponse Int

The response's http status code.

CreateImageBuilderStreamingURL

createImageBuilderStreamingURL_validity :: Lens' CreateImageBuilderStreamingURL (Maybe Integer)

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

createImageBuilderStreamingURL_name :: Lens' CreateImageBuilderStreamingURL Text

The name of the image builder.

createImageBuilderStreamingURLResponse_expires :: Lens' CreateImageBuilderStreamingURLResponse (Maybe UTCTime)

The elapsed time, in seconds after the Unix epoch, when this URL expires.

createImageBuilderStreamingURLResponse_streamingURL :: Lens' CreateImageBuilderStreamingURLResponse (Maybe Text)

The URL to start the AppStream 2.0 streaming session.

createImageBuilderStreamingURLResponse_httpStatus :: Lens' CreateImageBuilderStreamingURLResponse Int

The response's http status code.

CreateStack

createStack_accessEndpoints :: Lens' CreateStack (Maybe (NonEmpty AccessEndpoint))

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

createStack_applicationSettings :: Lens' CreateStack (Maybe ApplicationSettings)

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.

createStack_description :: Lens' CreateStack (Maybe Text)

The description to display.

createStack_displayName :: Lens' CreateStack (Maybe Text)

The stack name to display.

createStack_embedHostDomains :: Lens' CreateStack (Maybe (NonEmpty Text))

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

createStack_feedbackURL :: Lens' CreateStack (Maybe Text)

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.

createStack_redirectURL :: Lens' CreateStack (Maybe Text)

The URL that users are redirected to after their streaming session ends.

createStack_storageConnectors :: Lens' CreateStack (Maybe [StorageConnector])

The storage connectors to enable.

createStack_streamingExperienceSettings :: Lens' CreateStack (Maybe StreamingExperienceSettings)

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.

createStack_tags :: Lens' CreateStack (Maybe (HashMap Text Text))

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

createStack_userSettings :: Lens' CreateStack (Maybe (NonEmpty UserSetting))

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

createStack_name :: Lens' CreateStack Text

The name of the stack.

createStackResponse_stack :: Lens' CreateStackResponse (Maybe Stack)

Information about the stack.

createStackResponse_httpStatus :: Lens' CreateStackResponse Int

The response's http status code.

CreateStreamingURL

createStreamingURL_applicationId :: Lens' CreateStreamingURL (Maybe Text)

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.

createStreamingURL_sessionContext :: Lens' CreateStreamingURL (Maybe Text)

The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

createStreamingURL_validity :: Lens' CreateStreamingURL (Maybe Integer)

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

createStreamingURL_stackName :: Lens' CreateStreamingURL Text

The name of the stack.

createStreamingURL_fleetName :: Lens' CreateStreamingURL Text

The name of the fleet.

createStreamingURL_userId :: Lens' CreateStreamingURL Text

The identifier of the user.

createStreamingURLResponse_expires :: Lens' CreateStreamingURLResponse (Maybe UTCTime)

The elapsed time, in seconds after the Unix epoch, when this URL expires.

createStreamingURLResponse_streamingURL :: Lens' CreateStreamingURLResponse (Maybe Text)

The URL to start the AppStream 2.0 streaming session.

createStreamingURLResponse_httpStatus :: Lens' CreateStreamingURLResponse Int

The response's http status code.

CreateUpdatedImage

createUpdatedImage_dryRun :: Lens' CreateUpdatedImage (Maybe Bool)

Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.

createUpdatedImage_newImageDescription :: Lens' CreateUpdatedImage (Maybe Text)

The description to display for the new image.

createUpdatedImage_newImageDisplayName :: Lens' CreateUpdatedImage (Maybe Text)

The name to display for the new image.

createUpdatedImage_newImageTags :: Lens' CreateUpdatedImage (Maybe (HashMap Text Text))

The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

createUpdatedImage_existingImageName :: Lens' CreateUpdatedImage Text

The name of the image to update.

createUpdatedImage_newImageName :: Lens' CreateUpdatedImage Text

The name of the new image. The name must be unique within the AWS account and Region.

createUpdatedImageResponse_canUpdateImage :: Lens' CreateUpdatedImageResponse (Maybe Bool)

Indicates whether a new image can be created.

createUpdatedImageResponse_image :: Lens' CreateUpdatedImageResponse (Maybe Image)

Undocumented member.

createUpdatedImageResponse_httpStatus :: Lens' CreateUpdatedImageResponse Int

The response's http status code.

CreateUsageReportSubscription

createUsageReportSubscriptionResponse_s3BucketName :: Lens' CreateUsageReportSubscriptionResponse (Maybe Text)

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, AppStream 2.0 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, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

createUsageReportSubscriptionResponse_schedule :: Lens' CreateUsageReportSubscriptionResponse (Maybe UsageReportSchedule)

The schedule for generating usage reports.

createUsageReportSubscriptionResponse_httpStatus :: Lens' CreateUsageReportSubscriptionResponse Int

The response's http status code.

CreateUser

createUser_firstName :: Lens' CreateUser (Maybe Text)

The first name, or given name, of the user.

createUser_lastName :: Lens' CreateUser (Maybe Text)

The last name, or surname, of the user.

createUser_messageAction :: Lens' CreateUser (Maybe MessageAction)

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.

createUser_userName :: Lens' CreateUser Text

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.

createUser_authenticationType :: Lens' CreateUser AuthenticationType

The authentication type for the user. You must specify USERPOOL.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int

The response's http status code.

DeleteAppBlock

deleteAppBlock_name :: Lens' DeleteAppBlock Text

The name of the app block.

deleteAppBlockResponse_httpStatus :: Lens' DeleteAppBlockResponse Int

The response's http status code.

DeleteApplication

deleteApplication_name :: Lens' DeleteApplication Text

The name of the application.

deleteApplicationResponse_httpStatus :: Lens' DeleteApplicationResponse Int

The response's http status code.

DeleteDirectoryConfig

deleteDirectoryConfig_directoryName :: Lens' DeleteDirectoryConfig Text

The name of the directory configuration.

deleteDirectoryConfigResponse_httpStatus :: Lens' DeleteDirectoryConfigResponse Int

The response's http status code.

DeleteEntitlement

deleteEntitlement_name :: Lens' DeleteEntitlement Text

The name of the entitlement.

deleteEntitlement_stackName :: Lens' DeleteEntitlement Text

The name of the stack with which the entitlement is associated.

deleteEntitlementResponse_httpStatus :: Lens' DeleteEntitlementResponse Int

The response's http status code.

DeleteFleet

deleteFleet_name :: Lens' DeleteFleet Text

The name of the fleet.

deleteFleetResponse_httpStatus :: Lens' DeleteFleetResponse Int

The response's http status code.

DeleteImage

deleteImage_name :: Lens' DeleteImage Text

The name of the image.

deleteImageResponse_image :: Lens' DeleteImageResponse (Maybe Image)

Information about the image.

deleteImageResponse_httpStatus :: Lens' DeleteImageResponse Int

The response's http status code.

DeleteImageBuilder

deleteImageBuilder_name :: Lens' DeleteImageBuilder Text

The name of the image builder.

deleteImageBuilderResponse_imageBuilder :: Lens' DeleteImageBuilderResponse (Maybe ImageBuilder)

Information about the image builder.

deleteImageBuilderResponse_httpStatus :: Lens' DeleteImageBuilderResponse Int

The response's http status code.

DeleteImagePermissions

deleteImagePermissions_name :: Lens' DeleteImagePermissions Text

The name of the private image.

deleteImagePermissions_sharedAccountId :: Lens' DeleteImagePermissions Text

The 12-digit identifier of the AWS account for which to delete image permissions.

deleteImagePermissionsResponse_httpStatus :: Lens' DeleteImagePermissionsResponse Int

The response's http status code.

DeleteStack

deleteStack_name :: Lens' DeleteStack Text

The name of the stack.

deleteStackResponse_httpStatus :: Lens' DeleteStackResponse Int

The response's http status code.

DeleteUsageReportSubscription

deleteUsageReportSubscriptionResponse_httpStatus :: Lens' DeleteUsageReportSubscriptionResponse Int

The response's http status code.

DeleteUser

deleteUser_userName :: Lens' DeleteUser Text

The email address of the user.

Users' email addresses are case-sensitive.

deleteUser_authenticationType :: Lens' DeleteUser AuthenticationType

The authentication type for the user. You must specify USERPOOL.

deleteUserResponse_httpStatus :: Lens' DeleteUserResponse Int

The response's http status code.

DescribeAppBlocks

describeAppBlocks_arns :: Lens' DescribeAppBlocks (Maybe [Text])

The ARNs of the app blocks.

describeAppBlocks_maxResults :: Lens' DescribeAppBlocks (Maybe Int)

The maximum size of each page of results.

describeAppBlocks_nextToken :: Lens' DescribeAppBlocks (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeAppBlocksResponse_appBlocks :: Lens' DescribeAppBlocksResponse (Maybe [AppBlock])

The app blocks in the list.

describeAppBlocksResponse_nextToken :: Lens' DescribeAppBlocksResponse (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeAppBlocksResponse_httpStatus :: Lens' DescribeAppBlocksResponse Int

The response's http status code.

DescribeApplicationFleetAssociations

describeApplicationFleetAssociations_applicationArn :: Lens' DescribeApplicationFleetAssociations (Maybe Text)

The ARN of the application.

describeApplicationFleetAssociations_fleetName :: Lens' DescribeApplicationFleetAssociations (Maybe Text)

The name of the fleet.

describeApplicationFleetAssociations_maxResults :: Lens' DescribeApplicationFleetAssociations (Maybe Int)

The maximum size of each page of results.

describeApplicationFleetAssociations_nextToken :: Lens' DescribeApplicationFleetAssociations (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeApplicationFleetAssociationsResponse_applicationFleetAssociations :: Lens' DescribeApplicationFleetAssociationsResponse (Maybe (NonEmpty ApplicationFleetAssociation))

The application fleet associations in the list.

describeApplicationFleetAssociationsResponse_nextToken :: Lens' DescribeApplicationFleetAssociationsResponse (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeApplicationFleetAssociationsResponse_httpStatus :: Lens' DescribeApplicationFleetAssociationsResponse Int

The response's http status code.

DescribeApplications

describeApplications_arns :: Lens' DescribeApplications (Maybe [Text])

The ARNs for the applications.

describeApplications_maxResults :: Lens' DescribeApplications (Maybe Int)

The maximum size of each page of results.

describeApplications_nextToken :: Lens' DescribeApplications (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeApplicationsResponse_applications :: Lens' DescribeApplicationsResponse (Maybe [Application])

The applications in the list.

describeApplicationsResponse_nextToken :: Lens' DescribeApplicationsResponse (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeApplicationsResponse_httpStatus :: Lens' DescribeApplicationsResponse Int

The response's http status code.

DescribeDirectoryConfigs

describeDirectoryConfigs_directoryNames :: Lens' DescribeDirectoryConfigs (Maybe [Text])

The directory names.

describeDirectoryConfigs_maxResults :: Lens' DescribeDirectoryConfigs (Maybe Int)

The maximum size of each page of results.

describeDirectoryConfigs_nextToken :: Lens' DescribeDirectoryConfigs (Maybe Text)

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.

describeDirectoryConfigsResponse_directoryConfigs :: Lens' DescribeDirectoryConfigsResponse (Maybe [DirectoryConfig])

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.

describeDirectoryConfigsResponse_nextToken :: Lens' DescribeDirectoryConfigsResponse (Maybe Text)

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.

describeDirectoryConfigsResponse_httpStatus :: Lens' DescribeDirectoryConfigsResponse Int

The response's http status code.

DescribeEntitlements

describeEntitlements_maxResults :: Lens' DescribeEntitlements (Maybe Int)

The maximum size of each page of results.

describeEntitlements_name :: Lens' DescribeEntitlements (Maybe Text)

The name of the entitlement.

describeEntitlements_nextToken :: Lens' DescribeEntitlements (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeEntitlements_stackName :: Lens' DescribeEntitlements Text

The name of the stack with which the entitlement is associated.

describeEntitlementsResponse_entitlements :: Lens' DescribeEntitlementsResponse (Maybe [Entitlement])

The entitlements.

describeEntitlementsResponse_nextToken :: Lens' DescribeEntitlementsResponse (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

describeEntitlementsResponse_httpStatus :: Lens' DescribeEntitlementsResponse Int

The response's http status code.

DescribeFleets

describeFleets_names :: Lens' DescribeFleets (Maybe [Text])

The names of the fleets to describe.

describeFleets_nextToken :: Lens' DescribeFleets (Maybe Text)

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.

describeFleetsResponse_fleets :: Lens' DescribeFleetsResponse (Maybe [Fleet])

Information about the fleets.

describeFleetsResponse_nextToken :: Lens' DescribeFleetsResponse (Maybe Text)

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.

describeFleetsResponse_httpStatus :: Lens' DescribeFleetsResponse Int

The response's http status code.

DescribeImageBuilders

describeImageBuilders_maxResults :: Lens' DescribeImageBuilders (Maybe Int)

The maximum size of each page of results.

describeImageBuilders_names :: Lens' DescribeImageBuilders (Maybe [Text])

The names of the image builders to describe.

describeImageBuilders_nextToken :: Lens' DescribeImageBuilders (Maybe Text)

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.

describeImageBuildersResponse_imageBuilders :: Lens' DescribeImageBuildersResponse (Maybe [ImageBuilder])

Information about the image builders.

describeImageBuildersResponse_nextToken :: Lens' DescribeImageBuildersResponse (Maybe Text)

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.

describeImageBuildersResponse_httpStatus :: Lens' DescribeImageBuildersResponse Int

The response's http status code.

DescribeImagePermissions

describeImagePermissions_maxResults :: Lens' DescribeImagePermissions (Maybe Natural)

The maximum size of each page of results.

describeImagePermissions_nextToken :: Lens' DescribeImagePermissions (Maybe Text)

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.

describeImagePermissions_sharedAwsAccountIds :: Lens' DescribeImagePermissions (Maybe (NonEmpty Text))

The 12-digit identifier of one or more AWS accounts with which the image is shared.

describeImagePermissions_name :: Lens' DescribeImagePermissions Text

The name of the private image for which to describe permissions. The image must be one that you own.

describeImagePermissionsResponse_name :: Lens' DescribeImagePermissionsResponse (Maybe Text)

The name of the private image.

describeImagePermissionsResponse_nextToken :: Lens' DescribeImagePermissionsResponse (Maybe Text)

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.

describeImagePermissionsResponse_sharedImagePermissionsList :: Lens' DescribeImagePermissionsResponse (Maybe [SharedImagePermissions])

The permissions for a private image that you own.

describeImagePermissionsResponse_httpStatus :: Lens' DescribeImagePermissionsResponse Int

The response's http status code.

DescribeImages

describeImages_arns :: Lens' DescribeImages (Maybe [Text])

The ARNs of the public, private, and shared images to describe.

describeImages_maxResults :: Lens' DescribeImages (Maybe Natural)

The maximum size of each page of results.

describeImages_names :: Lens' DescribeImages (Maybe [Text])

The names of the public or private images to describe.

describeImages_nextToken :: Lens' DescribeImages (Maybe Text)

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.

describeImages_type :: Lens' DescribeImages (Maybe VisibilityType)

The type of image (public, private, or shared) to describe.

describeImagesResponse_images :: Lens' DescribeImagesResponse (Maybe [Image])

Information about the images.

describeImagesResponse_nextToken :: Lens' DescribeImagesResponse (Maybe Text)

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.

describeImagesResponse_httpStatus :: Lens' DescribeImagesResponse Int

The response's http status code.

DescribeSessions

describeSessions_authenticationType :: Lens' DescribeSessions (Maybe AuthenticationType)

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.

describeSessions_limit :: Lens' DescribeSessions (Maybe Int)

The size of each page of results. The default value is 20 and the maximum value is 50.

describeSessions_nextToken :: Lens' DescribeSessions (Maybe Text)

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.

describeSessions_userId :: Lens' DescribeSessions (Maybe Text)

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

describeSessions_stackName :: Lens' DescribeSessions Text

The name of the stack. This value is case-sensitive.

describeSessions_fleetName :: Lens' DescribeSessions Text

The name of the fleet. This value is case-sensitive.

describeSessionsResponse_nextToken :: Lens' DescribeSessionsResponse (Maybe Text)

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.

describeSessionsResponse_sessions :: Lens' DescribeSessionsResponse (Maybe [Session])

Information about the streaming sessions.

describeSessionsResponse_httpStatus :: Lens' DescribeSessionsResponse Int

The response's http status code.

DescribeStacks

describeStacks_names :: Lens' DescribeStacks (Maybe [Text])

The names of the stacks to describe.

describeStacks_nextToken :: Lens' DescribeStacks (Maybe Text)

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.

describeStacksResponse_nextToken :: Lens' DescribeStacksResponse (Maybe Text)

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.

describeStacksResponse_stacks :: Lens' DescribeStacksResponse (Maybe [Stack])

Information about the stacks.

describeStacksResponse_httpStatus :: Lens' DescribeStacksResponse Int

The response's http status code.

DescribeUsageReportSubscriptions

describeUsageReportSubscriptions_maxResults :: Lens' DescribeUsageReportSubscriptions (Maybe Int)

The maximum size of each page of results.

describeUsageReportSubscriptions_nextToken :: Lens' DescribeUsageReportSubscriptions (Maybe Text)

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.

describeUsageReportSubscriptionsResponse_nextToken :: Lens' DescribeUsageReportSubscriptionsResponse (Maybe Text)

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.

describeUsageReportSubscriptionsResponse_usageReportSubscriptions :: Lens' DescribeUsageReportSubscriptionsResponse (Maybe [UsageReportSubscription])

Information about the usage report subscription.

describeUsageReportSubscriptionsResponse_httpStatus :: Lens' DescribeUsageReportSubscriptionsResponse Int

The response's http status code.

DescribeUserStackAssociations

describeUserStackAssociations_authenticationType :: Lens' DescribeUserStackAssociations (Maybe AuthenticationType)

The authentication type for the user who is associated with the stack. You must specify USERPOOL.

describeUserStackAssociations_maxResults :: Lens' DescribeUserStackAssociations (Maybe Natural)

The maximum size of each page of results.

describeUserStackAssociations_nextToken :: Lens' DescribeUserStackAssociations (Maybe Text)

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.

describeUserStackAssociations_stackName :: Lens' DescribeUserStackAssociations (Maybe Text)

The name of the stack that is associated with the user.

describeUserStackAssociations_userName :: Lens' DescribeUserStackAssociations (Maybe Text)

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

describeUserStackAssociationsResponse_nextToken :: Lens' DescribeUserStackAssociationsResponse (Maybe Text)

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.

describeUserStackAssociationsResponse_userStackAssociations :: Lens' DescribeUserStackAssociationsResponse (Maybe (NonEmpty UserStackAssociation))

The UserStackAssociation objects.

describeUserStackAssociationsResponse_httpStatus :: Lens' DescribeUserStackAssociationsResponse Int

The response's http status code.

DescribeUsers

describeUsers_maxResults :: Lens' DescribeUsers (Maybe Int)

The maximum size of each page of results.

describeUsers_nextToken :: Lens' DescribeUsers (Maybe Text)

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.

describeUsers_authenticationType :: Lens' DescribeUsers AuthenticationType

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

describeUsersResponse_nextToken :: Lens' DescribeUsersResponse (Maybe Text)

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.

describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])

Information about users in the user pool.

describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int

The response's http status code.

DisableUser

disableUser_userName :: Lens' DisableUser Text

The email address of the user.

Users' email addresses are case-sensitive.

disableUser_authenticationType :: Lens' DisableUser AuthenticationType

The authentication type for the user. You must specify USERPOOL.

disableUserResponse_httpStatus :: Lens' DisableUserResponse Int

The response's http status code.

DisassociateApplicationFleet

disassociateApplicationFleet_fleetName :: Lens' DisassociateApplicationFleet Text

The name of the fleet.

disassociateApplicationFleet_applicationArn :: Lens' DisassociateApplicationFleet Text

The ARN of the application.

disassociateApplicationFleetResponse_httpStatus :: Lens' DisassociateApplicationFleetResponse Int

The response's http status code.

DisassociateApplicationFromEntitlement

disassociateApplicationFromEntitlement_stackName :: Lens' DisassociateApplicationFromEntitlement Text

The name of the stack with which the entitlement is associated.

disassociateApplicationFromEntitlement_entitlementName :: Lens' DisassociateApplicationFromEntitlement Text

The name of the entitlement.

disassociateApplicationFromEntitlement_applicationIdentifier :: Lens' DisassociateApplicationFromEntitlement Text

The identifier of the application to remove from the entitlement.

disassociateApplicationFromEntitlementResponse_httpStatus :: Lens' DisassociateApplicationFromEntitlementResponse Int

The response's http status code.

DisassociateFleet

disassociateFleet_fleetName :: Lens' DisassociateFleet Text

The name of the fleet.

disassociateFleet_stackName :: Lens' DisassociateFleet Text

The name of the stack.

disassociateFleetResponse_httpStatus :: Lens' DisassociateFleetResponse Int

The response's http status code.

EnableUser

enableUser_userName :: Lens' EnableUser Text

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.

enableUser_authenticationType :: Lens' EnableUser AuthenticationType

The authentication type for the user. You must specify USERPOOL.

enableUserResponse_httpStatus :: Lens' EnableUserResponse Int

The response's http status code.

ExpireSession

expireSession_sessionId :: Lens' ExpireSession Text

The identifier of the streaming session.

expireSessionResponse_httpStatus :: Lens' ExpireSessionResponse Int

The response's http status code.

ListAssociatedFleets

listAssociatedFleets_nextToken :: Lens' ListAssociatedFleets (Maybe Text)

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.

listAssociatedFleets_stackName :: Lens' ListAssociatedFleets Text

The name of the stack.

listAssociatedFleetsResponse_names :: Lens' ListAssociatedFleetsResponse (Maybe [Text])

The name of the fleet.

listAssociatedFleetsResponse_nextToken :: Lens' ListAssociatedFleetsResponse (Maybe Text)

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.

listAssociatedFleetsResponse_httpStatus :: Lens' ListAssociatedFleetsResponse Int

The response's http status code.

ListAssociatedStacks

listAssociatedStacks_nextToken :: Lens' ListAssociatedStacks (Maybe Text)

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.

listAssociatedStacks_fleetName :: Lens' ListAssociatedStacks Text

The name of the fleet.

listAssociatedStacksResponse_names :: Lens' ListAssociatedStacksResponse (Maybe [Text])

The name of the stack.

listAssociatedStacksResponse_nextToken :: Lens' ListAssociatedStacksResponse (Maybe Text)

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.

listAssociatedStacksResponse_httpStatus :: Lens' ListAssociatedStacksResponse Int

The response's http status code.

ListEntitledApplications

listEntitledApplications_maxResults :: Lens' ListEntitledApplications (Maybe Int)

The maximum size of each page of results.

listEntitledApplications_nextToken :: Lens' ListEntitledApplications (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

listEntitledApplications_stackName :: Lens' ListEntitledApplications Text

The name of the stack with which the entitlement is associated.

listEntitledApplications_entitlementName :: Lens' ListEntitledApplications Text

The name of the entitlement.

listEntitledApplicationsResponse_entitledApplications :: Lens' ListEntitledApplicationsResponse (Maybe [EntitledApplication])

The entitled applications.

listEntitledApplicationsResponse_nextToken :: Lens' ListEntitledApplicationsResponse (Maybe Text)

The pagination token used to retrieve the next page of results for this operation.

listEntitledApplicationsResponse_httpStatus :: Lens' ListEntitledApplicationsResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text

The Amazon Resource Name (ARN) of the resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))

The information about the tags.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

StartFleet

startFleet_name :: Lens' StartFleet Text

The name of the fleet.

startFleetResponse_httpStatus :: Lens' StartFleetResponse Int

The response's http status code.

StartImageBuilder

startImageBuilder_appstreamAgentVersion :: Lens' StartImageBuilder (Maybe Text)

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

startImageBuilder_name :: Lens' StartImageBuilder Text

The name of the image builder.

startImageBuilderResponse_imageBuilder :: Lens' StartImageBuilderResponse (Maybe ImageBuilder)

Information about the image builder.

startImageBuilderResponse_httpStatus :: Lens' StartImageBuilderResponse Int

The response's http status code.

StopFleet

stopFleet_name :: Lens' StopFleet Text

The name of the fleet.

stopFleetResponse_httpStatus :: Lens' StopFleetResponse Int

The response's http status code.

StopImageBuilder

stopImageBuilder_name :: Lens' StopImageBuilder Text

The name of the image builder.

stopImageBuilderResponse_imageBuilder :: Lens' StopImageBuilderResponse (Maybe ImageBuilder)

Information about the image builder.

stopImageBuilderResponse_httpStatus :: Lens' StopImageBuilderResponse Int

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text)

The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)

The tag keys for the tags to disassociate.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdateApplication

updateApplication_appBlockArn :: Lens' UpdateApplication (Maybe Text)

The ARN of the app block.

updateApplication_attributesToDelete :: Lens' UpdateApplication (Maybe [ApplicationAttribute])

The attributes to delete for an application.

updateApplication_description :: Lens' UpdateApplication (Maybe Text)

The description of the application.

updateApplication_displayName :: Lens' UpdateApplication (Maybe Text)

The display name of the application. This name is visible to users in the application catalog.

updateApplication_iconS3Location :: Lens' UpdateApplication (Maybe S3Location)

The icon S3 location of the application.

updateApplication_launchParameters :: Lens' UpdateApplication (Maybe Text)

The launch parameters of the application.

updateApplication_launchPath :: Lens' UpdateApplication (Maybe Text)

The launch path of the application.

updateApplication_workingDirectory :: Lens' UpdateApplication (Maybe Text)

The working directory of the application.

updateApplication_name :: Lens' UpdateApplication Text

The name of the application. This name is visible to users when display name is not specified.

updateApplicationResponse_application :: Lens' UpdateApplicationResponse (Maybe Application)

Undocumented member.

updateApplicationResponse_httpStatus :: Lens' UpdateApplicationResponse Int

The response's http status code.

UpdateDirectoryConfig

updateDirectoryConfig_certificateBasedAuthProperties :: Lens' UpdateDirectoryConfig (Maybe CertificateBasedAuthProperties)

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.

updateDirectoryConfig_organizationalUnitDistinguishedNames :: Lens' UpdateDirectoryConfig (Maybe [Text])

The distinguished names of the organizational units for computer accounts.

updateDirectoryConfig_serviceAccountCredentials :: Lens' UpdateDirectoryConfig (Maybe ServiceAccountCredentials)

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

updateDirectoryConfig_directoryName :: Lens' UpdateDirectoryConfig Text

The name of the Directory Config object.

updateDirectoryConfigResponse_directoryConfig :: Lens' UpdateDirectoryConfigResponse (Maybe DirectoryConfig)

Information about the Directory Config object.

updateDirectoryConfigResponse_httpStatus :: Lens' UpdateDirectoryConfigResponse Int

The response's http status code.

UpdateEntitlement

updateEntitlement_appVisibility :: Lens' UpdateEntitlement (Maybe AppVisibility)

Specifies whether all or only selected apps are entitled.

updateEntitlement_attributes :: Lens' UpdateEntitlement (Maybe (NonEmpty EntitlementAttribute))

The attributes of the entitlement.

updateEntitlement_description :: Lens' UpdateEntitlement (Maybe Text)

The description of the entitlement.

updateEntitlement_name :: Lens' UpdateEntitlement Text

The name of the entitlement.

updateEntitlement_stackName :: Lens' UpdateEntitlement Text

The name of the stack with which the entitlement is associated.

updateEntitlementResponse_entitlement :: Lens' UpdateEntitlementResponse (Maybe Entitlement)

The entitlement.

updateEntitlementResponse_httpStatus :: Lens' UpdateEntitlementResponse Int

The response's http status code.

UpdateFleet

updateFleet_attributesToDelete :: Lens' UpdateFleet (Maybe [FleetAttribute])

The fleet attributes to delete.

updateFleet_computeCapacity :: Lens' UpdateFleet (Maybe ComputeCapacity)

The desired capacity for the fleet. This is not allowed for Elastic fleets.

updateFleet_deleteVpcConfig :: Lens' UpdateFleet (Maybe Bool)

Deletes the VPC association for the specified fleet.

updateFleet_description :: Lens' UpdateFleet (Maybe Text)

The description to display.

updateFleet_disconnectTimeoutInSeconds :: Lens' UpdateFleet (Maybe Int)

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

updateFleet_displayName :: Lens' UpdateFleet (Maybe Text)

The fleet name to display.

updateFleet_domainJoinInfo :: Lens' UpdateFleet (Maybe DomainJoinInfo)

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

updateFleet_enableDefaultInternetAccess :: Lens' UpdateFleet (Maybe Bool)

Enables or disables default internet access for the fleet.

updateFleet_iamRoleArn :: Lens' UpdateFleet (Maybe Text)

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. AppStream 2.0 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 AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

updateFleet_idleDisconnectTimeoutInSeconds :: Lens' UpdateFleet (Maybe Int)

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

updateFleet_imageArn :: Lens' UpdateFleet (Maybe Text)

The ARN of the public, private, or shared image to use.

updateFleet_imageName :: Lens' UpdateFleet (Maybe Text)

The name of the image used to create the fleet.

updateFleet_instanceType :: Lens' UpdateFleet (Maybe Text)

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.standard.xlarge
• stream.standard.2xlarge
• stream.compute.large
• stream.compute.xlarge
• stream.compute.2xlarge
• stream.compute.4xlarge
• stream.compute.8xlarge
• stream.memory.large
• stream.memory.xlarge
• stream.memory.2xlarge
• stream.memory.4xlarge
• stream.memory.8xlarge
• stream.memory.z1d.large
• stream.memory.z1d.xlarge
• stream.memory.z1d.2xlarge
• stream.memory.z1d.3xlarge
• stream.memory.z1d.6xlarge
• stream.memory.z1d.12xlarge
• stream.graphics-design.large
• stream.graphics-design.xlarge
• stream.graphics-design.2xlarge
• stream.graphics-design.4xlarge
• stream.graphics-desktop.2xlarge
• stream.graphics.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics-pro.4xlarge
• stream.graphics-pro.8xlarge
• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.standard.xlarge
• stream.standard.2xlarge

updateFleet_maxConcurrentSessions :: Lens' UpdateFleet (Maybe Int)

The maximum number of concurrent sessions for a fleet.

updateFleet_maxUserDurationInSeconds :: Lens' UpdateFleet (Maybe Int)

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.

updateFleet_name :: Lens' UpdateFleet (Maybe Text)

A unique name for the fleet.

updateFleet_platform :: Lens' UpdateFleet (Maybe PlatformType)

The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

updateFleet_sessionScriptS3Location :: Lens' UpdateFleet (Maybe S3Location)

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

updateFleet_streamView :: Lens' UpdateFleet (Maybe StreamView)

The AppStream 2.0 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.

updateFleet_usbDeviceFilterStrings :: Lens' UpdateFleet (Maybe [Text])

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.

updateFleet_vpcConfig :: Lens' UpdateFleet (Maybe VpcConfig)

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.

updateFleetResponse_fleet :: Lens' UpdateFleetResponse (Maybe Fleet)

Information about the fleet.

updateFleetResponse_httpStatus :: Lens' UpdateFleetResponse Int

The response's http status code.

UpdateImagePermissions

updateImagePermissions_name :: Lens' UpdateImagePermissions Text

The name of the private image.

updateImagePermissions_sharedAccountId :: Lens' UpdateImagePermissions Text

The 12-digit identifier of the AWS account for which you want add or update image permissions.

updateImagePermissions_imagePermissions :: Lens' UpdateImagePermissions ImagePermissions

The permissions for the image.

updateImagePermissionsResponse_httpStatus :: Lens' UpdateImagePermissionsResponse Int

The response's http status code.

UpdateStack

updateStack_accessEndpoints :: Lens' UpdateStack (Maybe (NonEmpty AccessEndpoint))

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

updateStack_applicationSettings :: Lens' UpdateStack (Maybe ApplicationSettings)

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.

updateStack_attributesToDelete :: Lens' UpdateStack (Maybe [StackAttribute])

The stack attributes to delete.

updateStack_deleteStorageConnectors :: Lens' UpdateStack (Maybe Bool)

Deletes the storage connectors currently enabled for the stack.

updateStack_description :: Lens' UpdateStack (Maybe Text)

The description to display.

updateStack_displayName :: Lens' UpdateStack (Maybe Text)

The stack name to display.

updateStack_embedHostDomains :: Lens' UpdateStack (Maybe (NonEmpty Text))

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

updateStack_feedbackURL :: Lens' UpdateStack (Maybe Text)

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.

updateStack_redirectURL :: Lens' UpdateStack (Maybe Text)

The URL that users are redirected to after their streaming session ends.

updateStack_storageConnectors :: Lens' UpdateStack (Maybe [StorageConnector])

The storage connectors to enable.

updateStack_streamingExperienceSettings :: Lens' UpdateStack (Maybe StreamingExperienceSettings)

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.

updateStack_userSettings :: Lens' UpdateStack (Maybe (NonEmpty UserSetting))

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

updateStack_name :: Lens' UpdateStack Text

The name of the stack.

updateStackResponse_stack :: Lens' UpdateStackResponse (Maybe Stack)

Information about the stack.

updateStackResponse_httpStatus :: Lens' UpdateStackResponse Int

The response's http status code.

Types

AccessEndpoint

accessEndpoint_vpceId :: Lens' AccessEndpoint (Maybe Text)

The identifier (ID) of the VPC in which the interface endpoint is used.

accessEndpoint_endpointType :: Lens' AccessEndpoint AccessEndpointType

The type of interface endpoint.

AppBlock

appBlock_createdTime :: Lens' AppBlock (Maybe UTCTime)

The created time of the app block.

appBlock_description :: Lens' AppBlock (Maybe Text)

The description of the app block.

appBlock_displayName :: Lens' AppBlock (Maybe Text)

The display name of the app block.

appBlock_sourceS3Location :: Lens' AppBlock (Maybe S3Location)

The source S3 location of the app block.

appBlock_name :: Lens' AppBlock Text

The name of the app block.

appBlock_arn :: Lens' AppBlock Text

The ARN of the app block.

appBlock_setupScriptDetails :: Lens' AppBlock ScriptDetails

The setup script details of the app block.

Application

application_appBlockArn :: Lens' Application (Maybe Text)

The app block ARN of the application.

application_arn :: Lens' Application (Maybe Text)

The ARN of the application.

application_createdTime :: Lens' Application (Maybe UTCTime)

The time at which the application was created within the app block.

application_description :: Lens' Application (Maybe Text)

The description of the application.

application_displayName :: Lens' Application (Maybe Text)

The application name to display.

application_enabled :: Lens' Application (Maybe Bool)

If there is a problem, the application can be disabled after image creation.

application_iconS3Location :: Lens' Application (Maybe S3Location)

The S3 location of the application icon.

application_iconURL :: Lens' Application (Maybe Text)

The URL for the application icon. This URL might be time-limited.

application_instanceFamilies :: Lens' Application (Maybe [Text])

The instance families for the application.

application_launchParameters :: Lens' Application (Maybe Text)

The arguments that are passed to the application at launch.

application_launchPath :: Lens' Application (Maybe Text)

The path to the application executable in the instance.

application_metadata :: Lens' Application (Maybe (HashMap Text Text))

Additional attributes that describe the application.

application_name :: Lens' Application (Maybe Text)

The name of the application.

application_platforms :: Lens' Application (Maybe [PlatformType])

The platforms on which the application can run.

application_workingDirectory :: Lens' Application (Maybe Text)

The working directory for the application.

ApplicationFleetAssociation

applicationFleetAssociation_fleetName :: Lens' ApplicationFleetAssociation Text

The name of the fleet associated with the application.

applicationFleetAssociation_applicationArn :: Lens' ApplicationFleetAssociation Text

The ARN of the application associated with the fleet.

ApplicationSettings

applicationSettings_settingsGroup :: Lens' ApplicationSettings (Maybe Text)

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.

applicationSettings_enabled :: Lens' ApplicationSettings Bool

Enables or disables persistent application settings for users during their streaming sessions.

ApplicationSettingsResponse

applicationSettingsResponse_enabled :: Lens' ApplicationSettingsResponse (Maybe Bool)

Specifies whether persistent application settings are enabled for users during their streaming sessions.

applicationSettingsResponse_s3BucketName :: Lens' ApplicationSettingsResponse (Maybe Text)

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.

applicationSettingsResponse_settingsGroup :: Lens' ApplicationSettingsResponse (Maybe Text)

The path prefix for the S3 bucket where users’ persistent application settings are stored.

CertificateBasedAuthProperties

certificateBasedAuthProperties_certificateAuthorityArn :: Lens' CertificateBasedAuthProperties (Maybe Text)

The ARN of the AWS Certificate Manager Private CA resource.

certificateBasedAuthProperties_status :: Lens' CertificateBasedAuthProperties (Maybe CertificateBasedAuthStatus)

The status of the certificate-based authentication properties.

ComputeCapacity

computeCapacity_desiredInstances :: Lens' ComputeCapacity Int

The desired number of streaming instances.

ComputeCapacityStatus

computeCapacityStatus_available :: Lens' ComputeCapacityStatus (Maybe Int)

The number of currently available instances that can be used to stream sessions.

computeCapacityStatus_inUse :: Lens' ComputeCapacityStatus (Maybe Int)

The number of instances in use for streaming.

computeCapacityStatus_running :: Lens' ComputeCapacityStatus (Maybe Int)

The total number of simultaneous streaming instances that are running.

computeCapacityStatus_desired :: Lens' ComputeCapacityStatus Int

The desired number of streaming instances.

DirectoryConfig

directoryConfig_certificateBasedAuthProperties :: Lens' DirectoryConfig (Maybe CertificateBasedAuthProperties)

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.

directoryConfig_createdTime :: Lens' DirectoryConfig (Maybe UTCTime)

The time the directory configuration was created.

directoryConfig_organizationalUnitDistinguishedNames :: Lens' DirectoryConfig (Maybe [Text])

The distinguished names of the organizational units for computer accounts.

directoryConfig_serviceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials)

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

directoryConfig_directoryName :: Lens' DirectoryConfig Text

The fully qualified name of the directory (for example, corp.example.com).

DomainJoinInfo

domainJoinInfo_directoryName :: Lens' DomainJoinInfo (Maybe Text)

The fully qualified name of the directory (for example, corp.example.com).

domainJoinInfo_organizationalUnitDistinguishedName :: Lens' DomainJoinInfo (Maybe Text)

The distinguished name of the organizational unit for computer accounts.

EntitledApplication

entitledApplication_applicationIdentifier :: Lens' EntitledApplication Text

The identifier of the application.

Entitlement

entitlement_createdTime :: Lens' Entitlement (Maybe UTCTime)

The time when the entitlement was created.

entitlement_description :: Lens' Entitlement (Maybe Text)

The description of the entitlement.

entitlement_lastModifiedTime :: Lens' Entitlement (Maybe UTCTime)

The time when the entitlement was last modified.

entitlement_name :: Lens' Entitlement Text

The name of the entitlement.

entitlement_stackName :: Lens' Entitlement Text

The name of the stack with which the entitlement is associated.

entitlement_appVisibility :: Lens' Entitlement AppVisibility

Specifies whether all or selected apps are entitled.

entitlement_attributes :: Lens' Entitlement (NonEmpty EntitlementAttribute)

The attributes of the entitlement.

EntitlementAttribute

entitlementAttribute_name :: Lens' EntitlementAttribute Text

A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.

The following are valid values:

• roles
• department
• organization
• groups
• title
• costCenter
• userType

entitlementAttribute_value :: Lens' EntitlementAttribute Text

A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.

Fleet

fleet_createdTime :: Lens' Fleet (Maybe UTCTime)

The time the fleet was created.

fleet_description :: Lens' Fleet (Maybe Text)

The description to display.

fleet_disconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int)

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

fleet_displayName :: Lens' Fleet (Maybe Text)

The fleet name to display.

fleet_domainJoinInfo :: Lens' Fleet (Maybe DomainJoinInfo)

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

fleet_enableDefaultInternetAccess :: Lens' Fleet (Maybe Bool)

Indicates whether default internet access is enabled for the fleet.

fleet_fleetErrors :: Lens' Fleet (Maybe [FleetError])

The fleet errors.

fleet_fleetType :: Lens' Fleet (Maybe FleetType)

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.

fleet_iamRoleArn :: Lens' Fleet (Maybe Text)

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. AppStream 2.0 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 AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

fleet_idleDisconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int)

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

fleet_imageArn :: Lens' Fleet (Maybe Text)

The ARN for the public, private, or shared image.

fleet_imageName :: Lens' Fleet (Maybe Text)

The name of the image used to create the fleet.

fleet_maxConcurrentSessions :: Lens' Fleet (Maybe Int)

The maximum number of concurrent sessions for the fleet.

fleet_maxUserDurationInSeconds :: Lens' Fleet (Maybe Int)

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.

fleet_platform :: Lens' Fleet (Maybe PlatformType)

The platform of the fleet.

fleet_sessionScriptS3Location :: Lens' Fleet (Maybe S3Location)

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

fleet_streamView :: Lens' Fleet (Maybe StreamView)

The AppStream 2.0 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.

fleet_usbDeviceFilterStrings :: Lens' Fleet (Maybe [Text])

The USB device filter strings associated with the fleet.

fleet_vpcConfig :: Lens' Fleet (Maybe VpcConfig)

The VPC configuration for the fleet.

fleet_arn :: Lens' Fleet Text

The Amazon Resource Name (ARN) for the fleet.

fleet_name :: Lens' Fleet Text

The name of the fleet.

fleet_instanceType :: Lens' Fleet Text

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.compute.large
• stream.compute.xlarge
• stream.compute.2xlarge
• stream.compute.4xlarge
• stream.compute.8xlarge
• stream.memory.large
• stream.memory.xlarge
• stream.memory.2xlarge
• stream.memory.4xlarge
• stream.memory.8xlarge
• stream.memory.z1d.large
• stream.memory.z1d.xlarge
• stream.memory.z1d.2xlarge
• stream.memory.z1d.3xlarge
• stream.memory.z1d.6xlarge
• stream.memory.z1d.12xlarge
• stream.graphics-design.large
• stream.graphics-design.xlarge
• stream.graphics-design.2xlarge
• stream.graphics-design.4xlarge
• stream.graphics-desktop.2xlarge
• stream.graphics.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics-pro.4xlarge
• stream.graphics-pro.8xlarge
• stream.graphics-pro.16xlarge

fleet_computeCapacityStatus :: Lens' Fleet ComputeCapacityStatus

The capacity status for the fleet.

fleet_state :: Lens' Fleet FleetState

The current state for the fleet.

FleetError

fleetError_errorCode :: Lens' FleetError (Maybe FleetErrorCode)

The error code.

fleetError_errorMessage :: Lens' FleetError (Maybe Text)

The error message.

Image

image_applications :: Lens' Image (Maybe [Application])

The applications associated with the image.

image_appstreamAgentVersion :: Lens' Image (Maybe Text)

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

image_arn :: Lens' Image (Maybe Text)

The ARN of the image.

image_baseImageArn :: Lens' Image (Maybe Text)

The ARN of the image from which this image was created.

image_createdTime :: Lens' Image (Maybe UTCTime)

The time the image was created.

image_description :: Lens' Image (Maybe Text)

The description to display.

image_displayName :: Lens' Image (Maybe Text)

The image name to display.

image_imageBuilderName :: Lens' Image (Maybe Text)

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

image_imageBuilderSupported :: Lens' Image (Maybe Bool)

Indicates whether an image builder can be launched from this image.

image_imageErrors :: Lens' Image (Maybe [ResourceError])

Describes the errors that are returned when a new image can't be created.

image_imagePermissions :: Lens' Image (Maybe ImagePermissions)

The permissions to provide to the destination AWS account for the specified image.

image_platform :: Lens' Image (Maybe PlatformType)

The operating system platform of the image.

image_publicBaseImageReleasedDate :: Lens' Image (Maybe UTCTime)

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.

image_state :: Lens' Image (Maybe ImageState)

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

image_stateChangeReason :: Lens' Image (Maybe ImageStateChangeReason)

The reason why the last state change occurred.

image_visibility :: Lens' Image (Maybe VisibilityType)

Indicates whether the image is public or private.

image_name :: Lens' Image Text

The name of the image.

ImageBuilder

imageBuilder_accessEndpoints :: Lens' ImageBuilder (Maybe (NonEmpty AccessEndpoint))

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

imageBuilder_appstreamAgentVersion :: Lens' ImageBuilder (Maybe Text)

The version of the AppStream 2.0 agent that is currently being used by the image builder.

imageBuilder_arn :: Lens' ImageBuilder (Maybe Text)

The ARN for the image builder.

imageBuilder_createdTime :: Lens' ImageBuilder (Maybe UTCTime)

The time stamp when the image builder was created.

imageBuilder_description :: Lens' ImageBuilder (Maybe Text)

The description to display.

imageBuilder_displayName :: Lens' ImageBuilder (Maybe Text)

The image builder name to display.

imageBuilder_domainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo)

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

imageBuilder_enableDefaultInternetAccess :: Lens' ImageBuilder (Maybe Bool)

Enables or disables default internet access for the image builder.

imageBuilder_iamRoleArn :: Lens' ImageBuilder (Maybe Text)

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. AppStream 2.0 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 AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

imageBuilder_imageArn :: Lens' ImageBuilder (Maybe Text)

The ARN of the image from which this builder was created.

imageBuilder_imageBuilderErrors :: Lens' ImageBuilder (Maybe [ResourceError])

The image builder errors.

imageBuilder_instanceType :: Lens' ImageBuilder (Maybe Text)

The instance type for the image builder. The following instance types are available:

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.compute.large
• stream.compute.xlarge
• stream.compute.2xlarge
• stream.compute.4xlarge
• stream.compute.8xlarge
• stream.memory.large
• stream.memory.xlarge
• stream.memory.2xlarge
• stream.memory.4xlarge
• stream.memory.8xlarge
• stream.memory.z1d.large
• stream.memory.z1d.xlarge
• stream.memory.z1d.2xlarge
• stream.memory.z1d.3xlarge
• stream.memory.z1d.6xlarge
• stream.memory.z1d.12xlarge
• stream.graphics-design.large
• stream.graphics-design.xlarge
• stream.graphics-design.2xlarge
• stream.graphics-design.4xlarge
• stream.graphics-desktop.2xlarge
• stream.graphics.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics-pro.4xlarge
• stream.graphics-pro.8xlarge
• stream.graphics-pro.16xlarge

imageBuilder_networkAccessConfiguration :: Lens' ImageBuilder (Maybe NetworkAccessConfiguration)

Undocumented member.

imageBuilder_platform :: Lens' ImageBuilder (Maybe PlatformType)

The operating system platform of the image builder.

imageBuilder_state :: Lens' ImageBuilder (Maybe ImageBuilderState)

The state of the image builder.

imageBuilder_stateChangeReason :: Lens' ImageBuilder (Maybe ImageBuilderStateChangeReason)

The reason why the last state change occurred.

imageBuilder_vpcConfig :: Lens' ImageBuilder (Maybe VpcConfig)

The VPC configuration of the image builder.

imageBuilder_name :: Lens' ImageBuilder Text

The name of the image builder.

ImageBuilderStateChangeReason

imageBuilderStateChangeReason_code :: Lens' ImageBuilderStateChangeReason (Maybe ImageBuilderStateChangeReasonCode)

The state change reason code.

imageBuilderStateChangeReason_message :: Lens' ImageBuilderStateChangeReason (Maybe Text)

The state change reason message.

ImagePermissions

imagePermissions_allowFleet :: Lens' ImagePermissions (Maybe Bool)

Indicates whether the image can be used for a fleet.

imagePermissions_allowImageBuilder :: Lens' ImagePermissions (Maybe Bool)

Indicates whether the image can be used for an image builder.

ImageStateChangeReason

imageStateChangeReason_code :: Lens' ImageStateChangeReason (Maybe ImageStateChangeReasonCode)

The state change reason code.

imageStateChangeReason_message :: Lens' ImageStateChangeReason (Maybe Text)

The state change reason message.

LastReportGenerationExecutionError

lastReportGenerationExecutionError_errorCode :: Lens' LastReportGenerationExecutionError (Maybe UsageReportExecutionErrorCode)

The error code for the error that is returned when a usage report can't be generated.

lastReportGenerationExecutionError_errorMessage :: Lens' LastReportGenerationExecutionError (Maybe Text)

The error message for the error that is returned when a usage report can't be generated.

NetworkAccessConfiguration

networkAccessConfiguration_eniId :: Lens' NetworkAccessConfiguration (Maybe Text)

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.

networkAccessConfiguration_eniPrivateIpAddress :: Lens' NetworkAccessConfiguration (Maybe Text)

The private IP address of the elastic network interface that is attached to instances in your VPC.

ResourceError

resourceError_errorCode :: Lens' ResourceError (Maybe FleetErrorCode)

The error code.

resourceError_errorMessage :: Lens' ResourceError (Maybe Text)

The error message.

resourceError_errorTimestamp :: Lens' ResourceError (Maybe UTCTime)

The time the error occurred.

S3Location

s3Location_s3Bucket :: Lens' S3Location Text

The S3 bucket of the S3 object.

s3Location_s3Key :: Lens' S3Location Text

The S3 key of the S3 object.

ScriptDetails

scriptDetails_executableParameters :: Lens' ScriptDetails (Maybe Text)

The runtime parameters passed to the run path for the script.

scriptDetails_scriptS3Location :: Lens' ScriptDetails S3Location

The S3 object location for the script.

scriptDetails_executablePath :: Lens' ScriptDetails Text

The run path for the script.

scriptDetails_timeoutInSeconds :: Lens' ScriptDetails Int

The run timeout, in seconds, for the script.

ServiceAccountCredentials

serviceAccountCredentials_accountName :: Lens' ServiceAccountCredentials Text

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.

serviceAccountCredentials_accountPassword :: Lens' ServiceAccountCredentials Text

The password for the account.

Session

session_authenticationType :: Lens' Session (Maybe AuthenticationType)

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

session_connectionState :: Lens' Session (Maybe SessionConnectionState)

Specifies whether a user is connected to the streaming session.

session_maxExpirationTime :: Lens' Session (Maybe UTCTime)

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.

session_networkAccessConfiguration :: Lens' Session (Maybe NetworkAccessConfiguration)

The network details for the streaming session.

session_startTime :: Lens' Session (Maybe UTCTime)

The time when a streaming instance is dedicated for the user.

session_id :: Lens' Session Text

The identifier of the streaming session.

session_userId :: Lens' Session Text

The identifier of the user for whom the session was created.

session_stackName :: Lens' Session Text

The name of the stack for the streaming session.

session_fleetName :: Lens' Session Text

The name of the fleet for the streaming session.

session_state :: Lens' Session SessionState

The current state of the streaming session.

SharedImagePermissions

sharedImagePermissions_sharedAccountId :: Lens' SharedImagePermissions Text

The 12-digit identifier of the AWS account with which the image is shared.

sharedImagePermissions_imagePermissions :: Lens' SharedImagePermissions ImagePermissions

Describes the permissions for a shared image.

Stack

stack_accessEndpoints :: Lens' Stack (Maybe (NonEmpty AccessEndpoint))

The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

stack_applicationSettings :: Lens' Stack (Maybe ApplicationSettingsResponse)

The persistent application settings for users of the stack.

stack_arn :: Lens' Stack (Maybe Text)

The ARN of the stack.

stack_createdTime :: Lens' Stack (Maybe UTCTime)

The time the stack was created.

stack_description :: Lens' Stack (Maybe Text)

The description to display.

stack_displayName :: Lens' Stack (Maybe Text)

The stack name to display.

stack_embedHostDomains :: Lens' Stack (Maybe (NonEmpty Text))

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

stack_feedbackURL :: Lens' Stack (Maybe Text)

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.

stack_redirectURL :: Lens' Stack (Maybe Text)

The URL that users are redirected to after their streaming session ends.

stack_stackErrors :: Lens' Stack (Maybe [StackError])

The errors for the stack.

stack_storageConnectors :: Lens' Stack (Maybe [StorageConnector])

The storage connectors to enable.

stack_streamingExperienceSettings :: Lens' Stack (Maybe StreamingExperienceSettings)

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.

stack_userSettings :: Lens' Stack (Maybe (NonEmpty UserSetting))

The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

stack_name :: Lens' Stack Text

The name of the stack.

StackError

stackError_errorCode :: Lens' StackError (Maybe StackErrorCode)

The error code.

stackError_errorMessage :: Lens' StackError (Maybe Text)

The error message.

StorageConnector

storageConnector_domains :: Lens' StorageConnector (Maybe [Text])

The names of the domains for the account.

storageConnector_resourceIdentifier :: Lens' StorageConnector (Maybe Text)

The ARN of the storage connector.

storageConnector_connectorType :: Lens' StorageConnector StorageConnectorType

The type of storage connector.

StreamingExperienceSettings

streamingExperienceSettings_preferredProtocol :: Lens' StreamingExperienceSettings (Maybe PreferredProtocol)

The preferred protocol that you want to use while streaming your application.

UsageReportSubscription

usageReportSubscription_lastGeneratedReportDate :: Lens' UsageReportSubscription (Maybe UTCTime)

The time when the last usage report was generated.

usageReportSubscription_s3BucketName :: Lens' UsageReportSubscription (Maybe Text)

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, AppStream 2.0 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, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

usageReportSubscription_schedule :: Lens' UsageReportSubscription (Maybe UsageReportSchedule)

The schedule for generating usage reports.

usageReportSubscription_subscriptionErrors :: Lens' UsageReportSubscription (Maybe [LastReportGenerationExecutionError])

The errors that were returned if usage reports couldn't be generated.

User

user_arn :: Lens' User (Maybe Text)

The ARN of the user.

user_createdTime :: Lens' User (Maybe UTCTime)

The date and time the user was created in the user pool.

user_enabled :: Lens' User (Maybe Bool)

Specifies whether the user in the user pool is enabled.

user_firstName :: Lens' User (Maybe Text)

The first name, or given name, of the user.

user_lastName :: Lens' User (Maybe Text)

The last name, or surname, of the user.

user_status :: Lens' User (Maybe Text)

The status of the user in the user pool. The status can be one of the following:

• UNCONFIRMED – The user is created but not confirmed.
• CONFIRMED – The user is confirmed.
• ARCHIVED – The user is no longer active.
• COMPROMISED – The user is disabled because of a potential security threat.
• UNKNOWN – The user status is not known.

user_userName :: Lens' User (Maybe Text)

The email address of the user.

Users' email addresses are case-sensitive.

user_authenticationType :: Lens' User AuthenticationType

The authentication type for the user.

UserSetting

userSetting_action :: Lens' UserSetting Action

The action that is enabled or disabled.

userSetting_permission :: Lens' UserSetting Permission

Indicates whether the action is enabled or disabled.

UserStackAssociation

userStackAssociation_sendEmailNotification :: Lens' UserStackAssociation (Maybe Bool)

Specifies whether a welcome email is sent to a user after the user is created in the user pool.

userStackAssociation_stackName :: Lens' UserStackAssociation Text

The name of the stack that is associated with the user.

userStackAssociation_userName :: Lens' UserStackAssociation Text

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

userStackAssociation_authenticationType :: Lens' UserStackAssociation AuthenticationType

The authentication type for the user.

UserStackAssociationError

userStackAssociationError_errorCode :: Lens' UserStackAssociationError (Maybe UserStackAssociationErrorCode)

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

userStackAssociationError_errorMessage :: Lens' UserStackAssociationError (Maybe Text)

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

userStackAssociationError_userStackAssociation :: Lens' UserStackAssociationError (Maybe UserStackAssociation)

Information about the user and associated stack.

VpcConfig

vpcConfig_securityGroupIds :: Lens' VpcConfig (Maybe [Text])

The identifiers of the security groups for the fleet or image builder.

vpcConfig_subnetIds :: Lens' VpcConfig (Maybe [Text])

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.