IoTFleetWise / Client / list_decoder_manifests

list_decoder_manifests

IoTFleetWise.Client.list_decoder_manifests(**kwargs)

Lists decoder manifests.

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_decoder_manifests(
    modelManifestArn='string',
    nextToken='string',
    maxResults=123,
    listResponseScope='METADATA_ONLY'
)
Parameters:

  • modelManifestArn (string) – The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.

  • 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: decoder manifest name, Amazon Resource Name (ARN), creation time, and last modification time.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • summaries (list) –

      A list of information about each decoder manifest.

      • (dict) –

        Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.

        • name (string) –

          The name of the decoder manifest.

        • arn (string) –

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

        • modelManifestArn (string) –

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

        • description (string) –

          A brief description of the decoder manifest.

        • status (string) –

          The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can’t be edited. If the status is marked DRAFT, you can edit the decoder manifest.

        • creationTime (datetime) –

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

        • lastModificationTime (datetime) –

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

        • message (string) –

          The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.

    • nextToken (string) –

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

Exceptions