IoTFleetWise / Client / get_signal_catalog

get_signal_catalog

IoTFleetWise.Client.get_signal_catalog(**kwargs)

Retrieves information about a signal catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_signal_catalog(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the signal catalog to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'description': 'string',
    'nodeCounts': {
        'totalNodes': 123,
        'totalBranches': 123,
        'totalSensors': 123,
        'totalAttributes': 123,
        'totalActuators': 123,
        'totalStructs': 123,
        'totalProperties': 123
    },
    'creationTime': datetime(2015, 1, 1),
    'lastModificationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • name (string) –

    The name of the signal catalog.

  • arn (string) –

    The Amazon Resource Name (ARN) of the signal catalog.

  • description (string) –

    A brief description of the signal catalog.

  • nodeCounts (dict) –

    The total number of network nodes specified in a signal catalog.

    • totalNodes (integer) –

      The total number of nodes in a vehicle network.

    • totalBranches (integer) –

      The total number of nodes in a vehicle network that represent branches.

    • totalSensors (integer) –

      The total number of nodes in a vehicle network that represent sensors.

    • totalAttributes (integer) –

      The total number of nodes in a vehicle network that represent attributes.

    • totalActuators (integer) –

      The total number of nodes in a vehicle network that represent actuators.

    • totalStructs (integer) –

      The total structure for the node.

    • totalProperties (integer) –

      The total properties for the node.

  • creationTime (datetime) –

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

  • lastModificationTime (datetime) –

    The last time the signal catalog was modified.

Exceptions

• IoTFleetWise.Client.exceptions.ResourceNotFoundException

• IoTFleetWise.Client.exceptions.InternalServerException

• IoTFleetWise.Client.exceptions.ThrottlingException

• IoTFleetWise.Client.exceptions.ValidationException

• IoTFleetWise.Client.exceptions.AccessDeniedException