Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

Fleet

Contains the parameters for a fleet.

Contents

Arn

The ARN for the fleet.

Type: String

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: Yes

ComputeCapacityStatus

The capacity information for the fleet.

Type: ComputeCapacityStatus object

Required: Yes

CreatedTime

The time at which the fleet was created.

Type: Timestamp

Required: No

Description

The description displayed to end users on the AppStream 2.0 portal.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DisconnectTimeoutInSeconds

The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.

Type: Integer

Required: No

DisplayName

The name displayed to end users on the AppStream 2.0 portal.

Type: String

Length Constraints: Minimum length of 1.

Required: No

EnableDefaultInternetAccess

Whether default Internet access is enabled for the fleet.

Type: Boolean

Required: No

FleetErrors

The list of fleet errors is appended to this list.

Type: Array of FleetError objects

Required: No

ImageName

The image used by the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

InstanceType

The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

MaxUserDurationInSeconds

The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.

Type: Integer

Required: No

Name

The name of the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

State

The current state for the fleet.

Type: String

Valid Values: STARTING | RUNNING | STOPPING | STOPPED

Required: Yes

VpcConfig

The VPC configuration for the fleet.

Type: VpcConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: