| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.AppStream
Contents
- Service Configuration
- Errors
- InvalidRoleException
- ResourceAlreadyExistsException
- IncompatibleImageException
- ConcurrentModificationException
- OperationNotPermittedException
- InvalidAccountStatusException
- ResourceNotFoundException
- InvalidParameterCombinationException
- ResourceNotAvailableException
- LimitExceededException
- ResourceInUseException
- Waiters
- Operations
- DisassociateFleet
- ListAssociatedFleets
- DeleteStack
- UpdateStack
- CreateDirectoryConfig
- ListAssociatedStacks
- DeleteFleet
- UpdateFleet
- DeleteImageBuilder
- AssociateFleet
- CreateImageBuilder
- ListTagsForResource
- DescribeDirectoryConfigs
- CreateImageBuilderStreamingURL
- DescribeSessions
- DescribeStacks
- DescribeFleets
- DescribeImageBuilders
- StopFleet
- StartImageBuilder
- DeleteDirectoryConfig
- UpdateDirectoryConfig
- CreateFleet
- CreateStack
- CopyImage
- ExpireSession
- TagResource
- CreateStreamingURL
- UntagResource
- StartFleet
- StopImageBuilder
- DeleteImage
- DescribeImages
- Types
- AuthenticationType
- FleetAttribute
- FleetErrorCode
- FleetState
- FleetType
- ImageBuilderState
- ImageBuilderStateChangeReasonCode
- ImageState
- ImageStateChangeReasonCode
- PlatformType
- SessionState
- StackAttribute
- StackErrorCode
- StorageConnectorType
- VisibilityType
- Application
- ComputeCapacity
- ComputeCapacityStatus
- DirectoryConfig
- DomainJoinInfo
- Fleet
- FleetError
- Image
- ImageBuilder
- ImageBuilderStateChangeReason
- ImageStateChangeReason
- ResourceError
- ServiceAccountCredentials
- Session
- Stack
- StackError
- StorageConnector
- VPCConfig
Description
Amazon AppStream 2.0
You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.
Synopsis
- appStream :: Service
- _InvalidRoleException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _IncompatibleImageException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidAccountStatusException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotAvailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- fleetStopped :: Wait DescribeFleets
- fleetStarted :: Wait DescribeFleets
- module Network.AWS.AppStream.DisassociateFleet
- module Network.AWS.AppStream.ListAssociatedFleets
- module Network.AWS.AppStream.DeleteStack
- module Network.AWS.AppStream.UpdateStack
- module Network.AWS.AppStream.CreateDirectoryConfig
- module Network.AWS.AppStream.ListAssociatedStacks
- module Network.AWS.AppStream.DeleteFleet
- module Network.AWS.AppStream.UpdateFleet
- module Network.AWS.AppStream.DeleteImageBuilder
- module Network.AWS.AppStream.AssociateFleet
- module Network.AWS.AppStream.CreateImageBuilder
- module Network.AWS.AppStream.ListTagsForResource
- module Network.AWS.AppStream.DescribeDirectoryConfigs
- module Network.AWS.AppStream.CreateImageBuilderStreamingURL
- module Network.AWS.AppStream.DescribeSessions
- module Network.AWS.AppStream.DescribeStacks
- module Network.AWS.AppStream.DescribeFleets
- module Network.AWS.AppStream.DescribeImageBuilders
- module Network.AWS.AppStream.StopFleet
- module Network.AWS.AppStream.StartImageBuilder
- module Network.AWS.AppStream.DeleteDirectoryConfig
- module Network.AWS.AppStream.UpdateDirectoryConfig
- module Network.AWS.AppStream.CreateFleet
- module Network.AWS.AppStream.CreateStack
- module Network.AWS.AppStream.CopyImage
- module Network.AWS.AppStream.ExpireSession
- module Network.AWS.AppStream.TagResource
- module Network.AWS.AppStream.CreateStreamingURL
- module Network.AWS.AppStream.UntagResource
- module Network.AWS.AppStream.StartFleet
- module Network.AWS.AppStream.StopImageBuilder
- module Network.AWS.AppStream.DeleteImage
- module Network.AWS.AppStream.DescribeImages
- data AuthenticationType
- data FleetAttribute
- data FleetErrorCode
- = DomainJoinErrorAccessDenied
- | DomainJoinErrorDsMachineAccountQuotaExceeded
- | DomainJoinErrorFileNotFound
- | DomainJoinErrorInvalidParameter
- | DomainJoinErrorLogonFailure
- | DomainJoinErrorMoreData
- | DomainJoinErrorNoSuchDomain
- | DomainJoinErrorNotSupported
- | DomainJoinInternalServiceError
- | DomainJoinNerrInvalidWorkgroupName
- | DomainJoinNerrPasswordExpired
- | DomainJoinNerrWorkstationNotStarted
- | IAMServiceRoleIsMissing
- | IAMServiceRoleMissingDescribeSecurityGroupsAction
- | IAMServiceRoleMissingDescribeSubnetAction
- | IAMServiceRoleMissingEniCreateAction
- | IAMServiceRoleMissingEniDeleteAction
- | IAMServiceRoleMissingEniDescribeAction
- | IgwNotAttached
- | ImageNotFound
- | InternalServiceError
- | InvalidSubnetConfiguration
- | NetworkInterfaceLimitExceeded
- | SecurityGroupsNotFound
- | SubnetHasInsufficientIPAddresses
- | SubnetNotFound
- data FleetState
- data FleetType
- data ImageBuilderState
- data ImageBuilderStateChangeReasonCode
- data ImageState
- data ImageStateChangeReasonCode
- data PlatformType = Windows
- data SessionState
- data StackAttribute
- data StackErrorCode
- data StorageConnectorType = Homefolders
- data VisibilityType
- data Application
- application :: Application
- aEnabled :: Lens' Application (Maybe Bool)
- aLaunchPath :: Lens' Application (Maybe Text)
- aLaunchParameters :: Lens' Application (Maybe Text)
- aName :: Lens' Application (Maybe Text)
- aDisplayName :: Lens' Application (Maybe Text)
- aMetadata :: Lens' Application (HashMap Text Text)
- aIconURL :: Lens' Application (Maybe Text)
- data ComputeCapacity
- computeCapacity :: Int -> ComputeCapacity
- ccDesiredInstances :: Lens' ComputeCapacity Int
- data ComputeCapacityStatus
- computeCapacityStatus :: Int -> ComputeCapacityStatus
- ccsInUse :: Lens' ComputeCapacityStatus (Maybe Int)
- ccsRunning :: Lens' ComputeCapacityStatus (Maybe Int)
- ccsAvailable :: Lens' ComputeCapacityStatus (Maybe Int)
- ccsDesired :: Lens' ComputeCapacityStatus Int
- data DirectoryConfig
- directoryConfig :: Text -> DirectoryConfig
- dcCreatedTime :: Lens' DirectoryConfig (Maybe UTCTime)
- dcServiceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials)
- dcOrganizationalUnitDistinguishedNames :: Lens' DirectoryConfig [Text]
- dcDirectoryName :: Lens' DirectoryConfig Text
- data DomainJoinInfo
- domainJoinInfo :: DomainJoinInfo
- djiOrganizationalUnitDistinguishedName :: Lens' DomainJoinInfo (Maybe Text)
- djiDirectoryName :: Lens' DomainJoinInfo (Maybe Text)
- data Fleet
- fleet :: Text -> Text -> Text -> Text -> ComputeCapacityStatus -> FleetState -> Fleet
- fDomainJoinInfo :: Lens' Fleet (Maybe DomainJoinInfo)
- fDisconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int)
- fMaxUserDurationInSeconds :: Lens' Fleet (Maybe Int)
- fCreatedTime :: Lens' Fleet (Maybe UTCTime)
- fFleetType :: Lens' Fleet (Maybe FleetType)
- fVPCConfig :: Lens' Fleet (Maybe VPCConfig)
- fFleetErrors :: Lens' Fleet [FleetError]
- fDisplayName :: Lens' Fleet (Maybe Text)
- fEnableDefaultInternetAccess :: Lens' Fleet (Maybe Bool)
- fDescription :: Lens' Fleet (Maybe Text)
- fARN :: Lens' Fleet Text
- fName :: Lens' Fleet Text
- fImageName :: Lens' Fleet Text
- fInstanceType :: Lens' Fleet Text
- fComputeCapacityStatus :: Lens' Fleet ComputeCapacityStatus
- fState :: Lens' Fleet FleetState
- data FleetError
- fleetError :: FleetError
- feErrorCode :: Lens' FleetError (Maybe FleetErrorCode)
- feErrorMessage :: Lens' FleetError (Maybe Text)
- data Image
- image :: Text -> Image
- iState :: Lens' Image (Maybe ImageState)
- iPlatform :: Lens' Image (Maybe PlatformType)
- iPublicBaseImageReleasedDate :: Lens' Image (Maybe UTCTime)
- iStateChangeReason :: Lens' Image (Maybe ImageStateChangeReason)
- iARN :: Lens' Image (Maybe Text)
- iCreatedTime :: Lens' Image (Maybe UTCTime)
- iImageBuilderSupported :: Lens' Image (Maybe Bool)
- iVisibility :: Lens' Image (Maybe VisibilityType)
- iBaseImageARN :: Lens' Image (Maybe Text)
- iDisplayName :: Lens' Image (Maybe Text)
- iDescription :: Lens' Image (Maybe Text)
- iAppstreamAgentVersion :: Lens' Image (Maybe Text)
- iApplications :: Lens' Image [Application]
- iName :: Lens' Image Text
- data ImageBuilder
- imageBuilder :: Text -> ImageBuilder
- ibDomainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo)
- ibState :: Lens' ImageBuilder (Maybe ImageBuilderState)
- ibPlatform :: Lens' ImageBuilder (Maybe PlatformType)
- ibStateChangeReason :: Lens' ImageBuilder (Maybe ImageBuilderStateChangeReason)
- ibARN :: Lens' ImageBuilder (Maybe Text)
- ibCreatedTime :: Lens' ImageBuilder (Maybe UTCTime)
- ibImageBuilderErrors :: Lens' ImageBuilder [ResourceError]
- ibInstanceType :: Lens' ImageBuilder (Maybe Text)
- ibVPCConfig :: Lens' ImageBuilder (Maybe VPCConfig)
- ibImageARN :: Lens' ImageBuilder (Maybe Text)
- ibDisplayName :: Lens' ImageBuilder (Maybe Text)
- ibEnableDefaultInternetAccess :: Lens' ImageBuilder (Maybe Bool)
- ibDescription :: Lens' ImageBuilder (Maybe Text)
- ibAppstreamAgentVersion :: Lens' ImageBuilder (Maybe Text)
- ibName :: Lens' ImageBuilder Text
- data ImageBuilderStateChangeReason
- imageBuilderStateChangeReason :: ImageBuilderStateChangeReason
- ibscrCode :: Lens' ImageBuilderStateChangeReason (Maybe ImageBuilderStateChangeReasonCode)
- ibscrMessage :: Lens' ImageBuilderStateChangeReason (Maybe Text)
- data ImageStateChangeReason
- imageStateChangeReason :: ImageStateChangeReason
- iscrCode :: Lens' ImageStateChangeReason (Maybe ImageStateChangeReasonCode)
- iscrMessage :: Lens' ImageStateChangeReason (Maybe Text)
- data ResourceError
- resourceError :: ResourceError
- reErrorCode :: Lens' ResourceError (Maybe FleetErrorCode)
- reErrorMessage :: Lens' ResourceError (Maybe Text)
- reErrorTimestamp :: Lens' ResourceError (Maybe UTCTime)
- data ServiceAccountCredentials
- serviceAccountCredentials :: Text -> Text -> ServiceAccountCredentials
- sacAccountName :: Lens' ServiceAccountCredentials Text
- sacAccountPassword :: Lens' ServiceAccountCredentials Text
- data Session
- session :: Text -> Text -> Text -> Text -> SessionState -> Session
- sAuthenticationType :: Lens' Session (Maybe AuthenticationType)
- sId :: Lens' Session Text
- sUserId :: Lens' Session Text
- sStackName :: Lens' Session Text
- sFleetName :: Lens' Session Text
- sState :: Lens' Session SessionState
- data Stack
- stack :: Text -> Stack
- sFeedbackURL :: Lens' Stack (Maybe Text)
- sARN :: Lens' Stack (Maybe Text)
- sCreatedTime :: Lens' Stack (Maybe UTCTime)
- sStorageConnectors :: Lens' Stack [StorageConnector]
- sDisplayName :: Lens' Stack (Maybe Text)
- sStackErrors :: Lens' Stack [StackError]
- sDescription :: Lens' Stack (Maybe Text)
- sRedirectURL :: Lens' Stack (Maybe Text)
- sName :: Lens' Stack Text
- data StackError
- stackError :: StackError
- seErrorCode :: Lens' StackError (Maybe StackErrorCode)
- seErrorMessage :: Lens' StackError (Maybe Text)
- data StorageConnector
- storageConnector :: StorageConnectorType -> StorageConnector
- scResourceIdentifier :: Lens' StorageConnector (Maybe Text)
- scConnectorType :: Lens' StorageConnector StorageConnectorType
- data VPCConfig
- vpcConfig :: VPCConfig
- vcSecurityGroupIds :: Lens' VPCConfig [Text]
- vcSubnetIds :: Lens' VPCConfig [Text]
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AppStream.
InvalidRoleException
_InvalidRoleException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified role is invalid.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource already exists.
IncompatibleImageException
_IncompatibleImageException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The image does not support storage connectors.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An API error occurred. Wait a few minutes and try again.
OperationNotPermittedException
_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The attempted operation is not permitted.
InvalidAccountStatusException
_InvalidAccountStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource was not found.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates an incorrect combination of parameters, or a missing parameter.
ResourceNotAvailableException
_ResourceNotAvailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource exists and is not in use, but isn't available.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested limit exceeds the permitted limit for an account.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is in use.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
FleetStopped
fleetStopped :: Wait DescribeFleets Source #
Polls DescribeFleets every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
FleetStarted
fleetStarted :: Wait DescribeFleets Source #
Polls DescribeFleets every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DisassociateFleet
ListAssociatedFleets
DeleteStack
UpdateStack
CreateDirectoryConfig
ListAssociatedStacks
DeleteFleet
UpdateFleet
DeleteImageBuilder
AssociateFleet
CreateImageBuilder
ListTagsForResource
DescribeDirectoryConfigs
CreateImageBuilderStreamingURL
DescribeSessions
DescribeStacks
DescribeFleets
DescribeImageBuilders
StopFleet
StartImageBuilder
DeleteDirectoryConfig
UpdateDirectoryConfig
CreateFleet
CreateStack
CopyImage
ExpireSession
TagResource
CreateStreamingURL
UntagResource
StartFleet
StopImageBuilder
DeleteImage
DescribeImages
Types
AuthenticationType
data AuthenticationType Source #
Instances
FleetAttribute
data FleetAttribute Source #
The fleet attribute.
Instances
FleetErrorCode
data FleetErrorCode Source #
Constructors
Instances
FleetState
data FleetState Source #
Instances
FleetType
Instances
ImageBuilderState
data ImageBuilderState Source #
Constructors
| IBSDeleting | |
| IBSFailed | |
| IBSPending | |
| IBSRebooting | |
| IBSRunning | |
| IBSSnapshotting | |
| IBSStopped | |
| IBSStopping | |
| IBSUpdatingAgent |
Instances
ImageBuilderStateChangeReasonCode
data ImageBuilderStateChangeReasonCode Source #
Constructors
| ImageUnavailable | |
| InternalError |
Instances
ImageState
data ImageState Source #
Constructors
| ISAvailable | |
| ISCopying | |
| ISDeleting | |
| ISFailed | |
| ISPending |
Instances
ImageStateChangeReasonCode
data ImageStateChangeReasonCode Source #
Instances
PlatformType
data PlatformType Source #
Constructors
| Windows |
Instances
SessionState
data SessionState Source #
Possible values for the state of a streaming session.
Instances
StackAttribute
data StackAttribute Source #
Constructors
| FeedbackURL | |
| RedirectURL | |
| StorageConnectors | |
| ThemeName |
Instances
StackErrorCode
data StackErrorCode Source #
Constructors
| SECInternalServiceError | |
| SECStorageConnectorError |
Instances
StorageConnectorType
data StorageConnectorType Source #
The type of storage connector.
Constructors
| Homefolders |
Instances
VisibilityType
data VisibilityType Source #
Instances
Application
data Application Source #
Describes an application in the application catalog.
See: application smart constructor.
Instances
application :: Application Source #
Creates a value of Application with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aEnabled- If there is a problem, the application can be disabled after image creation.aLaunchPath- The path to the application executable in the instance.aLaunchParameters- The arguments that are passed to the application at launch.aName- The name of the application.aDisplayName- The application name for display.aMetadata- Additional attributes that describe the application.aIconURL- The URL for the application icon. This URL might be time-limited.
aEnabled :: Lens' Application (Maybe Bool) Source #
If there is a problem, the application can be disabled after image creation.
aLaunchPath :: Lens' Application (Maybe Text) Source #
The path to the application executable in the instance.
aLaunchParameters :: Lens' Application (Maybe Text) Source #
The arguments that are passed to the application at launch.
aDisplayName :: Lens' Application (Maybe Text) Source #
The application name for display.
aMetadata :: Lens' Application (HashMap Text Text) Source #
Additional attributes that describe the application.
aIconURL :: Lens' Application (Maybe Text) Source #
The URL for the application icon. This URL might be time-limited.
ComputeCapacity
data ComputeCapacity Source #
Describes the capacity for a fleet.
See: computeCapacity smart constructor.
Instances
Arguments
| :: Int | |
| -> ComputeCapacity |
Creates a value of ComputeCapacity with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccDesiredInstances- The desired number of streaming instances.
ccDesiredInstances :: Lens' ComputeCapacity Int Source #
The desired number of streaming instances.
ComputeCapacityStatus
data ComputeCapacityStatus Source #
Describes the capacity status for a fleet.
See: computeCapacityStatus smart constructor.
Instances
computeCapacityStatus Source #
Arguments
| :: Int | |
| -> ComputeCapacityStatus |
Creates a value of ComputeCapacityStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccsInUse- The number of instances in use for streaming.ccsRunning- The total number of simultaneous streaming instances that are running.ccsAvailable- The number of currently available instances that can be used to stream sessions.ccsDesired- The desired number of streaming instances.
ccsInUse :: Lens' ComputeCapacityStatus (Maybe Int) Source #
The number of instances in use for streaming.
ccsRunning :: Lens' ComputeCapacityStatus (Maybe Int) Source #
The total number of simultaneous streaming instances that are running.
ccsAvailable :: Lens' ComputeCapacityStatus (Maybe Int) Source #
The number of currently available instances that can be used to stream sessions.
ccsDesired :: Lens' ComputeCapacityStatus Int Source #
The desired number of streaming instances.
DirectoryConfig
data DirectoryConfig Source #
Configuration information for the directory used to join domains.
See: directoryConfig smart constructor.
Instances
Arguments
| :: Text | |
| -> DirectoryConfig |
Creates a value of DirectoryConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcCreatedTime- The time the directory configuration was created.dcServiceAccountCredentials- The credentials for the service account used by the streaming instance to connect to the directory.dcOrganizationalUnitDistinguishedNames- The distinguished names of the organizational units for computer accounts.dcDirectoryName- The fully qualified name of the directory (for example, corp.example.com).
dcCreatedTime :: Lens' DirectoryConfig (Maybe UTCTime) Source #
The time the directory configuration was created.
dcServiceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials) Source #
The credentials for the service account used by the streaming instance to connect to the directory.
dcOrganizationalUnitDistinguishedNames :: Lens' DirectoryConfig [Text] Source #
The distinguished names of the organizational units for computer accounts.
dcDirectoryName :: Lens' DirectoryConfig Text Source #
The fully qualified name of the directory (for example, corp.example.com).
DomainJoinInfo
data DomainJoinInfo Source #
Contains the information needed to join a Microsoft Active Directory domain.
See: domainJoinInfo smart constructor.
Instances
domainJoinInfo :: DomainJoinInfo Source #
Creates a value of DomainJoinInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
djiOrganizationalUnitDistinguishedName- The distinguished name of the organizational unit for computer accounts.djiDirectoryName- The fully qualified name of the directory (for example, corp.example.com).
djiOrganizationalUnitDistinguishedName :: Lens' DomainJoinInfo (Maybe Text) Source #
The distinguished name of the organizational unit for computer accounts.
djiDirectoryName :: Lens' DomainJoinInfo (Maybe Text) Source #
The fully qualified name of the directory (for example, corp.example.com).
Fleet
Contains the parameters for a fleet.
See: fleet smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ComputeCapacityStatus | |
| -> FleetState | |
| -> Fleet |
Creates a value of Fleet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fDomainJoinInfo- The information needed to join a Microsoft Active Directory domain.fDisconnectTimeoutInSeconds- The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.fMaxUserDurationInSeconds- The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.fCreatedTime- The time the fleet was created.fFleetType- 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.fVPCConfig- The VPC configuration for the fleet.fFleetErrors- The fleet errors.fDisplayName- The fleet name for display.fEnableDefaultInternetAccess- Indicates whether default internet access is enabled for the fleet.fDescription- The description for display.fARN- The ARN for the fleet.fName- The name of the fleet.fImageName- The name of the image used to create the fleet.fInstanceType- The instance type to use when launching fleet instances.fComputeCapacityStatus- The capacity status for the fleet.fState- The current state for the fleet.
fDomainJoinInfo :: Lens' Fleet (Maybe DomainJoinInfo) Source #
The information needed to join a Microsoft Active Directory domain.
fDisconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int) Source #
The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.
fMaxUserDurationInSeconds :: Lens' Fleet (Maybe Int) Source #
The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.
fFleetType :: 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.
fFleetErrors :: Lens' Fleet [FleetError] Source #
The fleet errors.
fEnableDefaultInternetAccess :: Lens' Fleet (Maybe Bool) Source #
Indicates whether default internet access is enabled for the fleet.
fComputeCapacityStatus :: Lens' Fleet ComputeCapacityStatus Source #
The capacity status for the fleet.
FleetError
data FleetError Source #
Describes a fleet error.
See: fleetError smart constructor.
Instances
fleetError :: FleetError Source #
Creates a value of FleetError with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
feErrorCode- The error code.feErrorMessage- The error message.
feErrorCode :: Lens' FleetError (Maybe FleetErrorCode) Source #
The error code.
feErrorMessage :: Lens' FleetError (Maybe Text) Source #
The error message.
Image
Describes an image.
See: image smart constructor.
Instances
Creates a value of Image with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iState- The image starts in thePENDINGstate. If image creation succeeds, the state isAVAILABLE. If image creation fails, the state isFAILED.iPlatform- The operating system platform of the image.iPublicBaseImageReleasedDate- 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.iStateChangeReason- The reason why the last state change occurred.iARN- The ARN of the image.iCreatedTime- The time the image was created.iImageBuilderSupported- Indicates whether an image builder can be launched from this image.iVisibility- Indicates whether the image is public or private.iBaseImageARN- The ARN of the image from which this image was created.iDisplayName- The image name for display.iDescription- The description for display.iAppstreamAgentVersion- The version of the AppStream 2.0 agent to use for instances that are launched from this image.iApplications- The applications associated with the image.iName- The name of the image.
iState :: 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 .
iPublicBaseImageReleasedDate :: 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.
iStateChangeReason :: Lens' Image (Maybe ImageStateChangeReason) Source #
The reason why the last state change occurred.
iImageBuilderSupported :: Lens' Image (Maybe Bool) Source #
Indicates whether an image builder can be launched from this image.
iVisibility :: Lens' Image (Maybe VisibilityType) Source #
Indicates whether the image is public or private.
iBaseImageARN :: Lens' Image (Maybe Text) Source #
The ARN of the image from which this image was created.
iAppstreamAgentVersion :: Lens' Image (Maybe Text) Source #
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
iApplications :: Lens' Image [Application] Source #
The applications associated with the image.
ImageBuilder
data ImageBuilder Source #
Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.
See: imageBuilder smart constructor.
Instances
Arguments
| :: Text | |
| -> ImageBuilder |
Creates a value of ImageBuilder with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ibDomainJoinInfo- The information needed to join a Microsoft Active Directory domain.ibState- The state of the image builder.ibPlatform- The operating system platform of the image builder.ibStateChangeReason- The reason why the last state change occurred.ibARN- The ARN for the image builder.ibCreatedTime- The time stamp when the image builder was created.ibImageBuilderErrors- The image builder errors.ibInstanceType- The instance type for the image builder.ibVPCConfig- The VPC configuration of the image builder.ibImageARN- The ARN of the image from which this builder was created.ibDisplayName- The image builder name for display.ibEnableDefaultInternetAccess- Enables or disables default internet access for the image builder.ibDescription- The description for display.ibAppstreamAgentVersion- The version of the AppStream 2.0 agent that is currently being used by this image builder.ibName- The name of the image builder.
ibDomainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo) Source #
The information needed to join a Microsoft Active Directory domain.
ibState :: Lens' ImageBuilder (Maybe ImageBuilderState) Source #
The state of the image builder.
ibPlatform :: Lens' ImageBuilder (Maybe PlatformType) Source #
The operating system platform of the image builder.
ibStateChangeReason :: Lens' ImageBuilder (Maybe ImageBuilderStateChangeReason) Source #
The reason why the last state change occurred.
ibCreatedTime :: Lens' ImageBuilder (Maybe UTCTime) Source #
The time stamp when the image builder was created.
ibImageBuilderErrors :: Lens' ImageBuilder [ResourceError] Source #
The image builder errors.
ibInstanceType :: Lens' ImageBuilder (Maybe Text) Source #
The instance type for the image builder.
ibVPCConfig :: Lens' ImageBuilder (Maybe VPCConfig) Source #
The VPC configuration of the image builder.
ibImageARN :: Lens' ImageBuilder (Maybe Text) Source #
The ARN of the image from which this builder was created.
ibDisplayName :: Lens' ImageBuilder (Maybe Text) Source #
The image builder name for display.
ibEnableDefaultInternetAccess :: Lens' ImageBuilder (Maybe Bool) Source #
Enables or disables default internet access for the image builder.
ibDescription :: Lens' ImageBuilder (Maybe Text) Source #
The description for display.
ibAppstreamAgentVersion :: Lens' ImageBuilder (Maybe Text) Source #
The version of the AppStream 2.0 agent that is currently being used by this image builder.
ImageBuilderStateChangeReason
data ImageBuilderStateChangeReason Source #
Describes the reason why the last image builder state change occurred.
See: imageBuilderStateChangeReason smart constructor.
Instances
imageBuilderStateChangeReason :: ImageBuilderStateChangeReason Source #
Creates a value of ImageBuilderStateChangeReason with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ibscrCode- The state change reason code.ibscrMessage- The state change reason message.
ibscrCode :: Lens' ImageBuilderStateChangeReason (Maybe ImageBuilderStateChangeReasonCode) Source #
The state change reason code.
ibscrMessage :: Lens' ImageBuilderStateChangeReason (Maybe Text) Source #
The state change reason message.
ImageStateChangeReason
data ImageStateChangeReason Source #
Describes the reason why the last image state change occurred.
See: imageStateChangeReason smart constructor.
Instances
imageStateChangeReason :: ImageStateChangeReason Source #
Creates a value of ImageStateChangeReason with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iscrCode- The state change reason code.iscrMessage- The state change reason message.
iscrCode :: Lens' ImageStateChangeReason (Maybe ImageStateChangeReasonCode) Source #
The state change reason code.
iscrMessage :: Lens' ImageStateChangeReason (Maybe Text) Source #
The state change reason message.
ResourceError
data ResourceError Source #
Describes a resource error.
See: resourceError smart constructor.
Instances
resourceError :: ResourceError Source #
Creates a value of ResourceError with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
reErrorCode- The error code.reErrorMessage- The error message.reErrorTimestamp- The time the error occurred.
reErrorCode :: Lens' ResourceError (Maybe FleetErrorCode) Source #
The error code.
reErrorMessage :: Lens' ResourceError (Maybe Text) Source #
The error message.
reErrorTimestamp :: Lens' ResourceError (Maybe UTCTime) Source #
The time the error occurred.
ServiceAccountCredentials
data ServiceAccountCredentials Source #
Describes the credentials for the service account used by the streaming instance to connect to the directory.
See: serviceAccountCredentials smart constructor.
Instances
serviceAccountCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> ServiceAccountCredentials |
Creates a value of ServiceAccountCredentials with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sacAccountName- 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.sacAccountPassword- The password for the account.
sacAccountName :: 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.
sacAccountPassword :: Lens' ServiceAccountCredentials Text Source #
The password for the account.
Session
Describes a streaming session.
See: session smart constructor.
Instances
Creates a value of Session with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sAuthenticationType- The authentication method. The user is authenticated using a streaming URL (API) or SAML federation (SAML).sId- The ID of the streaming session.sUserId- The identifier of the user for whom the session was created.sStackName- The name of the stack for the streaming session.sFleetName- The name of the fleet for the streaming session.sState- The current state of the streaming session.
sAuthenticationType :: Lens' Session (Maybe AuthenticationType) Source #
The authentication method. The user is authenticated using a streaming URL (API ) or SAML federation (SAML ).
Stack
Describes a stack.
See: stack smart constructor.
Instances
Creates a value of Stack with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sFeedbackURL- 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.sARN- The ARN of the stack.sCreatedTime- The time the stack was created.sStorageConnectors- The storage connectors to enable.sDisplayName- The stack name for display.sStackErrors- The errors for the stack.sDescription- The description for display.sRedirectURL- The URL that users are redirected to after their streaming session ends.sName- The name of the stack.
sFeedbackURL :: 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.
sStorageConnectors :: Lens' Stack [StorageConnector] Source #
The storage connectors to enable.
sStackErrors :: Lens' Stack [StackError] Source #
The errors for the stack.
sRedirectURL :: Lens' Stack (Maybe Text) Source #
The URL that users are redirected to after their streaming session ends.
StackError
data StackError Source #
Describes a stack error.
See: stackError smart constructor.
Instances
stackError :: StackError Source #
Creates a value of StackError with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
seErrorCode- The error code.seErrorMessage- The error message.
seErrorCode :: Lens' StackError (Maybe StackErrorCode) Source #
The error code.
seErrorMessage :: Lens' StackError (Maybe Text) Source #
The error message.
StorageConnector
data StorageConnector Source #
Describes a storage connector.
See: storageConnector smart constructor.
Instances
Arguments
| :: StorageConnectorType | |
| -> StorageConnector |
Creates a value of StorageConnector with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scResourceIdentifier- The ARN of the storage connector.scConnectorType- The type of storage connector.
scResourceIdentifier :: Lens' StorageConnector (Maybe Text) Source #
The ARN of the storage connector.
scConnectorType :: Lens' StorageConnector StorageConnectorType Source #
The type of storage connector.
VPCConfig
Describes VPC configuration information.
See: vpcConfig smart constructor.
Instances
| Eq VPCConfig Source # | |
| Data VPCConfig Source # | |
Defined in Network.AWS.AppStream.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VPCConfig -> c VPCConfig # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VPCConfig # toConstr :: VPCConfig -> Constr # dataTypeOf :: VPCConfig -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c VPCConfig) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VPCConfig) # gmapT :: (forall b. Data b => b -> b) -> VPCConfig -> VPCConfig # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VPCConfig -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VPCConfig -> r # gmapQ :: (forall d. Data d => d -> u) -> VPCConfig -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> VPCConfig -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> VPCConfig -> m VPCConfig # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VPCConfig -> m VPCConfig # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VPCConfig -> m VPCConfig # | |
| Read VPCConfig Source # | |
| Show VPCConfig Source # | |
| Generic VPCConfig Source # | |
| Hashable VPCConfig Source # | |
Defined in Network.AWS.AppStream.Types.Product | |
| ToJSON VPCConfig Source # | |
Defined in Network.AWS.AppStream.Types.Product | |
| FromJSON VPCConfig Source # | |
| NFData VPCConfig Source # | |
Defined in Network.AWS.AppStream.Types.Product | |
| type Rep VPCConfig Source # | |
Defined in Network.AWS.AppStream.Types.Product type Rep VPCConfig = D1 (MetaData "VPCConfig" "Network.AWS.AppStream.Types.Product" "amazonka-appstream-1.6.1-EdCHYsZUFpaEeuyeL4H95g" False) (C1 (MetaCons "VPCConfig'" PrefixI True) (S1 (MetaSel (Just "_vcSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_vcSubnetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) | |
vpcConfig :: VPCConfig Source #
Creates a value of VPCConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vcSecurityGroupIds- The security groups for the fleet.vcSubnetIds- The subnets to which a network interface is established from the fleet instance.