amazonka-appstream-2.0: Amazon AppStream SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppStream.Lens

Contents

Description

 
Synopsis

Operations

AssociateApplicationFleet

associateApplicationFleetResponse_applicationFleetAssociation :: Lens' AssociateApplicationFleetResponse (Maybe ApplicationFleetAssociation) Source #

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.

AssociateApplicationToEntitlement

AssociateFleet

BatchAssociateUserStack

BatchDisassociateUserStack

CopyImage

copyImage_destinationImageDescription :: Lens' CopyImage (Maybe Text) Source #

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

copyImage_sourceImageName :: Lens' CopyImage Text Source #

The name of the image to copy.

copyImage_destinationImageName :: Lens' CopyImage Text Source #

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

copyImage_destinationRegion :: Lens' CopyImage Text Source #

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

The response's http status code.

CreateAppBlock

createAppBlock_description :: Lens' CreateAppBlock (Maybe Text) Source #

The description of the app block.

createAppBlock_displayName :: Lens' CreateAppBlock (Maybe Text) Source #

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

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

The tags assigned to the app block.

createAppBlock_name :: Lens' CreateAppBlock Text Source #

The name of the app block.

createAppBlock_sourceS3Location :: Lens' CreateAppBlock S3Location Source #

The source S3 location of the app block.

createAppBlock_setupScriptDetails :: Lens' CreateAppBlock ScriptDetails Source #

The setup script details of the app block.

CreateApplication

createApplication_description :: Lens' CreateApplication (Maybe Text) Source #

The description of the application.

createApplication_displayName :: Lens' CreateApplication (Maybe Text) Source #

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

createApplication_launchParameters :: Lens' CreateApplication (Maybe Text) Source #

The launch parameters of the application.

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

The tags assigned to the application.

createApplication_workingDirectory :: Lens' CreateApplication (Maybe Text) Source #

The working directory of the application.

createApplication_name :: Lens' CreateApplication Text Source #

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

createApplication_iconS3Location :: Lens' CreateApplication S3Location Source #

The location in S3 of the application icon.

createApplication_launchPath :: Lens' CreateApplication Text Source #

The launch path of the application.

createApplication_platforms :: Lens' CreateApplication [PlatformType] Source #

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

createApplication_instanceFamilies :: Lens' CreateApplication [Text] Source #

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

createApplication_appBlockArn :: Lens' CreateApplication Text Source #

The app block ARN to which the application should be associated

CreateDirectoryConfig

createDirectoryConfig_certificateBasedAuthProperties :: Lens' CreateDirectoryConfig (Maybe CertificateBasedAuthProperties) Source #

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) Source #

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

createDirectoryConfig_directoryName :: Lens' CreateDirectoryConfig Text Source #

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

createDirectoryConfig_organizationalUnitDistinguishedNames :: Lens' CreateDirectoryConfig [Text] Source #

The distinguished names of the organizational units for computer accounts.

CreateEntitlement

createEntitlement_description :: Lens' CreateEntitlement (Maybe Text) Source #

The description of the entitlement.

createEntitlement_stackName :: Lens' CreateEntitlement Text Source #

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

createEntitlement_appVisibility :: Lens' CreateEntitlement AppVisibility Source #

Specifies whether all or selected apps are entitled.

CreateFleet

createFleet_computeCapacity :: Lens' CreateFleet (Maybe ComputeCapacity) Source #

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) Source #

The description to display.

createFleet_disconnectTimeoutInSeconds :: Lens' CreateFleet (Maybe Int) Source #

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) Source #

The fleet name to display.

createFleet_domainJoinInfo :: Lens' CreateFleet (Maybe DomainJoinInfo) Source #

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) Source #

Enables or disables default internet access for the fleet.

createFleet_fleetType :: Lens' CreateFleet (Maybe FleetType) Source #

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) Source #

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) Source #

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) Source #

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

createFleet_imageName :: Lens' CreateFleet (Maybe Text) Source #

The name of the image used to create the fleet.

createFleet_maxConcurrentSessions :: Lens' CreateFleet (Maybe Int) Source #

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) Source #

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) Source #

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

createFleet_sessionScriptS3Location :: Lens' CreateFleet (Maybe S3Location) Source #

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

createFleet_streamView :: Lens' CreateFleet (Maybe StreamView) Source #

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)) Source #

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]) Source #

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) Source #

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 Source #

A unique name for the fleet.

createFleet_instanceType :: Lens' CreateFleet Text Source #

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

CreateImageBuilder

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

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) Source #

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_domainJoinInfo :: Lens' CreateImageBuilder (Maybe DomainJoinInfo) Source #

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) Source #

Enables or disables default internet access for the image builder.

createImageBuilder_iamRoleArn :: Lens' CreateImageBuilder (Maybe Text) Source #

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) Source #

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

createImageBuilder_imageName :: Lens' CreateImageBuilder (Maybe Text) Source #

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

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

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) Source #

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

createImageBuilder_name :: Lens' CreateImageBuilder Text Source #

A unique name for the image builder.

createImageBuilder_instanceType :: Lens' CreateImageBuilder Text Source #

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

CreateImageBuilderStreamingURL

createImageBuilderStreamingURL_validity :: Lens' CreateImageBuilderStreamingURL (Maybe Integer) Source #

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

createImageBuilderStreamingURLResponse_expires :: Lens' CreateImageBuilderStreamingURLResponse (Maybe UTCTime) Source #

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

CreateStack

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

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) Source #

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) Source #

The description to display.

createStack_displayName :: Lens' CreateStack (Maybe Text) Source #

The stack name to display.

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

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) Source #

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) Source #

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

createStack_streamingExperienceSettings :: Lens' CreateStack (Maybe StreamingExperienceSettings) Source #

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)) Source #

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)) Source #

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

createStack_name :: Lens' CreateStack Text Source #

The name of the stack.

CreateStreamingURL

createStreamingURL_applicationId :: Lens' CreateStreamingURL (Maybe Text) Source #

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) Source #

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

createStreamingURL_validity :: Lens' CreateStreamingURL (Maybe Integer) Source #

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

createStreamingURLResponse_expires :: Lens' CreateStreamingURLResponse (Maybe UTCTime) Source #

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

createStreamingURLResponse_streamingURL :: Lens' CreateStreamingURLResponse (Maybe Text) Source #

The URL to start the AppStream 2.0 streaming session.

CreateUpdatedImage

createUpdatedImage_dryRun :: Lens' CreateUpdatedImage (Maybe Bool) Source #

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) Source #

The description to display for the new image.

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

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_newImageName :: Lens' CreateUpdatedImage Text Source #

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

CreateUsageReportSubscription

createUsageReportSubscriptionResponse_s3BucketName :: Lens' CreateUsageReportSubscriptionResponse (Maybe Text) Source #

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.

CreateUser

createUser_firstName :: Lens' CreateUser (Maybe Text) Source #

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

createUser_lastName :: Lens' CreateUser (Maybe Text) Source #

The last name, or surname, of the user.

createUser_messageAction :: Lens' CreateUser (Maybe MessageAction) Source #

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 Source #

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 Source #

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

DeleteAppBlock

deleteAppBlock_name :: Lens' DeleteAppBlock Text Source #

The name of the app block.

DeleteApplication

DeleteDirectoryConfig

deleteDirectoryConfig_directoryName :: Lens' DeleteDirectoryConfig Text Source #

The name of the directory configuration.

DeleteEntitlement

deleteEntitlement_stackName :: Lens' DeleteEntitlement Text Source #

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

DeleteFleet

deleteFleet_name :: Lens' DeleteFleet Text Source #

The name of the fleet.

DeleteImage

deleteImage_name :: Lens' DeleteImage Text Source #

The name of the image.

DeleteImageBuilder

deleteImageBuilder_name :: Lens' DeleteImageBuilder Text Source #

The name of the image builder.

DeleteImagePermissions

deleteImagePermissions_sharedAccountId :: Lens' DeleteImagePermissions Text Source #

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

DeleteStack

deleteStack_name :: Lens' DeleteStack Text Source #

The name of the stack.

DeleteUsageReportSubscription

DeleteUser

deleteUser_userName :: Lens' DeleteUser Text Source #

The email address of the user.

Users' email addresses are case-sensitive.

deleteUser_authenticationType :: Lens' DeleteUser AuthenticationType Source #

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

DescribeAppBlocks

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

The ARNs of the app blocks.

describeAppBlocks_maxResults :: Lens' DescribeAppBlocks (Maybe Int) Source #

The maximum size of each page of results.

describeAppBlocks_nextToken :: Lens' DescribeAppBlocks (Maybe Text) Source #

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

describeAppBlocksResponse_nextToken :: Lens' DescribeAppBlocksResponse (Maybe Text) Source #

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

DescribeApplicationFleetAssociations

describeApplicationFleetAssociations_nextToken :: Lens' DescribeApplicationFleetAssociations (Maybe Text) Source #

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

describeApplicationFleetAssociationsResponse_nextToken :: Lens' DescribeApplicationFleetAssociationsResponse (Maybe Text) Source #

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

DescribeApplications

describeApplications_maxResults :: Lens' DescribeApplications (Maybe Int) Source #

The maximum size of each page of results.

describeApplications_nextToken :: Lens' DescribeApplications (Maybe Text) Source #

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

describeApplicationsResponse_nextToken :: Lens' DescribeApplicationsResponse (Maybe Text) Source #

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

DescribeDirectoryConfigs

describeDirectoryConfigs_nextToken :: Lens' DescribeDirectoryConfigs (Maybe Text) Source #

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]) Source #

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) Source #

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.

DescribeEntitlements

describeEntitlements_maxResults :: Lens' DescribeEntitlements (Maybe Int) Source #

The maximum size of each page of results.

describeEntitlements_nextToken :: Lens' DescribeEntitlements (Maybe Text) Source #

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

describeEntitlements_stackName :: Lens' DescribeEntitlements Text Source #

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

describeEntitlementsResponse_nextToken :: Lens' DescribeEntitlementsResponse (Maybe Text) Source #

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

DescribeFleets

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

The names of the fleets to describe.

describeFleets_nextToken :: Lens' DescribeFleets (Maybe Text) Source #

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

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.

DescribeImageBuilders

describeImageBuilders_maxResults :: Lens' DescribeImageBuilders (Maybe Int) Source #

The maximum size of each page of results.

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

The names of the image builders to describe.

describeImageBuilders_nextToken :: Lens' DescribeImageBuilders (Maybe Text) Source #

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

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.

DescribeImagePermissions

describeImagePermissions_nextToken :: Lens' DescribeImagePermissions (Maybe Text) Source #

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)) Source #

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

describeImagePermissions_name :: Lens' DescribeImagePermissions Text Source #

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

describeImagePermissionsResponse_nextToken :: Lens' DescribeImagePermissionsResponse (Maybe Text) Source #

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.

DescribeImages

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

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

describeImages_maxResults :: Lens' DescribeImages (Maybe Natural) Source #

The maximum size of each page of results.

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

The names of the public or private images to describe.

describeImages_nextToken :: Lens' DescribeImages (Maybe Text) Source #

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) Source #

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

describeImagesResponse_nextToken :: Lens' DescribeImagesResponse (Maybe Text) Source #

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.

DescribeSessions

describeSessions_authenticationType :: Lens' DescribeSessions (Maybe AuthenticationType) Source #

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) Source #

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

describeSessions_nextToken :: Lens' DescribeSessions (Maybe Text) Source #

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) Source #

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

describeSessions_stackName :: Lens' DescribeSessions Text Source #

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

describeSessions_fleetName :: Lens' DescribeSessions Text Source #

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

describeSessionsResponse_nextToken :: Lens' DescribeSessionsResponse (Maybe Text) Source #

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]) Source #

Information about the streaming sessions.

DescribeStacks

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

The names of the stacks to describe.

describeStacks_nextToken :: Lens' DescribeStacks (Maybe Text) Source #

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) Source #

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.

DescribeUsageReportSubscriptions

describeUsageReportSubscriptions_nextToken :: Lens' DescribeUsageReportSubscriptions (Maybe Text) Source #

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) Source #

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.

DescribeUserStackAssociations

describeUserStackAssociations_authenticationType :: Lens' DescribeUserStackAssociations (Maybe AuthenticationType) Source #

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

describeUserStackAssociations_nextToken :: Lens' DescribeUserStackAssociations (Maybe Text) Source #

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) Source #

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

describeUserStackAssociations_userName :: Lens' DescribeUserStackAssociations (Maybe Text) Source #

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

Users' email addresses are case-sensitive.

describeUserStackAssociationsResponse_nextToken :: Lens' DescribeUserStackAssociationsResponse (Maybe Text) Source #

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.

DescribeUsers

describeUsers_maxResults :: Lens' DescribeUsers (Maybe Int) Source #

The maximum size of each page of results.

describeUsers_nextToken :: Lens' DescribeUsers (Maybe Text) Source #

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 Source #

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

describeUsersResponse_nextToken :: Lens' DescribeUsersResponse (Maybe Text) Source #

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]) Source #

Information about users in the user pool.

DisableUser

disableUser_userName :: Lens' DisableUser Text Source #

The email address of the user.

Users' email addresses are case-sensitive.

disableUser_authenticationType :: Lens' DisableUser AuthenticationType Source #

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

DisassociateApplicationFleet

DisassociateApplicationFromEntitlement

disassociateApplicationFromEntitlement_stackName :: Lens' DisassociateApplicationFromEntitlement Text Source #

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

DisassociateFleet

EnableUser

enableUser_userName :: Lens' EnableUser Text Source #

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 Source #

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

ExpireSession

expireSession_sessionId :: Lens' ExpireSession Text Source #

The identifier of the streaming session.

ListAssociatedFleets

listAssociatedFleets_nextToken :: Lens' ListAssociatedFleets (Maybe Text) Source #

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.

listAssociatedFleetsResponse_nextToken :: Lens' ListAssociatedFleetsResponse (Maybe Text) Source #

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.

ListAssociatedStacks

listAssociatedStacks_nextToken :: Lens' ListAssociatedStacks (Maybe Text) Source #

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.

listAssociatedStacksResponse_nextToken :: Lens' ListAssociatedStacksResponse (Maybe Text) Source #

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.

ListEntitledApplications

listEntitledApplications_nextToken :: Lens' ListEntitledApplications (Maybe Text) Source #

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

listEntitledApplications_stackName :: Lens' ListEntitledApplications Text Source #

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

listEntitledApplicationsResponse_nextToken :: Lens' ListEntitledApplicationsResponse (Maybe Text) Source #

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

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

StartFleet

startFleet_name :: Lens' StartFleet Text Source #

The name of the fleet.

StartImageBuilder

startImageBuilder_appstreamAgentVersion :: Lens' StartImageBuilder (Maybe Text) Source #

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 Source #

The name of the image builder.

StopFleet

stopFleet_name :: Lens' StopFleet Text Source #

The name of the fleet.

stopFleetResponse_httpStatus :: Lens' StopFleetResponse Int Source #

The response's http status code.

StopImageBuilder

stopImageBuilder_name :: Lens' StopImageBuilder Text Source #

The name of the image builder.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

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:

_ . : / = + \ - @

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The tag keys for the tags to disassociate.

UpdateApplication

updateApplication_description :: Lens' UpdateApplication (Maybe Text) Source #

The description of the application.

updateApplication_displayName :: Lens' UpdateApplication (Maybe Text) Source #

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

updateApplication_iconS3Location :: Lens' UpdateApplication (Maybe S3Location) Source #

The icon S3 location of the application.

updateApplication_launchParameters :: Lens' UpdateApplication (Maybe Text) Source #

The launch parameters of the application.

updateApplication_launchPath :: Lens' UpdateApplication (Maybe Text) Source #

The launch path of the application.

updateApplication_workingDirectory :: Lens' UpdateApplication (Maybe Text) Source #

The working directory of the application.

updateApplication_name :: Lens' UpdateApplication Text Source #

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

UpdateDirectoryConfig

updateDirectoryConfig_certificateBasedAuthProperties :: Lens' UpdateDirectoryConfig (Maybe CertificateBasedAuthProperties) Source #

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]) Source #

The distinguished names of the organizational units for computer accounts.

updateDirectoryConfig_serviceAccountCredentials :: Lens' UpdateDirectoryConfig (Maybe ServiceAccountCredentials) Source #

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

updateDirectoryConfig_directoryName :: Lens' UpdateDirectoryConfig Text Source #

The name of the Directory Config object.

UpdateEntitlement

updateEntitlement_appVisibility :: Lens' UpdateEntitlement (Maybe AppVisibility) Source #

Specifies whether all or only selected apps are entitled.

updateEntitlement_description :: Lens' UpdateEntitlement (Maybe Text) Source #

The description of the entitlement.

updateEntitlement_stackName :: Lens' UpdateEntitlement Text Source #

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

UpdateFleet

updateFleet_computeCapacity :: Lens' UpdateFleet (Maybe ComputeCapacity) Source #

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

updateFleet_deleteVpcConfig :: Lens' UpdateFleet (Maybe Bool) Source #

Deletes the VPC association for the specified fleet.

updateFleet_description :: Lens' UpdateFleet (Maybe Text) Source #

The description to display.

updateFleet_disconnectTimeoutInSeconds :: Lens' UpdateFleet (Maybe Int) Source #

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) Source #

The fleet name to display.

updateFleet_domainJoinInfo :: Lens' UpdateFleet (Maybe DomainJoinInfo) Source #

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) Source #

Enables or disables default internet access for the fleet.

updateFleet_iamRoleArn :: Lens' UpdateFleet (Maybe Text) Source #

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) Source #

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) Source #

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

updateFleet_imageName :: Lens' UpdateFleet (Maybe Text) Source #

The name of the image used to create the fleet.

updateFleet_instanceType :: Lens' UpdateFleet (Maybe Text) Source #

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) Source #

The maximum number of concurrent sessions for a fleet.

updateFleet_maxUserDurationInSeconds :: Lens' UpdateFleet (Maybe Int) Source #

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) Source #

A unique name for the fleet.

updateFleet_platform :: Lens' UpdateFleet (Maybe PlatformType) Source #

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

updateFleet_sessionScriptS3Location :: Lens' UpdateFleet (Maybe S3Location) Source #

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

updateFleet_streamView :: Lens' UpdateFleet (Maybe StreamView) Source #

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]) Source #

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) Source #

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.

UpdateImagePermissions

updateImagePermissions_sharedAccountId :: Lens' UpdateImagePermissions Text Source #

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

UpdateStack

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

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) Source #

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_deleteStorageConnectors :: Lens' UpdateStack (Maybe Bool) Source #

Deletes the storage connectors currently enabled for the stack.

updateStack_description :: Lens' UpdateStack (Maybe Text) Source #

The description to display.

updateStack_displayName :: Lens' UpdateStack (Maybe Text) Source #

The stack name to display.

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

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) Source #

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) Source #

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

updateStack_streamingExperienceSettings :: Lens' UpdateStack (Maybe StreamingExperienceSettings) Source #

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)) Source #

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

updateStack_name :: Lens' UpdateStack Text Source #

The name of the stack.

Types

AccessEndpoint

accessEndpoint_vpceId :: Lens' AccessEndpoint (Maybe Text) Source #

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

AppBlock

appBlock_createdTime :: Lens' AppBlock (Maybe UTCTime) Source #

The created time of the app block.

appBlock_description :: Lens' AppBlock (Maybe Text) Source #

The description of the app block.

appBlock_displayName :: Lens' AppBlock (Maybe Text) Source #

The display name of the app block.

appBlock_sourceS3Location :: Lens' AppBlock (Maybe S3Location) Source #

The source S3 location of the app block.

appBlock_name :: Lens' AppBlock Text Source #

The name of the app block.

appBlock_arn :: Lens' AppBlock Text Source #

The ARN of the app block.

appBlock_setupScriptDetails :: Lens' AppBlock ScriptDetails Source #

The setup script details of the app block.

Application

application_appBlockArn :: Lens' Application (Maybe Text) Source #

The app block ARN of the application.

application_arn :: Lens' Application (Maybe Text) Source #

The ARN of the application.

application_createdTime :: Lens' Application (Maybe UTCTime) Source #

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

application_description :: Lens' Application (Maybe Text) Source #

The description of the application.

application_displayName :: Lens' Application (Maybe Text) Source #

The application name to display.

application_enabled :: Lens' Application (Maybe Bool) Source #

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

application_iconS3Location :: Lens' Application (Maybe S3Location) Source #

The S3 location of the application icon.

application_iconURL :: Lens' Application (Maybe Text) Source #

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

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

The instance families for the application.

application_launchParameters :: Lens' Application (Maybe Text) Source #

The arguments that are passed to the application at launch.

application_launchPath :: Lens' Application (Maybe Text) Source #

The path to the application executable in the instance.

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

Additional attributes that describe the application.

application_name :: Lens' Application (Maybe Text) Source #

The name of the application.

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

The platforms on which the application can run.

application_workingDirectory :: Lens' Application (Maybe Text) Source #

The working directory for the application.

ApplicationFleetAssociation

applicationFleetAssociation_fleetName :: Lens' ApplicationFleetAssociation Text Source #

The name of the fleet associated with the application.

applicationFleetAssociation_applicationArn :: Lens' ApplicationFleetAssociation Text Source #

The ARN of the application associated with the fleet.

ApplicationSettings

applicationSettings_settingsGroup :: Lens' ApplicationSettings (Maybe Text) Source #

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 Source #

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

ApplicationSettingsResponse

applicationSettingsResponse_enabled :: Lens' ApplicationSettingsResponse (Maybe Bool) Source #

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

applicationSettingsResponse_s3BucketName :: Lens' ApplicationSettingsResponse (Maybe Text) Source #

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) Source #

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

CertificateBasedAuthProperties

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

The ARN of the AWS Certificate Manager Private CA resource.

ComputeCapacity

computeCapacity_desiredInstances :: Lens' ComputeCapacity Int Source #

The desired number of streaming instances.

ComputeCapacityStatus

computeCapacityStatus_available :: Lens' ComputeCapacityStatus (Maybe Int) Source #

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

computeCapacityStatus_inUse :: Lens' ComputeCapacityStatus (Maybe Int) Source #

The number of instances in use for streaming.

computeCapacityStatus_running :: Lens' ComputeCapacityStatus (Maybe Int) Source #

The total number of simultaneous streaming instances that are running.

computeCapacityStatus_desired :: Lens' ComputeCapacityStatus Int Source #

The desired number of streaming instances.

DirectoryConfig

directoryConfig_certificateBasedAuthProperties :: Lens' DirectoryConfig (Maybe CertificateBasedAuthProperties) Source #

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) Source #

The time the directory configuration was created.

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

The distinguished names of the organizational units for computer accounts.

directoryConfig_serviceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials) Source #

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

directoryConfig_directoryName :: Lens' DirectoryConfig Text Source #

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

DomainJoinInfo

domainJoinInfo_directoryName :: Lens' DomainJoinInfo (Maybe Text) Source #

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

domainJoinInfo_organizationalUnitDistinguishedName :: Lens' DomainJoinInfo (Maybe Text) Source #

The distinguished name of the organizational unit for computer accounts.

EntitledApplication

Entitlement

entitlement_createdTime :: Lens' Entitlement (Maybe UTCTime) Source #

The time when the entitlement was created.

entitlement_description :: Lens' Entitlement (Maybe Text) Source #

The description of the entitlement.

entitlement_lastModifiedTime :: Lens' Entitlement (Maybe UTCTime) Source #

The time when the entitlement was last modified.

entitlement_name :: Lens' Entitlement Text Source #

The name of the entitlement.

entitlement_stackName :: Lens' Entitlement Text Source #

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

entitlement_appVisibility :: Lens' Entitlement AppVisibility Source #

Specifies whether all or selected apps are entitled.

EntitlementAttribute

entitlementAttribute_name :: Lens' EntitlementAttribute Text Source #

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 Source #

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) Source #

The time the fleet was created.

fleet_description :: Lens' Fleet (Maybe Text) Source #

The description to display.

fleet_disconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int) Source #

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) Source #

The fleet name to display.

fleet_domainJoinInfo :: Lens' Fleet (Maybe DomainJoinInfo) Source #

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) Source #

Indicates whether default internet access is enabled for the fleet.

fleet_fleetType :: Lens' Fleet (Maybe FleetType) Source #

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) Source #

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) Source #

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) Source #

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

fleet_imageName :: Lens' Fleet (Maybe Text) Source #

The name of the image used to create the fleet.

fleet_maxConcurrentSessions :: Lens' Fleet (Maybe Int) Source #

The maximum number of concurrent sessions for the fleet.

fleet_maxUserDurationInSeconds :: Lens' Fleet (Maybe Int) Source #

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) Source #

The platform of the fleet.

fleet_sessionScriptS3Location :: Lens' Fleet (Maybe S3Location) Source #

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

fleet_streamView :: Lens' Fleet (Maybe StreamView) Source #

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]) Source #

The USB device filter strings associated with the fleet.

fleet_vpcConfig :: Lens' Fleet (Maybe VpcConfig) Source #

The VPC configuration for the fleet.

fleet_arn :: Lens' Fleet Text Source #

The Amazon Resource Name (ARN) for the fleet.

fleet_name :: Lens' Fleet Text Source #

The name of the fleet.

fleet_instanceType :: Lens' Fleet Text Source #

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_state :: Lens' Fleet FleetState Source #

The current state for the fleet.

FleetError

Image

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

The applications associated with the image.

image_appstreamAgentVersion :: Lens' Image (Maybe Text) Source #

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

image_arn :: Lens' Image (Maybe Text) Source #

The ARN of the image.

image_baseImageArn :: Lens' Image (Maybe Text) Source #

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

image_createdTime :: Lens' Image (Maybe UTCTime) Source #

The time the image was created.

image_description :: Lens' Image (Maybe Text) Source #

The description to display.

image_displayName :: Lens' Image (Maybe Text) Source #

The image name to display.

image_imageBuilderName :: Lens' Image (Maybe Text) Source #

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) Source #

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

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

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

image_imagePermissions :: Lens' Image (Maybe ImagePermissions) Source #

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

image_platform :: Lens' Image (Maybe PlatformType) Source #

The operating system platform of the image.

image_publicBaseImageReleasedDate :: Lens' Image (Maybe UTCTime) Source #

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) Source #

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) Source #

The reason why the last state change occurred.

image_visibility :: Lens' Image (Maybe VisibilityType) Source #

Indicates whether the image is public or private.

image_name :: Lens' Image Text Source #

The name of the image.

ImageBuilder

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

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) Source #

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

imageBuilder_arn :: Lens' ImageBuilder (Maybe Text) Source #

The ARN for the image builder.

imageBuilder_createdTime :: Lens' ImageBuilder (Maybe UTCTime) Source #

The time stamp when the image builder was created.

imageBuilder_description :: Lens' ImageBuilder (Maybe Text) Source #

The description to display.

imageBuilder_displayName :: Lens' ImageBuilder (Maybe Text) Source #

The image builder name to display.

imageBuilder_domainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo) Source #

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) Source #

Enables or disables default internet access for the image builder.

imageBuilder_iamRoleArn :: Lens' ImageBuilder (Maybe Text) Source #

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) Source #

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

imageBuilder_instanceType :: Lens' ImageBuilder (Maybe Text) Source #

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_platform :: Lens' ImageBuilder (Maybe PlatformType) Source #

The operating system platform of the image builder.

imageBuilder_vpcConfig :: Lens' ImageBuilder (Maybe VpcConfig) Source #

The VPC configuration of the image builder.

imageBuilder_name :: Lens' ImageBuilder Text Source #

The name of the image builder.

ImageBuilderStateChangeReason

ImagePermissions

imagePermissions_allowFleet :: Lens' ImagePermissions (Maybe Bool) Source #

Indicates whether the image can be used for a fleet.

imagePermissions_allowImageBuilder :: Lens' ImagePermissions (Maybe Bool) Source #

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

ImageStateChangeReason

LastReportGenerationExecutionError

lastReportGenerationExecutionError_errorCode :: Lens' LastReportGenerationExecutionError (Maybe UsageReportExecutionErrorCode) Source #

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

lastReportGenerationExecutionError_errorMessage :: Lens' LastReportGenerationExecutionError (Maybe Text) Source #

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

NetworkAccessConfiguration

networkAccessConfiguration_eniId :: Lens' NetworkAccessConfiguration (Maybe Text) Source #

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) Source #

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

ResourceError

S3Location

s3Location_s3Bucket :: Lens' S3Location Text Source #

The S3 bucket of the S3 object.

s3Location_s3Key :: Lens' S3Location Text Source #

The S3 key of the S3 object.

ScriptDetails

scriptDetails_executableParameters :: Lens' ScriptDetails (Maybe Text) Source #

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

scriptDetails_scriptS3Location :: Lens' ScriptDetails S3Location Source #

The S3 object location for the script.

scriptDetails_timeoutInSeconds :: Lens' ScriptDetails Int Source #

The run timeout, in seconds, for the script.

ServiceAccountCredentials

serviceAccountCredentials_accountName :: Lens' ServiceAccountCredentials Text Source #

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.

Session

session_authenticationType :: Lens' Session (Maybe AuthenticationType) Source #

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

session_connectionState :: Lens' Session (Maybe SessionConnectionState) Source #

Specifies whether a user is connected to the streaming session.

session_maxExpirationTime :: Lens' Session (Maybe UTCTime) Source #

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) Source #

The network details for the streaming session.

session_startTime :: Lens' Session (Maybe UTCTime) Source #

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

session_id :: Lens' Session Text Source #

The identifier of the streaming session.

session_userId :: Lens' Session Text Source #

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

session_stackName :: Lens' Session Text Source #

The name of the stack for the streaming session.

session_fleetName :: Lens' Session Text Source #

The name of the fleet for the streaming session.

session_state :: Lens' Session SessionState Source #

The current state of the streaming session.

SharedImagePermissions

sharedImagePermissions_sharedAccountId :: Lens' SharedImagePermissions Text Source #

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

Stack

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

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) Source #

The persistent application settings for users of the stack.

stack_arn :: Lens' Stack (Maybe Text) Source #

The ARN of the stack.

stack_createdTime :: Lens' Stack (Maybe UTCTime) Source #

The time the stack was created.

stack_description :: Lens' Stack (Maybe Text) Source #

The description to display.

stack_displayName :: Lens' Stack (Maybe Text) Source #

The stack name to display.

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

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) Source #

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) Source #

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

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

The errors for the stack.

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

The storage connectors to enable.

stack_streamingExperienceSettings :: Lens' Stack (Maybe StreamingExperienceSettings) Source #

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)) Source #

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

stack_name :: Lens' Stack Text Source #

The name of the stack.

StackError

StorageConnector

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

The names of the domains for the account.

StreamingExperienceSettings

streamingExperienceSettings_preferredProtocol :: Lens' StreamingExperienceSettings (Maybe PreferredProtocol) Source #

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

UsageReportSubscription

usageReportSubscription_s3BucketName :: Lens' UsageReportSubscription (Maybe Text) Source #

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_subscriptionErrors :: Lens' UsageReportSubscription (Maybe [LastReportGenerationExecutionError]) Source #

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

User

user_arn :: Lens' User (Maybe Text) Source #

The ARN of the user.

user_createdTime :: Lens' User (Maybe UTCTime) Source #

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

user_enabled :: Lens' User (Maybe Bool) Source #

Specifies whether the user in the user pool is enabled.

user_firstName :: Lens' User (Maybe Text) Source #

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

user_lastName :: Lens' User (Maybe Text) Source #

The last name, or surname, of the user.

user_status :: Lens' User (Maybe Text) Source #

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) Source #

The email address of the user.

Users' email addresses are case-sensitive.

user_authenticationType :: Lens' User AuthenticationType Source #

The authentication type for the user.

UserSetting

userSetting_action :: Lens' UserSetting Action Source #

The action that is enabled or disabled.

userSetting_permission :: Lens' UserSetting Permission Source #

Indicates whether the action is enabled or disabled.

UserStackAssociation

userStackAssociation_sendEmailNotification :: Lens' UserStackAssociation (Maybe Bool) Source #

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

userStackAssociation_stackName :: Lens' UserStackAssociation Text Source #

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

userStackAssociation_userName :: Lens' UserStackAssociation Text Source #

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

Users' email addresses are case-sensitive.

UserStackAssociationError

userStackAssociationError_errorCode :: Lens' UserStackAssociationError (Maybe UserStackAssociationErrorCode) Source #

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) Source #

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

VpcConfig

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

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

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

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.