IoTFleetWise / Client / list_fleets_for_vehicle

list_fleets_for_vehicle#

IoTFleetWise.Client.list_fleets_for_vehicle(**kwargs)#

Retrieves a list of IDs for all fleets that the vehicle is associated with.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.list_fleets_for_vehicle(
    vehicleName='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • vehicleName (string) –

    [REQUIRED]

    The ID of the vehicle to retrieve information about.

  • 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

{
    'fleets': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • fleets (list) –

      A list of fleet IDs that the vehicle is associated with.

      • (string) –

    • nextToken (string) –

      The token to retrieve the next set of results, or null if there are no more results.

Exceptions