Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . appstream ]

update-fleet

Description

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 display-name and compute-capacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-fleet
[--image-name <value>]
[--image-arn <value>]
[--name <value>]
[--instance-type <value>]
[--compute-capacity <value>]
[--vpc-config <value>]
[--max-user-duration-in-seconds <value>]
[--disconnect-timeout-in-seconds <value>]
[--delete-vpc-config | --no-delete-vpc-config]
[--description <value>]
[--display-name <value>]
[--enable-default-internet-access | --no-enable-default-internet-access]
[--domain-join-info <value>]
[--attributes-to-delete <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--image-name (string)

The name of the image used to create the fleet.

--image-arn (string)

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

--name (string)

A unique name for the fleet.

--instance-type (string)

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

--compute-capacity (structure)

The desired capacity for the fleet.

Shorthand Syntax:

DesiredInstances=integer

JSON Syntax:

{
  "DesiredInstances": integer
}

--vpc-config (structure)

The VPC configuration for the fleet.

Shorthand Syntax:

SubnetIds=string,string,SecurityGroupIds=string,string

JSON Syntax:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...]
}

--max-user-duration-in-seconds (integer)

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

--disconnect-timeout-in-seconds (integer)

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.

--delete-vpc-config | --no-delete-vpc-config (boolean)

Deletes the VPC association for the specified fleet.

--description (string)

The description for display.

--display-name (string)

The fleet name for display.

--enable-default-internet-access | --no-enable-default-internet-access (boolean)

Enables or disables default internet access for the fleet.

--domain-join-info (structure)

The information needed to join a Microsoft Active Directory domain.

Shorthand Syntax:

DirectoryName=string,OrganizationalUnitDistinguishedName=string

JSON Syntax:

{
  "DirectoryName": "string",
  "OrganizationalUnitDistinguishedName": "string"
}

--attributes-to-delete (list)

The fleet attributes to delete.

Syntax:

"string" "string" ...

Where valid values are:
  VPC_CONFIGURATION
  VPC_CONFIGURATION_SECURITY_GROUP_IDS
  DOMAIN_JOIN_INFO

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Fleet -> (structure)

Information about the fleet.

Arn -> (string)

The ARN for the fleet.

Name -> (string)

The name of the fleet.

DisplayName -> (string)

The fleet name for display.

Description -> (string)

The description for display.

ImageName -> (string)

The name of the image used to create the fleet.

ImageArn -> (string)

The ARN for the public, private, or shared image.

InstanceType -> (string)

The instance type to use when launching fleet instances.

FleetType -> (string)

The fleet type.

ALWAYS_ON

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.

ON_DEMAND

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.

ComputeCapacityStatus -> (structure)

The capacity status for the fleet.

Desired -> (integer)

The desired number of streaming instances.

Running -> (integer)

The total number of simultaneous streaming instances that are running.

InUse -> (integer)

The number of instances in use for streaming.

Available -> (integer)

The number of currently available instances that can be used to stream sessions.

MaxUserDurationInSeconds -> (integer)

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

DisconnectTimeoutInSeconds -> (integer)

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.

State -> (string)

The current state for the fleet.

VpcConfig -> (structure)

The VPC configuration for the fleet.

SubnetIds -> (list)

The subnets to which a network interface is established from the fleet instance.

(string)

SecurityGroupIds -> (list)

The security groups for the fleet.

(string)

CreatedTime -> (timestamp)

The time the fleet was created.

FleetErrors -> (list)

The fleet errors.

(structure)

Describes a fleet error.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.

EnableDefaultInternetAccess -> (boolean)

Indicates whether default internet access is enabled for the fleet.

DomainJoinInfo -> (structure)

The information needed to join a Microsoft Active Directory domain.

DirectoryName -> (string)

The fully qualified name of the directory (for example, corp.example.com).

OrganizationalUnitDistinguishedName -> (string)

The distinguished name of the organizational unit for computer accounts.