The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListFleets

Retrieves a list of fleets for the current account and Region.

Request Syntax


POST /listFleets HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to be included in the next page.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [\w\-]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "FleetSummaryList": [ 
      { 
         "CompanyCode": "string",
         "CreatedTime": number,
         "DisplayName": "string",
         "FleetArn": "string",
         "FleetName": "string",
         "FleetStatus": "string",
         "LastUpdatedTime": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FleetSummaryList

The summary list of the fleets.

Type: Array of FleetSummary objects

NextToken

The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [\w\-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerErrorException

The service is temporarily unavailable.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

TooManyRequestsException

The number of requests exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this action.

HTTP Status Code: 403