Table Of Contents


User Guide

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

[ aws . gamelift ]



Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.


Fleet records are not listed in any particular order.

Fleet-related operations include:

  • create-fleet
  • list-fleets
  • Describe fleets:
    • describe-fleet-attributes
    • describe-fleet-port-settings
    • describe-fleet-utilization
    • describe-runtime-configuration
    • describe-fleet-events
  • Update fleets:
    • update-fleet-attributes
    • update-fleet-capacity
    • update-fleet-port-settings
    • update-runtime-configuration
  • Manage fleet capacity:
    • describe-fleet-capacity
    • update-fleet-capacity
    • put-scaling-policy (automatic scaling)
    • describe-scaling-policies (automatic scaling)
    • delete-scaling-policy (automatic scaling)
    • describe-ec2-instance-limits
  • delete-fleet

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--build-id <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--build-id (string)

Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

--limit (integer)

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

--next-token (string)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

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


FleetIds -> (list)

Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to describe-fleet-attributes , describe-fleet-capacity , or describe-fleet-utilization .


NextToken -> (string)

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.