IoTFleetWise / Client / import_signal_catalog

import_signal_catalog#

IoTFleetWise.Client.import_signal_catalog(**kwargs)#

Creates a signal catalog using your existing VSS formatted content from your local device.

See also: AWS API Documentation

Request Syntax

response = client.import_signal_catalog(
    name='string',
    description='string',
    vss={
        'vssJson': 'string'
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the signal catalog to import.

  • description (string) – A brief description of the signal catalog.

  • vss (dict) –

    The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: vssJson.

    • vssJson (string) –

      Provides the VSS in JSON format.

  • tags (list) –

    Metadata that can be used to manage the signal catalog.

    • (dict) –

      A set of key/value pairs that are used to manage the resource.

      • Key (string) – [REQUIRED]

        The tag’s key.

      • Value (string) – [REQUIRED]

        The tag’s value.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string'
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the imported signal catalog.

    • arn (string) –

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

Exceptions