IoTFleetWise / Client / list_model_manifests

list_model_manifests#

IoTFleetWise.Client.list_model_manifests(**kwargs)#

Retrieves a list of vehicle models (model manifests).

Note

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

Request Syntax

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

Parameters:

signalCatalogArn (string) – The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
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

{
    'summaries': [
        {
            'name': 'string',
            'arn': 'string',
            'signalCatalogArn': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'DRAFT',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- summaries (list) –
  
  A list of information about vehicle models.
  - (dict) –
    
    Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.
    - name (string) –
      
      The name of the vehicle model.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the vehicle model.
    - signalCatalogArn (string) –
      
      The ARN of the signal catalog associated with the vehicle model.
    - description (string) –
      
      A brief description of the vehicle model.
    - status (string) –
      
      The state of the vehicle model. If the status is ACTIVE, the vehicle model can’t be edited. If the status is DRAFT, you can edit the vehicle model.
    - creationTime (datetime) –
      
      The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) –
      
      The time the vehicle model 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.ThrottlingException
IoTFleetWise.Client.exceptions.ValidationException
IoTFleetWise.Client.exceptions.AccessDeniedException