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


Creates a fleet. A fleet consists of streaming instances that run a specified image.

Request Syntax

{ "ComputeCapacity": { "DesiredInstances": number }, "Description": "string", "DisconnectTimeoutInSeconds": number, "DisplayName": "string", "DomainJoinInfo": { "DirectoryName": "string", "OrganizationalUnitDistinguishedName": "string" }, "EnableDefaultInternetAccess": boolean, "FleetType": "string", "ImageArn": "string", "ImageName": "string", "InstanceType": "string", "MaxUserDurationInSeconds": number, "Name": "string", "Tags": { "string" : "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.


The desired capacity for the fleet.

Type: ComputeCapacity object

Required: Yes


The description to display.

Type: String

Length Constraints: Maximum length of 256.

Required: No


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 360000.

Type: Integer

Required: No


The fleet name to display.

Type: String

Length Constraints: Maximum length of 100.

Required: No


The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

Type: DomainJoinInfo object

Required: No


Enables or disables default internet access for the fleet.

Type: Boolean

Required: No


The fleet type.


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.


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


Required: No


The ARN of the public, private, or shared image to use.

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: No


The name of the image used to create the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: No


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









Type: String

Length Constraints: Minimum length of 1.

Required: Yes


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

Type: Integer

Required: No


A unique name for the fleet.

Type: String

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

Required: Yes


The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(^(?!aws:).[\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No


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", "ImageArn": "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.


Information about the fleet.

Type: Fleet object


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


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

HTTP Status Code: 400


The image does not support storage connectors.

HTTP Status Code: 400


The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

HTTP Status Code: 400


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

HTTP Status Code: 400


The specified role is invalid.

HTTP Status Code: 400


The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400


The attempted operation is not permitted.

HTTP Status Code: 400


The specified resource already exists.

HTTP Status Code: 400


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

HTTP Status Code: 400


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: