[ aws . ec2 ]

describe-fleets

Description

Describes the specified EC2 Fleets or all of your EC2 Fleets.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-fleets is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Fleets

Synopsis

  describe-fleets
[--dry-run | --no-dry-run]
[--fleet-ids <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--fleet-ids (list)

The ID of the EC2 Fleets.

(string)

Syntax:

"string" "string" ...

--filters (list)

The filters.

• activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled ).

• excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false ).

• fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying ).

• replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false ).

• type - The type of request (instant | request | maintain ).

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

• DescribeAvailabilityZones

• DescribeImages

• DescribeInstances

• DescribeKeyPairs

• DescribeSecurityGroups

• DescribeSnapshots

• DescribeSubnets

• DescribeTags

• DescribeVolumes

• DescribeVpcs

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

The token for the next set of results.

Fleets -> (list)

Information about the EC2 Fleets.

(structure)

Describes an EC2 Fleet.

ActivityStatus -> (string)

The progress of the EC2 Fleet. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.

CreateTime -> (timestamp)

The creation date and time of the EC2 Fleet.

FleetId -> (string)

The ID of the EC2 Fleet.

FleetState -> (string)

The state of the EC2 Fleet.

ClientToken -> (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

Constraints: Maximum 64 ASCII characters

ExcessCapacityTerminationPolicy -> (string)

Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

FulfilledCapacity -> (double)

The number of units fulfilled by this request compared to the set target capacity.

FulfilledOnDemandCapacity -> (double)

The number of units fulfilled by this request compared to the set target On-Demand capacity.

LaunchTemplateConfigs -> (list)

The launch template and overrides.

(structure)

Describes a launch template and overrides.

LaunchTemplateSpecification -> (structure)

The launch template.

LaunchTemplateId -> (string)

The ID of the launch template. If you specify the template ID, you can’t specify the template name.

LaunchTemplateName -> (string)

The name of the launch template. If you specify the template name, you can’t specify the template ID.

Version -> (string)

The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

If the value is $Default , Amazon EC2 uses the default version of the launch template.

Overrides -> (list)

Any parameters that you specify override the same parameters in the launch template.

(structure)

Describes overrides for a launch template.

InstanceType -> (string)

The instance type.

MaxPrice -> (string)

The maximum price per unit hour that you are willing to pay for a Spot Instance.

SubnetId -> (string)

The ID of the subnet in which to launch the instances.

AvailabilityZone -> (string)

The Availability Zone in which to launch the instances.

WeightedCapacity -> (double)

The number of units provided by the specified instance type.

Priority -> (double)

The priority for the launch template override. If AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority.

Placement -> (structure)

The location where the instance launched, if applicable.

GroupName -> (string)

The name of the placement group that the instance is in.

TargetCapacitySpecification -> (structure)

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.

TotalTargetCapacity -> (integer)

The number of units to request, filled using DefaultTargetCapacityType .

OnDemandTargetCapacity -> (integer)

The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

SpotTargetCapacity -> (integer)

The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.

DefaultTargetCapacityType -> (string)

The default TotalTargetCapacity , which is either Spot or On-Demand .

TerminateInstancesWithExpiration -> (boolean)

Indicates whether running instances should be terminated when the EC2 Fleet expires.

Type -> (string)

The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain .

ValidFrom -> (timestamp)

The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.

ValidUntil -> (timestamp)

The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

ReplaceUnhealthyInstances -> (boolean)

Indicates whether EC2 Fleet should replace unhealthy instances.

SpotOptions -> (structure)

The configuration of Spot Instances in an EC2 Fleet.

AllocationStrategy -> (string)

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified , EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized , EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

InstanceInterruptionBehavior -> (string)

The behavior when a Spot Instance is interrupted. The default is terminate .

InstancePoolsToUseCount -> (integer)

The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowest-price . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

SingleInstanceType -> (boolean)

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant .

SingleAvailabilityZone -> (boolean)

Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant .

MinTargetCapacity -> (integer)

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

MaxTotalPrice -> (string)

The maximum amount per hour for Spot Instances that you’re willing to pay.

OnDemandOptions -> (structure)

The allocation strategy of On-Demand Instances in an EC2 Fleet.

AllocationStrategy -> (string)

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price , EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price .

CapacityReservationOptions -> (structure)

The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant .

UsageStrategy -> (string)

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized ).

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

SingleInstanceType -> (boolean)

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type instant .

SingleAvailabilityZone -> (boolean)

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant .

MinTargetCapacity -> (integer)

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

MaxTotalPrice -> (string)

The maximum amount per hour for On-Demand Instances that you’re willing to pay.

Tags -> (list)

The tags for an EC2 Fleet resource.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Errors -> (list)

Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant .

(structure)

Describes the instances that could not be launched by the fleet.

LaunchTemplateAndOverrides -> (structure)

The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

LaunchTemplateSpecification -> (structure)

The launch template.

LaunchTemplateId -> (string)

The ID of the launch template. If you specify the template ID, you can’t specify the template name.

LaunchTemplateName -> (string)

The name of the launch template. If you specify the template name, you can’t specify the template ID.

Version -> (string)

The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

If the value is $Default , Amazon EC2 uses the default version of the launch template.

Overrides -> (structure)

Any parameters that you specify override the same parameters in the launch template.

InstanceType -> (string)

The instance type.

MaxPrice -> (string)

The maximum price per unit hour that you are willing to pay for a Spot Instance.

SubnetId -> (string)

The ID of the subnet in which to launch the instances.

AvailabilityZone -> (string)

The Availability Zone in which to launch the instances.

WeightedCapacity -> (double)

The number of units provided by the specified instance type.

Priority -> (double)

The priority for the launch template override. If AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority.

Placement -> (structure)

The location where the instance launched, if applicable.

GroupName -> (string)

The name of the placement group that the instance is in.

Lifecycle -> (string)

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

ErrorCode -> (string)

The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes .

ErrorMessage -> (string)

The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes .

Instances -> (list)

Information about the instances that were launched by the fleet. Valid only when Type is set to instant .

(structure)

Describes the instances that were launched by the fleet.

LaunchTemplateAndOverrides -> (structure)

The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

LaunchTemplateSpecification -> (structure)

The launch template.

LaunchTemplateId -> (string)

The ID of the launch template. If you specify the template ID, you can’t specify the template name.

LaunchTemplateName -> (string)

The name of the launch template. If you specify the template name, you can’t specify the template ID.

Version -> (string)

The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

If the value is $Default , Amazon EC2 uses the default version of the launch template.

Overrides -> (structure)

Any parameters that you specify override the same parameters in the launch template.

InstanceType -> (string)

The instance type.

MaxPrice -> (string)

The maximum price per unit hour that you are willing to pay for a Spot Instance.

SubnetId -> (string)

The ID of the subnet in which to launch the instances.

AvailabilityZone -> (string)

The Availability Zone in which to launch the instances.

WeightedCapacity -> (double)

The number of units provided by the specified instance type.

Priority -> (double)

The priority for the launch template override. If AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority.

Placement -> (structure)

The location where the instance launched, if applicable.

GroupName -> (string)

The name of the placement group that the instance is in.

Lifecycle -> (string)

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

InstanceIds -> (list)

The IDs of the instances.

(string)

InstanceType -> (string)

The instance type.

Platform -> (string)

The value is Windows for Windows instances. Otherwise, the value is blank.