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

CreateFleet

Creates a new fleet.

Request Syntax

Copy
{ "ComputeCapacity": { "DesiredInstances": number }, "Description": "string", "DisconnectTimeoutInSeconds": number, "DisplayName": "string", "EnableDefaultInternetAccess": boolean, "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 parameters for the capacity allocated to the fleet.

Type: ComputeCapacity object

Required: Yes

Description

The description of the fleet.

Type: String

Length Constraints: Maximum length of 256.

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 display name of the fleet.

Type: String

Length Constraints: Maximum length of 100.

Required: No

EnableDefaultInternetAccess

Enables or disables default Internet access for the fleet.

Type: Boolean

Required: No

ImageName

Unique name of 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. 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 input can be any numeric value in seconds between 600 and 57600.

Type: Integer

Required: No

Name

A unique identifier 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

Copy
{ "Fleet": { "Arn": "string", "ComputeCapacityStatus": { "Available": number, "Desired": number, "InUse": number, "Running": number }, "CreatedTime": number, "Description": "string", "DisconnectTimeoutInSeconds": number, "DisplayName": "string", "EnableDefaultInternetAccess": boolean, "FleetErrors": [ { "ErrorCode": "string", "ErrorMessage": "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

The details for the created 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

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: