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

CreateFleet

Creates a fleet.

Request Syntax

{
   "ComputeCapacity": { 
      "DesiredInstances": number
   },
   "Description": "string",
   "DisconnectTimeoutInSeconds": number,
   "DisplayName": "string",
   "DomainJoinInfo": { 
      "DirectoryName": "string",
      "OrganizationalUnitDistinguishedName": "string"
   },
   "EnableDefaultInternetAccess": boolean,
   "FleetType": "string",
   "ImageName": "string",
   "InstanceType": "string",
   "MaxUserDurationInSeconds": number,
   "Name": "string",
   "VpcConfig": { 
      "SecurityGroupIds": [ "string" ],
      "SubnetIds": [ "string" ]
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ComputeCapacity

The desired capacity for the fleet.

Type: ComputeCapacity object

Required: Yes

Description

The description for display.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DisconnectTimeoutInSeconds

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.

Type: Integer

Required: No

DisplayName

The fleet name for display.

Type: String

Length Constraints: Maximum length of 100.

Required: No

DomainJoinInfo

The information needed to join a Microsoft Active Directory domain.

Type: DomainJoinInfo object

Required: No

EnableDefaultInternetAccess

Enables or disables default internet access for the fleet.

Type: Boolean

Required: No

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.

Type: String

Valid Values: ALWAYS_ON | ON_DEMAND

Required: No

ImageName

The name of the image used to create the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

InstanceType

The instance type to use when launching fleet instances. The following instance types are available:

  • 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.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

MaxUserDurationInSeconds

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

Type: Integer

Required: No

Name

A unique name for the fleet.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

VpcConfig

The VPC configuration for the fleet.

Type: VpcConfig object

Required: No

Response Syntax

{
   "Fleet": { 
      "Arn": "string",
      "ComputeCapacityStatus": { 
         "Available": number,
         "Desired": number,
         "InUse": number,
         "Running": number
      },
      "CreatedTime": number,
      "Description": "string",
      "DisconnectTimeoutInSeconds": number,
      "DisplayName": "string",
      "DomainJoinInfo": { 
         "DirectoryName": "string",
         "OrganizationalUnitDistinguishedName": "string"
      },
      "EnableDefaultInternetAccess": boolean,
      "FleetErrors": [ 
         { 
            "ErrorCode": "string",
            "ErrorMessage": "string"
         }
      ],
      "FleetType": "string",
      "ImageName": "string",
      "InstanceType": "string",
      "MaxUserDurationInSeconds": number,
      "Name": "string",
      "State": "string",
      "VpcConfig": { 
         "SecurityGroupIds": [ "string" ],
         "SubnetIds": [ "string" ]
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Fleet

Information about the fleet.

Type: Fleet object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

An API error occurred. Wait a few minutes and try again.

HTTP Status Code: 400

IncompatibleImageException

The image does not support storage connectors.

HTTP Status Code: 400

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

InvalidRoleException

The specified role is invalid.

HTTP Status Code: 400

LimitExceededException

The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceNotAvailableException

The specified resource exists and is not in use, but isn't available.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

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