IoTFleetWise / Client / get_campaign

get_campaign#

IoTFleetWise.Client.get_campaign(**kwargs)#

Retrieves information about a campaign.

See also: AWS API Documentation

Request Syntax

response = client.get_campaign(
    name='string'
)
Parameters:

name (string) –

[REQUIRED]

The name of the campaign to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'description': 'string',
    'signalCatalogArn': 'string',
    'targetArn': 'string',
    'status': 'CREATING'|'WAITING_FOR_APPROVAL'|'RUNNING'|'SUSPENDED',
    'startTime': datetime(2015, 1, 1),
    'expiryTime': datetime(2015, 1, 1),
    'postTriggerCollectionDuration': 123,
    'diagnosticsMode': 'OFF'|'SEND_ACTIVE_DTCS',
    'spoolingMode': 'OFF'|'TO_DISK',
    'compression': 'OFF'|'SNAPPY',
    'priority': 123,
    'signalsToCollect': [
        {
            'name': 'string',
            'maxSampleCount': 123,
            'minimumSamplingIntervalMs': 123
        },
    ],
    'collectionScheme': {
        'timeBasedCollectionScheme': {
            'periodMs': 123
        },
        'conditionBasedCollectionScheme': {
            'expression': 'string',
            'minimumTriggerIntervalMs': 123,
            'triggerMode': 'ALWAYS'|'RISING_EDGE',
            'conditionLanguageVersion': 123
        }
    },
    'dataExtraDimensions': [
        'string',
    ],
    'creationTime': datetime(2015, 1, 1),
    'lastModificationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the campaign.

    • arn (string) –

      The Amazon Resource Name (ARN) of the campaign.

    • description (string) –

      The description of the campaign.

    • signalCatalogArn (string) –

      The ARN of a signal catalog.

    • targetArn (string) –

      The ARN of the vehicle or the fleet targeted by the campaign.

    • status (string) –

      The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

    • startTime (datetime) –

      The time, in milliseconds, to deliver a campaign after it was approved.

    • expiryTime (datetime) –

      The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won’t be collected after the campaign expires.

    • postTriggerCollectionDuration (integer) –

      How long (in seconds) to collect raw data after a triggering event initiates the collection.

    • diagnosticsMode (string) –

      Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

    • spoolingMode (string) –

      Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.

    • compression (string) –

      Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren’t compressed. If it’s not specified, SNAPPY is used.

    • priority (integer) –

      A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.

    • signalsToCollect (list) –

      Information about a list of signals to collect data on.

      • (dict) –

        Information about a signal.

        • name (string) –

          The name of the signal.

        • maxSampleCount (integer) –

          The maximum number of samples to collect.

        • minimumSamplingIntervalMs (integer) –

          The minimum duration of time (in milliseconds) between two triggering events to collect data.

          Note

          If a signal changes often, you might want to collect data at a slower rate.

    • collectionScheme (dict) –

      Information about the data collection scheme associated with the campaign.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: timeBasedCollectionScheme, conditionBasedCollectionScheme. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • timeBasedCollectionScheme (dict) –

        Information about a collection scheme that uses a time period to decide how often to collect data.

        • periodMs (integer) –

          The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.

      • conditionBasedCollectionScheme (dict) –

        Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

        • expression (string) –

          The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0.

        • minimumTriggerIntervalMs (integer) –

          The minimum duration of time between two triggering events to collect data, in milliseconds.

          Note

          If a signal changes often, you might want to collect data at a slower rate.

        • triggerMode (string) –

          Whether to collect data for all triggering events ( ALWAYS). Specify ( RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on “AirbagDeployed”; Users aren’t interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.

        • conditionLanguageVersion (integer) –

          Specifies the version of the conditional expression language.

    • dataExtraDimensions (list) –

      A list of vehicle attributes associated with the campaign.

      • (string) –

    • creationTime (datetime) –

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

    • lastModificationTime (datetime) –

      The last time the campaign was modified.

Exceptions

  • IoTFleetWise.Client.exceptions.ResourceNotFoundException

  • IoTFleetWise.Client.exceptions.InternalServerException

  • IoTFleetWise.Client.exceptions.ThrottlingException

  • IoTFleetWise.Client.exceptions.ValidationException

  • IoTFleetWise.Client.exceptions.AccessDeniedException