| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.AppStream.Types
Contents
Description
- appStream :: Service
- _InvalidRoleException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: 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
- data FleetErrorCode
- = IAMServiceRoleIsMissing
- | IAMServiceRoleMissingDescribeSubnetAction
- | IAMServiceRoleMissingEniCreateAction
- | IAMServiceRoleMissingEniDeleteAction
- | IAMServiceRoleMissingEniDescribeAction
- | ImageNotFound
- | InternalServiceError
- | InvalidSubnetConfiguration
- | NetworkInterfaceLimitExceeded
- | SubnetHasInsufficientIPAddresses
- | SubnetNotFound
- data FleetState
- data ImageState
- data ImageStateChangeReasonCode
- data PlatformType = Windows
- data SessionState
- 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 Fleet
- fleet :: Text -> Text -> Text -> Text -> ComputeCapacityStatus -> FleetState -> Fleet
- fDisconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int)
- fMaxUserDurationInSeconds :: Lens' Fleet (Maybe Int)
- fCreatedTime :: Lens' Fleet (Maybe UTCTime)
- fVPCConfig :: Lens' Fleet (Maybe VPCConfig)
- fFleetErrors :: Lens' Fleet [FleetError]
- fDisplayName :: Lens' Fleet (Maybe Text)
- 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)
- iStateChangeReason :: Lens' Image (Maybe ImageStateChangeReason)
- iARN :: Lens' Image (Maybe Text)
- iCreatedTime :: Lens' Image (Maybe UTCTime)
- iVisibility :: Lens' Image (Maybe VisibilityType)
- iBaseImageARN :: Lens' Image (Maybe Text)
- iDisplayName :: Lens' Image (Maybe Text)
- iDescription :: Lens' Image (Maybe Text)
- iApplications :: Lens' Image [Application]
- iName :: Lens' Image Text
- data ImageStateChangeReason
- imageStateChangeReason :: ImageStateChangeReason
- iscrCode :: Lens' ImageStateChangeReason (Maybe ImageStateChangeReasonCode)
- iscrMessage :: Lens' ImageStateChangeReason (Maybe Text)
- data Session
- session :: Text -> Text -> Text -> Text -> SessionState -> Session
- 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
- sARN :: Lens' Stack (Maybe Text)
- sCreatedTime :: Lens' Stack (Maybe UTCTime)
- sDisplayName :: Lens' Stack (Maybe Text)
- sDescription :: Lens' Stack (Maybe Text)
- sName :: Lens' Stack Text
- data VPCConfig
- vpcConfig :: NonEmpty Text -> VPCConfig
- vcSubnetIds :: Lens' VPCConfig (NonEmpty Text)
Service Configuration
Errors
_InvalidRoleException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified role is invalid.
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource already exists.
_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The attempted operation is not permitted.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource was not found.
_ResourceNotAvailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource exists and is not in use, but isn't available.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested limit exceeds the permitted limit for an account.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is in use.
FleetErrorCode
data FleetErrorCode Source #
Constructors
Instances
FleetState
data FleetState Source #
Instances
ImageState
data ImageState Source #
Constructors
| ISAvailable | |
| ISDeleting | |
| ISFailed | |
| ISPending |
Instances
ImageStateChangeReasonCode
data ImageStateChangeReasonCode Source #
Constructors
| ImageBuilderNotAvailable | |
| InternalError |
Instances
PlatformType
data PlatformType Source #
Constructors
| Windows |
Instances
SessionState
data SessionState Source #
Possible values for the state of a streaming session.
Instances
VisibilityType
data VisibilityType Source #
Instances
Application
data Application Source #
An entry for a single application in the application catalog.
See: application smart constructor.
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- An application can be disabled after image creation if there is a problem.aLaunchPath- The path to the application executable in the instance.aLaunchParameters- A list of arguments that are passed to the application at launch.aName- The unique identifier for the application.aDisplayName- The name of the application shown to the end users.aMetadata- Additional attributes that describes the application.aIconURL- The URL for the application icon. This URL may be time-limited.
aEnabled :: Lens' Application (Maybe Bool) Source #
An application can be disabled after image creation if there is a problem.
aLaunchPath :: Lens' Application (Maybe Text) Source #
The path to the application executable in the instance.
aLaunchParameters :: Lens' Application (Maybe Text) Source #
A list of arguments that are passed to the application at launch.
aDisplayName :: Lens' Application (Maybe Text) Source #
The name of the application shown to the end users.
aMetadata :: Lens' Application (HashMap Text Text) Source #
Additional attributes that describes the application.
aIconURL :: Lens' Application (Maybe Text) Source #
The URL for the application icon. This URL may be time-limited.
ComputeCapacity
data ComputeCapacity Source #
The capacity configuration for the fleet.
See: computeCapacity smart constructor.
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 #
The capacity information for the 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 that are being used 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 that are being used 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.
Fleet
Contains the parameters for a fleet.
See: fleet smart constructor.
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:
fDisconnectTimeoutInSeconds- The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.fMaxUserDurationInSeconds- The maximum time during which a streaming session can run.fCreatedTime- The time at which the fleet was created.fVPCConfig- The VPC configuration for the fleet.fFleetErrors- The list of fleet errors is appended to this list.fDisplayName- The name displayed to end users on the AppStream 2.0 portal.fDescription- The description displayed to end users on the AppStream 2.0 portal.fARN- The ARN for the fleet.fName- The name of the fleet.fImageName- The image used by the fleet.fInstanceType- The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.fComputeCapacityStatus- The capacity information for the fleet.fState- The current state for the fleet.
fDisconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int) Source #
The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.
fMaxUserDurationInSeconds :: Lens' Fleet (Maybe Int) Source #
The maximum time during which a streaming session can run.
fFleetErrors :: Lens' Fleet [FleetError] Source #
The list of fleet errors is appended to this list.
fDisplayName :: Lens' Fleet (Maybe Text) Source #
The name displayed to end users on the AppStream 2.0 portal.
fDescription :: Lens' Fleet (Maybe Text) Source #
The description displayed to end users on the AppStream 2.0 portal.
fInstanceType :: Lens' Fleet Text Source #
The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.
fComputeCapacityStatus :: Lens' Fleet ComputeCapacityStatus Source #
The capacity information for the fleet.
FleetError
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 for the fleet error.feErrorMessage- The error message generated when the fleet has errors.
feErrorCode :: Lens' FleetError (Maybe FleetErrorCode) Source #
The error code for the fleet error.
feErrorMessage :: Lens' FleetError (Maybe Text) Source #
The error message generated when the fleet has errors.
Image
New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.
See: image smart constructor.
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 the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.iPlatform- The operating system platform of the image.iStateChangeReason- The reason why the last state change occurred.iARN- The ARN for the image.iCreatedTime- The timestamp when the image was created.iVisibility- The visibility of an image to the user; images can be public or private.iBaseImageARN- The source image ARN from which this image was created.iDisplayName- The display name for the image.iDescription- A meaningful description for the image.iApplications- The applications associated with an image.iName- The unique identifier for the image.
iState :: Lens' Image (Maybe ImageState) Source #
The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
iStateChangeReason :: Lens' Image (Maybe ImageStateChangeReason) Source #
The reason why the last state change occurred.
iVisibility :: Lens' Image (Maybe VisibilityType) Source #
The visibility of an image to the user; images can be public or private.
iBaseImageARN :: Lens' Image (Maybe Text) Source #
The source image ARN from which this image was created.
iApplications :: Lens' Image [Application] Source #
The applications associated with an image.
ImageStateChangeReason
data ImageStateChangeReason Source #
The reason why the last 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 of the image.iscrMessage- The state change reason message to the end user.
iscrCode :: Lens' ImageStateChangeReason (Maybe ImageStateChangeReasonCode) Source #
The state change reason code of the image.
iscrMessage :: Lens' ImageStateChangeReason (Maybe Text) Source #
The state change reason message to the end user.
Session
Contains the parameters for a streaming session.
See: session smart constructor.
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:
sId- The unique ID for a streaming session.sUserId- The identifier of the user for whom the session was created.sStackName- The name of the stack for which the streaming session was created.sFleetName- The name of the fleet for which the streaming session was created.sState- The current state of the streaming session.
sStackName :: Lens' Session Text Source #
The name of the stack for which the streaming session was created.
sFleetName :: Lens' Session Text Source #
The name of the fleet for which the streaming session was created.
Stack
Details about a stack.
See: stack smart constructor.
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:
sARN- The ARN of the stack.sCreatedTime- The timestamp when the stack was created.sDisplayName- A display name for the stack.sDescription- A meaningful description for the stack.sName- The unique identifier of the stack.
VPCConfig
The VPC in which the fleet is launched.
See: vpcConfig smart constructor.
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:
vcSubnetIds- The list of subnets to which a network interface is established from the fleet instance.