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

UpdateFleet

Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. When a fleet is in the RUNNING state, only DisplayName and ComputeCapacity can be updated. A fleet cannot be updated in a status of STARTING or STOPPING.

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

Fleet attributes to be deleted.

Type: Array of strings

Valid Values: VPC_CONFIGURATION | VPC_CONFIGURATION_SECURITY_GROUP_IDS | DOMAIN_JOIN_INFO

Required: No

ComputeCapacity

The parameters for the capacity allocated to the fleet.

Type: ComputeCapacity object

Required: No

DeleteVpcConfig

This parameter has been deprecated.

Delete the VPC association for the specified fleet.

Type: Boolean

Required: No

Description

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

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 name displayed to end users on the AppStream 2.0 portal.

Type: String

Length Constraints: Maximum length of 100.

Required: No

DomainJoinInfo

The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.

Type: DomainJoinInfo object

Required: No

EnableDefaultInternetAccess

Enables or disables default internet access for the fleet.

Type: Boolean

Required: No

ImageName

The image name from which a fleet is created.

Type: String

Length Constraints: Minimum length of 1.

Required: No

InstanceType

The instance type of compute resources for the fleet. Fleet instances are launched from this instance type. Available instance types are:

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

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

The name of 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" } ], "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

A list of fleet details.

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: