| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AppStream
Contents
- Service Configuration
- Errors
- ConcurrentModificationException
- EntitlementAlreadyExistsException
- EntitlementNotFoundException
- IncompatibleImageException
- InvalidAccountStatusException
- InvalidParameterCombinationException
- InvalidRoleException
- LimitExceededException
- OperationNotPermittedException
- RequestLimitExceededException
- ResourceAlreadyExistsException
- ResourceInUseException
- ResourceNotAvailableException
- ResourceNotFoundException
- Waiters
- Operations
- AssociateApplicationFleet
- AssociateApplicationToEntitlement
- AssociateFleet
- BatchAssociateUserStack
- BatchDisassociateUserStack
- CopyImage
- CreateAppBlock
- CreateApplication
- CreateDirectoryConfig
- CreateEntitlement
- CreateFleet
- CreateImageBuilder
- CreateImageBuilderStreamingURL
- CreateStack
- CreateStreamingURL
- CreateUpdatedImage
- CreateUsageReportSubscription
- CreateUser
- DeleteAppBlock
- DeleteApplication
- DeleteDirectoryConfig
- DeleteEntitlement
- DeleteFleet
- DeleteImage
- DeleteImageBuilder
- DeleteImagePermissions
- DeleteStack
- DeleteUsageReportSubscription
- DeleteUser
- DescribeAppBlocks
- DescribeApplicationFleetAssociations
- DescribeApplications
- DescribeDirectoryConfigs (Paginated)
- DescribeEntitlements
- DescribeFleets (Paginated)
- DescribeImageBuilders (Paginated)
- DescribeImagePermissions
- DescribeImages (Paginated)
- DescribeSessions (Paginated)
- DescribeStacks (Paginated)
- DescribeUsageReportSubscriptions
- DescribeUserStackAssociations (Paginated)
- DescribeUsers (Paginated)
- DisableUser
- DisassociateApplicationFleet
- DisassociateApplicationFromEntitlement
- DisassociateFleet
- EnableUser
- ExpireSession
- ListAssociatedFleets (Paginated)
- ListAssociatedStacks (Paginated)
- ListEntitledApplications
- ListTagsForResource
- StartFleet
- StartImageBuilder
- StopFleet
- StopImageBuilder
- TagResource
- UntagResource
- UpdateApplication
- UpdateDirectoryConfig
- UpdateEntitlement
- UpdateFleet
- UpdateImagePermissions
- UpdateStack
- Types
- AccessEndpointType
- Action
- AppVisibility
- ApplicationAttribute
- AuthenticationType
- CertificateBasedAuthStatus
- FleetAttribute
- FleetErrorCode
- FleetState
- FleetType
- ImageBuilderState
- ImageBuilderStateChangeReasonCode
- ImageState
- ImageStateChangeReasonCode
- MessageAction
- Permission
- PlatformType
- PreferredProtocol
- SessionConnectionState
- SessionState
- StackAttribute
- StackErrorCode
- StorageConnectorType
- StreamView
- UsageReportExecutionErrorCode
- UsageReportSchedule
- UserStackAssociationErrorCode
- VisibilityType
- AccessEndpoint
- AppBlock
- Application
- ApplicationFleetAssociation
- ApplicationSettings
- ApplicationSettingsResponse
- CertificateBasedAuthProperties
- ComputeCapacity
- ComputeCapacityStatus
- DirectoryConfig
- DomainJoinInfo
- EntitledApplication
- Entitlement
- EntitlementAttribute
- Fleet
- FleetError
- Image
- ImageBuilder
- ImageBuilderStateChangeReason
- ImagePermissions
- ImageStateChangeReason
- LastReportGenerationExecutionError
- NetworkAccessConfiguration
- ResourceError
- S3Location
- ScriptDetails
- ServiceAccountCredentials
- Session
- SharedImagePermissions
- Stack
- StackError
- StorageConnector
- StreamingExperienceSettings
- UsageReportSubscription
- User
- UserSetting
- UserStackAssociation
- UserStackAssociationError
- VpcConfig
Description
Derived from API version 2016-12-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon AppStream 2.0
This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
To learn more about AppStream 2.0, see the following resources:
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _EntitlementAlreadyExistsException :: AsError a => Fold a ServiceError
- _EntitlementNotFoundException :: AsError a => Fold a ServiceError
- _IncompatibleImageException :: AsError a => Fold a ServiceError
- _InvalidAccountStatusException :: AsError a => Fold a ServiceError
- _InvalidParameterCombinationException :: AsError a => Fold a ServiceError
- _InvalidRoleException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _OperationNotPermittedException :: AsError a => Fold a ServiceError
- _RequestLimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotAvailableException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- newFleetStarted :: Wait DescribeFleets
- newFleetStopped :: Wait DescribeFleets
- data AssociateApplicationFleet = AssociateApplicationFleet' Text Text
- newAssociateApplicationFleet :: Text -> Text -> AssociateApplicationFleet
- data AssociateApplicationFleetResponse = AssociateApplicationFleetResponse' (Maybe ApplicationFleetAssociation) Int
- newAssociateApplicationFleetResponse :: Int -> AssociateApplicationFleetResponse
- data AssociateApplicationToEntitlement = AssociateApplicationToEntitlement' Text Text Text
- newAssociateApplicationToEntitlement :: Text -> Text -> Text -> AssociateApplicationToEntitlement
- data AssociateApplicationToEntitlementResponse = AssociateApplicationToEntitlementResponse' Int
- newAssociateApplicationToEntitlementResponse :: Int -> AssociateApplicationToEntitlementResponse
- data AssociateFleet = AssociateFleet' Text Text
- newAssociateFleet :: Text -> Text -> AssociateFleet
- data AssociateFleetResponse = AssociateFleetResponse' Int
- newAssociateFleetResponse :: Int -> AssociateFleetResponse
- data BatchAssociateUserStack = BatchAssociateUserStack' (NonEmpty UserStackAssociation)
- newBatchAssociateUserStack :: NonEmpty UserStackAssociation -> BatchAssociateUserStack
- data BatchAssociateUserStackResponse = BatchAssociateUserStackResponse' (Maybe [UserStackAssociationError]) Int
- newBatchAssociateUserStackResponse :: Int -> BatchAssociateUserStackResponse
- data BatchDisassociateUserStack = BatchDisassociateUserStack' (NonEmpty UserStackAssociation)
- newBatchDisassociateUserStack :: NonEmpty UserStackAssociation -> BatchDisassociateUserStack
- data BatchDisassociateUserStackResponse = BatchDisassociateUserStackResponse' (Maybe [UserStackAssociationError]) Int
- newBatchDisassociateUserStackResponse :: Int -> BatchDisassociateUserStackResponse
- data CopyImage = CopyImage' (Maybe Text) Text Text Text
- newCopyImage :: Text -> Text -> Text -> CopyImage
- data CopyImageResponse = CopyImageResponse' (Maybe Text) Int
- newCopyImageResponse :: Int -> CopyImageResponse
- data CreateAppBlock = CreateAppBlock' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text S3Location ScriptDetails
- newCreateAppBlock :: Text -> S3Location -> ScriptDetails -> CreateAppBlock
- data CreateAppBlockResponse = CreateAppBlockResponse' (Maybe AppBlock) Int
- newCreateAppBlockResponse :: Int -> CreateAppBlockResponse
- data CreateApplication = CreateApplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text S3Location Text [PlatformType] [Text] Text
- newCreateApplication :: Text -> S3Location -> Text -> Text -> CreateApplication
- data CreateApplicationResponse = CreateApplicationResponse' (Maybe Application) Int
- newCreateApplicationResponse :: Int -> CreateApplicationResponse
- data CreateDirectoryConfig = CreateDirectoryConfig' (Maybe CertificateBasedAuthProperties) (Maybe ServiceAccountCredentials) Text [Text]
- newCreateDirectoryConfig :: Text -> CreateDirectoryConfig
- data CreateDirectoryConfigResponse = CreateDirectoryConfigResponse' (Maybe DirectoryConfig) Int
- newCreateDirectoryConfigResponse :: Int -> CreateDirectoryConfigResponse
- data CreateEntitlement = CreateEntitlement' (Maybe Text) Text Text AppVisibility (NonEmpty EntitlementAttribute)
- newCreateEntitlement :: Text -> Text -> AppVisibility -> NonEmpty EntitlementAttribute -> CreateEntitlement
- data CreateEntitlementResponse = CreateEntitlementResponse' (Maybe Entitlement) Int
- newCreateEntitlementResponse :: Int -> CreateEntitlementResponse
- data CreateFleet = CreateFleet' (Maybe ComputeCapacity) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe FleetType) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe PlatformType) (Maybe S3Location) (Maybe StreamView) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe VpcConfig) Text Text
- newCreateFleet :: Text -> Text -> CreateFleet
- data CreateFleetResponse = CreateFleetResponse' (Maybe Fleet) Int
- newCreateFleetResponse :: Int -> CreateFleetResponse
- data CreateImageBuilder = CreateImageBuilder' (Maybe (NonEmpty AccessEndpoint)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe VpcConfig) Text Text
- newCreateImageBuilder :: Text -> Text -> CreateImageBuilder
- data CreateImageBuilderResponse = CreateImageBuilderResponse' (Maybe ImageBuilder) Int
- newCreateImageBuilderResponse :: Int -> CreateImageBuilderResponse
- data CreateImageBuilderStreamingURL = CreateImageBuilderStreamingURL' (Maybe Integer) Text
- newCreateImageBuilderStreamingURL :: Text -> CreateImageBuilderStreamingURL
- data CreateImageBuilderStreamingURLResponse = CreateImageBuilderStreamingURLResponse' (Maybe POSIX) (Maybe Text) Int
- newCreateImageBuilderStreamingURLResponse :: Int -> CreateImageBuilderStreamingURLResponse
- data CreateStack = CreateStack' (Maybe (NonEmpty AccessEndpoint)) (Maybe ApplicationSettings) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [StorageConnector]) (Maybe StreamingExperienceSettings) (Maybe (HashMap Text Text)) (Maybe (NonEmpty UserSetting)) Text
- newCreateStack :: Text -> CreateStack
- data CreateStackResponse = CreateStackResponse' (Maybe Stack) Int
- newCreateStackResponse :: Int -> CreateStackResponse
- data CreateStreamingURL = CreateStreamingURL' (Maybe Text) (Maybe Text) (Maybe Integer) Text Text Text
- newCreateStreamingURL :: Text -> Text -> Text -> CreateStreamingURL
- data CreateStreamingURLResponse = CreateStreamingURLResponse' (Maybe POSIX) (Maybe Text) Int
- newCreateStreamingURLResponse :: Int -> CreateStreamingURLResponse
- data CreateUpdatedImage = CreateUpdatedImage' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateUpdatedImage :: Text -> Text -> CreateUpdatedImage
- data CreateUpdatedImageResponse = CreateUpdatedImageResponse' (Maybe Bool) (Maybe Image) Int
- newCreateUpdatedImageResponse :: Int -> CreateUpdatedImageResponse
- data CreateUsageReportSubscription = CreateUsageReportSubscription' {
- newCreateUsageReportSubscription :: CreateUsageReportSubscription
- data CreateUsageReportSubscriptionResponse = CreateUsageReportSubscriptionResponse' (Maybe Text) (Maybe UsageReportSchedule) Int
- newCreateUsageReportSubscriptionResponse :: Int -> CreateUsageReportSubscriptionResponse
- data CreateUser = CreateUser' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe MessageAction) (Sensitive Text) AuthenticationType
- newCreateUser :: Text -> AuthenticationType -> CreateUser
- data CreateUserResponse = CreateUserResponse' Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data DeleteAppBlock = DeleteAppBlock' Text
- newDeleteAppBlock :: Text -> DeleteAppBlock
- data DeleteAppBlockResponse = DeleteAppBlockResponse' Int
- newDeleteAppBlockResponse :: Int -> DeleteAppBlockResponse
- data DeleteApplication = DeleteApplication' Text
- newDeleteApplication :: Text -> DeleteApplication
- data DeleteApplicationResponse = DeleteApplicationResponse' Int
- newDeleteApplicationResponse :: Int -> DeleteApplicationResponse
- data DeleteDirectoryConfig = DeleteDirectoryConfig' Text
- newDeleteDirectoryConfig :: Text -> DeleteDirectoryConfig
- data DeleteDirectoryConfigResponse = DeleteDirectoryConfigResponse' Int
- newDeleteDirectoryConfigResponse :: Int -> DeleteDirectoryConfigResponse
- data DeleteEntitlement = DeleteEntitlement' Text Text
- newDeleteEntitlement :: Text -> Text -> DeleteEntitlement
- data DeleteEntitlementResponse = DeleteEntitlementResponse' Int
- newDeleteEntitlementResponse :: Int -> DeleteEntitlementResponse
- data DeleteFleet = DeleteFleet' Text
- newDeleteFleet :: Text -> DeleteFleet
- data DeleteFleetResponse = DeleteFleetResponse' Int
- newDeleteFleetResponse :: Int -> DeleteFleetResponse
- data DeleteImage = DeleteImage' Text
- newDeleteImage :: Text -> DeleteImage
- data DeleteImageResponse = DeleteImageResponse' (Maybe Image) Int
- newDeleteImageResponse :: Int -> DeleteImageResponse
- data DeleteImageBuilder = DeleteImageBuilder' Text
- newDeleteImageBuilder :: Text -> DeleteImageBuilder
- data DeleteImageBuilderResponse = DeleteImageBuilderResponse' (Maybe ImageBuilder) Int
- newDeleteImageBuilderResponse :: Int -> DeleteImageBuilderResponse
- data DeleteImagePermissions = DeleteImagePermissions' Text Text
- newDeleteImagePermissions :: Text -> Text -> DeleteImagePermissions
- data DeleteImagePermissionsResponse = DeleteImagePermissionsResponse' Int
- newDeleteImagePermissionsResponse :: Int -> DeleteImagePermissionsResponse
- data DeleteStack = DeleteStack' Text
- newDeleteStack :: Text -> DeleteStack
- data DeleteStackResponse = DeleteStackResponse' Int
- newDeleteStackResponse :: Int -> DeleteStackResponse
- data DeleteUsageReportSubscription = DeleteUsageReportSubscription' {
- newDeleteUsageReportSubscription :: DeleteUsageReportSubscription
- data DeleteUsageReportSubscriptionResponse = DeleteUsageReportSubscriptionResponse' Int
- newDeleteUsageReportSubscriptionResponse :: Int -> DeleteUsageReportSubscriptionResponse
- data DeleteUser = DeleteUser' (Sensitive Text) AuthenticationType
- newDeleteUser :: Text -> AuthenticationType -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' Int
- newDeleteUserResponse :: Int -> DeleteUserResponse
- data DescribeAppBlocks = DescribeAppBlocks' (Maybe [Text]) (Maybe Int) (Maybe Text)
- newDescribeAppBlocks :: DescribeAppBlocks
- data DescribeAppBlocksResponse = DescribeAppBlocksResponse' (Maybe [AppBlock]) (Maybe Text) Int
- newDescribeAppBlocksResponse :: Int -> DescribeAppBlocksResponse
- data DescribeApplicationFleetAssociations = DescribeApplicationFleetAssociations' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeApplicationFleetAssociations :: DescribeApplicationFleetAssociations
- data DescribeApplicationFleetAssociationsResponse = DescribeApplicationFleetAssociationsResponse' (Maybe (NonEmpty ApplicationFleetAssociation)) (Maybe Text) Int
- newDescribeApplicationFleetAssociationsResponse :: Int -> DescribeApplicationFleetAssociationsResponse
- data DescribeApplications = DescribeApplications' (Maybe [Text]) (Maybe Int) (Maybe Text)
- newDescribeApplications :: DescribeApplications
- data DescribeApplicationsResponse = DescribeApplicationsResponse' (Maybe [Application]) (Maybe Text) Int
- newDescribeApplicationsResponse :: Int -> DescribeApplicationsResponse
- data DescribeDirectoryConfigs = DescribeDirectoryConfigs' (Maybe [Text]) (Maybe Int) (Maybe Text)
- newDescribeDirectoryConfigs :: DescribeDirectoryConfigs
- data DescribeDirectoryConfigsResponse = DescribeDirectoryConfigsResponse' (Maybe [DirectoryConfig]) (Maybe Text) Int
- newDescribeDirectoryConfigsResponse :: Int -> DescribeDirectoryConfigsResponse
- data DescribeEntitlements = DescribeEntitlements' (Maybe Int) (Maybe Text) (Maybe Text) Text
- newDescribeEntitlements :: Text -> DescribeEntitlements
- data DescribeEntitlementsResponse = DescribeEntitlementsResponse' (Maybe [Entitlement]) (Maybe Text) Int
- newDescribeEntitlementsResponse :: Int -> DescribeEntitlementsResponse
- data DescribeFleets = DescribeFleets' (Maybe [Text]) (Maybe Text)
- newDescribeFleets :: DescribeFleets
- data DescribeFleetsResponse = DescribeFleetsResponse' (Maybe [Fleet]) (Maybe Text) Int
- newDescribeFleetsResponse :: Int -> DescribeFleetsResponse
- data DescribeImageBuilders = DescribeImageBuilders' (Maybe Int) (Maybe [Text]) (Maybe Text)
- newDescribeImageBuilders :: DescribeImageBuilders
- data DescribeImageBuildersResponse = DescribeImageBuildersResponse' (Maybe [ImageBuilder]) (Maybe Text) Int
- newDescribeImageBuildersResponse :: Int -> DescribeImageBuildersResponse
- data DescribeImagePermissions = DescribeImagePermissions' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty Text)) Text
- newDescribeImagePermissions :: Text -> DescribeImagePermissions
- data DescribeImagePermissionsResponse = DescribeImagePermissionsResponse' (Maybe Text) (Maybe Text) (Maybe [SharedImagePermissions]) Int
- newDescribeImagePermissionsResponse :: Int -> DescribeImagePermissionsResponse
- data DescribeImages = DescribeImages' (Maybe [Text]) (Maybe Natural) (Maybe [Text]) (Maybe Text) (Maybe VisibilityType)
- newDescribeImages :: DescribeImages
- data DescribeImagesResponse = DescribeImagesResponse' (Maybe [Image]) (Maybe Text) Int
- newDescribeImagesResponse :: Int -> DescribeImagesResponse
- data DescribeSessions = DescribeSessions' (Maybe AuthenticationType) (Maybe Int) (Maybe Text) (Maybe Text) Text Text
- newDescribeSessions :: Text -> Text -> DescribeSessions
- data DescribeSessionsResponse = DescribeSessionsResponse' (Maybe Text) (Maybe [Session]) Int
- newDescribeSessionsResponse :: Int -> DescribeSessionsResponse
- data DescribeStacks = DescribeStacks' (Maybe [Text]) (Maybe Text)
- newDescribeStacks :: DescribeStacks
- data DescribeStacksResponse = DescribeStacksResponse' (Maybe Text) (Maybe [Stack]) Int
- newDescribeStacksResponse :: Int -> DescribeStacksResponse
- data DescribeUsageReportSubscriptions = DescribeUsageReportSubscriptions' (Maybe Int) (Maybe Text)
- newDescribeUsageReportSubscriptions :: DescribeUsageReportSubscriptions
- data DescribeUsageReportSubscriptionsResponse = DescribeUsageReportSubscriptionsResponse' (Maybe Text) (Maybe [UsageReportSubscription]) Int
- newDescribeUsageReportSubscriptionsResponse :: Int -> DescribeUsageReportSubscriptionsResponse
- data DescribeUserStackAssociations = DescribeUserStackAssociations' (Maybe AuthenticationType) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text))
- newDescribeUserStackAssociations :: DescribeUserStackAssociations
- data DescribeUserStackAssociationsResponse = DescribeUserStackAssociationsResponse' (Maybe Text) (Maybe (NonEmpty UserStackAssociation)) Int
- newDescribeUserStackAssociationsResponse :: Int -> DescribeUserStackAssociationsResponse
- data DescribeUsers = DescribeUsers' (Maybe Int) (Maybe Text) AuthenticationType
- newDescribeUsers :: AuthenticationType -> DescribeUsers
- data DescribeUsersResponse = DescribeUsersResponse' (Maybe Text) (Maybe [User]) Int
- newDescribeUsersResponse :: Int -> DescribeUsersResponse
- data DisableUser = DisableUser' (Sensitive Text) AuthenticationType
- newDisableUser :: Text -> AuthenticationType -> DisableUser
- data DisableUserResponse = DisableUserResponse' Int
- newDisableUserResponse :: Int -> DisableUserResponse
- data DisassociateApplicationFleet = DisassociateApplicationFleet' Text Text
- newDisassociateApplicationFleet :: Text -> Text -> DisassociateApplicationFleet
- data DisassociateApplicationFleetResponse = DisassociateApplicationFleetResponse' Int
- newDisassociateApplicationFleetResponse :: Int -> DisassociateApplicationFleetResponse
- data DisassociateApplicationFromEntitlement = DisassociateApplicationFromEntitlement' Text Text Text
- newDisassociateApplicationFromEntitlement :: Text -> Text -> Text -> DisassociateApplicationFromEntitlement
- data DisassociateApplicationFromEntitlementResponse = DisassociateApplicationFromEntitlementResponse' Int
- newDisassociateApplicationFromEntitlementResponse :: Int -> DisassociateApplicationFromEntitlementResponse
- data DisassociateFleet = DisassociateFleet' Text Text
- newDisassociateFleet :: Text -> Text -> DisassociateFleet
- data DisassociateFleetResponse = DisassociateFleetResponse' Int
- newDisassociateFleetResponse :: Int -> DisassociateFleetResponse
- data EnableUser = EnableUser' (Sensitive Text) AuthenticationType
- newEnableUser :: Text -> AuthenticationType -> EnableUser
- data EnableUserResponse = EnableUserResponse' Int
- newEnableUserResponse :: Int -> EnableUserResponse
- data ExpireSession = ExpireSession' Text
- newExpireSession :: Text -> ExpireSession
- data ExpireSessionResponse = ExpireSessionResponse' Int
- newExpireSessionResponse :: Int -> ExpireSessionResponse
- data ListAssociatedFleets = ListAssociatedFleets' (Maybe Text) Text
- newListAssociatedFleets :: Text -> ListAssociatedFleets
- data ListAssociatedFleetsResponse = ListAssociatedFleetsResponse' (Maybe [Text]) (Maybe Text) Int
- newListAssociatedFleetsResponse :: Int -> ListAssociatedFleetsResponse
- data ListAssociatedStacks = ListAssociatedStacks' (Maybe Text) Text
- newListAssociatedStacks :: Text -> ListAssociatedStacks
- data ListAssociatedStacksResponse = ListAssociatedStacksResponse' (Maybe [Text]) (Maybe Text) Int
- newListAssociatedStacksResponse :: Int -> ListAssociatedStacksResponse
- data ListEntitledApplications = ListEntitledApplications' (Maybe Int) (Maybe Text) Text Text
- newListEntitledApplications :: Text -> Text -> ListEntitledApplications
- data ListEntitledApplicationsResponse = ListEntitledApplicationsResponse' (Maybe [EntitledApplication]) (Maybe Text) Int
- newListEntitledApplicationsResponse :: Int -> ListEntitledApplicationsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StartFleet = StartFleet' Text
- newStartFleet :: Text -> StartFleet
- data StartFleetResponse = StartFleetResponse' Int
- newStartFleetResponse :: Int -> StartFleetResponse
- data StartImageBuilder = StartImageBuilder' (Maybe Text) Text
- newStartImageBuilder :: Text -> StartImageBuilder
- data StartImageBuilderResponse = StartImageBuilderResponse' (Maybe ImageBuilder) Int
- newStartImageBuilderResponse :: Int -> StartImageBuilderResponse
- data StopFleet = StopFleet' Text
- newStopFleet :: Text -> StopFleet
- data StopFleetResponse = StopFleetResponse' Int
- newStopFleetResponse :: Int -> StopFleetResponse
- data StopImageBuilder = StopImageBuilder' Text
- newStopImageBuilder :: Text -> StopImageBuilder
- data StopImageBuilderResponse = StopImageBuilderResponse' (Maybe ImageBuilder) Int
- newStopImageBuilderResponse :: Int -> StopImageBuilderResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateApplication = UpdateApplication' (Maybe Text) (Maybe [ApplicationAttribute]) (Maybe Text) (Maybe Text) (Maybe S3Location) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateApplication :: Text -> UpdateApplication
- data UpdateApplicationResponse = UpdateApplicationResponse' (Maybe Application) Int
- newUpdateApplicationResponse :: Int -> UpdateApplicationResponse
- data UpdateDirectoryConfig = UpdateDirectoryConfig' (Maybe CertificateBasedAuthProperties) (Maybe [Text]) (Maybe ServiceAccountCredentials) Text
- newUpdateDirectoryConfig :: Text -> UpdateDirectoryConfig
- data UpdateDirectoryConfigResponse = UpdateDirectoryConfigResponse' (Maybe DirectoryConfig) Int
- newUpdateDirectoryConfigResponse :: Int -> UpdateDirectoryConfigResponse
- data UpdateEntitlement = UpdateEntitlement' (Maybe AppVisibility) (Maybe (NonEmpty EntitlementAttribute)) (Maybe Text) Text Text
- newUpdateEntitlement :: Text -> Text -> UpdateEntitlement
- data UpdateEntitlementResponse = UpdateEntitlementResponse' (Maybe Entitlement) Int
- newUpdateEntitlementResponse :: Int -> UpdateEntitlementResponse
- data UpdateFleet = UpdateFleet' (Maybe [FleetAttribute]) (Maybe ComputeCapacity) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe PlatformType) (Maybe S3Location) (Maybe StreamView) (Maybe [Text]) (Maybe VpcConfig)
- newUpdateFleet :: UpdateFleet
- data UpdateFleetResponse = UpdateFleetResponse' (Maybe Fleet) Int
- newUpdateFleetResponse :: Int -> UpdateFleetResponse
- data UpdateImagePermissions = UpdateImagePermissions' Text Text ImagePermissions
- newUpdateImagePermissions :: Text -> Text -> ImagePermissions -> UpdateImagePermissions
- data UpdateImagePermissionsResponse = UpdateImagePermissionsResponse' Int
- newUpdateImagePermissionsResponse :: Int -> UpdateImagePermissionsResponse
- data UpdateStack = UpdateStack' (Maybe (NonEmpty AccessEndpoint)) (Maybe ApplicationSettings) (Maybe [StackAttribute]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [StorageConnector]) (Maybe StreamingExperienceSettings) (Maybe (NonEmpty UserSetting)) Text
- newUpdateStack :: Text -> UpdateStack
- data UpdateStackResponse = UpdateStackResponse' (Maybe Stack) Int
- newUpdateStackResponse :: Int -> UpdateStackResponse
- newtype AccessEndpointType where
- newtype Action where
- Action' {
- fromAction :: Text
- pattern Action_CLIPBOARD_COPY_FROM_LOCAL_DEVICE :: Action
- pattern Action_CLIPBOARD_COPY_TO_LOCAL_DEVICE :: Action
- pattern Action_DOMAIN_PASSWORD_SIGNIN :: Action
- pattern Action_DOMAIN_SMART_CARD_SIGNIN :: Action
- pattern Action_FILE_DOWNLOAD :: Action
- pattern Action_FILE_UPLOAD :: Action
- pattern Action_PRINTING_TO_LOCAL_DEVICE :: Action
- Action' {
- newtype AppVisibility where
- AppVisibility' { }
- pattern AppVisibility_ALL :: AppVisibility
- pattern AppVisibility_ASSOCIATED :: AppVisibility
- newtype ApplicationAttribute where
- newtype AuthenticationType where
- AuthenticationType' { }
- pattern AuthenticationType_API :: AuthenticationType
- pattern AuthenticationType_AWS_AD :: AuthenticationType
- pattern AuthenticationType_SAML :: AuthenticationType
- pattern AuthenticationType_USERPOOL :: AuthenticationType
- newtype CertificateBasedAuthStatus where
- newtype FleetAttribute where
- FleetAttribute' { }
- pattern FleetAttribute_DOMAIN_JOIN_INFO :: FleetAttribute
- pattern FleetAttribute_IAM_ROLE_ARN :: FleetAttribute
- pattern FleetAttribute_SESSION_SCRIPT_S3_LOCATION :: FleetAttribute
- pattern FleetAttribute_USB_DEVICE_FILTER_STRINGS :: FleetAttribute
- pattern FleetAttribute_VPC_CONFIGURATION :: FleetAttribute
- pattern FleetAttribute_VPC_CONFIGURATION_SECURITY_GROUP_IDS :: FleetAttribute
- newtype FleetErrorCode where
- FleetErrorCode' { }
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_ACCESS_DENIED :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_FILE_NOT_FOUND :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_INVALID_PARAMETER :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_LOGON_FAILURE :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_MORE_DATA :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_NOT_SUPPORTED :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_INTERNAL_SERVICE_ERROR :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_NERR_PASSWORD_EXPIRED :: FleetErrorCode
- pattern FleetErrorCode_DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED :: FleetErrorCode
- pattern FleetErrorCode_FLEET_INSTANCE_PROVISIONING_FAILURE :: FleetErrorCode
- pattern FleetErrorCode_FLEET_STOPPED :: FleetErrorCode
- pattern FleetErrorCode_IAM_SERVICE_ROLE_IS_MISSING :: FleetErrorCode
- pattern FleetErrorCode_IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION :: FleetErrorCode
- pattern FleetErrorCode_IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION :: FleetErrorCode
- pattern FleetErrorCode_IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION :: FleetErrorCode
- pattern FleetErrorCode_IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION :: FleetErrorCode
- pattern FleetErrorCode_IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION :: FleetErrorCode
- pattern FleetErrorCode_IGW_NOT_ATTACHED :: FleetErrorCode
- pattern FleetErrorCode_IMAGE_NOT_FOUND :: FleetErrorCode
- pattern FleetErrorCode_INTERNAL_SERVICE_ERROR :: FleetErrorCode
- pattern FleetErrorCode_INVALID_SUBNET_CONFIGURATION :: FleetErrorCode
- pattern FleetErrorCode_MACHINE_ROLE_IS_MISSING :: FleetErrorCode
- pattern FleetErrorCode_NETWORK_INTERFACE_LIMIT_EXCEEDED :: FleetErrorCode
- pattern FleetErrorCode_SECURITY_GROUPS_NOT_FOUND :: FleetErrorCode
- pattern FleetErrorCode_STS_DISABLED_IN_REGION :: FleetErrorCode
- pattern FleetErrorCode_SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES :: FleetErrorCode
- pattern FleetErrorCode_SUBNET_NOT_FOUND :: FleetErrorCode
- newtype FleetState where
- FleetState' { }
- pattern FleetState_RUNNING :: FleetState
- pattern FleetState_STARTING :: FleetState
- pattern FleetState_STOPPED :: FleetState
- pattern FleetState_STOPPING :: FleetState
- newtype FleetType where
- FleetType' { }
- pattern FleetType_ALWAYS_ON :: FleetType
- pattern FleetType_ELASTIC :: FleetType
- pattern FleetType_ON_DEMAND :: FleetType
- newtype ImageBuilderState where
- ImageBuilderState' { }
- pattern ImageBuilderState_DELETING :: ImageBuilderState
- pattern ImageBuilderState_FAILED :: ImageBuilderState
- pattern ImageBuilderState_PENDING :: ImageBuilderState
- pattern ImageBuilderState_PENDING_QUALIFICATION :: ImageBuilderState
- pattern ImageBuilderState_REBOOTING :: ImageBuilderState
- pattern ImageBuilderState_RUNNING :: ImageBuilderState
- pattern ImageBuilderState_SNAPSHOTTING :: ImageBuilderState
- pattern ImageBuilderState_STOPPED :: ImageBuilderState
- pattern ImageBuilderState_STOPPING :: ImageBuilderState
- pattern ImageBuilderState_UPDATING :: ImageBuilderState
- pattern ImageBuilderState_UPDATING_AGENT :: ImageBuilderState
- newtype ImageBuilderStateChangeReasonCode where
- newtype ImageState where
- ImageState' { }
- pattern ImageState_AVAILABLE :: ImageState
- pattern ImageState_COPYING :: ImageState
- pattern ImageState_CREATING :: ImageState
- pattern ImageState_DELETING :: ImageState
- pattern ImageState_FAILED :: ImageState
- pattern ImageState_IMPORTING :: ImageState
- pattern ImageState_PENDING :: ImageState
- newtype ImageStateChangeReasonCode where
- newtype MessageAction where
- MessageAction' { }
- pattern MessageAction_RESEND :: MessageAction
- pattern MessageAction_SUPPRESS :: MessageAction
- newtype Permission where
- Permission' { }
- pattern Permission_DISABLED :: Permission
- pattern Permission_ENABLED :: Permission
- newtype PlatformType where
- PlatformType' { }
- pattern PlatformType_AMAZON_LINUX2 :: PlatformType
- pattern PlatformType_WINDOWS :: PlatformType
- pattern PlatformType_WINDOWS_SERVER_2016 :: PlatformType
- pattern PlatformType_WINDOWS_SERVER_2019 :: PlatformType
- newtype PreferredProtocol where
- PreferredProtocol' { }
- pattern PreferredProtocol_TCP :: PreferredProtocol
- pattern PreferredProtocol_UDP :: PreferredProtocol
- newtype SessionConnectionState where
- newtype SessionState where
- SessionState' { }
- pattern SessionState_ACTIVE :: SessionState
- pattern SessionState_EXPIRED :: SessionState
- pattern SessionState_PENDING :: SessionState
- newtype StackAttribute where
- StackAttribute' { }
- pattern StackAttribute_ACCESS_ENDPOINTS :: StackAttribute
- pattern StackAttribute_EMBED_HOST_DOMAINS :: StackAttribute
- pattern StackAttribute_FEEDBACK_URL :: StackAttribute
- pattern StackAttribute_IAM_ROLE_ARN :: StackAttribute
- pattern StackAttribute_REDIRECT_URL :: StackAttribute
- pattern StackAttribute_STORAGE_CONNECTORS :: StackAttribute
- pattern StackAttribute_STORAGE_CONNECTOR_GOOGLE_DRIVE :: StackAttribute
- pattern StackAttribute_STORAGE_CONNECTOR_HOMEFOLDERS :: StackAttribute
- pattern StackAttribute_STORAGE_CONNECTOR_ONE_DRIVE :: StackAttribute
- pattern StackAttribute_STREAMING_EXPERIENCE_SETTINGS :: StackAttribute
- pattern StackAttribute_THEME_NAME :: StackAttribute
- pattern StackAttribute_USER_SETTINGS :: StackAttribute
- newtype StackErrorCode where
- newtype StorageConnectorType where
- newtype StreamView where
- StreamView' { }
- pattern StreamView_APP :: StreamView
- pattern StreamView_DESKTOP :: StreamView
- newtype UsageReportExecutionErrorCode where
- UsageReportExecutionErrorCode' { }
- pattern UsageReportExecutionErrorCode_ACCESS_DENIED :: UsageReportExecutionErrorCode
- pattern UsageReportExecutionErrorCode_INTERNAL_SERVICE_ERROR :: UsageReportExecutionErrorCode
- pattern UsageReportExecutionErrorCode_RESOURCE_NOT_FOUND :: UsageReportExecutionErrorCode
- newtype UsageReportSchedule where
- newtype UserStackAssociationErrorCode where
- UserStackAssociationErrorCode' { }
- pattern UserStackAssociationErrorCode_DIRECTORY_NOT_FOUND :: UserStackAssociationErrorCode
- pattern UserStackAssociationErrorCode_INTERNAL_ERROR :: UserStackAssociationErrorCode
- pattern UserStackAssociationErrorCode_STACK_NOT_FOUND :: UserStackAssociationErrorCode
- pattern UserStackAssociationErrorCode_USER_NAME_NOT_FOUND :: UserStackAssociationErrorCode
- newtype VisibilityType where
- VisibilityType' { }
- pattern VisibilityType_PRIVATE :: VisibilityType
- pattern VisibilityType_PUBLIC :: VisibilityType
- pattern VisibilityType_SHARED :: VisibilityType
- data AccessEndpoint = AccessEndpoint' (Maybe Text) AccessEndpointType
- newAccessEndpoint :: AccessEndpointType -> AccessEndpoint
- data AppBlock = AppBlock' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe S3Location) Text Text ScriptDetails
- newAppBlock :: Text -> Text -> ScriptDetails -> AppBlock
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe S3Location) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [PlatformType]) (Maybe Text)
- newApplication :: Application
- data ApplicationFleetAssociation = ApplicationFleetAssociation' Text Text
- newApplicationFleetAssociation :: Text -> Text -> ApplicationFleetAssociation
- data ApplicationSettings = ApplicationSettings' (Maybe Text) Bool
- newApplicationSettings :: Bool -> ApplicationSettings
- data ApplicationSettingsResponse = ApplicationSettingsResponse' (Maybe Bool) (Maybe Text) (Maybe Text)
- newApplicationSettingsResponse :: ApplicationSettingsResponse
- data CertificateBasedAuthProperties = CertificateBasedAuthProperties' (Maybe Text) (Maybe CertificateBasedAuthStatus)
- newCertificateBasedAuthProperties :: CertificateBasedAuthProperties
- data ComputeCapacity = ComputeCapacity' Int
- newComputeCapacity :: Int -> ComputeCapacity
- data ComputeCapacityStatus = ComputeCapacityStatus' (Maybe Int) (Maybe Int) (Maybe Int) Int
- newComputeCapacityStatus :: Int -> ComputeCapacityStatus
- data DirectoryConfig = DirectoryConfig' (Maybe CertificateBasedAuthProperties) (Maybe POSIX) (Maybe [Text]) (Maybe ServiceAccountCredentials) Text
- newDirectoryConfig :: Text -> DirectoryConfig
- data DomainJoinInfo = DomainJoinInfo' (Maybe Text) (Maybe Text)
- newDomainJoinInfo :: DomainJoinInfo
- data EntitledApplication = EntitledApplication' Text
- newEntitledApplication :: Text -> EntitledApplication
- data Entitlement = Entitlement' (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text Text AppVisibility (NonEmpty EntitlementAttribute)
- newEntitlement :: Text -> Text -> AppVisibility -> NonEmpty EntitlementAttribute -> Entitlement
- data EntitlementAttribute = EntitlementAttribute' Text Text
- newEntitlementAttribute :: Text -> Text -> EntitlementAttribute
- data Fleet = Fleet' (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe [FleetError]) (Maybe FleetType) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe PlatformType) (Maybe S3Location) (Maybe StreamView) (Maybe [Text]) (Maybe VpcConfig) Text Text Text ComputeCapacityStatus FleetState
- newFleet :: Text -> Text -> Text -> ComputeCapacityStatus -> FleetState -> Fleet
- data FleetError = FleetError' (Maybe FleetErrorCode) (Maybe Text)
- newFleetError :: FleetError
- data Image = Image' (Maybe [Application]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [ResourceError]) (Maybe ImagePermissions) (Maybe PlatformType) (Maybe POSIX) (Maybe ImageState) (Maybe ImageStateChangeReason) (Maybe VisibilityType) Text
- newImage :: Text -> Image
- data ImageBuilder = ImageBuilder' (Maybe (NonEmpty AccessEndpoint)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ResourceError]) (Maybe Text) (Maybe NetworkAccessConfiguration) (Maybe PlatformType) (Maybe ImageBuilderState) (Maybe ImageBuilderStateChangeReason) (Maybe VpcConfig) Text
- newImageBuilder :: Text -> ImageBuilder
- data ImageBuilderStateChangeReason = ImageBuilderStateChangeReason' (Maybe ImageBuilderStateChangeReasonCode) (Maybe Text)
- newImageBuilderStateChangeReason :: ImageBuilderStateChangeReason
- data ImagePermissions = ImagePermissions' (Maybe Bool) (Maybe Bool)
- newImagePermissions :: ImagePermissions
- data ImageStateChangeReason = ImageStateChangeReason' (Maybe ImageStateChangeReasonCode) (Maybe Text)
- newImageStateChangeReason :: ImageStateChangeReason
- data LastReportGenerationExecutionError = LastReportGenerationExecutionError' (Maybe UsageReportExecutionErrorCode) (Maybe Text)
- newLastReportGenerationExecutionError :: LastReportGenerationExecutionError
- data NetworkAccessConfiguration = NetworkAccessConfiguration' (Maybe Text) (Maybe Text)
- newNetworkAccessConfiguration :: NetworkAccessConfiguration
- data ResourceError = ResourceError' (Maybe FleetErrorCode) (Maybe Text) (Maybe POSIX)
- newResourceError :: ResourceError
- data S3Location = S3Location' Text Text
- newS3Location :: Text -> Text -> S3Location
- data ScriptDetails = ScriptDetails' (Maybe Text) S3Location Text Int
- newScriptDetails :: S3Location -> Text -> Int -> ScriptDetails
- data ServiceAccountCredentials = ServiceAccountCredentials' (Sensitive Text) (Sensitive Text)
- newServiceAccountCredentials :: Text -> Text -> ServiceAccountCredentials
- data Session = Session' (Maybe AuthenticationType) (Maybe SessionConnectionState) (Maybe POSIX) (Maybe NetworkAccessConfiguration) (Maybe POSIX) Text Text Text Text SessionState
- newSession :: Text -> Text -> Text -> Text -> SessionState -> Session
- data SharedImagePermissions = SharedImagePermissions' Text ImagePermissions
- newSharedImagePermissions :: Text -> ImagePermissions -> SharedImagePermissions
- data Stack = Stack' (Maybe (NonEmpty AccessEndpoint)) (Maybe ApplicationSettingsResponse) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [StackError]) (Maybe [StorageConnector]) (Maybe StreamingExperienceSettings) (Maybe (NonEmpty UserSetting)) Text
- newStack :: Text -> Stack
- data StackError = StackError' (Maybe StackErrorCode) (Maybe Text)
- newStackError :: StackError
- data StorageConnector = StorageConnector' (Maybe [Text]) (Maybe Text) StorageConnectorType
- newStorageConnector :: StorageConnectorType -> StorageConnector
- data StreamingExperienceSettings = StreamingExperienceSettings' (Maybe PreferredProtocol)
- newStreamingExperienceSettings :: StreamingExperienceSettings
- data UsageReportSubscription = UsageReportSubscription' (Maybe POSIX) (Maybe Text) (Maybe UsageReportSchedule) (Maybe [LastReportGenerationExecutionError])
- newUsageReportSubscription :: UsageReportSubscription
- data User = User' (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) AuthenticationType
- newUser :: AuthenticationType -> User
- data UserSetting = UserSetting' Action Permission
- newUserSetting :: Action -> Permission -> UserSetting
- data UserStackAssociation = UserStackAssociation' (Maybe Bool) Text (Sensitive Text) AuthenticationType
- newUserStackAssociation :: Text -> Text -> AuthenticationType -> UserStackAssociation
- data UserStackAssociationError = UserStackAssociationError' (Maybe UserStackAssociationErrorCode) (Maybe Text) (Maybe UserStackAssociation)
- newUserStackAssociationError :: UserStackAssociationError
- data VpcConfig = VpcConfig' (Maybe [Text]) (Maybe [Text])
- newVpcConfig :: VpcConfig
Service Configuration
defaultService :: Service Source #
API version 2016-12-01 of the Amazon AppStream SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AppStream.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
An API error occurred. Wait a few minutes and try again.
EntitlementAlreadyExistsException
_EntitlementAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The entitlement already exists.
EntitlementNotFoundException
_EntitlementNotFoundException :: AsError a => Fold a ServiceError Source #
The entitlement can't be found.
IncompatibleImageException
_IncompatibleImageException :: AsError a => Fold a ServiceError Source #
The image can't be updated because it's not compatible for updates.
InvalidAccountStatusException
_InvalidAccountStatusException :: AsError a => Fold a ServiceError Source #
The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError Source #
Indicates an incorrect combination of parameters, or a missing parameter.
InvalidRoleException
_InvalidRoleException :: AsError a => Fold a ServiceError Source #
The specified role is invalid.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The requested limit exceeds the permitted limit for an account.
OperationNotPermittedException
_OperationNotPermittedException :: AsError a => Fold a ServiceError Source #
The attempted operation is not permitted.
RequestLimitExceededException
_RequestLimitExceededException :: AsError a => Fold a ServiceError Source #
AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified resource already exists.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The specified resource is in use.
ResourceNotAvailableException
_ResourceNotAvailableException :: AsError a => Fold a ServiceError Source #
The specified resource exists and is not in use, but isn't available.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource was not found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
FleetStarted
newFleetStarted :: Wait DescribeFleets Source #
Polls DescribeFleets every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
FleetStopped
newFleetStopped :: Wait DescribeFleets Source #
Polls DescribeFleets every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateApplicationFleet
data AssociateApplicationFleet Source #
See: newAssociateApplicationFleet smart constructor.
Constructors
| AssociateApplicationFleet' Text Text |
Instances
newAssociateApplicationFleet Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssociateApplicationFleet |
Create a value of AssociateApplicationFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateApplicationFleet, associateApplicationFleet_fleetName - The name of the fleet.
AssociateApplicationFleet, associateApplicationFleet_applicationArn - The ARN of the application.
data AssociateApplicationFleetResponse Source #
See: newAssociateApplicationFleetResponse smart constructor.
Instances
newAssociateApplicationFleetResponse Source #
Arguments
| :: Int | |
| -> AssociateApplicationFleetResponse |
Create a value of AssociateApplicationFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationFleetAssociation:AssociateApplicationFleetResponse', associateApplicationFleetResponse_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.
$sel:httpStatus:AssociateApplicationFleetResponse', associateApplicationFleetResponse_httpStatus - The response's http status code.
AssociateApplicationToEntitlement
data AssociateApplicationToEntitlement Source #
See: newAssociateApplicationToEntitlement smart constructor.
Constructors
| AssociateApplicationToEntitlement' Text Text Text |
Instances
newAssociateApplicationToEntitlement Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssociateApplicationToEntitlement |
Create a value of AssociateApplicationToEntitlement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateApplicationToEntitlement, associateApplicationToEntitlement_stackName - The name of the stack.
$sel:entitlementName:AssociateApplicationToEntitlement', associateApplicationToEntitlement_entitlementName - The name of the entitlement.
AssociateApplicationToEntitlement, associateApplicationToEntitlement_applicationIdentifier - The identifier of the application.
data AssociateApplicationToEntitlementResponse Source #
See: newAssociateApplicationToEntitlementResponse smart constructor.
Constructors
| AssociateApplicationToEntitlementResponse' Int |
Instances
newAssociateApplicationToEntitlementResponse Source #
Arguments
| :: Int | |
| -> AssociateApplicationToEntitlementResponse |
Create a value of AssociateApplicationToEntitlementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateApplicationToEntitlementResponse', associateApplicationToEntitlementResponse_httpStatus - The response's http status code.
AssociateFleet
data AssociateFleet Source #
See: newAssociateFleet smart constructor.
Constructors
| AssociateFleet' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AssociateFleet |
Create a value of AssociateFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateFleet, associateFleet_fleetName - The name of the fleet.
AssociateFleet, associateFleet_stackName - The name of the stack.
data AssociateFleetResponse Source #
See: newAssociateFleetResponse smart constructor.
Constructors
| AssociateFleetResponse' Int |
Instances
newAssociateFleetResponse Source #
Create a value of AssociateFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateFleetResponse', associateFleetResponse_httpStatus - The response's http status code.
BatchAssociateUserStack
data BatchAssociateUserStack Source #
See: newBatchAssociateUserStack smart constructor.
Constructors
| BatchAssociateUserStack' (NonEmpty UserStackAssociation) |
Instances
newBatchAssociateUserStack Source #
Arguments
| :: NonEmpty UserStackAssociation | |
| -> BatchAssociateUserStack |
Create a value of BatchAssociateUserStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userStackAssociations:BatchAssociateUserStack', batchAssociateUserStack_userStackAssociations - The list of UserStackAssociation objects.
data BatchAssociateUserStackResponse Source #
See: newBatchAssociateUserStackResponse smart constructor.
Constructors
| BatchAssociateUserStackResponse' (Maybe [UserStackAssociationError]) Int |
Instances
newBatchAssociateUserStackResponse Source #
Create a value of BatchAssociateUserStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchAssociateUserStackResponse', batchAssociateUserStackResponse_errors - The list of UserStackAssociationError objects.
$sel:httpStatus:BatchAssociateUserStackResponse', batchAssociateUserStackResponse_httpStatus - The response's http status code.
BatchDisassociateUserStack
data BatchDisassociateUserStack Source #
See: newBatchDisassociateUserStack smart constructor.
Constructors
| BatchDisassociateUserStack' (NonEmpty UserStackAssociation) |
Instances
newBatchDisassociateUserStack Source #
Arguments
| :: NonEmpty UserStackAssociation | |
| -> BatchDisassociateUserStack |
Create a value of BatchDisassociateUserStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userStackAssociations:BatchDisassociateUserStack', batchDisassociateUserStack_userStackAssociations - The list of UserStackAssociation objects.
data BatchDisassociateUserStackResponse Source #
See: newBatchDisassociateUserStackResponse smart constructor.
Constructors
| BatchDisassociateUserStackResponse' (Maybe [UserStackAssociationError]) Int |
Instances
newBatchDisassociateUserStackResponse Source #
Arguments
| :: Int | |
| -> BatchDisassociateUserStackResponse |
Create a value of BatchDisassociateUserStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchDisassociateUserStackResponse', batchDisassociateUserStackResponse_errors - The list of UserStackAssociationError objects.
$sel:httpStatus:BatchDisassociateUserStackResponse', batchDisassociateUserStackResponse_httpStatus - The response's http status code.
CopyImage
See: newCopyImage smart constructor.
Instances
Create a value of CopyImage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationImageDescription:CopyImage', copyImage_destinationImageDescription - The description that the image will have when it is copied to the
destination.
$sel:sourceImageName:CopyImage', copyImage_sourceImageName - The name of the image to copy.
CopyImage, copyImage_destinationImageName - The name that the image will have when it is copied to the destination.
$sel:destinationRegion:CopyImage', copyImage_destinationRegion - 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.
data CopyImageResponse Source #
See: newCopyImageResponse smart constructor.
Constructors
| CopyImageResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> CopyImageResponse |
Create a value of CopyImageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CopyImage, copyImageResponse_destinationImageName - The name of the destination image.
$sel:httpStatus:CopyImageResponse', copyImageResponse_httpStatus - The response's http status code.
CreateAppBlock
data CreateAppBlock Source #
See: newCreateAppBlock smart constructor.
Constructors
| CreateAppBlock' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text S3Location ScriptDetails |
Instances
Arguments
| :: Text | |
| -> S3Location | |
| -> ScriptDetails | |
| -> CreateAppBlock |
Create a value of CreateAppBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAppBlock, createAppBlock_description - The description of the app block.
CreateAppBlock, createAppBlock_displayName - The display name of the app block. This is not displayed to the user.
$sel:tags:CreateAppBlock', createAppBlock_tags - The tags assigned to the app block.
CreateAppBlock, createAppBlock_name - The name of the app block.
CreateAppBlock, createAppBlock_sourceS3Location - The source S3 location of the app block.
CreateAppBlock, createAppBlock_setupScriptDetails - The setup script details of the app block.
data CreateAppBlockResponse Source #
See: newCreateAppBlockResponse smart constructor.
Constructors
| CreateAppBlockResponse' (Maybe AppBlock) Int |
Instances
newCreateAppBlockResponse Source #
Create a value of CreateAppBlockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appBlock:CreateAppBlockResponse', createAppBlockResponse_appBlock - The app block.
$sel:httpStatus:CreateAppBlockResponse', createAppBlockResponse_httpStatus - The response's http status code.
CreateApplication
data CreateApplication Source #
See: newCreateApplication smart constructor.
Constructors
| CreateApplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text S3Location Text [PlatformType] [Text] Text |
Instances
Arguments
| :: Text | |
| -> S3Location | |
| -> Text | |
| -> Text | |
| -> CreateApplication |
Create a value of CreateApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateApplication, createApplication_description - The description of the application.
CreateApplication, createApplication_displayName - The display name of the application. This name is visible to users in
the application catalog.
CreateApplication, createApplication_launchParameters - The launch parameters of the application.
$sel:tags:CreateApplication', createApplication_tags - The tags assigned to the application.
CreateApplication, createApplication_workingDirectory - The working directory of the application.
CreateApplication, createApplication_name - The name of the application. This name is visible to users when display
name is not specified.
CreateApplication, createApplication_iconS3Location - The location in S3 of the application icon.
CreateApplication, createApplication_launchPath - The launch path of the application.
CreateApplication, createApplication_platforms - The platforms the application supports. WINDOWS_SERVER_2019 and
AMAZON_LINUX2 are supported for Elastic fleets.
CreateApplication, createApplication_instanceFamilies - The instance families the application supports. Valid values are
GENERAL_PURPOSE and GRAPHICS_G4.
CreateApplication, createApplication_appBlockArn - The app block ARN to which the application should be associated
data CreateApplicationResponse Source #
See: newCreateApplicationResponse smart constructor.
Constructors
| CreateApplicationResponse' (Maybe Application) Int |
Instances
newCreateApplicationResponse Source #
Create a value of CreateApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:application:CreateApplicationResponse', createApplicationResponse_application - Undocumented member.
$sel:httpStatus:CreateApplicationResponse', createApplicationResponse_httpStatus - The response's http status code.
CreateDirectoryConfig
data CreateDirectoryConfig Source #
See: newCreateDirectoryConfig smart constructor.
Constructors
| CreateDirectoryConfig' (Maybe CertificateBasedAuthProperties) (Maybe ServiceAccountCredentials) Text [Text] |
Instances
newCreateDirectoryConfig Source #
Arguments
| :: Text | |
| -> CreateDirectoryConfig |
Create a value of CreateDirectoryConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDirectoryConfig, createDirectoryConfig_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, createDirectoryConfig_serviceAccountCredentials - The credentials for the service account used by the fleet or image
builder to connect to the directory.
CreateDirectoryConfig, createDirectoryConfig_directoryName - The fully qualified name of the directory (for example,
corp.example.com).
CreateDirectoryConfig, createDirectoryConfig_organizationalUnitDistinguishedNames - The distinguished names of the organizational units for computer
accounts.
data CreateDirectoryConfigResponse Source #
See: newCreateDirectoryConfigResponse smart constructor.
Constructors
| CreateDirectoryConfigResponse' (Maybe DirectoryConfig) Int |
Instances
newCreateDirectoryConfigResponse Source #
Create a value of CreateDirectoryConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryConfig:CreateDirectoryConfigResponse', createDirectoryConfigResponse_directoryConfig - Information about the directory configuration.
$sel:httpStatus:CreateDirectoryConfigResponse', createDirectoryConfigResponse_httpStatus - The response's http status code.
CreateEntitlement
data CreateEntitlement Source #
See: newCreateEntitlement smart constructor.
Constructors
| CreateEntitlement' (Maybe Text) Text Text AppVisibility (NonEmpty EntitlementAttribute) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AppVisibility | |
| -> NonEmpty EntitlementAttribute | |
| -> CreateEntitlement |
Create a value of CreateEntitlement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEntitlement, createEntitlement_description - The description of the entitlement.
CreateEntitlement, createEntitlement_name - The name of the entitlement.
CreateEntitlement, createEntitlement_stackName - The name of the stack with which the entitlement is associated.
CreateEntitlement, createEntitlement_appVisibility - Specifies whether all or selected apps are entitled.
CreateEntitlement, createEntitlement_attributes - The attributes of the entitlement.
data CreateEntitlementResponse Source #
See: newCreateEntitlementResponse smart constructor.
Constructors
| CreateEntitlementResponse' (Maybe Entitlement) Int |
Instances
newCreateEntitlementResponse Source #
Create a value of CreateEntitlementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitlement:CreateEntitlementResponse', createEntitlementResponse_entitlement - The entitlement.
$sel:httpStatus:CreateEntitlementResponse', createEntitlementResponse_httpStatus - The response's http status code.
CreateFleet
data CreateFleet Source #
See: newCreateFleet smart constructor.
Constructors
| CreateFleet' (Maybe ComputeCapacity) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe FleetType) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe PlatformType) (Maybe S3Location) (Maybe StreamView) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe VpcConfig) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateFleet |
Create a value of CreateFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeCapacity:CreateFleet', createFleet_computeCapacity - The desired capacity for the fleet. This is not allowed for Elastic
fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
CreateFleet, createFleet_description - The description to display.
CreateFleet, createFleet_disconnectTimeoutInSeconds - 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, createFleet_displayName - The fleet name to display.
CreateFleet, createFleet_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, createFleet_enableDefaultInternetAccess - Enables or disables default internet access for the fleet.
CreateFleet, createFleet_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, createFleet_iamRoleArn - 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, createFleet_idleDisconnectTimeoutInSeconds - 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, createFleet_imageArn - The ARN of the public, private, or shared image to use.
CreateFleet, createFleet_imageName - The name of the image used to create the fleet.
CreateFleet, createFleet_maxConcurrentSessions - The maximum concurrent sessions of the Elastic fleet. This is required
for Elastic fleets, and not allowed for other fleet types.
CreateFleet, createFleet_maxUserDurationInSeconds - 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, createFleet_platform - The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported
for Elastic fleets.
CreateFleet, createFleet_sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This only
applies to Elastic fleets.
CreateFleet, createFleet_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.
$sel:tags:CreateFleet', createFleet_tags - 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, createFleet_usbDeviceFilterStrings - 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, createFleet_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, createFleet_name - A unique name for the fleet.
CreateFleet, createFleet_instanceType - 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
data CreateFleetResponse Source #
See: newCreateFleetResponse smart constructor.
Constructors
| CreateFleetResponse' (Maybe Fleet) Int |
Instances
newCreateFleetResponse Source #
Arguments
| :: Int | |
| -> CreateFleetResponse |
Create a value of CreateFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fleet:CreateFleetResponse', createFleetResponse_fleet - Information about the fleet.
$sel:httpStatus:CreateFleetResponse', createFleetResponse_httpStatus - The response's http status code.
CreateImageBuilder
data CreateImageBuilder Source #
See: newCreateImageBuilder smart constructor.
Constructors
| CreateImageBuilder' (Maybe (NonEmpty AccessEndpoint)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe VpcConfig) Text Text |
Instances
newCreateImageBuilder Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateImageBuilder |
Create a value of CreateImageBuilder with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateImageBuilder, createImageBuilder_accessEndpoints - The list of interface VPC endpoint (interface endpoint) objects.
Administrators can connect to the image builder only through the
specified endpoints.
CreateImageBuilder, createImageBuilder_appstreamAgentVersion - 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, createImageBuilder_description - The description to display.
CreateImageBuilder, createImageBuilder_displayName - The image builder name to display.
CreateImageBuilder, createImageBuilder_domainJoinInfo - The name of the directory and organizational unit (OU) to use to join
the image builder to a Microsoft Active Directory domain.
CreateImageBuilder, createImageBuilder_enableDefaultInternetAccess - Enables or disables default internet access for the image builder.
CreateImageBuilder, createImageBuilder_iamRoleArn - 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, createImageBuilder_imageArn - The ARN of the public, private, or shared image to use.
CreateImageBuilder, createImageBuilder_imageName - The name of the image used to create the image builder.
$sel:tags:CreateImageBuilder', createImageBuilder_tags - 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, createImageBuilder_vpcConfig - The VPC configuration for the image builder. You can specify only one
subnet.
CreateImageBuilder, createImageBuilder_name - A unique name for the image builder.
CreateImageBuilder, createImageBuilder_instanceType - 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
data CreateImageBuilderResponse Source #
See: newCreateImageBuilderResponse smart constructor.
Constructors
| CreateImageBuilderResponse' (Maybe ImageBuilder) Int |
Instances
newCreateImageBuilderResponse Source #
Create a value of CreateImageBuilderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageBuilder:CreateImageBuilderResponse', createImageBuilderResponse_imageBuilder - Information about the image builder.
$sel:httpStatus:CreateImageBuilderResponse', createImageBuilderResponse_httpStatus - The response's http status code.
CreateImageBuilderStreamingURL
data CreateImageBuilderStreamingURL Source #
See: newCreateImageBuilderStreamingURL smart constructor.
Constructors
| CreateImageBuilderStreamingURL' (Maybe Integer) Text |
Instances
newCreateImageBuilderStreamingURL Source #
Create a value of CreateImageBuilderStreamingURL with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:validity:CreateImageBuilderStreamingURL', createImageBuilderStreamingURL_validity - 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, createImageBuilderStreamingURL_name - The name of the image builder.
data CreateImageBuilderStreamingURLResponse Source #
See: newCreateImageBuilderStreamingURLResponse smart constructor.
Instances
newCreateImageBuilderStreamingURLResponse Source #
Arguments
| :: Int | |
| -> CreateImageBuilderStreamingURLResponse |
Create a value of CreateImageBuilderStreamingURLResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expires:CreateImageBuilderStreamingURLResponse', createImageBuilderStreamingURLResponse_expires - The elapsed time, in seconds after the Unix epoch, when this URL
expires.
$sel:streamingURL:CreateImageBuilderStreamingURLResponse', createImageBuilderStreamingURLResponse_streamingURL - The URL to start the AppStream 2.0 streaming session.
$sel:httpStatus:CreateImageBuilderStreamingURLResponse', createImageBuilderStreamingURLResponse_httpStatus - The response's http status code.
CreateStack
data CreateStack Source #
See: newCreateStack smart constructor.
Constructors
| CreateStack' (Maybe (NonEmpty AccessEndpoint)) (Maybe ApplicationSettings) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [StorageConnector]) (Maybe StreamingExperienceSettings) (Maybe (HashMap Text Text)) (Maybe (NonEmpty UserSetting)) Text |
Instances
Arguments
| :: Text | |
| -> CreateStack |
Create a value of CreateStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStack, createStack_accessEndpoints - 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, createStack_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, createStack_description - The description to display.
CreateStack, createStack_displayName - The stack name to display.
CreateStack, createStack_embedHostDomains - 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, createStack_feedbackURL - 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, createStack_redirectURL - The URL that users are redirected to after their streaming session ends.
CreateStack, createStack_storageConnectors - The storage connectors to enable.
CreateStack, createStack_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.
$sel:tags:CreateStack', createStack_tags - 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, createStack_userSettings - The actions that are enabled or disabled for users during their
streaming sessions. By default, these actions are enabled.
CreateStack, createStack_name - The name of the stack.
data CreateStackResponse Source #
See: newCreateStackResponse smart constructor.
Constructors
| CreateStackResponse' (Maybe Stack) Int |
Instances
newCreateStackResponse Source #
Arguments
| :: Int | |
| -> CreateStackResponse |
Create a value of CreateStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stack:CreateStackResponse', createStackResponse_stack - Information about the stack.
$sel:httpStatus:CreateStackResponse', createStackResponse_httpStatus - The response's http status code.
CreateStreamingURL
data CreateStreamingURL Source #
See: newCreateStreamingURL smart constructor.
Instances
newCreateStreamingURL Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateStreamingURL |
Create a value of CreateStreamingURL with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:CreateStreamingURL', createStreamingURL_applicationId - 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.
$sel:sessionContext:CreateStreamingURL', createStreamingURL_sessionContext - The session context. For more information, see
Session Context
in the Amazon AppStream 2.0 Administration Guide.
$sel:validity:CreateStreamingURL', createStreamingURL_validity - 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, createStreamingURL_stackName - The name of the stack.
CreateStreamingURL, createStreamingURL_fleetName - The name of the fleet.
CreateStreamingURL, createStreamingURL_userId - The identifier of the user.
data CreateStreamingURLResponse Source #
See: newCreateStreamingURLResponse smart constructor.
Instances
newCreateStreamingURLResponse Source #
Create a value of CreateStreamingURLResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expires:CreateStreamingURLResponse', createStreamingURLResponse_expires - The elapsed time, in seconds after the Unix epoch, when this URL
expires.
$sel:streamingURL:CreateStreamingURLResponse', createStreamingURLResponse_streamingURL - The URL to start the AppStream 2.0 streaming session.
$sel:httpStatus:CreateStreamingURLResponse', createStreamingURLResponse_httpStatus - The response's http status code.
CreateUpdatedImage
data CreateUpdatedImage Source #
See: newCreateUpdatedImage smart constructor.
Constructors
| CreateUpdatedImage' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text |
Instances
newCreateUpdatedImage Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateUpdatedImage |
Create a value of CreateUpdatedImage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:CreateUpdatedImage', createUpdatedImage_dryRun - 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.
$sel:newImageDescription':CreateUpdatedImage', createUpdatedImage_newImageDescription - The description to display for the new image.
$sel:newImageDisplayName':CreateUpdatedImage', createUpdatedImage_newImageDisplayName - The name to display for the new image.
$sel:newImageTags':CreateUpdatedImage', createUpdatedImage_newImageTags - 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.
$sel:existingImageName:CreateUpdatedImage', createUpdatedImage_existingImageName - The name of the image to update.
$sel:newImageName':CreateUpdatedImage', createUpdatedImage_newImageName - The name of the new image. The name must be unique within the AWS
account and Region.
data CreateUpdatedImageResponse Source #
See: newCreateUpdatedImageResponse smart constructor.
Instances
newCreateUpdatedImageResponse Source #
Create a value of CreateUpdatedImageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:canUpdateImage:CreateUpdatedImageResponse', createUpdatedImageResponse_canUpdateImage - Indicates whether a new image can be created.
$sel:image:CreateUpdatedImageResponse', createUpdatedImageResponse_image - Undocumented member.
$sel:httpStatus:CreateUpdatedImageResponse', createUpdatedImageResponse_httpStatus - The response's http status code.
CreateUsageReportSubscription
data CreateUsageReportSubscription Source #
See: newCreateUsageReportSubscription smart constructor.
Constructors
| CreateUsageReportSubscription' | |
Instances
newCreateUsageReportSubscription :: CreateUsageReportSubscription Source #
Create a value of CreateUsageReportSubscription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data CreateUsageReportSubscriptionResponse Source #
See: newCreateUsageReportSubscriptionResponse smart constructor.
Constructors
| CreateUsageReportSubscriptionResponse' (Maybe Text) (Maybe UsageReportSchedule) Int |
Instances
newCreateUsageReportSubscriptionResponse Source #
Arguments
| :: Int | |
| -> CreateUsageReportSubscriptionResponse |
Create a value of CreateUsageReportSubscriptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUsageReportSubscriptionResponse, createUsageReportSubscriptionResponse_s3BucketName - 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, createUsageReportSubscriptionResponse_schedule - The schedule for generating usage reports.
$sel:httpStatus:CreateUsageReportSubscriptionResponse', createUsageReportSubscriptionResponse_httpStatus - The response's http status code.
CreateUser
data CreateUser Source #
See: newCreateUser smart constructor.
Constructors
| CreateUser' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe MessageAction) (Sensitive Text) AuthenticationType |
Instances
Arguments
| :: Text | |
| -> AuthenticationType | |
| -> CreateUser |
Create a value of CreateUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUser, createUser_firstName - The first name, or given name, of the user.
CreateUser, createUser_lastName - The last name, or surname, of the user.
$sel:messageAction:CreateUser', createUser_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, createUser_userName - The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
CreateUser, createUser_authenticationType - The authentication type for the user. You must specify USERPOOL.
data CreateUserResponse Source #
See: newCreateUserResponse smart constructor.
Constructors
| CreateUserResponse' Int |
Instances
newCreateUserResponse Source #
Arguments
| :: Int | |
| -> CreateUserResponse |
Create a value of CreateUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.
DeleteAppBlock
data DeleteAppBlock Source #
See: newDeleteAppBlock smart constructor.
Constructors
| DeleteAppBlock' Text |
Instances
Arguments
| :: Text | |
| -> DeleteAppBlock |
Create a value of DeleteAppBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAppBlock, deleteAppBlock_name - The name of the app block.
data DeleteAppBlockResponse Source #
See: newDeleteAppBlockResponse smart constructor.
Constructors
| DeleteAppBlockResponse' Int |
Instances
newDeleteAppBlockResponse Source #
Create a value of DeleteAppBlockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAppBlockResponse', deleteAppBlockResponse_httpStatus - The response's http status code.
DeleteApplication
data DeleteApplication Source #
See: newDeleteApplication smart constructor.
Constructors
| DeleteApplication' Text |
Instances
Arguments
| :: Text | |
| -> DeleteApplication |
Create a value of DeleteApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteApplication, deleteApplication_name - The name of the application.
data DeleteApplicationResponse Source #
See: newDeleteApplicationResponse smart constructor.
Constructors
| DeleteApplicationResponse' Int |
Instances
newDeleteApplicationResponse Source #
Create a value of DeleteApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApplicationResponse', deleteApplicationResponse_httpStatus - The response's http status code.
DeleteDirectoryConfig
data DeleteDirectoryConfig Source #
See: newDeleteDirectoryConfig smart constructor.
Constructors
| DeleteDirectoryConfig' Text |
Instances
newDeleteDirectoryConfig Source #
Arguments
| :: Text | |
| -> DeleteDirectoryConfig |
Create a value of DeleteDirectoryConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDirectoryConfig, deleteDirectoryConfig_directoryName - The name of the directory configuration.
data DeleteDirectoryConfigResponse Source #
See: newDeleteDirectoryConfigResponse smart constructor.
Constructors
| DeleteDirectoryConfigResponse' Int |
Instances
newDeleteDirectoryConfigResponse Source #
Create a value of DeleteDirectoryConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDirectoryConfigResponse', deleteDirectoryConfigResponse_httpStatus - The response's http status code.
DeleteEntitlement
data DeleteEntitlement Source #
See: newDeleteEntitlement smart constructor.
Constructors
| DeleteEntitlement' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteEntitlement |
Create a value of DeleteEntitlement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEntitlement, deleteEntitlement_name - The name of the entitlement.
DeleteEntitlement, deleteEntitlement_stackName - The name of the stack with which the entitlement is associated.
data DeleteEntitlementResponse Source #
See: newDeleteEntitlementResponse smart constructor.
Constructors
| DeleteEntitlementResponse' Int |
Instances
newDeleteEntitlementResponse Source #
Create a value of DeleteEntitlementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEntitlementResponse', deleteEntitlementResponse_httpStatus - The response's http status code.
DeleteFleet
data DeleteFleet Source #
See: newDeleteFleet smart constructor.
Constructors
| DeleteFleet' Text |
Instances
Arguments
| :: Text | |
| -> DeleteFleet |
Create a value of DeleteFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteFleet, deleteFleet_name - The name of the fleet.
data DeleteFleetResponse Source #
See: newDeleteFleetResponse smart constructor.
Constructors
| DeleteFleetResponse' Int |
Instances
newDeleteFleetResponse Source #
Arguments
| :: Int | |
| -> DeleteFleetResponse |
Create a value of DeleteFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteFleetResponse', deleteFleetResponse_httpStatus - The response's http status code.
DeleteImage
data DeleteImage Source #
See: newDeleteImage smart constructor.
Constructors
| DeleteImage' Text |
Instances
Arguments
| :: Text | |
| -> DeleteImage |
Create a value of DeleteImage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteImage, deleteImage_name - The name of the image.
data DeleteImageResponse Source #
See: newDeleteImageResponse smart constructor.
Constructors
| DeleteImageResponse' (Maybe Image) Int |
Instances
newDeleteImageResponse Source #
Arguments
| :: Int | |
| -> DeleteImageResponse |
Create a value of DeleteImageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:image:DeleteImageResponse', deleteImageResponse_image - Information about the image.
$sel:httpStatus:DeleteImageResponse', deleteImageResponse_httpStatus - The response's http status code.
DeleteImageBuilder
data DeleteImageBuilder Source #
See: newDeleteImageBuilder smart constructor.
Constructors
| DeleteImageBuilder' Text |
Instances
newDeleteImageBuilder Source #
Arguments
| :: Text | |
| -> DeleteImageBuilder |
Create a value of DeleteImageBuilder with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteImageBuilder, deleteImageBuilder_name - The name of the image builder.
data DeleteImageBuilderResponse Source #
See: newDeleteImageBuilderResponse smart constructor.
Constructors
| DeleteImageBuilderResponse' (Maybe ImageBuilder) Int |
Instances
newDeleteImageBuilderResponse Source #
Create a value of DeleteImageBuilderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageBuilder:DeleteImageBuilderResponse', deleteImageBuilderResponse_imageBuilder - Information about the image builder.
$sel:httpStatus:DeleteImageBuilderResponse', deleteImageBuilderResponse_httpStatus - The response's http status code.
DeleteImagePermissions
data DeleteImagePermissions Source #
See: newDeleteImagePermissions smart constructor.
Constructors
| DeleteImagePermissions' Text Text |
Instances
newDeleteImagePermissions Source #
Create a value of DeleteImagePermissions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteImagePermissions, deleteImagePermissions_name - The name of the private image.
DeleteImagePermissions, deleteImagePermissions_sharedAccountId - The 12-digit identifier of the AWS account for which to delete image
permissions.
data DeleteImagePermissionsResponse Source #
See: newDeleteImagePermissionsResponse smart constructor.
Constructors
| DeleteImagePermissionsResponse' Int |
Instances
newDeleteImagePermissionsResponse Source #
Create a value of DeleteImagePermissionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteImagePermissionsResponse', deleteImagePermissionsResponse_httpStatus - The response's http status code.
DeleteStack
data DeleteStack Source #
See: newDeleteStack smart constructor.
Constructors
| DeleteStack' Text |
Instances
Arguments
| :: Text | |
| -> DeleteStack |
Create a value of DeleteStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStack, deleteStack_name - The name of the stack.
data DeleteStackResponse Source #
See: newDeleteStackResponse smart constructor.
Constructors
| DeleteStackResponse' Int |
Instances
newDeleteStackResponse Source #
Arguments
| :: Int | |
| -> DeleteStackResponse |
Create a value of DeleteStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteStackResponse', deleteStackResponse_httpStatus - The response's http status code.
DeleteUsageReportSubscription
data DeleteUsageReportSubscription Source #
See: newDeleteUsageReportSubscription smart constructor.
Constructors
| DeleteUsageReportSubscription' | |
Instances
newDeleteUsageReportSubscription :: DeleteUsageReportSubscription Source #
Create a value of DeleteUsageReportSubscription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DeleteUsageReportSubscriptionResponse Source #
See: newDeleteUsageReportSubscriptionResponse smart constructor.
Constructors
| DeleteUsageReportSubscriptionResponse' Int |
Instances
newDeleteUsageReportSubscriptionResponse Source #
Arguments
| :: Int | |
| -> DeleteUsageReportSubscriptionResponse |
Create a value of DeleteUsageReportSubscriptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteUsageReportSubscriptionResponse', deleteUsageReportSubscriptionResponse_httpStatus - The response's http status code.
DeleteUser
data DeleteUser Source #
See: newDeleteUser smart constructor.
Constructors
| DeleteUser' (Sensitive Text) AuthenticationType |
Instances
Arguments
| :: Text | |
| -> AuthenticationType | |
| -> DeleteUser |
Create a value of DeleteUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteUser, deleteUser_userName - The email address of the user.
Users' email addresses are case-sensitive.
DeleteUser, deleteUser_authenticationType - The authentication type for the user. You must specify USERPOOL.
data DeleteUserResponse Source #
See: newDeleteUserResponse smart constructor.
Constructors
| DeleteUserResponse' Int |
Instances
newDeleteUserResponse Source #
Arguments
| :: Int | |
| -> DeleteUserResponse |
Create a value of DeleteUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteUserResponse', deleteUserResponse_httpStatus - The response's http status code.
DescribeAppBlocks
data DescribeAppBlocks Source #
See: newDescribeAppBlocks smart constructor.
Instances
newDescribeAppBlocks :: DescribeAppBlocks Source #
Create a value of DescribeAppBlocks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arns:DescribeAppBlocks', describeAppBlocks_arns - The ARNs of the app blocks.
$sel:maxResults:DescribeAppBlocks', describeAppBlocks_maxResults - The maximum size of each page of results.
DescribeAppBlocks, describeAppBlocks_nextToken - The pagination token used to retrieve the next page of results for this
operation.
data DescribeAppBlocksResponse Source #
See: newDescribeAppBlocksResponse smart constructor.
Instances
newDescribeAppBlocksResponse Source #
Create a value of DescribeAppBlocksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appBlocks:DescribeAppBlocksResponse', describeAppBlocksResponse_appBlocks - The app blocks in the list.
DescribeAppBlocks, describeAppBlocksResponse_nextToken - The pagination token used to retrieve the next page of results for this
operation.
$sel:httpStatus:DescribeAppBlocksResponse', describeAppBlocksResponse_httpStatus - The response's http status code.
DescribeApplicationFleetAssociations
data DescribeApplicationFleetAssociations Source #
See: newDescribeApplicationFleetAssociations smart constructor.
Constructors
| DescribeApplicationFleetAssociations' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newDescribeApplicationFleetAssociations :: DescribeApplicationFleetAssociations Source #
Create a value of DescribeApplicationFleetAssociations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeApplicationFleetAssociations, describeApplicationFleetAssociations_applicationArn - The ARN of the application.
DescribeApplicationFleetAssociations, describeApplicationFleetAssociations_fleetName - The name of the fleet.
$sel:maxResults:DescribeApplicationFleetAssociations', describeApplicationFleetAssociations_maxResults - The maximum size of each page of results.
DescribeApplicationFleetAssociations, describeApplicationFleetAssociations_nextToken - The pagination token used to retrieve the next page of results for this
operation.
data DescribeApplicationFleetAssociationsResponse Source #
See: newDescribeApplicationFleetAssociationsResponse smart constructor.
Constructors
| DescribeApplicationFleetAssociationsResponse' (Maybe (NonEmpty ApplicationFleetAssociation)) (Maybe Text) Int |
Instances
newDescribeApplicationFleetAssociationsResponse Source #
Arguments
| :: Int |
|
| -> DescribeApplicationFleetAssociationsResponse |
Create a value of DescribeApplicationFleetAssociationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationFleetAssociations:DescribeApplicationFleetAssociationsResponse', describeApplicationFleetAssociationsResponse_applicationFleetAssociations - The application fleet associations in the list.
DescribeApplicationFleetAssociations, describeApplicationFleetAssociationsResponse_nextToken - The pagination token used to retrieve the next page of results for this
operation.
$sel:httpStatus:DescribeApplicationFleetAssociationsResponse', describeApplicationFleetAssociationsResponse_httpStatus - The response's http status code.
DescribeApplications
data DescribeApplications Source #
See: newDescribeApplications smart constructor.
Instances
newDescribeApplications :: DescribeApplications Source #
Create a value of DescribeApplications with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arns:DescribeApplications', describeApplications_arns - The ARNs for the applications.
$sel:maxResults:DescribeApplications', describeApplications_maxResults - The maximum size of each page of results.
DescribeApplications, describeApplications_nextToken - The pagination token used to retrieve the next page of results for this
operation.
data DescribeApplicationsResponse Source #
See: newDescribeApplicationsResponse smart constructor.
Constructors
| DescribeApplicationsResponse' (Maybe [Application]) (Maybe Text) Int |
Instances
newDescribeApplicationsResponse Source #
Create a value of DescribeApplicationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeApplicationsResponse, describeApplicationsResponse_applications - The applications in the list.
DescribeApplications, describeApplicationsResponse_nextToken - The pagination token used to retrieve the next page of results for this
operation.
$sel:httpStatus:DescribeApplicationsResponse', describeApplicationsResponse_httpStatus - The response's http status code.
DescribeDirectoryConfigs (Paginated)
data DescribeDirectoryConfigs Source #
See: newDescribeDirectoryConfigs smart constructor.
Instances
newDescribeDirectoryConfigs :: DescribeDirectoryConfigs Source #
Create a value of DescribeDirectoryConfigs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryNames:DescribeDirectoryConfigs', describeDirectoryConfigs_directoryNames - The directory names.
$sel:maxResults:DescribeDirectoryConfigs', describeDirectoryConfigs_maxResults - The maximum size of each page of results.
DescribeDirectoryConfigs, describeDirectoryConfigs_nextToken - 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.
data DescribeDirectoryConfigsResponse Source #
See: newDescribeDirectoryConfigsResponse smart constructor.
Constructors
| DescribeDirectoryConfigsResponse' (Maybe [DirectoryConfig]) (Maybe Text) Int |
Instances
newDescribeDirectoryConfigsResponse Source #
Create a value of DescribeDirectoryConfigsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryConfigs:DescribeDirectoryConfigsResponse', describeDirectoryConfigsResponse_directoryConfigs - 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.
DescribeDirectoryConfigs, describeDirectoryConfigsResponse_nextToken - 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.
$sel:httpStatus:DescribeDirectoryConfigsResponse', describeDirectoryConfigsResponse_httpStatus - The response's http status code.
DescribeEntitlements
data DescribeEntitlements Source #
See: newDescribeEntitlements smart constructor.
Instances
newDescribeEntitlements Source #
Arguments
| :: Text | |
| -> DescribeEntitlements |
Create a value of DescribeEntitlements with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeEntitlements', describeEntitlements_maxResults - The maximum size of each page of results.
DescribeEntitlements, describeEntitlements_name - The name of the entitlement.
DescribeEntitlements, describeEntitlements_nextToken - The pagination token used to retrieve the next page of results for this
operation.
DescribeEntitlements, describeEntitlements_stackName - The name of the stack with which the entitlement is associated.
data DescribeEntitlementsResponse Source #
See: newDescribeEntitlementsResponse smart constructor.
Constructors
| DescribeEntitlementsResponse' (Maybe [Entitlement]) (Maybe Text) Int |
Instances
newDescribeEntitlementsResponse Source #
Create a value of DescribeEntitlementsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitlements:DescribeEntitlementsResponse', describeEntitlementsResponse_entitlements - The entitlements.
DescribeEntitlements, describeEntitlementsResponse_nextToken - The pagination token used to retrieve the next page of results for this
operation.
$sel:httpStatus:DescribeEntitlementsResponse', describeEntitlementsResponse_httpStatus - The response's http status code.
DescribeFleets (Paginated)
data DescribeFleets Source #
See: newDescribeFleets smart constructor.
Constructors
| DescribeFleets' (Maybe [Text]) (Maybe Text) |
Instances
newDescribeFleets :: DescribeFleets Source #
Create a value of DescribeFleets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:names:DescribeFleets', describeFleets_names - The names of the fleets to describe.
DescribeFleets, describeFleets_nextToken - 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.
data DescribeFleetsResponse Source #
See: newDescribeFleetsResponse smart constructor.
Instances
newDescribeFleetsResponse Source #
Create a value of DescribeFleetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fleets:DescribeFleetsResponse', describeFleetsResponse_fleets - Information about the fleets.
DescribeFleets, describeFleetsResponse_nextToken - 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.
$sel:httpStatus:DescribeFleetsResponse', describeFleetsResponse_httpStatus - The response's http status code.
DescribeImageBuilders (Paginated)
data DescribeImageBuilders Source #
See: newDescribeImageBuilders smart constructor.
Instances
newDescribeImageBuilders :: DescribeImageBuilders Source #
Create a value of DescribeImageBuilders with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeImageBuilders', describeImageBuilders_maxResults - The maximum size of each page of results.
$sel:names:DescribeImageBuilders', describeImageBuilders_names - The names of the image builders to describe.
DescribeImageBuilders, describeImageBuilders_nextToken - 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.
data DescribeImageBuildersResponse Source #
See: newDescribeImageBuildersResponse smart constructor.
Constructors
| DescribeImageBuildersResponse' (Maybe [ImageBuilder]) (Maybe Text) Int |
Instances
newDescribeImageBuildersResponse Source #
Create a value of DescribeImageBuildersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageBuilders:DescribeImageBuildersResponse', describeImageBuildersResponse_imageBuilders - Information about the image builders.
DescribeImageBuilders, describeImageBuildersResponse_nextToken - 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.
$sel:httpStatus:DescribeImageBuildersResponse', describeImageBuildersResponse_httpStatus - The response's http status code.
DescribeImagePermissions
data DescribeImagePermissions Source #
See: newDescribeImagePermissions smart constructor.
Instances
newDescribeImagePermissions Source #
Arguments
| :: Text | |
| -> DescribeImagePermissions |
Create a value of DescribeImagePermissions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeImagePermissions', describeImagePermissions_maxResults - The maximum size of each page of results.
DescribeImagePermissions, describeImagePermissions_nextToken - 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.
$sel:sharedAwsAccountIds:DescribeImagePermissions', describeImagePermissions_sharedAwsAccountIds - The 12-digit identifier of one or more AWS accounts with which the image
is shared.
DescribeImagePermissions, describeImagePermissions_name - The name of the private image for which to describe permissions. The
image must be one that you own.
data DescribeImagePermissionsResponse Source #
See: newDescribeImagePermissionsResponse smart constructor.
Constructors
| DescribeImagePermissionsResponse' (Maybe Text) (Maybe Text) (Maybe [SharedImagePermissions]) Int |
Instances
newDescribeImagePermissionsResponse Source #
Create a value of DescribeImagePermissionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeImagePermissions, describeImagePermissionsResponse_name - The name of the private image.
DescribeImagePermissions, describeImagePermissionsResponse_nextToken - 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.
$sel:sharedImagePermissionsList:DescribeImagePermissionsResponse', describeImagePermissionsResponse_sharedImagePermissionsList - The permissions for a private image that you own.
$sel:httpStatus:DescribeImagePermissionsResponse', describeImagePermissionsResponse_httpStatus - The response's http status code.
DescribeImages (Paginated)
data DescribeImages Source #
See: newDescribeImages smart constructor.
Constructors
| DescribeImages' (Maybe [Text]) (Maybe Natural) (Maybe [Text]) (Maybe Text) (Maybe VisibilityType) |
Instances
newDescribeImages :: DescribeImages Source #
Create a value of DescribeImages with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arns:DescribeImages', describeImages_arns - The ARNs of the public, private, and shared images to describe.
$sel:maxResults:DescribeImages', describeImages_maxResults - The maximum size of each page of results.
$sel:names:DescribeImages', describeImages_names - The names of the public or private images to describe.
DescribeImages, describeImages_nextToken - 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.
$sel:type':DescribeImages', describeImages_type - The type of image (public, private, or shared) to describe.
data DescribeImagesResponse Source #
See: newDescribeImagesResponse smart constructor.
Instances
newDescribeImagesResponse Source #
Create a value of DescribeImagesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:images:DescribeImagesResponse', describeImagesResponse_images - Information about the images.
DescribeImages, describeImagesResponse_nextToken - 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.
$sel:httpStatus:DescribeImagesResponse', describeImagesResponse_httpStatus - The response's http status code.
DescribeSessions (Paginated)
data DescribeSessions Source #
See: newDescribeSessions smart constructor.
Constructors
| DescribeSessions' (Maybe AuthenticationType) (Maybe Int) (Maybe Text) (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeSessions |
Create a value of DescribeSessions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSessions, describeSessions_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.
$sel:limit:DescribeSessions', describeSessions_limit - The size of each page of results. The default value is 20 and the
maximum value is 50.
DescribeSessions, describeSessions_nextToken - 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, describeSessions_userId - The user identifier (ID). If you specify a user ID, you must also
specify the authentication type.
DescribeSessions, describeSessions_stackName - The name of the stack. This value is case-sensitive.
DescribeSessions, describeSessions_fleetName - The name of the fleet. This value is case-sensitive.
data DescribeSessionsResponse Source #
See: newDescribeSessionsResponse smart constructor.
Instances
newDescribeSessionsResponse Source #
Create a value of DescribeSessionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSessions, describeSessionsResponse_nextToken - 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.
$sel:sessions:DescribeSessionsResponse', describeSessionsResponse_sessions - Information about the streaming sessions.
$sel:httpStatus:DescribeSessionsResponse', describeSessionsResponse_httpStatus - The response's http status code.
DescribeStacks (Paginated)
data DescribeStacks Source #
See: newDescribeStacks smart constructor.
Constructors
| DescribeStacks' (Maybe [Text]) (Maybe Text) |
Instances
newDescribeStacks :: DescribeStacks Source #
Create a value of DescribeStacks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:names:DescribeStacks', describeStacks_names - The names of the stacks to describe.
DescribeStacks, describeStacks_nextToken - 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.
data DescribeStacksResponse Source #
See: newDescribeStacksResponse smart constructor.
Instances
newDescribeStacksResponse Source #
Create a value of DescribeStacksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStacks, describeStacksResponse_nextToken - 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.
$sel:stacks:DescribeStacksResponse', describeStacksResponse_stacks - Information about the stacks.
$sel:httpStatus:DescribeStacksResponse', describeStacksResponse_httpStatus - The response's http status code.
DescribeUsageReportSubscriptions
data DescribeUsageReportSubscriptions Source #
See: newDescribeUsageReportSubscriptions smart constructor.
Constructors
| DescribeUsageReportSubscriptions' (Maybe Int) (Maybe Text) |
Instances
newDescribeUsageReportSubscriptions :: DescribeUsageReportSubscriptions Source #
Create a value of DescribeUsageReportSubscriptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeUsageReportSubscriptions', describeUsageReportSubscriptions_maxResults - The maximum size of each page of results.
DescribeUsageReportSubscriptions, describeUsageReportSubscriptions_nextToken - 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.
data DescribeUsageReportSubscriptionsResponse Source #
See: newDescribeUsageReportSubscriptionsResponse smart constructor.
Constructors
| DescribeUsageReportSubscriptionsResponse' (Maybe Text) (Maybe [UsageReportSubscription]) Int |
Instances
newDescribeUsageReportSubscriptionsResponse Source #
Arguments
| :: Int | |
| -> DescribeUsageReportSubscriptionsResponse |
Create a value of DescribeUsageReportSubscriptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUsageReportSubscriptions, describeUsageReportSubscriptionsResponse_nextToken - 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.
$sel:usageReportSubscriptions:DescribeUsageReportSubscriptionsResponse', describeUsageReportSubscriptionsResponse_usageReportSubscriptions - Information about the usage report subscription.
$sel:httpStatus:DescribeUsageReportSubscriptionsResponse', describeUsageReportSubscriptionsResponse_httpStatus - The response's http status code.
DescribeUserStackAssociations (Paginated)
data DescribeUserStackAssociations Source #
See: newDescribeUserStackAssociations smart constructor.
Constructors
| DescribeUserStackAssociations' (Maybe AuthenticationType) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) |
Instances
newDescribeUserStackAssociations :: DescribeUserStackAssociations Source #
Create a value of DescribeUserStackAssociations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUserStackAssociations, describeUserStackAssociations_authenticationType - The authentication type for the user who is associated with the stack.
You must specify USERPOOL.
$sel:maxResults:DescribeUserStackAssociations', describeUserStackAssociations_maxResults - The maximum size of each page of results.
DescribeUserStackAssociations, describeUserStackAssociations_nextToken - 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, describeUserStackAssociations_stackName - The name of the stack that is associated with the user.
DescribeUserStackAssociations, describeUserStackAssociations_userName - The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
data DescribeUserStackAssociationsResponse Source #
See: newDescribeUserStackAssociationsResponse smart constructor.
Constructors
| DescribeUserStackAssociationsResponse' (Maybe Text) (Maybe (NonEmpty UserStackAssociation)) Int |
Instances
newDescribeUserStackAssociationsResponse Source #
Arguments
| :: Int | |
| -> DescribeUserStackAssociationsResponse |
Create a value of DescribeUserStackAssociationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUserStackAssociations, describeUserStackAssociationsResponse_nextToken - 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.
$sel:userStackAssociations:DescribeUserStackAssociationsResponse', describeUserStackAssociationsResponse_userStackAssociations - The UserStackAssociation objects.
$sel:httpStatus:DescribeUserStackAssociationsResponse', describeUserStackAssociationsResponse_httpStatus - The response's http status code.
DescribeUsers (Paginated)
data DescribeUsers Source #
See: newDescribeUsers smart constructor.
Constructors
| DescribeUsers' (Maybe Int) (Maybe Text) AuthenticationType |
Instances
Arguments
| :: AuthenticationType | |
| -> DescribeUsers |
Create a value of DescribeUsers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeUsers', describeUsers_maxResults - The maximum size of each page of results.
DescribeUsers, describeUsers_nextToken - 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, describeUsers_authenticationType - The authentication type for the users in the user pool to describe. You
must specify USERPOOL.
data DescribeUsersResponse Source #
See: newDescribeUsersResponse smart constructor.
Instances
newDescribeUsersResponse Source #
Create a value of DescribeUsersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUsers, describeUsersResponse_nextToken - 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.
$sel:users:DescribeUsersResponse', describeUsersResponse_users - Information about users in the user pool.
$sel:httpStatus:DescribeUsersResponse', describeUsersResponse_httpStatus - The response's http status code.
DisableUser
data DisableUser Source #
See: newDisableUser smart constructor.
Constructors
| DisableUser' (Sensitive Text) AuthenticationType |
Instances
Arguments
| :: Text | |
| -> AuthenticationType | |
| -> DisableUser |
Create a value of DisableUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisableUser, disableUser_userName - The email address of the user.
Users' email addresses are case-sensitive.
DisableUser, disableUser_authenticationType - The authentication type for the user. You must specify USERPOOL.
data DisableUserResponse Source #
See: newDisableUserResponse smart constructor.
Constructors
| DisableUserResponse' Int |
Instances
newDisableUserResponse Source #
Arguments
| :: Int | |
| -> DisableUserResponse |
Create a value of DisableUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisableUserResponse', disableUserResponse_httpStatus - The response's http status code.
DisassociateApplicationFleet
data DisassociateApplicationFleet Source #
See: newDisassociateApplicationFleet smart constructor.
Constructors
| DisassociateApplicationFleet' Text Text |
Instances
newDisassociateApplicationFleet Source #
Arguments
| :: Text | |
| -> Text | |
| -> DisassociateApplicationFleet |
Create a value of DisassociateApplicationFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateApplicationFleet, disassociateApplicationFleet_fleetName - The name of the fleet.
DisassociateApplicationFleet, disassociateApplicationFleet_applicationArn - The ARN of the application.
data DisassociateApplicationFleetResponse Source #
See: newDisassociateApplicationFleetResponse smart constructor.
Constructors
| DisassociateApplicationFleetResponse' Int |
Instances
newDisassociateApplicationFleetResponse Source #
Arguments
| :: Int | |
| -> DisassociateApplicationFleetResponse |
Create a value of DisassociateApplicationFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateApplicationFleetResponse', disassociateApplicationFleetResponse_httpStatus - The response's http status code.
DisassociateApplicationFromEntitlement
data DisassociateApplicationFromEntitlement Source #
See: newDisassociateApplicationFromEntitlement smart constructor.
Constructors
| DisassociateApplicationFromEntitlement' Text Text Text |
Instances
newDisassociateApplicationFromEntitlement Source #
Arguments
| :: Text | |
| -> Text |
|
| -> Text | |
| -> DisassociateApplicationFromEntitlement |
Create a value of DisassociateApplicationFromEntitlement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateApplicationFromEntitlement, disassociateApplicationFromEntitlement_stackName - The name of the stack with which the entitlement is associated.
$sel:entitlementName:DisassociateApplicationFromEntitlement', disassociateApplicationFromEntitlement_entitlementName - The name of the entitlement.
DisassociateApplicationFromEntitlement, disassociateApplicationFromEntitlement_applicationIdentifier - The identifier of the application to remove from the entitlement.
data DisassociateApplicationFromEntitlementResponse Source #
See: newDisassociateApplicationFromEntitlementResponse smart constructor.
Constructors
| DisassociateApplicationFromEntitlementResponse' Int |
Instances
newDisassociateApplicationFromEntitlementResponse Source #
Arguments
| :: Int |
|
| -> DisassociateApplicationFromEntitlementResponse |
Create a value of DisassociateApplicationFromEntitlementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateApplicationFromEntitlementResponse', disassociateApplicationFromEntitlementResponse_httpStatus - The response's http status code.
DisassociateFleet
data DisassociateFleet Source #
See: newDisassociateFleet smart constructor.
Constructors
| DisassociateFleet' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DisassociateFleet |
Create a value of DisassociateFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateFleet, disassociateFleet_fleetName - The name of the fleet.
DisassociateFleet, disassociateFleet_stackName - The name of the stack.
data DisassociateFleetResponse Source #
See: newDisassociateFleetResponse smart constructor.
Constructors
| DisassociateFleetResponse' Int |
Instances
newDisassociateFleetResponse Source #
Create a value of DisassociateFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateFleetResponse', disassociateFleetResponse_httpStatus - The response's http status code.
EnableUser
data EnableUser Source #
See: newEnableUser smart constructor.
Constructors
| EnableUser' (Sensitive Text) AuthenticationType |
Instances
Arguments
| :: Text | |
| -> AuthenticationType | |
| -> EnableUser |
Create a value of EnableUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
EnableUser, enableUser_userName - The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
EnableUser, enableUser_authenticationType - The authentication type for the user. You must specify USERPOOL.
data EnableUserResponse Source #
See: newEnableUserResponse smart constructor.
Constructors
| EnableUserResponse' Int |
Instances
newEnableUserResponse Source #
Arguments
| :: Int | |
| -> EnableUserResponse |
Create a value of EnableUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:EnableUserResponse', enableUserResponse_httpStatus - The response's http status code.
ExpireSession
data ExpireSession Source #
See: newExpireSession smart constructor.
Constructors
| ExpireSession' Text |
Instances
Arguments
| :: Text | |
| -> ExpireSession |
Create a value of ExpireSession with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sessionId:ExpireSession', expireSession_sessionId - The identifier of the streaming session.
data ExpireSessionResponse Source #
See: newExpireSessionResponse smart constructor.
Constructors
| ExpireSessionResponse' Int |
Instances
newExpireSessionResponse Source #
Create a value of ExpireSessionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ExpireSessionResponse', expireSessionResponse_httpStatus - The response's http status code.
ListAssociatedFleets (Paginated)
data ListAssociatedFleets Source #
See: newListAssociatedFleets smart constructor.
Constructors
| ListAssociatedFleets' (Maybe Text) Text |
Instances
newListAssociatedFleets Source #
Arguments
| :: Text | |
| -> ListAssociatedFleets |
Create a value of ListAssociatedFleets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAssociatedFleets, listAssociatedFleets_nextToken - 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, listAssociatedFleets_stackName - The name of the stack.
data ListAssociatedFleetsResponse Source #
See: newListAssociatedFleetsResponse smart constructor.
Instances
newListAssociatedFleetsResponse Source #
Create a value of ListAssociatedFleetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:names:ListAssociatedFleetsResponse', listAssociatedFleetsResponse_names - The name of the fleet.
ListAssociatedFleets, listAssociatedFleetsResponse_nextToken - 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.
$sel:httpStatus:ListAssociatedFleetsResponse', listAssociatedFleetsResponse_httpStatus - The response's http status code.
ListAssociatedStacks (Paginated)
data ListAssociatedStacks Source #
See: newListAssociatedStacks smart constructor.
Constructors
| ListAssociatedStacks' (Maybe Text) Text |
Instances
newListAssociatedStacks Source #
Arguments
| :: Text | |
| -> ListAssociatedStacks |
Create a value of ListAssociatedStacks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAssociatedStacks, listAssociatedStacks_nextToken - 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, listAssociatedStacks_fleetName - The name of the fleet.
data ListAssociatedStacksResponse Source #
See: newListAssociatedStacksResponse smart constructor.
Instances
newListAssociatedStacksResponse Source #
Create a value of ListAssociatedStacksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:names:ListAssociatedStacksResponse', listAssociatedStacksResponse_names - The name of the stack.
ListAssociatedStacks, listAssociatedStacksResponse_nextToken - 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.
$sel:httpStatus:ListAssociatedStacksResponse', listAssociatedStacksResponse_httpStatus - The response's http status code.
ListEntitledApplications
data ListEntitledApplications Source #
See: newListEntitledApplications smart constructor.
Instances
newListEntitledApplications Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListEntitledApplications |
Create a value of ListEntitledApplications with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEntitledApplications', listEntitledApplications_maxResults - The maximum size of each page of results.
ListEntitledApplications, listEntitledApplications_nextToken - The pagination token used to retrieve the next page of results for this
operation.
ListEntitledApplications, listEntitledApplications_stackName - The name of the stack with which the entitlement is associated.
$sel:entitlementName:ListEntitledApplications', listEntitledApplications_entitlementName - The name of the entitlement.
data ListEntitledApplicationsResponse Source #
See: newListEntitledApplicationsResponse smart constructor.
Constructors
| ListEntitledApplicationsResponse' (Maybe [EntitledApplication]) (Maybe Text) Int |
Instances
newListEntitledApplicationsResponse Source #
Create a value of ListEntitledApplicationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitledApplications:ListEntitledApplicationsResponse', listEntitledApplicationsResponse_entitledApplications - The entitled applications.
ListEntitledApplications, listEntitledApplicationsResponse_nextToken - The pagination token used to retrieve the next page of results for this
operation.
$sel:httpStatus:ListEntitledApplicationsResponse', listEntitledApplicationsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The information about the tags.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
StartFleet
data StartFleet Source #
See: newStartFleet smart constructor.
Constructors
| StartFleet' Text |
Instances
Arguments
| :: Text | |
| -> StartFleet |
Create a value of StartFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartFleet, startFleet_name - The name of the fleet.
data StartFleetResponse Source #
See: newStartFleetResponse smart constructor.
Constructors
| StartFleetResponse' Int |
Instances
newStartFleetResponse Source #
Arguments
| :: Int | |
| -> StartFleetResponse |
Create a value of StartFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartFleetResponse', startFleetResponse_httpStatus - The response's http status code.
StartImageBuilder
data StartImageBuilder Source #
See: newStartImageBuilder smart constructor.
Constructors
| StartImageBuilder' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> StartImageBuilder |
Create a value of StartImageBuilder with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartImageBuilder, startImageBuilder_appstreamAgentVersion - 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, startImageBuilder_name - The name of the image builder.
data StartImageBuilderResponse Source #
See: newStartImageBuilderResponse smart constructor.
Constructors
| StartImageBuilderResponse' (Maybe ImageBuilder) Int |
Instances
newStartImageBuilderResponse Source #
Create a value of StartImageBuilderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageBuilder:StartImageBuilderResponse', startImageBuilderResponse_imageBuilder - Information about the image builder.
$sel:httpStatus:StartImageBuilderResponse', startImageBuilderResponse_httpStatus - The response's http status code.
StopFleet
See: newStopFleet smart constructor.
Constructors
| StopFleet' Text |
Instances
Create a value of StopFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopFleet, stopFleet_name - The name of the fleet.
data StopFleetResponse Source #
See: newStopFleetResponse smart constructor.
Constructors
| StopFleetResponse' Int |
Instances
Arguments
| :: Int | |
| -> StopFleetResponse |
Create a value of StopFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopFleetResponse', stopFleetResponse_httpStatus - The response's http status code.
StopImageBuilder
data StopImageBuilder Source #
See: newStopImageBuilder smart constructor.
Constructors
| StopImageBuilder' Text |
Instances
Arguments
| :: Text | |
| -> StopImageBuilder |
Create a value of StopImageBuilder with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopImageBuilder, stopImageBuilder_name - The name of the image builder.
data StopImageBuilderResponse Source #
See: newStopImageBuilderResponse smart constructor.
Constructors
| StopImageBuilderResponse' (Maybe ImageBuilder) Int |
Instances
newStopImageBuilderResponse Source #
Create a value of StopImageBuilderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageBuilder:StopImageBuilderResponse', stopImageBuilderResponse_imageBuilder - Information about the image builder.
$sel:httpStatus:StopImageBuilderResponse', stopImageBuilderResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource.
$sel:tags:TagResource', tagResource_tags - 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:
_ . : / = + \ - @
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag keys for the tags to disassociate.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateApplication
data UpdateApplication Source #
See: newUpdateApplication smart constructor.
Constructors
| UpdateApplication' (Maybe Text) (Maybe [ApplicationAttribute]) (Maybe Text) (Maybe Text) (Maybe S3Location) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateApplication |
Create a value of UpdateApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateApplication, updateApplication_appBlockArn - The ARN of the app block.
$sel:attributesToDelete:UpdateApplication', updateApplication_attributesToDelete - The attributes to delete for an application.
UpdateApplication, updateApplication_description - The description of the application.
UpdateApplication, updateApplication_displayName - The display name of the application. This name is visible to users in
the application catalog.
UpdateApplication, updateApplication_iconS3Location - The icon S3 location of the application.
UpdateApplication, updateApplication_launchParameters - The launch parameters of the application.
UpdateApplication, updateApplication_launchPath - The launch path of the application.
UpdateApplication, updateApplication_workingDirectory - The working directory of the application.
UpdateApplication, updateApplication_name - The name of the application. This name is visible to users when display
name is not specified.
data UpdateApplicationResponse Source #
See: newUpdateApplicationResponse smart constructor.
Constructors
| UpdateApplicationResponse' (Maybe Application) Int |
Instances
newUpdateApplicationResponse Source #
Create a value of UpdateApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:application:UpdateApplicationResponse', updateApplicationResponse_application - Undocumented member.
$sel:httpStatus:UpdateApplicationResponse', updateApplicationResponse_httpStatus - The response's http status code.
UpdateDirectoryConfig
data UpdateDirectoryConfig Source #
See: newUpdateDirectoryConfig smart constructor.
Constructors
| UpdateDirectoryConfig' (Maybe CertificateBasedAuthProperties) (Maybe [Text]) (Maybe ServiceAccountCredentials) Text |
Instances
newUpdateDirectoryConfig Source #
Arguments
| :: Text | |
| -> UpdateDirectoryConfig |
Create a value of UpdateDirectoryConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDirectoryConfig, updateDirectoryConfig_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, updateDirectoryConfig_organizationalUnitDistinguishedNames - The distinguished names of the organizational units for computer
accounts.
UpdateDirectoryConfig, updateDirectoryConfig_serviceAccountCredentials - The credentials for the service account used by the fleet or image
builder to connect to the directory.
UpdateDirectoryConfig, updateDirectoryConfig_directoryName - The name of the Directory Config object.
data UpdateDirectoryConfigResponse Source #
See: newUpdateDirectoryConfigResponse smart constructor.
Constructors
| UpdateDirectoryConfigResponse' (Maybe DirectoryConfig) Int |
Instances
newUpdateDirectoryConfigResponse Source #
Create a value of UpdateDirectoryConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryConfig:UpdateDirectoryConfigResponse', updateDirectoryConfigResponse_directoryConfig - Information about the Directory Config object.
$sel:httpStatus:UpdateDirectoryConfigResponse', updateDirectoryConfigResponse_httpStatus - The response's http status code.
UpdateEntitlement
data UpdateEntitlement Source #
See: newUpdateEntitlement smart constructor.
Constructors
| UpdateEntitlement' (Maybe AppVisibility) (Maybe (NonEmpty EntitlementAttribute)) (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateEntitlement |
Create a value of UpdateEntitlement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEntitlement, updateEntitlement_appVisibility - Specifies whether all or only selected apps are entitled.
UpdateEntitlement, updateEntitlement_attributes - The attributes of the entitlement.
UpdateEntitlement, updateEntitlement_description - The description of the entitlement.
UpdateEntitlement, updateEntitlement_name - The name of the entitlement.
UpdateEntitlement, updateEntitlement_stackName - The name of the stack with which the entitlement is associated.
data UpdateEntitlementResponse Source #
See: newUpdateEntitlementResponse smart constructor.
Constructors
| UpdateEntitlementResponse' (Maybe Entitlement) Int |
Instances
newUpdateEntitlementResponse Source #
Create a value of UpdateEntitlementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitlement:UpdateEntitlementResponse', updateEntitlementResponse_entitlement - The entitlement.
$sel:httpStatus:UpdateEntitlementResponse', updateEntitlementResponse_httpStatus - The response's http status code.
UpdateFleet
data UpdateFleet Source #
See: newUpdateFleet smart constructor.
Constructors
| UpdateFleet' (Maybe [FleetAttribute]) (Maybe ComputeCapacity) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe PlatformType) (Maybe S3Location) (Maybe StreamView) (Maybe [Text]) (Maybe VpcConfig) |
Instances
newUpdateFleet :: UpdateFleet Source #
Create a value of UpdateFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributesToDelete:UpdateFleet', updateFleet_attributesToDelete - The fleet attributes to delete.
$sel:computeCapacity:UpdateFleet', updateFleet_computeCapacity - The desired capacity for the fleet. This is not allowed for Elastic
fleets.
$sel:deleteVpcConfig:UpdateFleet', updateFleet_deleteVpcConfig - Deletes the VPC association for the specified fleet.
UpdateFleet, updateFleet_description - The description to display.
UpdateFleet, updateFleet_disconnectTimeoutInSeconds - 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, updateFleet_displayName - The fleet name to display.
UpdateFleet, updateFleet_domainJoinInfo - The name of the directory and organizational unit (OU) to use to join
the fleet to a Microsoft Active Directory domain.
UpdateFleet, updateFleet_enableDefaultInternetAccess - Enables or disables default internet access for the fleet.
UpdateFleet, updateFleet_iamRoleArn - 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, updateFleet_idleDisconnectTimeoutInSeconds - 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, updateFleet_imageArn - The ARN of the public, private, or shared image to use.
UpdateFleet, updateFleet_imageName - The name of the image used to create the fleet.
UpdateFleet, updateFleet_instanceType - 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, updateFleet_maxConcurrentSessions - The maximum number of concurrent sessions for a fleet.
UpdateFleet, updateFleet_maxUserDurationInSeconds - 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, updateFleet_name - A unique name for the fleet.
UpdateFleet, updateFleet_platform - The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are
supported for Elastic fleets.
UpdateFleet, updateFleet_sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This only
applies to Elastic fleets.
UpdateFleet, updateFleet_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, updateFleet_usbDeviceFilterStrings - 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, updateFleet_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.
data UpdateFleetResponse Source #
See: newUpdateFleetResponse smart constructor.
Constructors
| UpdateFleetResponse' (Maybe Fleet) Int |
Instances
newUpdateFleetResponse Source #
Arguments
| :: Int | |
| -> UpdateFleetResponse |
Create a value of UpdateFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fleet:UpdateFleetResponse', updateFleetResponse_fleet - Information about the fleet.
$sel:httpStatus:UpdateFleetResponse', updateFleetResponse_httpStatus - The response's http status code.
UpdateImagePermissions
data UpdateImagePermissions Source #
See: newUpdateImagePermissions smart constructor.
Constructors
| UpdateImagePermissions' Text Text ImagePermissions |
Instances
newUpdateImagePermissions Source #
Arguments
| :: Text | |
| -> Text | |
| -> ImagePermissions | |
| -> UpdateImagePermissions |
Create a value of UpdateImagePermissions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateImagePermissions, updateImagePermissions_name - The name of the private image.
UpdateImagePermissions, updateImagePermissions_sharedAccountId - The 12-digit identifier of the AWS account for which you want add or
update image permissions.
UpdateImagePermissions, updateImagePermissions_imagePermissions - The permissions for the image.
data UpdateImagePermissionsResponse Source #
See: newUpdateImagePermissionsResponse smart constructor.
Constructors
| UpdateImagePermissionsResponse' Int |
Instances
newUpdateImagePermissionsResponse Source #
Create a value of UpdateImagePermissionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateImagePermissionsResponse', updateImagePermissionsResponse_httpStatus - The response's http status code.
UpdateStack
data UpdateStack Source #
See: newUpdateStack smart constructor.
Constructors
| UpdateStack' (Maybe (NonEmpty AccessEndpoint)) (Maybe ApplicationSettings) (Maybe [StackAttribute]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [StorageConnector]) (Maybe StreamingExperienceSettings) (Maybe (NonEmpty UserSetting)) Text |
Instances
Arguments
| :: Text | |
| -> UpdateStack |
Create a value of UpdateStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStack, updateStack_accessEndpoints - 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, updateStack_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.
$sel:attributesToDelete:UpdateStack', updateStack_attributesToDelete - The stack attributes to delete.
$sel:deleteStorageConnectors:UpdateStack', updateStack_deleteStorageConnectors - Deletes the storage connectors currently enabled for the stack.
UpdateStack, updateStack_description - The description to display.
UpdateStack, updateStack_displayName - The stack name to display.
UpdateStack, updateStack_embedHostDomains - 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, updateStack_feedbackURL - 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, updateStack_redirectURL - The URL that users are redirected to after their streaming session ends.
UpdateStack, updateStack_storageConnectors - The storage connectors to enable.
UpdateStack, updateStack_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, updateStack_userSettings - The actions that are enabled or disabled for users during their
streaming sessions. By default, these actions are enabled.
UpdateStack, updateStack_name - The name of the stack.
data UpdateStackResponse Source #
See: newUpdateStackResponse smart constructor.
Constructors
| UpdateStackResponse' (Maybe Stack) Int |
Instances
newUpdateStackResponse Source #
Arguments
| :: Int | |
| -> UpdateStackResponse |
Create a value of UpdateStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stack:UpdateStackResponse', updateStackResponse_stack - Information about the stack.
$sel:httpStatus:UpdateStackResponse', updateStackResponse_httpStatus - The response's http status code.
Types
AccessEndpointType
newtype AccessEndpointType Source #
Constructors
| AccessEndpointType' | |
Fields | |
Bundled Patterns
| pattern AccessEndpointType_STREAMING :: AccessEndpointType |
Instances
Action
Constructors
| Action' | |
Fields
| |
Bundled Patterns
| pattern Action_CLIPBOARD_COPY_FROM_LOCAL_DEVICE :: Action | |
| pattern Action_CLIPBOARD_COPY_TO_LOCAL_DEVICE :: Action | |
| pattern Action_DOMAIN_PASSWORD_SIGNIN :: Action | |
| pattern Action_DOMAIN_SMART_CARD_SIGNIN :: Action | |
| pattern Action_FILE_DOWNLOAD :: Action | |
| pattern Action_FILE_UPLOAD :: Action | |
| pattern Action_PRINTING_TO_LOCAL_DEVICE :: Action |
Instances
AppVisibility
newtype AppVisibility Source #
Constructors
| AppVisibility' | |
Fields | |
Bundled Patterns
| pattern AppVisibility_ALL :: AppVisibility | |
| pattern AppVisibility_ASSOCIATED :: AppVisibility |
Instances
ApplicationAttribute
newtype ApplicationAttribute Source #
Constructors
| ApplicationAttribute' | |
Fields | |
Bundled Patterns
| pattern ApplicationAttribute_LAUNCH_PARAMETERS :: ApplicationAttribute | |
| pattern ApplicationAttribute_WORKING_DIRECTORY :: ApplicationAttribute |
Instances
AuthenticationType
newtype AuthenticationType Source #
Constructors
| AuthenticationType' | |
Fields | |
Bundled Patterns
| pattern AuthenticationType_API :: AuthenticationType | |
| pattern AuthenticationType_AWS_AD :: AuthenticationType | |
| pattern AuthenticationType_SAML :: AuthenticationType | |
| pattern AuthenticationType_USERPOOL :: AuthenticationType |
Instances
CertificateBasedAuthStatus
newtype CertificateBasedAuthStatus Source #
Constructors
| CertificateBasedAuthStatus' | |
Fields | |
Bundled Patterns
Instances
FleetAttribute
newtype FleetAttribute Source #
The fleet attribute.
Constructors
| FleetAttribute' | |
Fields | |
Bundled Patterns
| pattern FleetAttribute_DOMAIN_JOIN_INFO :: FleetAttribute | |
| pattern FleetAttribute_IAM_ROLE_ARN :: FleetAttribute | |
| pattern FleetAttribute_SESSION_SCRIPT_S3_LOCATION :: FleetAttribute | |
| pattern FleetAttribute_USB_DEVICE_FILTER_STRINGS :: FleetAttribute | |
| pattern FleetAttribute_VPC_CONFIGURATION :: FleetAttribute | |
| pattern FleetAttribute_VPC_CONFIGURATION_SECURITY_GROUP_IDS :: FleetAttribute |
Instances
FleetErrorCode
newtype FleetErrorCode Source #
Constructors
| FleetErrorCode' | |
Fields | |
Bundled Patterns
Instances
FleetState
newtype FleetState Source #
Constructors
| FleetState' | |
Fields | |
Bundled Patterns
| pattern FleetState_RUNNING :: FleetState | |
| pattern FleetState_STARTING :: FleetState | |
| pattern FleetState_STOPPED :: FleetState | |
| pattern FleetState_STOPPING :: FleetState |
Instances
FleetType
Constructors
| FleetType' | |
Fields | |
Bundled Patterns
| pattern FleetType_ALWAYS_ON :: FleetType | |
| pattern FleetType_ELASTIC :: FleetType | |
| pattern FleetType_ON_DEMAND :: FleetType |
Instances
ImageBuilderState
newtype ImageBuilderState Source #
Constructors
| ImageBuilderState' | |
Fields | |
Bundled Patterns
| pattern ImageBuilderState_DELETING :: ImageBuilderState | |
| pattern ImageBuilderState_FAILED :: ImageBuilderState | |
| pattern ImageBuilderState_PENDING :: ImageBuilderState | |
| pattern ImageBuilderState_PENDING_QUALIFICATION :: ImageBuilderState | |
| pattern ImageBuilderState_REBOOTING :: ImageBuilderState | |
| pattern ImageBuilderState_RUNNING :: ImageBuilderState | |
| pattern ImageBuilderState_SNAPSHOTTING :: ImageBuilderState | |
| pattern ImageBuilderState_STOPPED :: ImageBuilderState | |
| pattern ImageBuilderState_STOPPING :: ImageBuilderState | |
| pattern ImageBuilderState_UPDATING :: ImageBuilderState | |
| pattern ImageBuilderState_UPDATING_AGENT :: ImageBuilderState |
Instances
ImageBuilderStateChangeReasonCode
newtype ImageBuilderStateChangeReasonCode Source #
Constructors
| ImageBuilderStateChangeReasonCode' | |
Bundled Patterns
| pattern ImageBuilderStateChangeReasonCode_IMAGE_UNAVAILABLE :: ImageBuilderStateChangeReasonCode | |
| pattern ImageBuilderStateChangeReasonCode_INTERNAL_ERROR :: ImageBuilderStateChangeReasonCode |
Instances
ImageState
newtype ImageState Source #
Constructors
| ImageState' | |
Fields | |
Bundled Patterns
| pattern ImageState_AVAILABLE :: ImageState | |
| pattern ImageState_COPYING :: ImageState | |
| pattern ImageState_CREATING :: ImageState | |
| pattern ImageState_DELETING :: ImageState | |
| pattern ImageState_FAILED :: ImageState | |
| pattern ImageState_IMPORTING :: ImageState | |
| pattern ImageState_PENDING :: ImageState |
Instances
ImageStateChangeReasonCode
newtype ImageStateChangeReasonCode Source #
Constructors
| ImageStateChangeReasonCode' | |
Fields | |
Bundled Patterns
Instances
MessageAction
newtype MessageAction Source #
Constructors
| MessageAction' | |
Fields | |
Bundled Patterns
| pattern MessageAction_RESEND :: MessageAction | |
| pattern MessageAction_SUPPRESS :: MessageAction |
Instances
Permission
newtype Permission Source #
Constructors
| Permission' | |
Fields | |
Bundled Patterns
| pattern Permission_DISABLED :: Permission | |
| pattern Permission_ENABLED :: Permission |
Instances
PlatformType
newtype PlatformType Source #
Constructors
| PlatformType' | |
Fields | |
Bundled Patterns
| pattern PlatformType_AMAZON_LINUX2 :: PlatformType | |
| pattern PlatformType_WINDOWS :: PlatformType | |
| pattern PlatformType_WINDOWS_SERVER_2016 :: PlatformType | |
| pattern PlatformType_WINDOWS_SERVER_2019 :: PlatformType |
Instances
PreferredProtocol
newtype PreferredProtocol Source #
Constructors
| PreferredProtocol' | |
Fields | |
Bundled Patterns
| pattern PreferredProtocol_TCP :: PreferredProtocol | |
| pattern PreferredProtocol_UDP :: PreferredProtocol |
Instances
SessionConnectionState
newtype SessionConnectionState Source #
Constructors
| SessionConnectionState' | |
Fields | |
Bundled Patterns
| pattern SessionConnectionState_CONNECTED :: SessionConnectionState | |
| pattern SessionConnectionState_NOT_CONNECTED :: SessionConnectionState |
Instances
SessionState
newtype SessionState Source #
Possible values for the state of a streaming session.
Constructors
| SessionState' | |
Fields | |
Bundled Patterns
| pattern SessionState_ACTIVE :: SessionState | |
| pattern SessionState_EXPIRED :: SessionState | |
| pattern SessionState_PENDING :: SessionState |
Instances
StackAttribute
newtype StackAttribute Source #
Constructors
| StackAttribute' | |
Fields | |
Bundled Patterns
| pattern StackAttribute_ACCESS_ENDPOINTS :: StackAttribute | |
| pattern StackAttribute_EMBED_HOST_DOMAINS :: StackAttribute | |
| pattern StackAttribute_FEEDBACK_URL :: StackAttribute | |
| pattern StackAttribute_IAM_ROLE_ARN :: StackAttribute | |
| pattern StackAttribute_REDIRECT_URL :: StackAttribute | |
| pattern StackAttribute_STORAGE_CONNECTORS :: StackAttribute | |
| pattern StackAttribute_STORAGE_CONNECTOR_GOOGLE_DRIVE :: StackAttribute | |
| pattern StackAttribute_STORAGE_CONNECTOR_HOMEFOLDERS :: StackAttribute | |
| pattern StackAttribute_STORAGE_CONNECTOR_ONE_DRIVE :: StackAttribute | |
| pattern StackAttribute_STREAMING_EXPERIENCE_SETTINGS :: StackAttribute | |
| pattern StackAttribute_THEME_NAME :: StackAttribute | |
| pattern StackAttribute_USER_SETTINGS :: StackAttribute |
Instances
StackErrorCode
newtype StackErrorCode Source #
Constructors
| StackErrorCode' | |
Fields | |
Bundled Patterns
| pattern StackErrorCode_INTERNAL_SERVICE_ERROR :: StackErrorCode | |
| pattern StackErrorCode_STORAGE_CONNECTOR_ERROR :: StackErrorCode |
Instances
StorageConnectorType
newtype StorageConnectorType Source #
The type of storage connector.
Constructors
| StorageConnectorType' | |
Fields | |
Bundled Patterns
| pattern StorageConnectorType_GOOGLE_DRIVE :: StorageConnectorType | |
| pattern StorageConnectorType_HOMEFOLDERS :: StorageConnectorType | |
| pattern StorageConnectorType_ONE_DRIVE :: StorageConnectorType |
Instances
StreamView
newtype StreamView Source #
Constructors
| StreamView' | |
Fields | |
Bundled Patterns
| pattern StreamView_APP :: StreamView | |
| pattern StreamView_DESKTOP :: StreamView |
Instances
UsageReportExecutionErrorCode
newtype UsageReportExecutionErrorCode Source #
Constructors
| UsageReportExecutionErrorCode' | |
Fields | |
Bundled Patterns
Instances
UsageReportSchedule
newtype UsageReportSchedule Source #
Constructors
| UsageReportSchedule' | |
Fields | |
Bundled Patterns
| pattern UsageReportSchedule_DAILY :: UsageReportSchedule |
Instances
UserStackAssociationErrorCode
newtype UserStackAssociationErrorCode Source #
Constructors
| UserStackAssociationErrorCode' | |
Fields | |
Bundled Patterns
Instances
VisibilityType
newtype VisibilityType Source #
Constructors
| VisibilityType' | |
Fields | |
Bundled Patterns
| pattern VisibilityType_PRIVATE :: VisibilityType | |
| pattern VisibilityType_PUBLIC :: VisibilityType | |
| pattern VisibilityType_SHARED :: VisibilityType |
Instances
AccessEndpoint
data AccessEndpoint Source #
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
See: newAccessEndpoint smart constructor.
Constructors
| AccessEndpoint' (Maybe Text) AccessEndpointType |
Instances
Create a value of AccessEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpceId:AccessEndpoint', accessEndpoint_vpceId - The identifier (ID) of the VPC in which the interface endpoint is used.
$sel:endpointType:AccessEndpoint', accessEndpoint_endpointType - The type of interface endpoint.
AppBlock
Describes an app block.
App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.
This is only supported for Elastic fleets.
See: newAppBlock smart constructor.
Constructors
| AppBlock' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe S3Location) Text Text ScriptDetails |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ScriptDetails | |
| -> AppBlock |
Create a value of AppBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTime:AppBlock', appBlock_createdTime - The created time of the app block.
$sel:description:AppBlock', appBlock_description - The description of the app block.
$sel:displayName:AppBlock', appBlock_displayName - The display name of the app block.
$sel:sourceS3Location:AppBlock', appBlock_sourceS3Location - The source S3 location of the app block.
$sel:name:AppBlock', appBlock_name - The name of the app block.
$sel:arn:AppBlock', appBlock_arn - The ARN of the app block.
$sel:setupScriptDetails:AppBlock', appBlock_setupScriptDetails - The setup script details of the app block.
Application
data Application Source #
Describes an application in the application catalog.
See: newApplication smart constructor.
Constructors
| Application' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe S3Location) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [PlatformType]) (Maybe Text) |
Instances
newApplication :: Application Source #
Create a value of Application with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appBlockArn:Application', application_appBlockArn - The app block ARN of the application.
$sel:arn:Application', application_arn - The ARN of the application.
$sel:createdTime:Application', application_createdTime - The time at which the application was created within the app block.
$sel:description:Application', application_description - The description of the application.
$sel:displayName:Application', application_displayName - The application name to display.
$sel:enabled:Application', application_enabled - If there is a problem, the application can be disabled after image
creation.
$sel:iconS3Location:Application', application_iconS3Location - The S3 location of the application icon.
$sel:iconURL:Application', application_iconURL - The URL for the application icon. This URL might be time-limited.
$sel:instanceFamilies:Application', application_instanceFamilies - The instance families for the application.
$sel:launchParameters:Application', application_launchParameters - The arguments that are passed to the application at launch.
$sel:launchPath:Application', application_launchPath - The path to the application executable in the instance.
$sel:metadata:Application', application_metadata - Additional attributes that describe the application.
$sel:name:Application', application_name - The name of the application.
$sel:platforms:Application', application_platforms - The platforms on which the application can run.
$sel:workingDirectory:Application', application_workingDirectory - The working directory for the application.
ApplicationFleetAssociation
data ApplicationFleetAssociation Source #
Describes the application fleet association.
See: newApplicationFleetAssociation smart constructor.
Constructors
| ApplicationFleetAssociation' Text Text |
Instances
newApplicationFleetAssociation Source #
Arguments
| :: Text | |
| -> Text | |
| -> ApplicationFleetAssociation |
Create a value of ApplicationFleetAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fleetName:ApplicationFleetAssociation', applicationFleetAssociation_fleetName - The name of the fleet associated with the application.
$sel:applicationArn:ApplicationFleetAssociation', applicationFleetAssociation_applicationArn - The ARN of the application associated with the fleet.
ApplicationSettings
data ApplicationSettings Source #
The persistent application settings for users of a stack.
See: newApplicationSettings smart constructor.
Constructors
| ApplicationSettings' (Maybe Text) Bool |
Instances
newApplicationSettings Source #
Arguments
| :: Bool | |
| -> ApplicationSettings |
Create a value of ApplicationSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:settingsGroup:ApplicationSettings', applicationSettings_settingsGroup - 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.
$sel:enabled:ApplicationSettings', applicationSettings_enabled - Enables or disables persistent application settings for users during
their streaming sessions.
ApplicationSettingsResponse
data ApplicationSettingsResponse Source #
Describes the persistent application settings for users of a stack.
See: newApplicationSettingsResponse smart constructor.
Instances
newApplicationSettingsResponse :: ApplicationSettingsResponse Source #
Create a value of ApplicationSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:ApplicationSettingsResponse', applicationSettingsResponse_enabled - Specifies whether persistent application settings are enabled for users
during their streaming sessions.
$sel:s3BucketName:ApplicationSettingsResponse', applicationSettingsResponse_s3BucketName - 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.
$sel:settingsGroup:ApplicationSettingsResponse', applicationSettingsResponse_settingsGroup - The path prefix for the S3 bucket where users’ persistent application
settings are stored.
CertificateBasedAuthProperties
data 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.
See: newCertificateBasedAuthProperties smart constructor.
Constructors
| CertificateBasedAuthProperties' (Maybe Text) (Maybe CertificateBasedAuthStatus) |
Instances
newCertificateBasedAuthProperties :: CertificateBasedAuthProperties Source #
Create a value of CertificateBasedAuthProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateAuthorityArn:CertificateBasedAuthProperties', certificateBasedAuthProperties_certificateAuthorityArn - The ARN of the AWS Certificate Manager Private CA resource.
$sel:status:CertificateBasedAuthProperties', certificateBasedAuthProperties_status - The status of the certificate-based authentication properties.
ComputeCapacity
data ComputeCapacity Source #
Describes the capacity for a fleet.
See: newComputeCapacity smart constructor.
Constructors
| ComputeCapacity' Int |
Instances
Arguments
| :: Int | |
| -> ComputeCapacity |
Create a value of ComputeCapacity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredInstances:ComputeCapacity', computeCapacity_desiredInstances - The desired number of streaming instances.
ComputeCapacityStatus
data ComputeCapacityStatus Source #
Describes the capacity status for a fleet.
See: newComputeCapacityStatus smart constructor.
Instances
newComputeCapacityStatus Source #
Arguments
| :: Int | |
| -> ComputeCapacityStatus |
Create a value of ComputeCapacityStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:available:ComputeCapacityStatus', computeCapacityStatus_available - The number of currently available instances that can be used to stream
sessions.
$sel:inUse:ComputeCapacityStatus', computeCapacityStatus_inUse - The number of instances in use for streaming.
$sel:running:ComputeCapacityStatus', computeCapacityStatus_running - The total number of simultaneous streaming instances that are running.
$sel:desired:ComputeCapacityStatus', computeCapacityStatus_desired - The desired number of streaming instances.
DirectoryConfig
data DirectoryConfig Source #
Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
See: newDirectoryConfig smart constructor.
Constructors
| DirectoryConfig' (Maybe CertificateBasedAuthProperties) (Maybe POSIX) (Maybe [Text]) (Maybe ServiceAccountCredentials) Text |
Instances
Arguments
| :: Text | |
| -> DirectoryConfig |
Create a value of DirectoryConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateBasedAuthProperties:DirectoryConfig', directoryConfig_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.
$sel:createdTime:DirectoryConfig', directoryConfig_createdTime - The time the directory configuration was created.
$sel:organizationalUnitDistinguishedNames:DirectoryConfig', directoryConfig_organizationalUnitDistinguishedNames - The distinguished names of the organizational units for computer
accounts.
$sel:serviceAccountCredentials:DirectoryConfig', directoryConfig_serviceAccountCredentials - The credentials for the service account used by the fleet or image
builder to connect to the directory.
$sel:directoryName:DirectoryConfig', directoryConfig_directoryName - The fully qualified name of the directory (for example,
corp.example.com).
DomainJoinInfo
data DomainJoinInfo Source #
Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
See: newDomainJoinInfo smart constructor.
Constructors
| DomainJoinInfo' (Maybe Text) (Maybe Text) |
Instances
newDomainJoinInfo :: DomainJoinInfo Source #
Create a value of DomainJoinInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryName:DomainJoinInfo', domainJoinInfo_directoryName - The fully qualified name of the directory (for example,
corp.example.com).
$sel:organizationalUnitDistinguishedName:DomainJoinInfo', domainJoinInfo_organizationalUnitDistinguishedName - The distinguished name of the organizational unit for computer accounts.
EntitledApplication
data EntitledApplication Source #
The application associated to an entitlement. Access is controlled based on user attributes.
See: newEntitledApplication smart constructor.
Constructors
| EntitledApplication' Text |
Instances
newEntitledApplication Source #
Create a value of EntitledApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIdentifier:EntitledApplication', entitledApplication_applicationIdentifier - The identifier of the application.
Entitlement
data Entitlement Source #
Specifies an entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
See: newEntitlement smart constructor.
Constructors
| Entitlement' (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text Text AppVisibility (NonEmpty EntitlementAttribute) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AppVisibility | |
| -> NonEmpty EntitlementAttribute | |
| -> Entitlement |
Create a value of Entitlement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTime:Entitlement', entitlement_createdTime - The time when the entitlement was created.
$sel:description:Entitlement', entitlement_description - The description of the entitlement.
$sel:lastModifiedTime:Entitlement', entitlement_lastModifiedTime - The time when the entitlement was last modified.
Entitlement, entitlement_name - The name of the entitlement.
$sel:stackName:Entitlement', entitlement_stackName - The name of the stack with which the entitlement is associated.
$sel:appVisibility:Entitlement', entitlement_appVisibility - Specifies whether all or selected apps are entitled.
$sel:attributes:Entitlement', entitlement_attributes - The attributes of the entitlement.
EntitlementAttribute
data EntitlementAttribute Source #
An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.
See: newEntitlementAttribute smart constructor.
Constructors
| EntitlementAttribute' Text Text |
Instances
newEntitlementAttribute Source #
Arguments
| :: Text | |
| -> Text | |
| -> EntitlementAttribute |
Create a value of EntitlementAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:EntitlementAttribute', entitlementAttribute_name - 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
$sel:value:EntitlementAttribute', entitlementAttribute_value - 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
Describes a fleet.
See: newFleet smart constructor.
Constructors
| Fleet' (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe [FleetError]) (Maybe FleetType) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe PlatformType) (Maybe S3Location) (Maybe StreamView) (Maybe [Text]) (Maybe VpcConfig) Text Text Text ComputeCapacityStatus FleetState |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ComputeCapacityStatus | |
| -> FleetState | |
| -> Fleet |
Create a value of Fleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTime:Fleet', fleet_createdTime - The time the fleet was created.
$sel:description:Fleet', fleet_description - The description to display.
$sel:disconnectTimeoutInSeconds:Fleet', fleet_disconnectTimeoutInSeconds - 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.
$sel:displayName:Fleet', fleet_displayName - The fleet name to display.
$sel:domainJoinInfo:Fleet', fleet_domainJoinInfo - The name of the directory and organizational unit (OU) to use to join
the fleet to a Microsoft Active Directory domain.
$sel:enableDefaultInternetAccess:Fleet', fleet_enableDefaultInternetAccess - Indicates whether default internet access is enabled for the fleet.
$sel:fleetErrors:Fleet', fleet_fleetErrors - The fleet errors.
$sel:fleetType:Fleet', fleet_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.
$sel:iamRoleArn:Fleet', fleet_iamRoleArn - 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.
$sel:idleDisconnectTimeoutInSeconds:Fleet', fleet_idleDisconnectTimeoutInSeconds - 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.
$sel:imageArn:Fleet', fleet_imageArn - The ARN for the public, private, or shared image.
$sel:imageName:Fleet', fleet_imageName - The name of the image used to create the fleet.
$sel:maxConcurrentSessions:Fleet', fleet_maxConcurrentSessions - The maximum number of concurrent sessions for the fleet.
$sel:maxUserDurationInSeconds:Fleet', fleet_maxUserDurationInSeconds - 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.
$sel:platform:Fleet', fleet_platform - The platform of the fleet.
$sel:sessionScriptS3Location:Fleet', fleet_sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This only
applies to Elastic fleets.
$sel:streamView:Fleet', fleet_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.
$sel:usbDeviceFilterStrings:Fleet', fleet_usbDeviceFilterStrings - The USB device filter strings associated with the fleet.
$sel:vpcConfig:Fleet', fleet_vpcConfig - The VPC configuration for the fleet.
$sel:arn:Fleet', fleet_arn - The Amazon Resource Name (ARN) for the fleet.
$sel:name:Fleet', fleet_name - The name of the fleet.
$sel:instanceType:Fleet', fleet_instanceType - 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
$sel:computeCapacityStatus:Fleet', fleet_computeCapacityStatus - The capacity status for the fleet.
$sel:state:Fleet', fleet_state - The current state for the fleet.
FleetError
data FleetError Source #
Describes a fleet error.
See: newFleetError smart constructor.
Constructors
| FleetError' (Maybe FleetErrorCode) (Maybe Text) |
Instances
newFleetError :: FleetError Source #
Create a value of FleetError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:FleetError', fleetError_errorCode - The error code.
$sel:errorMessage:FleetError', fleetError_errorMessage - The error message.
Image
Describes an image.
See: newImage smart constructor.
Constructors
| Image' (Maybe [Application]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [ResourceError]) (Maybe ImagePermissions) (Maybe PlatformType) (Maybe POSIX) (Maybe ImageState) (Maybe ImageStateChangeReason) (Maybe VisibilityType) Text |
Instances
Create a value of Image with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applications:Image', image_applications - The applications associated with the image.
$sel:appstreamAgentVersion:Image', image_appstreamAgentVersion - The version of the AppStream 2.0 agent to use for instances that are
launched from this image.
Image, image_arn - The ARN of the image.
$sel:baseImageArn:Image', image_baseImageArn - The ARN of the image from which this image was created.
Image, image_createdTime - The time the image was created.
Image, image_description - The description to display.
Image, image_displayName - The image name to display.
$sel:imageBuilderName:Image', image_imageBuilderName - The name of the image builder that was used to create the private image.
If the image is shared, this value is null.
$sel:imageBuilderSupported:Image', image_imageBuilderSupported - Indicates whether an image builder can be launched from this image.
$sel:imageErrors:Image', image_imageErrors - Describes the errors that are returned when a new image can't be
created.
$sel:imagePermissions:Image', image_imagePermissions - The permissions to provide to the destination AWS account for the
specified image.
$sel:platform:Image', image_platform - The operating system platform of the image.
$sel:publicBaseImageReleasedDate:Image', image_publicBaseImageReleasedDate - 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.
$sel:state:Image', image_state - The image starts in the PENDING state. If image creation succeeds, the
state is AVAILABLE. If image creation fails, the state is FAILED.
$sel:stateChangeReason:Image', image_stateChangeReason - The reason why the last state change occurred.
$sel:visibility:Image', image_visibility - Indicates whether the image is public or private.
Image, image_name - The name of the image.
ImageBuilder
data ImageBuilder Source #
Describes a virtual machine that is used to create an image.
See: newImageBuilder smart constructor.
Constructors
| ImageBuilder' (Maybe (NonEmpty AccessEndpoint)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DomainJoinInfo) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ResourceError]) (Maybe Text) (Maybe NetworkAccessConfiguration) (Maybe PlatformType) (Maybe ImageBuilderState) (Maybe ImageBuilderStateChangeReason) (Maybe VpcConfig) Text |
Instances
Arguments
| :: Text | |
| -> ImageBuilder |
Create a value of ImageBuilder with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessEndpoints:ImageBuilder', imageBuilder_accessEndpoints - The list of virtual private cloud (VPC) interface endpoint objects.
Administrators can connect to the image builder only through the
specified endpoints.
$sel:appstreamAgentVersion:ImageBuilder', imageBuilder_appstreamAgentVersion - The version of the AppStream 2.0 agent that is currently being used by
the image builder.
$sel:arn:ImageBuilder', imageBuilder_arn - The ARN for the image builder.
$sel:createdTime:ImageBuilder', imageBuilder_createdTime - The time stamp when the image builder was created.
$sel:description:ImageBuilder', imageBuilder_description - The description to display.
$sel:displayName:ImageBuilder', imageBuilder_displayName - The image builder name to display.
$sel:domainJoinInfo:ImageBuilder', imageBuilder_domainJoinInfo - The name of the directory and organizational unit (OU) to use to join
the image builder to a Microsoft Active Directory domain.
$sel:enableDefaultInternetAccess:ImageBuilder', imageBuilder_enableDefaultInternetAccess - Enables or disables default internet access for the image builder.
$sel:iamRoleArn:ImageBuilder', imageBuilder_iamRoleArn - 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.
$sel:imageArn:ImageBuilder', imageBuilder_imageArn - The ARN of the image from which this builder was created.
$sel:imageBuilderErrors:ImageBuilder', imageBuilder_imageBuilderErrors - The image builder errors.
$sel:instanceType:ImageBuilder', imageBuilder_instanceType - 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
$sel:networkAccessConfiguration:ImageBuilder', imageBuilder_networkAccessConfiguration - Undocumented member.
$sel:platform:ImageBuilder', imageBuilder_platform - The operating system platform of the image builder.
$sel:state:ImageBuilder', imageBuilder_state - The state of the image builder.
$sel:stateChangeReason:ImageBuilder', imageBuilder_stateChangeReason - The reason why the last state change occurred.
$sel:vpcConfig:ImageBuilder', imageBuilder_vpcConfig - The VPC configuration of the image builder.
$sel:name:ImageBuilder', imageBuilder_name - The name of the image builder.
ImageBuilderStateChangeReason
data ImageBuilderStateChangeReason Source #
Describes the reason why the last image builder state change occurred.
See: newImageBuilderStateChangeReason smart constructor.
Constructors
| ImageBuilderStateChangeReason' (Maybe ImageBuilderStateChangeReasonCode) (Maybe Text) |
Instances
newImageBuilderStateChangeReason :: ImageBuilderStateChangeReason Source #
Create a value of ImageBuilderStateChangeReason with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:ImageBuilderStateChangeReason', imageBuilderStateChangeReason_code - The state change reason code.
$sel:message:ImageBuilderStateChangeReason', imageBuilderStateChangeReason_message - The state change reason message.
ImagePermissions
data ImagePermissions Source #
Describes the permissions for an image.
See: newImagePermissions smart constructor.
Constructors
| ImagePermissions' (Maybe Bool) (Maybe Bool) |
Instances
newImagePermissions :: ImagePermissions Source #
Create a value of ImagePermissions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowFleet:ImagePermissions', imagePermissions_allowFleet - Indicates whether the image can be used for a fleet.
$sel:allowImageBuilder:ImagePermissions', imagePermissions_allowImageBuilder - Indicates whether the image can be used for an image builder.
ImageStateChangeReason
data ImageStateChangeReason Source #
Describes the reason why the last image state change occurred.
See: newImageStateChangeReason smart constructor.
Constructors
| ImageStateChangeReason' (Maybe ImageStateChangeReasonCode) (Maybe Text) |
Instances
newImageStateChangeReason :: ImageStateChangeReason Source #
Create a value of ImageStateChangeReason with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:ImageStateChangeReason', imageStateChangeReason_code - The state change reason code.
$sel:message:ImageStateChangeReason', imageStateChangeReason_message - The state change reason message.
LastReportGenerationExecutionError
data LastReportGenerationExecutionError Source #
Describes the error that is returned when a usage report can't be generated.
See: newLastReportGenerationExecutionError smart constructor.
Constructors
| LastReportGenerationExecutionError' (Maybe UsageReportExecutionErrorCode) (Maybe Text) |
Instances
newLastReportGenerationExecutionError :: LastReportGenerationExecutionError Source #
Create a value of LastReportGenerationExecutionError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:LastReportGenerationExecutionError', lastReportGenerationExecutionError_errorCode - The error code for the error that is returned when a usage report can't
be generated.
$sel:errorMessage:LastReportGenerationExecutionError', lastReportGenerationExecutionError_errorMessage - The error message for the error that is returned when a usage report
can't be generated.
NetworkAccessConfiguration
data NetworkAccessConfiguration Source #
Describes the network details of the fleet or image builder instance.
See: newNetworkAccessConfiguration smart constructor.
Constructors
| NetworkAccessConfiguration' (Maybe Text) (Maybe Text) |
Instances
newNetworkAccessConfiguration :: NetworkAccessConfiguration Source #
Create a value of NetworkAccessConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eniId:NetworkAccessConfiguration', networkAccessConfiguration_eniId - 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.
$sel:eniPrivateIpAddress:NetworkAccessConfiguration', networkAccessConfiguration_eniPrivateIpAddress - The private IP address of the elastic network interface that is attached
to instances in your VPC.
ResourceError
data ResourceError Source #
Describes a resource error.
See: newResourceError smart constructor.
Constructors
| ResourceError' (Maybe FleetErrorCode) (Maybe Text) (Maybe POSIX) |
Instances
newResourceError :: ResourceError Source #
Create a value of ResourceError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:ResourceError', resourceError_errorCode - The error code.
$sel:errorMessage:ResourceError', resourceError_errorMessage - The error message.
$sel:errorTimestamp:ResourceError', resourceError_errorTimestamp - The time the error occurred.
S3Location
data S3Location Source #
Describes the S3 location.
See: newS3Location smart constructor.
Constructors
| S3Location' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> S3Location |
Create a value of S3Location with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Bucket:S3Location', s3Location_s3Bucket - The S3 bucket of the S3 object.
$sel:s3Key:S3Location', s3Location_s3Key - The S3 key of the S3 object.
ScriptDetails
data ScriptDetails Source #
Describes the details of the script.
See: newScriptDetails smart constructor.
Constructors
| ScriptDetails' (Maybe Text) S3Location Text Int |
Instances
Arguments
| :: S3Location | |
| -> Text | |
| -> Int | |
| -> ScriptDetails |
Create a value of ScriptDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:executableParameters:ScriptDetails', scriptDetails_executableParameters - The runtime parameters passed to the run path for the script.
$sel:scriptS3Location:ScriptDetails', scriptDetails_scriptS3Location - The S3 object location for the script.
$sel:executablePath:ScriptDetails', scriptDetails_executablePath - The run path for the script.
$sel:timeoutInSeconds:ScriptDetails', scriptDetails_timeoutInSeconds - The run timeout, in seconds, for the script.
ServiceAccountCredentials
data ServiceAccountCredentials Source #
Describes the credentials for the service account used by the fleet or image builder to connect to the directory.
See: newServiceAccountCredentials smart constructor.
Constructors
| ServiceAccountCredentials' (Sensitive Text) (Sensitive Text) |
Instances
newServiceAccountCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> ServiceAccountCredentials |
Create a value of ServiceAccountCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountName:ServiceAccountCredentials', serviceAccountCredentials_accountName - 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.
$sel:accountPassword:ServiceAccountCredentials', serviceAccountCredentials_accountPassword - The password for the account.
Session
Describes a streaming session.
See: newSession smart constructor.
Constructors
| Session' (Maybe AuthenticationType) (Maybe SessionConnectionState) (Maybe POSIX) (Maybe NetworkAccessConfiguration) (Maybe POSIX) Text Text Text Text SessionState |
Instances
Create a value of Session with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authenticationType:Session', session_authenticationType - The authentication method. The user is authenticated using a streaming
URL (API) or SAML 2.0 federation (SAML).
$sel:connectionState:Session', session_connectionState - Specifies whether a user is connected to the streaming session.
$sel:maxExpirationTime:Session', session_maxExpirationTime - 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.
$sel:networkAccessConfiguration:Session', session_networkAccessConfiguration - The network details for the streaming session.
$sel:startTime:Session', session_startTime - The time when a streaming instance is dedicated for the user.
$sel:id:Session', session_id - The identifier of the streaming session.
$sel:userId:Session', session_userId - The identifier of the user for whom the session was created.
$sel:stackName:Session', session_stackName - The name of the stack for the streaming session.
$sel:fleetName:Session', session_fleetName - The name of the fleet for the streaming session.
$sel:state:Session', session_state - The current state of the streaming session.
SharedImagePermissions
data SharedImagePermissions Source #
Describes the permissions that are available to the specified AWS account for a shared image.
See: newSharedImagePermissions smart constructor.
Constructors
| SharedImagePermissions' Text ImagePermissions |
Instances
newSharedImagePermissions Source #
Arguments
| :: Text | |
| -> ImagePermissions | |
| -> SharedImagePermissions |
Create a value of SharedImagePermissions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sharedAccountId:SharedImagePermissions', sharedImagePermissions_sharedAccountId - The 12-digit identifier of the AWS account with which the image is
shared.
$sel:imagePermissions:SharedImagePermissions', sharedImagePermissions_imagePermissions - Describes the permissions for a shared image.
Stack
Describes a stack.
See: newStack smart constructor.
Constructors
| Stack' (Maybe (NonEmpty AccessEndpoint)) (Maybe ApplicationSettingsResponse) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [StackError]) (Maybe [StorageConnector]) (Maybe StreamingExperienceSettings) (Maybe (NonEmpty UserSetting)) Text |
Instances
Create a value of Stack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessEndpoints:Stack', stack_accessEndpoints - 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.
$sel:applicationSettings:Stack', stack_applicationSettings - The persistent application settings for users of the stack.
$sel:arn:Stack', stack_arn - The ARN of the stack.
$sel:createdTime:Stack', stack_createdTime - The time the stack was created.
$sel:description:Stack', stack_description - The description to display.
$sel:displayName:Stack', stack_displayName - The stack name to display.
$sel:embedHostDomains:Stack', stack_embedHostDomains - 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.
$sel:feedbackURL:Stack', stack_feedbackURL - 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.
$sel:redirectURL:Stack', stack_redirectURL - The URL that users are redirected to after their streaming session ends.
$sel:stackErrors:Stack', stack_stackErrors - The errors for the stack.
$sel:storageConnectors:Stack', stack_storageConnectors - The storage connectors to enable.
$sel:streamingExperienceSettings:Stack', stack_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.
$sel:userSettings:Stack', stack_userSettings - The actions that are enabled or disabled for users during their
streaming sessions. By default these actions are enabled.
$sel:name:Stack', stack_name - The name of the stack.
StackError
data StackError Source #
Describes a stack error.
See: newStackError smart constructor.
Constructors
| StackError' (Maybe StackErrorCode) (Maybe Text) |
Instances
newStackError :: StackError Source #
Create a value of StackError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:StackError', stackError_errorCode - The error code.
$sel:errorMessage:StackError', stackError_errorMessage - The error message.
StorageConnector
data StorageConnector Source #
Describes a connector that enables persistent storage for users.
See: newStorageConnector smart constructor.
Constructors
| StorageConnector' (Maybe [Text]) (Maybe Text) StorageConnectorType |
Instances
Create a value of StorageConnector with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domains:StorageConnector', storageConnector_domains - The names of the domains for the account.
$sel:resourceIdentifier:StorageConnector', storageConnector_resourceIdentifier - The ARN of the storage connector.
$sel:connectorType:StorageConnector', storageConnector_connectorType - The type of storage connector.
StreamingExperienceSettings
data 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.
See: newStreamingExperienceSettings smart constructor.
Constructors
| StreamingExperienceSettings' (Maybe PreferredProtocol) |
Instances
newStreamingExperienceSettings :: StreamingExperienceSettings Source #
Create a value of StreamingExperienceSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:preferredProtocol:StreamingExperienceSettings', streamingExperienceSettings_preferredProtocol - The preferred protocol that you want to use while streaming your
application.
UsageReportSubscription
data UsageReportSubscription Source #
Describes information about the usage report subscription.
See: newUsageReportSubscription smart constructor.
Constructors
| UsageReportSubscription' (Maybe POSIX) (Maybe Text) (Maybe UsageReportSchedule) (Maybe [LastReportGenerationExecutionError]) |
Instances
newUsageReportSubscription :: UsageReportSubscription Source #
Create a value of UsageReportSubscription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastGeneratedReportDate:UsageReportSubscription', usageReportSubscription_lastGeneratedReportDate - The time when the last usage report was generated.
$sel:s3BucketName:UsageReportSubscription', usageReportSubscription_s3BucketName - 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.
$sel:schedule:UsageReportSubscription', usageReportSubscription_schedule - The schedule for generating usage reports.
$sel:subscriptionErrors:UsageReportSubscription', usageReportSubscription_subscriptionErrors - The errors that were returned if usage reports couldn't be generated.
User
Describes a user in the user pool.
See: newUser smart constructor.
Constructors
| User' (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) AuthenticationType |
Instances
Arguments
| :: AuthenticationType | |
| -> User |
Create a value of User with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:User', user_arn - The ARN of the user.
$sel:createdTime:User', user_createdTime - The date and time the user was created in the user pool.
$sel:enabled:User', user_enabled - Specifies whether the user in the user pool is enabled.
$sel:firstName:User', user_firstName - The first name, or given name, of the user.
$sel:lastName:User', user_lastName - The last name, or surname, of the user.
$sel:status:User', user_status - 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.
$sel:userName:User', user_userName - The email address of the user.
Users' email addresses are case-sensitive.
$sel:authenticationType:User', user_authenticationType - The authentication type for the user.
UserSetting
data UserSetting Source #
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
See: newUserSetting smart constructor.
Constructors
| UserSetting' Action Permission |
Instances
Create a value of UserSetting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:UserSetting', userSetting_action - The action that is enabled or disabled.
$sel:permission:UserSetting', userSetting_permission - Indicates whether the action is enabled or disabled.
UserStackAssociation
data UserStackAssociation Source #
Describes a user in the user pool and the associated stack.
See: newUserStackAssociation smart constructor.
Constructors
| UserStackAssociation' (Maybe Bool) Text (Sensitive Text) AuthenticationType |
Instances
newUserStackAssociation Source #
Arguments
| :: Text | |
| -> Text | |
| -> AuthenticationType | |
| -> UserStackAssociation |
Create a value of UserStackAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sendEmailNotification:UserStackAssociation', userStackAssociation_sendEmailNotification - Specifies whether a welcome email is sent to a user after the user is
created in the user pool.
$sel:stackName:UserStackAssociation', userStackAssociation_stackName - The name of the stack that is associated with the user.
$sel:userName:UserStackAssociation', userStackAssociation_userName - The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
$sel:authenticationType:UserStackAssociation', userStackAssociation_authenticationType - The authentication type for the user.
UserStackAssociationError
data UserStackAssociationError Source #
Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
See: newUserStackAssociationError smart constructor.
Constructors
| UserStackAssociationError' (Maybe UserStackAssociationErrorCode) (Maybe Text) (Maybe UserStackAssociation) |
Instances
newUserStackAssociationError :: UserStackAssociationError Source #
Create a value of UserStackAssociationError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:UserStackAssociationError', userStackAssociationError_errorCode - The error code for the error that is returned when a user can’t be
associated with or disassociated from a stack.
$sel:errorMessage:UserStackAssociationError', userStackAssociationError_errorMessage - The error message for the error that is returned when a user can’t be
associated with or disassociated from a stack.
$sel:userStackAssociation:UserStackAssociationError', userStackAssociationError_userStackAssociation - Information about the user and associated stack.
VpcConfig
Describes VPC configuration information for fleets and image builders.
See: newVpcConfig smart constructor.
Constructors
| VpcConfig' (Maybe [Text]) (Maybe [Text]) |
Instances
| FromJSON VpcConfig Source # | |
| ToJSON VpcConfig Source # | |
Defined in Amazonka.AppStream.Types.VpcConfig | |
| Generic VpcConfig Source # | |
| Read VpcConfig Source # | |
| Show VpcConfig Source # | |
| NFData VpcConfig Source # | |
Defined in Amazonka.AppStream.Types.VpcConfig | |
| Eq VpcConfig Source # | |
| Hashable VpcConfig Source # | |
Defined in Amazonka.AppStream.Types.VpcConfig | |
| type Rep VpcConfig Source # | |
Defined in Amazonka.AppStream.Types.VpcConfig type Rep VpcConfig = D1 ('MetaData "VpcConfig" "Amazonka.AppStream.Types.VpcConfig" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "VpcConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) | |
newVpcConfig :: VpcConfig Source #
Create a value of VpcConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:VpcConfig', vpcConfig_securityGroupIds - The identifiers of the security groups for the fleet or image builder.
$sel:subnetIds:VpcConfig', vpcConfig_subnetIds - 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.