IoTFleetWise.Client.get_campaign(**kwargs)¶Retrieves information about a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign(
name='string'
)
[REQUIRED]
The name of the campaign to retrieve information about.
{
'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
The name of the campaign.
The Amazon Resource Name (ARN) of the campaign.
The description of the campaign.
The ARN of a signal catalog.
The ARN of the vehicle or the fleet targeted by the campaign.
The state of the campaign. The status can be one of: CREATING , WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED .
The time, in milliseconds, to deliver a campaign after it was approved.
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.
How long (in seconds) to collect raw data after a triggering event initiates the collection.
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
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.
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.
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.
Information about a list of signals to collect data on.
Information about a signal.
The name of the signal.
The maximum number of samples to collect.
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.
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'}
Information about a collection scheme that uses a time period to decide how often to collect data.
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.
Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0 .
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.
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.
Specifies the version of the conditional expression language.
A list of vehicle attributes associated with the campaign.
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
The last time the campaign was modified.
Exceptions
IoTFleetWise.Client.exceptions.ResourceNotFoundExceptionIoTFleetWise.Client.exceptions.InternalServerExceptionIoTFleetWise.Client.exceptions.ThrottlingExceptionIoTFleetWise.Client.exceptions.ValidationExceptionIoTFleetWise.Client.exceptions.AccessDeniedException