IoTFleetWise / Client / list_vehicles

list_vehicles

IoTFleetWise.Client.list_vehicles(**kwargs)

Retrieves a list of summaries of created vehicles.

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_vehicles(
    modelManifestArn='string',
    attributeNames=[
        'string',
    ],
    attributeValues=[
        'string',
    ],
    nextToken='string',
    maxResults=123,
    listResponseScope='METADATA_ONLY'
)
Parameters:

  • modelManifestArn (string) – The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.

  • attributeNames (list) –

    The fully qualified names of the attributes. You can use this optional parameter to list the vehicles containing all the attributes in the request. For example, attributeNames could be “ Vehicle.Body.Engine.Type, Vehicle.Color” and the corresponding attributeValues could be “ 1.3 L R2, Blue” . In this case, the API will filter vehicles with an attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of “ Blue”. A request must contain unique values for the attributeNames filter and the matching number of attributeValues filters to return the subset of vehicles that match the attributes filter condition.

    • (string) –

  • attributeValues (list) –

    Static information about a vehicle attribute value in string format. You can use this optional parameter in conjunction with attributeNames to list the vehicles containing all the attributeValues corresponding to the attributeNames filter. For example, attributeValues could be “ 1.3 L R2, Blue” and the corresponding attributeNames filter could be “ Vehicle.Body.Engine.Type, Vehicle.Color”. In this case, the API will filter vehicles with attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of “ Blue”. A request must contain unique values for the attributeNames filter and the matching number of attributeValues filter to return the subset of vehicles that match the attributes filter condition.

    • (string) –

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

  • listResponseScope (string) – When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time.

Return type:

dict

Returns:

Response Syntax

{
    'vehicleSummaries': [
        {
            'vehicleName': 'string',
            'arn': 'string',
            'modelManifestArn': 'string',
            'decoderManifestArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1),
            'attributes': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • vehicleSummaries (list) –

      A list of vehicles and information about them.

      • (dict) –

        Information about a vehicle.

        To return this information about vehicles in your account, you can use the API operation.

        • vehicleName (string) –

          The unique ID of the vehicle.

        • arn (string) –

          The Amazon Resource Name (ARN) of the vehicle.

        • modelManifestArn (string) –

          The ARN of a vehicle model (model manifest) associated with the vehicle.

        • decoderManifestArn (string) –

          The ARN of a decoder manifest associated with the vehicle.

        • creationTime (datetime) –

          The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).

        • lastModificationTime (datetime) –

          The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

        • attributes (dict) –

          Static information about a vehicle in a key-value pair. For example:

          "engineType" : "1.3 L R2"

          • (string) –

            • (string) –

    • nextToken (string) –

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

Exceptions