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

UpdateFleet

Updates the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

Request Syntax

Copy
{ "AttributesToDelete": [ "string" ], "ComputeCapacity": { "DesiredInstances": number }, "DeleteVpcConfig": boolean, "Description": "string", "DisconnectTimeoutInSeconds": number, "DisplayName": "string", "DomainJoinInfo": { "DirectoryName": "string", "OrganizationalUnitDistinguishedName": "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.

AttributesToDelete

The fleet attributes to delete.

Type: Array of strings

Valid Values: VPC_CONFIGURATION | VPC_CONFIGURATION_SECURITY_GROUP_IDS | DOMAIN_JOIN_INFO

Required: No

ComputeCapacity

The desired capacity for the fleet.

Type: ComputeCapacity object

Required: No

DeleteVpcConfig

This parameter has been deprecated.

Deletes the VPC association for the specified fleet.

Type: Boolean

Required: No

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

ImageName

The name of the image used to create the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: No

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

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

Length Constraints: Minimum length of 1.

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", "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

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceInUseException

The specified resource is in use.

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: