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 following based on the fleet type:

• Always-On and On-Demand fleet types

  You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes.

• Elastic fleet type

  You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes.

If the fleet is in the STARTING or STOPPED state, you can't update it.

Request Syntax

{
   "AttributesToDelete": [ "string" ],
   "ComputeCapacity": { 
      "DesiredInstances": number,
      "DesiredSessions": number
   },
   "DeleteVpcConfig": boolean,
   "Description": "string",
   "DisconnectTimeoutInSeconds": number,
   "DisplayName": "string",
   "DomainJoinInfo": { 
      "DirectoryName": "string",
      "OrganizationalUnitDistinguishedName": "string"
   },
   "EnableDefaultInternetAccess": boolean,
   "IamRoleArn": "string",
   "IdleDisconnectTimeoutInSeconds": number,
   "ImageArn": "string",
   "ImageName": "string",
   "InstanceType": "string",
   "MaxConcurrentSessions": number,
   "MaxSessionsPerInstance": number,
   "MaxUserDurationInSeconds": number,
   "Name": "string",
   "Platform": "string",
   "SessionScriptS3Location": { 
      "S3Bucket": "string",
      "S3Key": "string"
   },
   "StreamView": "string",
   "UsbDeviceFilterStrings": [ "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 | IAM_ROLE_ARN | USB_DEVICE_FILTER_STRINGS | SESSION_SCRIPT_S3_LOCATION | MAX_SESSIONS_PER_INSTANCE

Required: No

ComputeCapacity

The desired capacity for the fleet. This is not allowed for Elastic fleets.

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 to display.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DisconnectTimeoutInSeconds

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 36000.

Type: Integer

Required: No

DisplayName

The fleet name to display.

Type: String

Length Constraints: Maximum length of 100.

Required: No

DomainJoinInfo

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

EnableDefaultInternetAccess

Enables or disables default internet access for the fleet.

Type: Boolean

Required: No

IamRoleArn

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[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

IdleDisconnectTimeoutInSeconds

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.

Note

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

Type: Integer

Required: No

ImageArn

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

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[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

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

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

• 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.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

Type: String

Length Constraints: Minimum length of 1.

Required: No

MaxConcurrentSessions

The maximum number of concurrent sessions for a fleet.

Type: Integer

Required: No

MaxSessionsPerInstance

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

Type: Integer

Required: No

MaxUserDurationInSeconds

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 432000.

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

Platform

The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

Type: String

Valid Values: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2 | RHEL8 | ROCKY_LINUX8

Required: No

SessionScriptS3Location

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

Type: S3Location object

Required: No

StreamView

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

Type: String

Valid Values: APP | DESKTOP

Required: No

UsbDeviceFilterStrings

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: ^((\w*)\s*(\w*)\s*\,\s*(\w*)\s*\,\s*\*?(\w*)\s*\,\s*\*?(\w*)\s*\,\s*\*?\d*\s*\,\s*\*?\d*\s*\,\s*[0-1]\s*\,\s*[0-1]\s*)$

Required: No

VpcConfig

The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.

Type: VpcConfig object

Required: No

Response Syntax

{
   "Fleet": { 
      "Arn": "string",
      "ComputeCapacityStatus": { 
         "ActiveUserSessions": number,
         "ActualUserSessions": number,
         "Available": number,
         "AvailableUserSessions": number,
         "Desired": number,
         "DesiredUserSessions": 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",
      "IamRoleArn": "string",
      "IdleDisconnectTimeoutInSeconds": number,
      "ImageArn": "string",
      "ImageName": "string",
      "InstanceType": "string",
      "MaxConcurrentSessions": number,
      "MaxSessionsPerInstance": number,
      "MaxUserDurationInSeconds": number,
      "Name": "string",
      "Platform": "string",
      "SessionScriptS3Location": { 
         "S3Bucket": "string",
         "S3Key": "string"
      },
      "State": "string",
      "StreamView": "string",
      "UsbDeviceFilterStrings": [ "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 can't be updated because it's not compatible for updates.

HTTP Status Code: 400

InvalidAccountStatusException

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

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

RequestLimitExceededException

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

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:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3