IoTFleetWise / Client / list_signal_catalogs

list_signal_catalogs#

IoTFleetWise.Client.list_signal_catalogs(**kwargs)#

Lists all the created signal catalogs in an Amazon Web Services account.

You can use to list information about each signal (node) specified in a signal catalog.

Note

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

Request Syntax

response = client.list_signal_catalogs(
    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

{
    'summaries': [
        {
            'name': 'string',
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- summaries (list) –
  
  A list of information about each signal catalog.
  - (dict) –
    
    Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.
    - name (string) –
      
      The name of the signal catalog.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the signal catalog.
    - creationTime (datetime) –
      
      The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) –
      
      The time the signal catalog 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