Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UpdateFleetCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppStreamClient, UpdateFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import
// const { AppStreamClient, UpdateFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import
const client = new AppStreamClient(config);
const input = { // UpdateFleetRequest
  ImageName: "STRING_VALUE",
  ImageArn: "STRING_VALUE",
  Name: "STRING_VALUE",
  InstanceType: "STRING_VALUE",
  ComputeCapacity: { // ComputeCapacity
    DesiredInstances: Number("int"),
    DesiredSessions: Number("int"),
  },
  VpcConfig: { // VpcConfig
    SubnetIds: [ // SubnetIdList
      "STRING_VALUE",
    ],
    SecurityGroupIds: [ // SecurityGroupIdList
      "STRING_VALUE",
    ],
  },
  MaxUserDurationInSeconds: Number("int"),
  DisconnectTimeoutInSeconds: Number("int"),
  DeleteVpcConfig: true || false,
  Description: "STRING_VALUE",
  DisplayName: "STRING_VALUE",
  EnableDefaultInternetAccess: true || false,
  DomainJoinInfo: { // DomainJoinInfo
    DirectoryName: "STRING_VALUE",
    OrganizationalUnitDistinguishedName: "STRING_VALUE",
  },
  IdleDisconnectTimeoutInSeconds: Number("int"),
  AttributesToDelete: [ // FleetAttributes
    "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",
  ],
  IamRoleArn: "STRING_VALUE",
  StreamView: "APP" || "DESKTOP",
  Platform: "WINDOWS" || "WINDOWS_SERVER_2016" || "WINDOWS_SERVER_2019" || "WINDOWS_SERVER_2022" || "AMAZON_LINUX2" || "RHEL8" || "ROCKY_LINUX8",
  MaxConcurrentSessions: Number("int"),
  UsbDeviceFilterStrings: [ // UsbDeviceFilterStrings
    "STRING_VALUE",
  ],
  SessionScriptS3Location: { // S3Location
    S3Bucket: "STRING_VALUE", // required
    S3Key: "STRING_VALUE",
  },
  MaxSessionsPerInstance: Number("int"),
};
const command = new UpdateFleetCommand(input);
const response = await client.send(command);
// { // UpdateFleetResult
//   Fleet: { // Fleet
//     Arn: "STRING_VALUE", // required
//     Name: "STRING_VALUE", // required
//     DisplayName: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     ImageName: "STRING_VALUE",
//     ImageArn: "STRING_VALUE",
//     InstanceType: "STRING_VALUE", // required
//     FleetType: "ALWAYS_ON" || "ON_DEMAND" || "ELASTIC",
//     ComputeCapacityStatus: { // ComputeCapacityStatus
//       Desired: Number("int"), // required
//       Running: Number("int"),
//       InUse: Number("int"),
//       Available: Number("int"),
//       DesiredUserSessions: Number("int"),
//       AvailableUserSessions: Number("int"),
//       ActiveUserSessions: Number("int"),
//       ActualUserSessions: Number("int"),
//     },
//     MaxUserDurationInSeconds: Number("int"),
//     DisconnectTimeoutInSeconds: Number("int"),
//     State: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED", // required
//     VpcConfig: { // VpcConfig
//       SubnetIds: [ // SubnetIdList
//         "STRING_VALUE",
//       ],
//       SecurityGroupIds: [ // SecurityGroupIdList
//         "STRING_VALUE",
//       ],
//     },
//     CreatedTime: new Date("TIMESTAMP"),
//     FleetErrors: [ // FleetErrors
//       { // FleetError
//         ErrorCode: "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION" || "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION" || "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION" || "NETWORK_INTERFACE_LIMIT_EXCEEDED" || "INTERNAL_SERVICE_ERROR" || "IAM_SERVICE_ROLE_IS_MISSING" || "MACHINE_ROLE_IS_MISSING" || "STS_DISABLED_IN_REGION" || "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES" || "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION" || "SUBNET_NOT_FOUND" || "IMAGE_NOT_FOUND" || "INVALID_SUBNET_CONFIGURATION" || "SECURITY_GROUPS_NOT_FOUND" || "IGW_NOT_ATTACHED" || "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION" || "FLEET_STOPPED" || "FLEET_INSTANCE_PROVISIONING_FAILURE" || "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND" || "DOMAIN_JOIN_ERROR_ACCESS_DENIED" || "DOMAIN_JOIN_ERROR_LOGON_FAILURE" || "DOMAIN_JOIN_ERROR_INVALID_PARAMETER" || "DOMAIN_JOIN_ERROR_MORE_DATA" || "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN" || "DOMAIN_JOIN_ERROR_NOT_SUPPORTED" || "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME" || "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED" || "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED" || "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED" || "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR",
//         ErrorMessage: "STRING_VALUE",
//       },
//     ],
//     EnableDefaultInternetAccess: true || false,
//     DomainJoinInfo: { // DomainJoinInfo
//       DirectoryName: "STRING_VALUE",
//       OrganizationalUnitDistinguishedName: "STRING_VALUE",
//     },
//     IdleDisconnectTimeoutInSeconds: Number("int"),
//     IamRoleArn: "STRING_VALUE",
//     StreamView: "APP" || "DESKTOP",
//     Platform: "WINDOWS" || "WINDOWS_SERVER_2016" || "WINDOWS_SERVER_2019" || "WINDOWS_SERVER_2022" || "AMAZON_LINUX2" || "RHEL8" || "ROCKY_LINUX8",
//     MaxConcurrentSessions: Number("int"),
//     UsbDeviceFilterStrings: [ // UsbDeviceFilterStrings
//       "STRING_VALUE",
//     ],
//     SessionScriptS3Location: { // S3Location
//       S3Bucket: "STRING_VALUE", // required
//       S3Key: "STRING_VALUE",
//     },
//     MaxSessionsPerInstance: Number("int"),
//   },
// };

UpdateFleetCommand Input

See UpdateFleetCommandInput for more details

Parameter	Type	Description
`AttributesToDelete`	`FleetAttribute[] \| undefined`	The fleet attributes to delete.
`ComputeCapacity`	`ComputeCapacity \| undefined`	The desired capacity for the fleet. This is not allowed for Elastic fleets.
`DeleteVpcConfig`	`boolean \| undefined`	Deletes the VPC association for the specified fleet.
`Description`	`string \| undefined`	The description to display.
`DisconnectTimeoutInSeconds`	`number \| undefined`	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.
`DisplayName`	`string \| undefined`	The fleet name to display.
`DomainJoinInfo`	`DomainJoinInfo \| undefined`	The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
`EnableDefaultInternetAccess`	`boolean \| undefined`	Enables or disables default internet access for the fleet.
`IamRoleArn`	`string \| undefined`	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.
`IdleDisconnectTimeoutInSeconds`	`number \| undefined`	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. 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.
`ImageArn`	`string \| undefined`	The ARN of the public, private, or shared image to use.
`ImageName`	`string \| undefined`	The name of the image used to create the fleet.
`InstanceType`	`string \| undefined`	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
`MaxConcurrentSessions`	`number \| undefined`	The maximum number of concurrent sessions for a fleet.
`MaxSessionsPerInstance`	`number \| undefined`	The maximum number of user sessions on an instance. This only applies to multi-session fleets.
`MaxUserDurationInSeconds`	`number \| undefined`	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.
`Name`	`string \| undefined`	A unique name for the fleet.
`Platform`	`PlatformType \| undefined`	The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
`SessionScriptS3Location`	`S3Location \| undefined`	The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
`StreamView`	`StreamView \| undefined`	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`.
`UsbDeviceFilterStrings`	`string[] \| undefined`	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.
`VpcConfig`	`VpcConfig \| undefined`	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.

UpdateFleetCommand Output

See UpdateFleetCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`Fleet`	`Fleet \| undefined`	Information about the fleet.

Throws

Name	Fault	Details
ConcurrentModificationException	client	An API error occurred. Wait a few minutes and try again.
IncompatibleImageException	client	The image can't be updated because it's not compatible for updates.
InvalidAccountStatusException	client	The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
InvalidParameterCombinationException	client	Indicates an incorrect combination of parameters, or a missing parameter.
InvalidRoleException	client	The specified role is invalid.
LimitExceededException	client	The requested limit exceeds the permitted limit for an account.
OperationNotPermittedException	client	The attempted operation is not permitted.
RequestLimitExceededException	client	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.
ResourceInUseException	client	The specified resource is in use.
ResourceNotAvailableException	client	The specified resource exists and is not in use, but isn't available.
ResourceNotFoundException	client	The specified resource was not found.
AppStreamServiceException		Base exception class for all service exceptions from AppStream service.

Getting Started

References

UpdateFleetCommand

Example Syntax

UpdateFleetCommand Input

UpdateFleetCommand Output

Throws

Table of Contents

Search