AWS CLI Command Reference

[ aws . autoscaling ]

launch-instances

Description

Launches a specified number of instances in an Auto Scaling group. Returns instance IDs and other details if launch is successful or error details if launch is unsuccessful.

See also: AWS API Documentation

Synopsis

  launch-instances
--auto-scaling-group-name <value>
--requested-capacity <value>
[--client-token <value>]
[--availability-zones <value>]
[--availability-zone-ids <value>]
[--subnet-ids <value>]
[--retry-strategy <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--auto-scaling-group-name (string) [required]

The name of the Auto Scaling group to launch instances into.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

--requested-capacity (integer) [required]

The number of instances to launch. Although this value can exceed 100 for instance weights, the actual instance count is limited to 100 instances per launch.

Constraints:

  • min: 1

--client-token (string)

A unique, case-sensitive identifier to ensure idempotency of the request.

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z0-9\-_\/]+

--availability-zones (list)

The Availability Zones for the instance launch. Must match or be included in the Auto Scaling group’s Availability Zone configuration. Either AvailabilityZones or SubnetIds must be specified for groups with multiple Availability Zone configurations.

Constraints:

  • max: 1

(string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Syntax:

"string" "string" ...

--availability-zone-ids (list)

A list of Availability Zone IDs where instances should be launched. Must match or be included in the group’s AZ configuration. You cannot specify both AvailabilityZones and AvailabilityZoneIds. Required for multi-AZ groups, optional for single-AZ groups.

Constraints:

  • max: 1

(string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Syntax:

"string" "string" ...

--subnet-ids (list)

The subnet IDs for the instance launch. Either AvailabilityZones or SubnetIds must be specified. If both are specified, the subnets must reside in the specified Availability Zones.

Constraints:

  • max: 1

(string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Syntax:

"string" "string" ...

--retry-strategy (string)

Specifies whether to retry asynchronously if the synchronous launch fails. Valid values are NONE (default, no async retry) and RETRY_WITH_GROUP_CONFIGURATION (increase desired capacity and retry with group configuration).

Possible values:

  • retry-with-group-configuration
  • none

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

AutoScalingGroupName -> (string)

The name of the Auto Scaling group where the instances were launched.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ClientToken -> (string)

The idempotency token used for the request, either customer-specified or auto-generated.

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z0-9\-_\/]+

Instances -> (list)

A list of successfully launched instances including details such as instance type, Availability Zone, subnet, lifecycle state, and instance IDs.

(structure)

Contains details about a collection of instances launched in the Auto Scaling group.

InstanceType -> (string)

The instance type of the launched instances.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

MarketType -> (string)

The market type for the instances (On-Demand or Spot).

Constraints:

  • min: 1
  • max: 64
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

SubnetId -> (string)

The ID of the subnet where the instances were launched.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

AvailabilityZone -> (string)

The Availability Zone where the instances were launched.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

AvailabilityZoneId -> (string)

The Availability Zone ID where the instances in this collection were launched.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

InstanceIds -> (list)

A list of instance IDs for the successfully launched instances.

(string)

Constraints:

  • min: 1
  • max: 19
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Errors -> (list)

A list of errors encountered during the launch attempt including details about failed instance launches with their corresponding error codes and messages.

(structure)

Contains details about errors encountered during instance launch attempts.

InstanceType -> (string)

The instance type that failed to launch.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

MarketType -> (string)

The market type (On-Demand or Spot) that encountered the launch error.

Constraints:

  • min: 1
  • max: 64
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

SubnetId -> (string)

The subnet ID where the instance launch was attempted.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

AvailabilityZone -> (string)

The Availability Zone where the instance launch was attempted.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

AvailabilityZoneId -> (string)

The Availability Zone ID where the launch error occurred.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ErrorCode -> (string)

The error code representing the type of error encountered (e.g., InsufficientInstanceCapacity).

Constraints:

  • min: 1
  • max: 64
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ErrorMessage -> (string)

A descriptive message providing details about the error encountered during the launch attempt.

Constraints:

  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
© Copyright 2025, Amazon Web Services. Created using Sphinx.