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 |
- Service Configuration
- Errors
- 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
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
- 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' {}
- newAccessEndpoint :: AccessEndpointType -> AccessEndpoint
- accessEndpoint_vpceId :: Lens' AccessEndpoint (Maybe Text)
- accessEndpoint_endpointType :: Lens' AccessEndpoint AccessEndpointType
- data AppBlock = AppBlock' {}
- newAppBlock :: Text -> Text -> ScriptDetails -> AppBlock
- appBlock_createdTime :: Lens' AppBlock (Maybe UTCTime)
- appBlock_description :: Lens' AppBlock (Maybe Text)
- appBlock_displayName :: Lens' AppBlock (Maybe Text)
- appBlock_sourceS3Location :: Lens' AppBlock (Maybe S3Location)
- appBlock_name :: Lens' AppBlock Text
- appBlock_arn :: Lens' AppBlock Text
- appBlock_setupScriptDetails :: Lens' AppBlock ScriptDetails
- data Application = Application' {
- appBlockArn :: Maybe Text
- arn :: Maybe Text
- createdTime :: Maybe POSIX
- description :: Maybe Text
- displayName :: Maybe Text
- enabled :: Maybe Bool
- iconS3Location :: Maybe S3Location
- iconURL :: Maybe Text
- instanceFamilies :: Maybe [Text]
- launchParameters :: Maybe Text
- launchPath :: Maybe Text
- metadata :: Maybe (HashMap Text Text)
- name :: Maybe Text
- platforms :: Maybe [PlatformType]
- workingDirectory :: Maybe Text
- newApplication :: Application
- application_appBlockArn :: Lens' Application (Maybe Text)
- application_arn :: Lens' Application (Maybe Text)
- application_createdTime :: Lens' Application (Maybe UTCTime)
- application_description :: Lens' Application (Maybe Text)
- application_displayName :: Lens' Application (Maybe Text)
- application_enabled :: Lens' Application (Maybe Bool)
- application_iconS3Location :: Lens' Application (Maybe S3Location)
- application_iconURL :: Lens' Application (Maybe Text)
- application_instanceFamilies :: Lens' Application (Maybe [Text])
- application_launchParameters :: Lens' Application (Maybe Text)
- application_launchPath :: Lens' Application (Maybe Text)
- application_metadata :: Lens' Application (Maybe (HashMap Text Text))
- application_name :: Lens' Application (Maybe Text)
- application_platforms :: Lens' Application (Maybe [PlatformType])
- application_workingDirectory :: Lens' Application (Maybe Text)
- data ApplicationFleetAssociation = ApplicationFleetAssociation' {
- fleetName :: Text
- applicationArn :: Text
- newApplicationFleetAssociation :: Text -> Text -> ApplicationFleetAssociation
- applicationFleetAssociation_fleetName :: Lens' ApplicationFleetAssociation Text
- applicationFleetAssociation_applicationArn :: Lens' ApplicationFleetAssociation Text
- data ApplicationSettings = ApplicationSettings' {
- settingsGroup :: Maybe Text
- enabled :: Bool
- newApplicationSettings :: Bool -> ApplicationSettings
- applicationSettings_settingsGroup :: Lens' ApplicationSettings (Maybe Text)
- applicationSettings_enabled :: Lens' ApplicationSettings Bool
- data ApplicationSettingsResponse = ApplicationSettingsResponse' {
- enabled :: Maybe Bool
- s3BucketName :: Maybe Text
- settingsGroup :: Maybe Text
- newApplicationSettingsResponse :: ApplicationSettingsResponse
- applicationSettingsResponse_enabled :: Lens' ApplicationSettingsResponse (Maybe Bool)
- applicationSettingsResponse_s3BucketName :: Lens' ApplicationSettingsResponse (Maybe Text)
- applicationSettingsResponse_settingsGroup :: Lens' ApplicationSettingsResponse (Maybe Text)
- data CertificateBasedAuthProperties = CertificateBasedAuthProperties' {}
- newCertificateBasedAuthProperties :: CertificateBasedAuthProperties
- certificateBasedAuthProperties_certificateAuthorityArn :: Lens' CertificateBasedAuthProperties (Maybe Text)
- certificateBasedAuthProperties_status :: Lens' CertificateBasedAuthProperties (Maybe CertificateBasedAuthStatus)
- data ComputeCapacity = ComputeCapacity' {}
- newComputeCapacity :: Int -> ComputeCapacity
- computeCapacity_desiredInstances :: Lens' ComputeCapacity Int
- data ComputeCapacityStatus = ComputeCapacityStatus' {}
- newComputeCapacityStatus :: Int -> ComputeCapacityStatus
- computeCapacityStatus_available :: Lens' ComputeCapacityStatus (Maybe Int)
- computeCapacityStatus_inUse :: Lens' ComputeCapacityStatus (Maybe Int)
- computeCapacityStatus_running :: Lens' ComputeCapacityStatus (Maybe Int)
- computeCapacityStatus_desired :: Lens' ComputeCapacityStatus Int
- data DirectoryConfig = DirectoryConfig' {}
- newDirectoryConfig :: Text -> DirectoryConfig
- directoryConfig_certificateBasedAuthProperties :: Lens' DirectoryConfig (Maybe CertificateBasedAuthProperties)
- directoryConfig_createdTime :: Lens' DirectoryConfig (Maybe UTCTime)
- directoryConfig_organizationalUnitDistinguishedNames :: Lens' DirectoryConfig (Maybe [Text])
- directoryConfig_serviceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials)
- directoryConfig_directoryName :: Lens' DirectoryConfig Text
- data DomainJoinInfo = DomainJoinInfo' {}
- newDomainJoinInfo :: DomainJoinInfo
- domainJoinInfo_directoryName :: Lens' DomainJoinInfo (Maybe Text)
- domainJoinInfo_organizationalUnitDistinguishedName :: Lens' DomainJoinInfo (Maybe Text)
- data EntitledApplication = EntitledApplication' {}
- newEntitledApplication :: Text -> EntitledApplication
- entitledApplication_applicationIdentifier :: Lens' EntitledApplication Text
- data Entitlement = Entitlement' {}
- newEntitlement :: Text -> Text -> AppVisibility -> NonEmpty EntitlementAttribute -> Entitlement
- entitlement_createdTime :: Lens' Entitlement (Maybe UTCTime)
- entitlement_description :: Lens' Entitlement (Maybe Text)
- entitlement_lastModifiedTime :: Lens' Entitlement (Maybe UTCTime)
- entitlement_name :: Lens' Entitlement Text
- entitlement_stackName :: Lens' Entitlement Text
- entitlement_appVisibility :: Lens' Entitlement AppVisibility
- entitlement_attributes :: Lens' Entitlement (NonEmpty EntitlementAttribute)
- data EntitlementAttribute = EntitlementAttribute' {}
- newEntitlementAttribute :: Text -> Text -> EntitlementAttribute
- entitlementAttribute_name :: Lens' EntitlementAttribute Text
- entitlementAttribute_value :: Lens' EntitlementAttribute Text
- data Fleet = Fleet' {
- createdTime :: Maybe POSIX
- description :: Maybe Text
- disconnectTimeoutInSeconds :: Maybe Int
- displayName :: Maybe Text
- domainJoinInfo :: Maybe DomainJoinInfo
- enableDefaultInternetAccess :: Maybe Bool
- fleetErrors :: Maybe [FleetError]
- fleetType :: Maybe FleetType
- iamRoleArn :: Maybe Text
- idleDisconnectTimeoutInSeconds :: Maybe Int
- imageArn :: Maybe Text
- imageName :: Maybe Text
- maxConcurrentSessions :: Maybe Int
- maxUserDurationInSeconds :: Maybe Int
- platform :: Maybe PlatformType
- sessionScriptS3Location :: Maybe S3Location
- streamView :: Maybe StreamView
- usbDeviceFilterStrings :: Maybe [Text]
- vpcConfig :: Maybe VpcConfig
- arn :: Text
- name :: Text
- instanceType :: Text
- computeCapacityStatus :: ComputeCapacityStatus
- state :: FleetState
- newFleet :: Text -> Text -> Text -> ComputeCapacityStatus -> FleetState -> Fleet
- fleet_createdTime :: Lens' Fleet (Maybe UTCTime)
- fleet_description :: Lens' Fleet (Maybe Text)
- fleet_disconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int)
- fleet_displayName :: Lens' Fleet (Maybe Text)
- fleet_domainJoinInfo :: Lens' Fleet (Maybe DomainJoinInfo)
- fleet_enableDefaultInternetAccess :: Lens' Fleet (Maybe Bool)
- fleet_fleetErrors :: Lens' Fleet (Maybe [FleetError])
- fleet_fleetType :: Lens' Fleet (Maybe FleetType)
- fleet_iamRoleArn :: Lens' Fleet (Maybe Text)
- fleet_idleDisconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int)
- fleet_imageArn :: Lens' Fleet (Maybe Text)
- fleet_imageName :: Lens' Fleet (Maybe Text)
- fleet_maxConcurrentSessions :: Lens' Fleet (Maybe Int)
- fleet_maxUserDurationInSeconds :: Lens' Fleet (Maybe Int)
- fleet_platform :: Lens' Fleet (Maybe PlatformType)
- fleet_sessionScriptS3Location :: Lens' Fleet (Maybe S3Location)
- fleet_streamView :: Lens' Fleet (Maybe StreamView)
- fleet_usbDeviceFilterStrings :: Lens' Fleet (Maybe [Text])
- fleet_vpcConfig :: Lens' Fleet (Maybe VpcConfig)
- fleet_arn :: Lens' Fleet Text
- fleet_name :: Lens' Fleet Text
- fleet_instanceType :: Lens' Fleet Text
- fleet_computeCapacityStatus :: Lens' Fleet ComputeCapacityStatus
- fleet_state :: Lens' Fleet FleetState
- data FleetError = FleetError' {}
- newFleetError :: FleetError
- fleetError_errorCode :: Lens' FleetError (Maybe FleetErrorCode)
- fleetError_errorMessage :: Lens' FleetError (Maybe Text)
- data Image = Image' {
- applications :: Maybe [Application]
- appstreamAgentVersion :: Maybe Text
- arn :: Maybe Text
- baseImageArn :: Maybe Text
- createdTime :: Maybe POSIX
- description :: Maybe Text
- displayName :: Maybe Text
- imageBuilderName :: Maybe Text
- imageBuilderSupported :: Maybe Bool
- imageErrors :: Maybe [ResourceError]
- imagePermissions :: Maybe ImagePermissions
- platform :: Maybe PlatformType
- publicBaseImageReleasedDate :: Maybe POSIX
- state :: Maybe ImageState
- stateChangeReason :: Maybe ImageStateChangeReason
- visibility :: Maybe VisibilityType
- name :: Text
- newImage :: Text -> Image
- image_applications :: Lens' Image (Maybe [Application])
- image_appstreamAgentVersion :: Lens' Image (Maybe Text)
- image_arn :: Lens' Image (Maybe Text)
- image_baseImageArn :: Lens' Image (Maybe Text)
- image_createdTime :: Lens' Image (Maybe UTCTime)
- image_description :: Lens' Image (Maybe Text)
- image_displayName :: Lens' Image (Maybe Text)
- image_imageBuilderName :: Lens' Image (Maybe Text)
- image_imageBuilderSupported :: Lens' Image (Maybe Bool)
- image_imageErrors :: Lens' Image (Maybe [ResourceError])
- image_imagePermissions :: Lens' Image (Maybe ImagePermissions)
- image_platform :: Lens' Image (Maybe PlatformType)
- image_publicBaseImageReleasedDate :: Lens' Image (Maybe UTCTime)
- image_state :: Lens' Image (Maybe ImageState)
- image_stateChangeReason :: Lens' Image (Maybe ImageStateChangeReason)
- image_visibility :: Lens' Image (Maybe VisibilityType)
- image_name :: Lens' Image Text
- data ImageBuilder = ImageBuilder' {
- accessEndpoints :: Maybe (NonEmpty AccessEndpoint)
- appstreamAgentVersion :: Maybe Text
- arn :: Maybe Text
- createdTime :: Maybe POSIX
- description :: Maybe Text
- displayName :: Maybe Text
- domainJoinInfo :: Maybe DomainJoinInfo
- enableDefaultInternetAccess :: Maybe Bool
- iamRoleArn :: Maybe Text
- imageArn :: Maybe Text
- imageBuilderErrors :: Maybe [ResourceError]
- instanceType :: Maybe Text
- networkAccessConfiguration :: Maybe NetworkAccessConfiguration
- platform :: Maybe PlatformType
- state :: Maybe ImageBuilderState
- stateChangeReason :: Maybe ImageBuilderStateChangeReason
- vpcConfig :: Maybe VpcConfig
- name :: Text
- newImageBuilder :: Text -> ImageBuilder
- imageBuilder_accessEndpoints :: Lens' ImageBuilder (Maybe (NonEmpty AccessEndpoint))
- imageBuilder_appstreamAgentVersion :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_arn :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_createdTime :: Lens' ImageBuilder (Maybe UTCTime)
- imageBuilder_description :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_displayName :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_domainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo)
- imageBuilder_enableDefaultInternetAccess :: Lens' ImageBuilder (Maybe Bool)
- imageBuilder_iamRoleArn :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_imageArn :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_imageBuilderErrors :: Lens' ImageBuilder (Maybe [ResourceError])
- imageBuilder_instanceType :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_networkAccessConfiguration :: Lens' ImageBuilder (Maybe NetworkAccessConfiguration)
- imageBuilder_platform :: Lens' ImageBuilder (Maybe PlatformType)
- imageBuilder_state :: Lens' ImageBuilder (Maybe ImageBuilderState)
- imageBuilder_stateChangeReason :: Lens' ImageBuilder (Maybe ImageBuilderStateChangeReason)
- imageBuilder_vpcConfig :: Lens' ImageBuilder (Maybe VpcConfig)
- imageBuilder_name :: Lens' ImageBuilder Text
- data ImageBuilderStateChangeReason = ImageBuilderStateChangeReason' {}
- newImageBuilderStateChangeReason :: ImageBuilderStateChangeReason
- imageBuilderStateChangeReason_code :: Lens' ImageBuilderStateChangeReason (Maybe ImageBuilderStateChangeReasonCode)
- imageBuilderStateChangeReason_message :: Lens' ImageBuilderStateChangeReason (Maybe Text)
- data ImagePermissions = ImagePermissions' {}
- newImagePermissions :: ImagePermissions
- imagePermissions_allowFleet :: Lens' ImagePermissions (Maybe Bool)
- imagePermissions_allowImageBuilder :: Lens' ImagePermissions (Maybe Bool)
- data ImageStateChangeReason = ImageStateChangeReason' {}
- newImageStateChangeReason :: ImageStateChangeReason
- imageStateChangeReason_code :: Lens' ImageStateChangeReason (Maybe ImageStateChangeReasonCode)
- imageStateChangeReason_message :: Lens' ImageStateChangeReason (Maybe Text)
- data LastReportGenerationExecutionError = LastReportGenerationExecutionError' {}
- newLastReportGenerationExecutionError :: LastReportGenerationExecutionError
- lastReportGenerationExecutionError_errorCode :: Lens' LastReportGenerationExecutionError (Maybe UsageReportExecutionErrorCode)
- lastReportGenerationExecutionError_errorMessage :: Lens' LastReportGenerationExecutionError (Maybe Text)
- data NetworkAccessConfiguration = NetworkAccessConfiguration' {}
- newNetworkAccessConfiguration :: NetworkAccessConfiguration
- networkAccessConfiguration_eniId :: Lens' NetworkAccessConfiguration (Maybe Text)
- networkAccessConfiguration_eniPrivateIpAddress :: Lens' NetworkAccessConfiguration (Maybe Text)
- data ResourceError = ResourceError' {}
- newResourceError :: ResourceError
- resourceError_errorCode :: Lens' ResourceError (Maybe FleetErrorCode)
- resourceError_errorMessage :: Lens' ResourceError (Maybe Text)
- resourceError_errorTimestamp :: Lens' ResourceError (Maybe UTCTime)
- data S3Location = S3Location' {}
- newS3Location :: Text -> Text -> S3Location
- s3Location_s3Bucket :: Lens' S3Location Text
- s3Location_s3Key :: Lens' S3Location Text
- data ScriptDetails = ScriptDetails' {}
- newScriptDetails :: S3Location -> Text -> Int -> ScriptDetails
- scriptDetails_executableParameters :: Lens' ScriptDetails (Maybe Text)
- scriptDetails_scriptS3Location :: Lens' ScriptDetails S3Location
- scriptDetails_executablePath :: Lens' ScriptDetails Text
- scriptDetails_timeoutInSeconds :: Lens' ScriptDetails Int
- data ServiceAccountCredentials = ServiceAccountCredentials' {}
- newServiceAccountCredentials :: Text -> Text -> ServiceAccountCredentials
- serviceAccountCredentials_accountName :: Lens' ServiceAccountCredentials Text
- serviceAccountCredentials_accountPassword :: Lens' ServiceAccountCredentials Text
- data Session = Session' {}
- newSession :: Text -> Text -> Text -> Text -> SessionState -> Session
- session_authenticationType :: Lens' Session (Maybe AuthenticationType)
- session_connectionState :: Lens' Session (Maybe SessionConnectionState)
- session_maxExpirationTime :: Lens' Session (Maybe UTCTime)
- session_networkAccessConfiguration :: Lens' Session (Maybe NetworkAccessConfiguration)
- session_startTime :: Lens' Session (Maybe UTCTime)
- session_id :: Lens' Session Text
- session_userId :: Lens' Session Text
- session_stackName :: Lens' Session Text
- session_fleetName :: Lens' Session Text
- session_state :: Lens' Session SessionState
- data SharedImagePermissions = SharedImagePermissions' {}
- newSharedImagePermissions :: Text -> ImagePermissions -> SharedImagePermissions
- sharedImagePermissions_sharedAccountId :: Lens' SharedImagePermissions Text
- sharedImagePermissions_imagePermissions :: Lens' SharedImagePermissions ImagePermissions
- data Stack = Stack' {
- accessEndpoints :: Maybe (NonEmpty AccessEndpoint)
- applicationSettings :: Maybe ApplicationSettingsResponse
- arn :: Maybe Text
- createdTime :: Maybe POSIX
- description :: Maybe Text
- displayName :: Maybe Text
- embedHostDomains :: Maybe (NonEmpty Text)
- feedbackURL :: Maybe Text
- redirectURL :: Maybe Text
- stackErrors :: Maybe [StackError]
- storageConnectors :: Maybe [StorageConnector]
- streamingExperienceSettings :: Maybe StreamingExperienceSettings
- userSettings :: Maybe (NonEmpty UserSetting)
- name :: Text
- newStack :: Text -> Stack
- stack_accessEndpoints :: Lens' Stack (Maybe (NonEmpty AccessEndpoint))
- stack_applicationSettings :: Lens' Stack (Maybe ApplicationSettingsResponse)
- stack_arn :: Lens' Stack (Maybe Text)
- stack_createdTime :: Lens' Stack (Maybe UTCTime)
- stack_description :: Lens' Stack (Maybe Text)
- stack_displayName :: Lens' Stack (Maybe Text)
- stack_embedHostDomains :: Lens' Stack (Maybe (NonEmpty Text))
- stack_feedbackURL :: Lens' Stack (Maybe Text)
- stack_redirectURL :: Lens' Stack (Maybe Text)
- stack_stackErrors :: Lens' Stack (Maybe [StackError])
- stack_storageConnectors :: Lens' Stack (Maybe [StorageConnector])
- stack_streamingExperienceSettings :: Lens' Stack (Maybe StreamingExperienceSettings)
- stack_userSettings :: Lens' Stack (Maybe (NonEmpty UserSetting))
- stack_name :: Lens' Stack Text
- data StackError = StackError' {}
- newStackError :: StackError
- stackError_errorCode :: Lens' StackError (Maybe StackErrorCode)
- stackError_errorMessage :: Lens' StackError (Maybe Text)
- data StorageConnector = StorageConnector' {}
- newStorageConnector :: StorageConnectorType -> StorageConnector
- storageConnector_domains :: Lens' StorageConnector (Maybe [Text])
- storageConnector_resourceIdentifier :: Lens' StorageConnector (Maybe Text)
- storageConnector_connectorType :: Lens' StorageConnector StorageConnectorType
- data StreamingExperienceSettings = StreamingExperienceSettings' {}
- newStreamingExperienceSettings :: StreamingExperienceSettings
- streamingExperienceSettings_preferredProtocol :: Lens' StreamingExperienceSettings (Maybe PreferredProtocol)
- data UsageReportSubscription = UsageReportSubscription' {}
- newUsageReportSubscription :: UsageReportSubscription
- usageReportSubscription_lastGeneratedReportDate :: Lens' UsageReportSubscription (Maybe UTCTime)
- usageReportSubscription_s3BucketName :: Lens' UsageReportSubscription (Maybe Text)
- usageReportSubscription_schedule :: Lens' UsageReportSubscription (Maybe UsageReportSchedule)
- usageReportSubscription_subscriptionErrors :: Lens' UsageReportSubscription (Maybe [LastReportGenerationExecutionError])
- data User = User' {}
- newUser :: AuthenticationType -> User
- user_arn :: Lens' User (Maybe Text)
- user_createdTime :: Lens' User (Maybe UTCTime)
- user_enabled :: Lens' User (Maybe Bool)
- user_firstName :: Lens' User (Maybe Text)
- user_lastName :: Lens' User (Maybe Text)
- user_status :: Lens' User (Maybe Text)
- user_userName :: Lens' User (Maybe Text)
- user_authenticationType :: Lens' User AuthenticationType
- data UserSetting = UserSetting' {
- action :: Action
- permission :: Permission
- newUserSetting :: Action -> Permission -> UserSetting
- userSetting_action :: Lens' UserSetting Action
- userSetting_permission :: Lens' UserSetting Permission
- data UserStackAssociation = UserStackAssociation' {}
- newUserStackAssociation :: Text -> Text -> AuthenticationType -> UserStackAssociation
- userStackAssociation_sendEmailNotification :: Lens' UserStackAssociation (Maybe Bool)
- userStackAssociation_stackName :: Lens' UserStackAssociation Text
- userStackAssociation_userName :: Lens' UserStackAssociation Text
- userStackAssociation_authenticationType :: Lens' UserStackAssociation AuthenticationType
- data UserStackAssociationError = UserStackAssociationError' {}
- newUserStackAssociationError :: UserStackAssociationError
- userStackAssociationError_errorCode :: Lens' UserStackAssociationError (Maybe UserStackAssociationErrorCode)
- userStackAssociationError_errorMessage :: Lens' UserStackAssociationError (Maybe Text)
- userStackAssociationError_userStackAssociation :: Lens' UserStackAssociationError (Maybe UserStackAssociation)
- data VpcConfig = VpcConfig' {}
- newVpcConfig :: VpcConfig
- vpcConfig_securityGroupIds :: Lens' VpcConfig (Maybe [Text])
- vpcConfig_subnetIds :: Lens' VpcConfig (Maybe [Text])
Service Configuration
defaultService :: Service Source #
API version 2016-12-01
of the Amazon AppStream SDK configuration.
Errors
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
An API error occurred. Wait a few minutes and try again.
_EntitlementAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The entitlement already exists.
_EntitlementNotFoundException :: AsError a => Fold a ServiceError Source #
The entitlement can't be found.
_IncompatibleImageException :: AsError a => Fold a ServiceError Source #
The image can't be updated because it's not compatible for updates.
_InvalidAccountStatusException :: AsError a => Fold a ServiceError Source #
The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError Source #
Indicates an incorrect combination of parameters, or a missing parameter.
_InvalidRoleException :: AsError a => Fold a ServiceError Source #
The specified role is invalid.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The requested limit exceeds the permitted limit for an account.
_OperationNotPermittedException :: AsError a => Fold a ServiceError Source #
The attempted operation is not permitted.
_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 :: AsError a => Fold a ServiceError Source #
The specified resource already exists.
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The specified resource is in use.
_ResourceNotAvailableException :: AsError a => Fold a ServiceError Source #
The specified resource exists and is not in use, but isn't available.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource was not found.
AccessEndpointType
newtype AccessEndpointType Source #
pattern AccessEndpointType_STREAMING :: AccessEndpointType |
Instances
Action
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 #
pattern AppVisibility_ALL :: AppVisibility | |
pattern AppVisibility_ASSOCIATED :: AppVisibility |
Instances
ApplicationAttribute
newtype ApplicationAttribute Source #
pattern ApplicationAttribute_LAUNCH_PARAMETERS :: ApplicationAttribute | |
pattern ApplicationAttribute_WORKING_DIRECTORY :: ApplicationAttribute |
Instances
AuthenticationType
newtype AuthenticationType Source #
pattern AuthenticationType_API :: AuthenticationType | |
pattern AuthenticationType_AWS_AD :: AuthenticationType | |
pattern AuthenticationType_SAML :: AuthenticationType | |
pattern AuthenticationType_USERPOOL :: AuthenticationType |
Instances
CertificateBasedAuthStatus
newtype CertificateBasedAuthStatus Source #
Instances
FleetAttribute
newtype FleetAttribute Source #
The fleet attribute.
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 #
Instances
FleetState
newtype FleetState Source #
pattern FleetState_RUNNING :: FleetState | |
pattern FleetState_STARTING :: FleetState | |
pattern FleetState_STOPPED :: FleetState | |
pattern FleetState_STOPPING :: FleetState |
Instances
FleetType
pattern FleetType_ALWAYS_ON :: FleetType | |
pattern FleetType_ELASTIC :: FleetType | |
pattern FleetType_ON_DEMAND :: FleetType |
Instances
ImageBuilderState
newtype ImageBuilderState Source #
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 #
pattern ImageBuilderStateChangeReasonCode_IMAGE_UNAVAILABLE :: ImageBuilderStateChangeReasonCode | |
pattern ImageBuilderStateChangeReasonCode_INTERNAL_ERROR :: ImageBuilderStateChangeReasonCode |
Instances
ImageState
newtype ImageState Source #
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 #
Instances
MessageAction
newtype MessageAction Source #
pattern MessageAction_RESEND :: MessageAction | |
pattern MessageAction_SUPPRESS :: MessageAction |
Instances
Permission
newtype Permission Source #
pattern Permission_DISABLED :: Permission | |
pattern Permission_ENABLED :: Permission |
Instances
PlatformType
newtype PlatformType Source #
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 #
pattern PreferredProtocol_TCP :: PreferredProtocol | |
pattern PreferredProtocol_UDP :: PreferredProtocol |
Instances
SessionConnectionState
newtype SessionConnectionState Source #
pattern SessionConnectionState_CONNECTED :: SessionConnectionState | |
pattern SessionConnectionState_NOT_CONNECTED :: SessionConnectionState |
Instances
SessionState
newtype SessionState Source #
Possible values for the state of a streaming session.
pattern SessionState_ACTIVE :: SessionState | |
pattern SessionState_EXPIRED :: SessionState | |
pattern SessionState_PENDING :: SessionState |
Instances
StackAttribute
newtype StackAttribute Source #
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 #
pattern StackErrorCode_INTERNAL_SERVICE_ERROR :: StackErrorCode | |
pattern StackErrorCode_STORAGE_CONNECTOR_ERROR :: StackErrorCode |
Instances
StorageConnectorType
newtype StorageConnectorType Source #
The type of storage connector.
pattern StorageConnectorType_GOOGLE_DRIVE :: StorageConnectorType | |
pattern StorageConnectorType_HOMEFOLDERS :: StorageConnectorType | |
pattern StorageConnectorType_ONE_DRIVE :: StorageConnectorType |
Instances
StreamView
newtype StreamView Source #
pattern StreamView_APP :: StreamView | |
pattern StreamView_DESKTOP :: StreamView |
Instances
UsageReportExecutionErrorCode
newtype UsageReportExecutionErrorCode Source #
Instances
UsageReportSchedule
newtype UsageReportSchedule Source #
pattern UsageReportSchedule_DAILY :: UsageReportSchedule |
Instances
UserStackAssociationErrorCode
newtype UserStackAssociationErrorCode Source #
Instances
VisibilityType
newtype VisibilityType Source #
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.
AccessEndpoint' | |
|
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.
accessEndpoint_vpceId :: Lens' AccessEndpoint (Maybe Text) Source #
The identifier (ID) of the VPC in which the interface endpoint is used.
accessEndpoint_endpointType :: Lens' AccessEndpoint AccessEndpointType Source #
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.
AppBlock' | |
|
Instances
:: 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.
appBlock_sourceS3Location :: Lens' AppBlock (Maybe S3Location) Source #
The source S3 location of the app block.
appBlock_setupScriptDetails :: Lens' AppBlock ScriptDetails Source #
The setup script details of the app block.
Application
data Application Source #
Describes an application in the application catalog.
See: newApplication
smart constructor.
Application' | |
|
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.
application_appBlockArn :: Lens' Application (Maybe Text) Source #
The app block ARN of the application.
application_arn :: Lens' Application (Maybe Text) Source #
The ARN of the application.
application_createdTime :: Lens' Application (Maybe UTCTime) Source #
The time at which the application was created within the app block.
application_description :: Lens' Application (Maybe Text) Source #
The description of the application.
application_displayName :: Lens' Application (Maybe Text) Source #
The application name to display.
application_enabled :: Lens' Application (Maybe Bool) Source #
If there is a problem, the application can be disabled after image creation.
application_iconS3Location :: Lens' Application (Maybe S3Location) Source #
The S3 location of the application icon.
application_iconURL :: Lens' Application (Maybe Text) Source #
The URL for the application icon. This URL might be time-limited.
application_instanceFamilies :: Lens' Application (Maybe [Text]) Source #
The instance families for the application.
application_launchParameters :: Lens' Application (Maybe Text) Source #
The arguments that are passed to the application at launch.
application_launchPath :: Lens' Application (Maybe Text) Source #
The path to the application executable in the instance.
application_metadata :: Lens' Application (Maybe (HashMap Text Text)) Source #
Additional attributes that describe the application.
application_name :: Lens' Application (Maybe Text) Source #
The name of the application.
application_platforms :: Lens' Application (Maybe [PlatformType]) Source #
The platforms on which the application can run.
application_workingDirectory :: Lens' Application (Maybe Text) Source #
The working directory for the application.
ApplicationFleetAssociation
data ApplicationFleetAssociation Source #
Describes the application fleet association.
See: newApplicationFleetAssociation
smart constructor.
ApplicationFleetAssociation' | |
|
Instances
newApplicationFleetAssociation Source #
:: 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.
applicationFleetAssociation_fleetName :: Lens' ApplicationFleetAssociation Text Source #
The name of the fleet associated with the application.
applicationFleetAssociation_applicationArn :: Lens' ApplicationFleetAssociation Text Source #
The ARN of the application associated with the fleet.
ApplicationSettings
data ApplicationSettings Source #
The persistent application settings for users of a stack.
See: newApplicationSettings
smart constructor.
ApplicationSettings' | |
|
Instances
newApplicationSettings Source #
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.
applicationSettings_settingsGroup :: Lens' ApplicationSettings (Maybe Text) Source #
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
applicationSettings_enabled :: Lens' ApplicationSettings Bool Source #
Enables or disables persistent application settings for users during their streaming sessions.
ApplicationSettingsResponse
data ApplicationSettingsResponse Source #
Describes the persistent application settings for users of a stack.
See: newApplicationSettingsResponse
smart constructor.
ApplicationSettingsResponse' | |
|
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.
applicationSettingsResponse_enabled :: Lens' ApplicationSettingsResponse (Maybe Bool) Source #
Specifies whether persistent application settings are enabled for users during their streaming sessions.
applicationSettingsResponse_s3BucketName :: Lens' ApplicationSettingsResponse (Maybe Text) Source #
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
applicationSettingsResponse_settingsGroup :: Lens' ApplicationSettingsResponse (Maybe Text) Source #
The path prefix for the S3 bucket where users’ persistent application settings are stored.
CertificateBasedAuthProperties
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.
CertificateBasedAuthProperties' | |
|
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.
certificateBasedAuthProperties_certificateAuthorityArn :: Lens' CertificateBasedAuthProperties (Maybe Text) Source #
The ARN of the AWS Certificate Manager Private CA resource.
certificateBasedAuthProperties_status :: Lens' CertificateBasedAuthProperties (Maybe CertificateBasedAuthStatus) Source #
The status of the certificate-based authentication properties.
ComputeCapacity
data ComputeCapacity Source #
Describes the capacity for a fleet.
See: newComputeCapacity
smart constructor.
ComputeCapacity' | |
|
Instances
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.
computeCapacity_desiredInstances :: Lens' ComputeCapacity Int Source #
The desired number of streaming instances.
ComputeCapacityStatus
data ComputeCapacityStatus Source #
Describes the capacity status for a fleet.
See: newComputeCapacityStatus
smart constructor.
ComputeCapacityStatus' | |
|
Instances
newComputeCapacityStatus Source #
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.
computeCapacityStatus_available :: Lens' ComputeCapacityStatus (Maybe Int) Source #
The number of currently available instances that can be used to stream sessions.
computeCapacityStatus_inUse :: Lens' ComputeCapacityStatus (Maybe Int) Source #
The number of instances in use for streaming.
computeCapacityStatus_running :: Lens' ComputeCapacityStatus (Maybe Int) Source #
The total number of simultaneous streaming instances that are running.
computeCapacityStatus_desired :: Lens' ComputeCapacityStatus Int Source #
The desired number of streaming instances.
DirectoryConfig
data DirectoryConfig Source #
Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
See: newDirectoryConfig
smart constructor.
DirectoryConfig' | |
|
Instances
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).
directoryConfig_certificateBasedAuthProperties :: Lens' DirectoryConfig (Maybe CertificateBasedAuthProperties) Source #
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
directoryConfig_createdTime :: Lens' DirectoryConfig (Maybe UTCTime) Source #
The time the directory configuration was created.
directoryConfig_organizationalUnitDistinguishedNames :: Lens' DirectoryConfig (Maybe [Text]) Source #
The distinguished names of the organizational units for computer accounts.
directoryConfig_serviceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials) Source #
The credentials for the service account used by the fleet or image builder to connect to the directory.
directoryConfig_directoryName :: Lens' DirectoryConfig Text Source #
The fully qualified name of the directory (for example, corp.example.com).
DomainJoinInfo
data DomainJoinInfo Source #
Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
See: newDomainJoinInfo
smart constructor.
DomainJoinInfo' | |
|
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.
domainJoinInfo_directoryName :: Lens' DomainJoinInfo (Maybe Text) Source #
The fully qualified name of the directory (for example, corp.example.com).
domainJoinInfo_organizationalUnitDistinguishedName :: Lens' DomainJoinInfo (Maybe Text) Source #
The distinguished name of the organizational unit for computer accounts.
EntitledApplication
data EntitledApplication Source #
The application associated to an entitlement. Access is controlled based on user attributes.
See: newEntitledApplication
smart constructor.
EntitledApplication' | |
|
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.
entitledApplication_applicationIdentifier :: Lens' EntitledApplication Text Source #
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.
Entitlement' | |
|
Instances
:: 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.
entitlement_createdTime :: Lens' Entitlement (Maybe UTCTime) Source #
The time when the entitlement was created.
entitlement_description :: Lens' Entitlement (Maybe Text) Source #
The description of the entitlement.
entitlement_lastModifiedTime :: Lens' Entitlement (Maybe UTCTime) Source #
The time when the entitlement was last modified.
entitlement_name :: Lens' Entitlement Text Source #
The name of the entitlement.
entitlement_stackName :: Lens' Entitlement Text Source #
The name of the stack with which the entitlement is associated.
entitlement_appVisibility :: Lens' Entitlement AppVisibility Source #
Specifies whether all or selected apps are entitled.
entitlement_attributes :: Lens' Entitlement (NonEmpty EntitlementAttribute) Source #
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.
EntitlementAttribute' | |
|
Instances
newEntitlementAttribute Source #
:: 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.
entitlementAttribute_name :: Lens' EntitlementAttribute Text Source #
A supported AWS IAM SAML PrincipalTag
attribute that is matched to the
associated value when a user identity federates into an Amazon AppStream
2.0 SAML application.
The following are valid values:
- roles
- department
- organization
- groups
- title
- costCenter
- userType
entitlementAttribute_value :: Lens' EntitlementAttribute Text Source #
A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.
Fleet
Describes a fleet.
See: newFleet
smart constructor.
Fleet' | |
|
Instances
:: 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.
fleet_disconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int) Source #
The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 360000.
fleet_domainJoinInfo :: Lens' Fleet (Maybe DomainJoinInfo) Source #
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
fleet_enableDefaultInternetAccess :: Lens' Fleet (Maybe Bool) Source #
Indicates whether default internet access is enabled for the fleet.
fleet_fleetErrors :: Lens' Fleet (Maybe [FleetError]) Source #
The fleet errors.
fleet_fleetType :: Lens' Fleet (Maybe FleetType) Source #
The fleet type.
- ALWAYS_ON
- Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
- ON_DEMAND
- Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
fleet_iamRoleArn :: Lens' Fleet (Maybe Text) Source #
The ARN of the IAM role that is applied to the fleet. To assume a role,
the fleet instance calls the AWS Security Token Service (STS)
AssumeRole
API operation and passes the ARN of the role to use. The
operation creates a new session with temporary credentials. AppStream
2.0 retrieves the temporary credentials and creates the
appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
fleet_idleDisconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int) Source #
The amount of time that users can be idle (inactive) before they are
disconnected from their streaming session and the
DisconnectTimeoutInSeconds
time interval begins. Users are notified
before they are disconnected due to inactivity. If users try to
reconnect to the streaming session before the time interval specified in
DisconnectTimeoutInSeconds
elapses, they are connected to their
previous session. Users are considered idle when they stop providing
keyboard or mouse input during their streaming session. File uploads and
downloads, audio in, audio out, and pixels changing do not qualify as
user activity. If users continue to be idle after the time interval in
IdleDisconnectTimeoutInSeconds
elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
fleet_imageArn :: Lens' Fleet (Maybe Text) Source #
The ARN for the public, private, or shared image.
fleet_maxConcurrentSessions :: Lens' Fleet (Maybe Int) Source #
The maximum number of concurrent sessions for the fleet.
fleet_maxUserDurationInSeconds :: Lens' Fleet (Maybe Int) Source #
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 360000.
fleet_platform :: Lens' Fleet (Maybe PlatformType) Source #
The platform of the fleet.
fleet_sessionScriptS3Location :: Lens' Fleet (Maybe S3Location) Source #
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
fleet_streamView :: Lens' Fleet (Maybe StreamView) Source #
The AppStream 2.0 view that is displayed to your users when they stream
from the fleet. When APP
is specified, only the windows of
applications opened by users display. When DESKTOP
is specified, the
standard desktop that is provided by the operating system displays.
The default value is APP
.
fleet_usbDeviceFilterStrings :: Lens' Fleet (Maybe [Text]) Source #
The USB device filter strings associated with the fleet.
fleet_instanceType :: Lens' Fleet Text Source #
The instance type to use when launching fleet instances. The following instance types are available:
- stream.standard.small
- stream.standard.medium
- stream.standard.large
- stream.compute.large
- stream.compute.xlarge
- stream.compute.2xlarge
- stream.compute.4xlarge
- stream.compute.8xlarge
- stream.memory.large
- stream.memory.xlarge
- stream.memory.2xlarge
- stream.memory.4xlarge
- stream.memory.8xlarge
- stream.memory.z1d.large
- stream.memory.z1d.xlarge
- stream.memory.z1d.2xlarge
- stream.memory.z1d.3xlarge
- stream.memory.z1d.6xlarge
- stream.memory.z1d.12xlarge
- stream.graphics-design.large
- stream.graphics-design.xlarge
- stream.graphics-design.2xlarge
- stream.graphics-design.4xlarge
- stream.graphics-desktop.2xlarge
- stream.graphics.g4dn.xlarge
- stream.graphics.g4dn.2xlarge
- stream.graphics.g4dn.4xlarge
- stream.graphics.g4dn.8xlarge
- stream.graphics.g4dn.12xlarge
- stream.graphics.g4dn.16xlarge
- stream.graphics-pro.4xlarge
- stream.graphics-pro.8xlarge
- stream.graphics-pro.16xlarge
fleet_computeCapacityStatus :: Lens' Fleet ComputeCapacityStatus Source #
The capacity status for the fleet.
fleet_state :: Lens' Fleet FleetState Source #
The current state for the fleet.
FleetError
data FleetError Source #
Describes a fleet error.
See: newFleetError
smart constructor.
FleetError' | |
|
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.
fleetError_errorCode :: Lens' FleetError (Maybe FleetErrorCode) Source #
The error code.
fleetError_errorMessage :: Lens' FleetError (Maybe Text) Source #
The error message.
Image
Describes an image.
See: newImage
smart constructor.
Image' | |
|
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.
image_applications :: Lens' Image (Maybe [Application]) Source #
The applications associated with the image.
image_appstreamAgentVersion :: Lens' Image (Maybe Text) Source #
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
image_baseImageArn :: Lens' Image (Maybe Text) Source #
The ARN of the image from which this image was created.
image_imageBuilderName :: Lens' Image (Maybe Text) Source #
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
image_imageBuilderSupported :: Lens' Image (Maybe Bool) Source #
Indicates whether an image builder can be launched from this image.
image_imageErrors :: Lens' Image (Maybe [ResourceError]) Source #
Describes the errors that are returned when a new image can't be created.
image_imagePermissions :: Lens' Image (Maybe ImagePermissions) Source #
The permissions to provide to the destination AWS account for the specified image.
image_platform :: Lens' Image (Maybe PlatformType) Source #
The operating system platform of the image.
image_publicBaseImageReleasedDate :: Lens' Image (Maybe UTCTime) Source #
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
image_state :: Lens' Image (Maybe ImageState) Source #
The image starts in the PENDING
state. If image creation succeeds, the
state is AVAILABLE
. If image creation fails, the state is FAILED
.
image_stateChangeReason :: Lens' Image (Maybe ImageStateChangeReason) Source #
The reason why the last state change occurred.
image_visibility :: Lens' Image (Maybe VisibilityType) Source #
Indicates whether the image is public or private.
ImageBuilder
data ImageBuilder Source #
Describes a virtual machine that is used to create an image.
See: newImageBuilder
smart constructor.
ImageBuilder' | |
|
Instances
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.
imageBuilder_accessEndpoints :: Lens' ImageBuilder (Maybe (NonEmpty AccessEndpoint)) Source #
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
imageBuilder_appstreamAgentVersion :: Lens' ImageBuilder (Maybe Text) Source #
The version of the AppStream 2.0 agent that is currently being used by the image builder.
imageBuilder_arn :: Lens' ImageBuilder (Maybe Text) Source #
The ARN for the image builder.
imageBuilder_createdTime :: Lens' ImageBuilder (Maybe UTCTime) Source #
The time stamp when the image builder was created.
imageBuilder_description :: Lens' ImageBuilder (Maybe Text) Source #
The description to display.
imageBuilder_displayName :: Lens' ImageBuilder (Maybe Text) Source #
The image builder name to display.
imageBuilder_domainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo) Source #
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
imageBuilder_enableDefaultInternetAccess :: Lens' ImageBuilder (Maybe Bool) Source #
Enables or disables default internet access for the image builder.
imageBuilder_iamRoleArn :: Lens' ImageBuilder (Maybe Text) Source #
The ARN of the IAM role that is applied to the image builder. To assume
a role, the image builder calls the AWS Security Token Service (STS)
AssumeRole
API operation and passes the ARN of the role to use. The
operation creates a new session with temporary credentials. AppStream
2.0 retrieves the temporary credentials and creates the
appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
imageBuilder_imageArn :: Lens' ImageBuilder (Maybe Text) Source #
The ARN of the image from which this builder was created.
imageBuilder_imageBuilderErrors :: Lens' ImageBuilder (Maybe [ResourceError]) Source #
The image builder errors.
imageBuilder_instanceType :: Lens' ImageBuilder (Maybe Text) Source #
The instance type for the image builder. The following instance types are available:
- stream.standard.small
- stream.standard.medium
- stream.standard.large
- stream.compute.large
- stream.compute.xlarge
- stream.compute.2xlarge
- stream.compute.4xlarge
- stream.compute.8xlarge
- stream.memory.large
- stream.memory.xlarge
- stream.memory.2xlarge
- stream.memory.4xlarge
- stream.memory.8xlarge
- stream.memory.z1d.large
- stream.memory.z1d.xlarge
- stream.memory.z1d.2xlarge
- stream.memory.z1d.3xlarge
- stream.memory.z1d.6xlarge
- stream.memory.z1d.12xlarge
- stream.graphics-design.large
- stream.graphics-design.xlarge
- stream.graphics-design.2xlarge
- stream.graphics-design.4xlarge
- stream.graphics-desktop.2xlarge
- stream.graphics.g4dn.xlarge
- stream.graphics.g4dn.2xlarge
- stream.graphics.g4dn.4xlarge
- stream.graphics.g4dn.8xlarge
- stream.graphics.g4dn.12xlarge
- stream.graphics.g4dn.16xlarge
- stream.graphics-pro.4xlarge
- stream.graphics-pro.8xlarge
- stream.graphics-pro.16xlarge
imageBuilder_networkAccessConfiguration :: Lens' ImageBuilder (Maybe NetworkAccessConfiguration) Source #
Undocumented member.
imageBuilder_platform :: Lens' ImageBuilder (Maybe PlatformType) Source #
The operating system platform of the image builder.
imageBuilder_state :: Lens' ImageBuilder (Maybe ImageBuilderState) Source #
The state of the image builder.
imageBuilder_stateChangeReason :: Lens' ImageBuilder (Maybe ImageBuilderStateChangeReason) Source #
The reason why the last state change occurred.
imageBuilder_vpcConfig :: Lens' ImageBuilder (Maybe VpcConfig) Source #
The VPC configuration of the image builder.
imageBuilder_name :: Lens' ImageBuilder Text Source #
The name of the image builder.
ImageBuilderStateChangeReason
data ImageBuilderStateChangeReason Source #
Describes the reason why the last image builder state change occurred.
See: newImageBuilderStateChangeReason
smart constructor.
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.
imageBuilderStateChangeReason_code :: Lens' ImageBuilderStateChangeReason (Maybe ImageBuilderStateChangeReasonCode) Source #
The state change reason code.
imageBuilderStateChangeReason_message :: Lens' ImageBuilderStateChangeReason (Maybe Text) Source #
The state change reason message.
ImagePermissions
data ImagePermissions Source #
Describes the permissions for an image.
See: newImagePermissions
smart constructor.
ImagePermissions' | |
|
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.
imagePermissions_allowFleet :: Lens' ImagePermissions (Maybe Bool) Source #
Indicates whether the image can be used for a fleet.
imagePermissions_allowImageBuilder :: Lens' ImagePermissions (Maybe Bool) Source #
Indicates whether the image can be used for an image builder.
ImageStateChangeReason
data ImageStateChangeReason Source #
Describes the reason why the last image state change occurred.
See: newImageStateChangeReason
smart constructor.
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.
imageStateChangeReason_code :: Lens' ImageStateChangeReason (Maybe ImageStateChangeReasonCode) Source #
The state change reason code.
imageStateChangeReason_message :: Lens' ImageStateChangeReason (Maybe Text) Source #
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.
LastReportGenerationExecutionError' | |
|
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.
lastReportGenerationExecutionError_errorCode :: Lens' LastReportGenerationExecutionError (Maybe UsageReportExecutionErrorCode) Source #
The error code for the error that is returned when a usage report can't be generated.
lastReportGenerationExecutionError_errorMessage :: Lens' LastReportGenerationExecutionError (Maybe Text) Source #
The error message for the error that is returned when a usage report can't be generated.
NetworkAccessConfiguration
data NetworkAccessConfiguration Source #
Describes the network details of the fleet or image builder instance.
See: newNetworkAccessConfiguration
smart constructor.
NetworkAccessConfiguration' | |
|
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.
networkAccessConfiguration_eniId :: Lens' NetworkAccessConfiguration (Maybe Text) Source #
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
networkAccessConfiguration_eniPrivateIpAddress :: Lens' NetworkAccessConfiguration (Maybe Text) Source #
The private IP address of the elastic network interface that is attached to instances in your VPC.
ResourceError
data ResourceError Source #
Describes a resource error.
See: newResourceError
smart constructor.
ResourceError' | |
|
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.
resourceError_errorCode :: Lens' ResourceError (Maybe FleetErrorCode) Source #
The error code.
resourceError_errorMessage :: Lens' ResourceError (Maybe Text) Source #
The error message.
resourceError_errorTimestamp :: Lens' ResourceError (Maybe UTCTime) Source #
The time the error occurred.
S3Location
data S3Location Source #
Describes the S3 location.
See: newS3Location
smart constructor.
Instances
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.
s3Location_s3Bucket :: Lens' S3Location Text Source #
The S3 bucket of the S3 object.
s3Location_s3Key :: Lens' S3Location Text Source #
The S3 key of the S3 object.
ScriptDetails
data ScriptDetails Source #
Describes the details of the script.
See: newScriptDetails
smart constructor.
ScriptDetails' | |
|
Instances
:: 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.
scriptDetails_executableParameters :: Lens' ScriptDetails (Maybe Text) Source #
The runtime parameters passed to the run path for the script.
scriptDetails_scriptS3Location :: Lens' ScriptDetails S3Location Source #
The S3 object location for the script.
scriptDetails_executablePath :: Lens' ScriptDetails Text Source #
The run path for the script.
scriptDetails_timeoutInSeconds :: Lens' ScriptDetails Int Source #
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.
ServiceAccountCredentials' | |
|
Instances
newServiceAccountCredentials Source #
:: 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.
serviceAccountCredentials_accountName :: Lens' ServiceAccountCredentials Text Source #
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
serviceAccountCredentials_accountPassword :: Lens' ServiceAccountCredentials Text Source #
The password for the account.
Session
Describes a streaming session.
See: newSession
smart constructor.
Session' | |
|
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.
session_authenticationType :: Lens' Session (Maybe AuthenticationType) Source #
The authentication method. The user is authenticated using a streaming
URL (API
) or SAML 2.0 federation (SAML
).
session_connectionState :: Lens' Session (Maybe SessionConnectionState) Source #
Specifies whether a user is connected to the streaming session.
session_maxExpirationTime :: Lens' Session (Maybe UTCTime) Source #
The time when the streaming session is set to expire. This time is based
on the MaxUserDurationinSeconds
value, which determines the maximum
length of time that a streaming session can run. A streaming session
might end earlier than the time specified in SessionMaxExpirationTime
,
when the DisconnectTimeOutInSeconds
elapses or the user chooses to end
his or her session. If the DisconnectTimeOutInSeconds
elapses, or the
user chooses to end his or her session, the streaming instance is
terminated and the streaming session ends.
session_networkAccessConfiguration :: Lens' Session (Maybe NetworkAccessConfiguration) Source #
The network details for the streaming session.
session_startTime :: Lens' Session (Maybe UTCTime) Source #
The time when a streaming instance is dedicated for the user.
session_userId :: Lens' Session Text Source #
The identifier of the user for whom the session was created.
session_state :: Lens' Session SessionState Source #
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.
SharedImagePermissions' | |
|
Instances
newSharedImagePermissions Source #
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.
sharedImagePermissions_sharedAccountId :: Lens' SharedImagePermissions Text Source #
The 12-digit identifier of the AWS account with which the image is shared.
sharedImagePermissions_imagePermissions :: Lens' SharedImagePermissions ImagePermissions Source #
Describes the permissions for a shared image.
Stack
Describes a stack.
See: newStack
smart constructor.
Stack' | |
|
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.
stack_accessEndpoints :: Lens' Stack (Maybe (NonEmpty AccessEndpoint)) Source #
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
stack_applicationSettings :: Lens' Stack (Maybe ApplicationSettingsResponse) Source #
The persistent application settings for users of the stack.
stack_embedHostDomains :: Lens' Stack (Maybe (NonEmpty Text)) Source #
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
stack_feedbackURL :: Lens' Stack (Maybe Text) Source #
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
stack_redirectURL :: Lens' Stack (Maybe Text) Source #
The URL that users are redirected to after their streaming session ends.
stack_stackErrors :: Lens' Stack (Maybe [StackError]) Source #
The errors for the stack.
stack_storageConnectors :: Lens' Stack (Maybe [StorageConnector]) Source #
The storage connectors to enable.
stack_streamingExperienceSettings :: Lens' Stack (Maybe StreamingExperienceSettings) Source #
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
stack_userSettings :: Lens' Stack (Maybe (NonEmpty UserSetting)) Source #
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
StackError
data StackError Source #
Describes a stack error.
See: newStackError
smart constructor.
StackError' | |
|
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.
stackError_errorCode :: Lens' StackError (Maybe StackErrorCode) Source #
The error code.
stackError_errorMessage :: Lens' StackError (Maybe Text) Source #
The error message.
StorageConnector
data StorageConnector Source #
Describes a connector that enables persistent storage for users.
See: newStorageConnector
smart constructor.
StorageConnector' | |
|
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.
storageConnector_domains :: Lens' StorageConnector (Maybe [Text]) Source #
The names of the domains for the account.
storageConnector_resourceIdentifier :: Lens' StorageConnector (Maybe Text) Source #
The ARN of the storage connector.
storageConnector_connectorType :: Lens' StorageConnector StorageConnectorType Source #
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.
StreamingExperienceSettings' | |
|
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.
streamingExperienceSettings_preferredProtocol :: Lens' StreamingExperienceSettings (Maybe PreferredProtocol) Source #
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.
UsageReportSubscription' | |
|
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.
usageReportSubscription_lastGeneratedReportDate :: Lens' UsageReportSubscription (Maybe UTCTime) Source #
The time when the last usage report was generated.
usageReportSubscription_s3BucketName :: Lens' UsageReportSubscription (Maybe Text) Source #
The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
usageReportSubscription_schedule :: Lens' UsageReportSubscription (Maybe UsageReportSchedule) Source #
The schedule for generating usage reports.
usageReportSubscription_subscriptionErrors :: Lens' UsageReportSubscription (Maybe [LastReportGenerationExecutionError]) Source #
The errors that were returned if usage reports couldn't be generated.
User
Describes a user in the user pool.
See: newUser
smart constructor.
User' | |
|
Instances
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.
user_createdTime :: Lens' User (Maybe UTCTime) Source #
The date and time the user was created in the user pool.
user_enabled :: Lens' User (Maybe Bool) Source #
Specifies whether the user in the user pool is enabled.
user_status :: Lens' User (Maybe Text) Source #
The status of the user in the user pool. The status can be one of the following:
- UNCONFIRMED – The user is created but not confirmed.
- CONFIRMED – The user is confirmed.
- ARCHIVED – The user is no longer active.
- COMPROMISED – The user is disabled because of a potential security threat.
- UNKNOWN – The user status is not known.
user_userName :: Lens' User (Maybe Text) Source #
The email address of the user.
Users' email addresses are case-sensitive.
user_authenticationType :: Lens' User AuthenticationType Source #
The authentication type for the user.
UserSetting
data UserSetting Source #
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
See: newUserSetting
smart constructor.
UserSetting' | |
|
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.
userSetting_action :: Lens' UserSetting Action Source #
The action that is enabled or disabled.
userSetting_permission :: Lens' UserSetting Permission Source #
Indicates whether the action is enabled or disabled.
UserStackAssociation
data UserStackAssociation Source #
Describes a user in the user pool and the associated stack.
See: newUserStackAssociation
smart constructor.
UserStackAssociation' | |
|
Instances
newUserStackAssociation Source #
:: 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.
userStackAssociation_sendEmailNotification :: Lens' UserStackAssociation (Maybe Bool) Source #
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
userStackAssociation_stackName :: Lens' UserStackAssociation Text Source #
The name of the stack that is associated with the user.
userStackAssociation_userName :: Lens' UserStackAssociation Text Source #
The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
userStackAssociation_authenticationType :: Lens' UserStackAssociation AuthenticationType Source #
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.
UserStackAssociationError' | |
|
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.
userStackAssociationError_errorCode :: Lens' UserStackAssociationError (Maybe UserStackAssociationErrorCode) Source #
The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
userStackAssociationError_errorMessage :: Lens' UserStackAssociationError (Maybe Text) Source #
The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
userStackAssociationError_userStackAssociation :: Lens' UserStackAssociationError (Maybe UserStackAssociation) Source #
Information about the user and associated stack.
VpcConfig
Describes VPC configuration information for fleets and image builders.
See: newVpcConfig
smart constructor.
VpcConfig' | |
|
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.