IoTFleetWise / Client / list_fleets

list_fleets#

IoTFleetWise.Client.list_fleets(**kwargs)#

Retrieves information for each created fleet in an Amazon Web Services account.

Note

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Request Syntax

response = client.list_fleets(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) –
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
maxResults (integer) – The maximum number of items to return, between 1 and 100, inclusive.

Return type:

dict

Returns:

Response Syntax

{
    'fleetSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'description': 'string',
            'signalCatalogArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- fleetSummaries (list) –
  
  A list of information for each fleet.
  - (dict) –
    
    Information about a fleet.
    
    You can use the API operation to return this information about multiple fleets.
    - id (string) –
      
      The unique ID of the fleet.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the fleet.
    - description (string) –
      
      A brief description of the fleet.
    - signalCatalogArn (string) –
      
      The ARN of the signal catalog associated with the fleet.
    - creationTime (datetime) –
      
      The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) –
      
      The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- nextToken (string) –
  
  The token to retrieve the next set of results, or null if there are no more results.

Exceptions

IoTFleetWise.Client.exceptions.InternalServerException
IoTFleetWise.Client.exceptions.ResourceNotFoundException
IoTFleetWise.Client.exceptions.ThrottlingException
IoTFleetWise.Client.exceptions.ValidationException
IoTFleetWise.Client.exceptions.AccessDeniedException