Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCampaign

Retrieves information about a campaign.

Important

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide.

Request Syntax


{
   "name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

name

The name of the campaign to retrieve information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

Required: Yes

Response Syntax


{
   "arn": "string",
   "collectionScheme": { ... },
   "compression": "string",
   "creationTime": number,
   "dataDestinationConfigs": [ 
      { ... }
   ],
   "dataExtraDimensions": [ "string" ],
   "dataPartitions": [ 
      { 
         "id": "string",
         "storageOptions": { 
            "maximumSize": { 
               "unit": "string",
               "value": number
            },
            "minimumTimeToLive": { 
               "unit": "string",
               "value": number
            },
            "storageLocation": "string"
         },
         "uploadOptions": { 
            "conditionLanguageVersion": number,
            "expression": "string"
         }
      }
   ],
   "description": "string",
   "diagnosticsMode": "string",
   "expiryTime": number,
   "lastModificationTime": number,
   "name": "string",
   "postTriggerCollectionDuration": number,
   "priority": number,
   "signalCatalogArn": "string",
   "signalsToCollect": [ 
      { 
         "dataPartitionId": "string",
         "maxSampleCount": number,
         "minimumSamplingIntervalMs": number,
         "name": "string"
      }
   ],
   "signalsToFetch": [ 
      { 
         "actions": [ "string" ],
         "conditionLanguageVersion": number,
         "fullyQualifiedName": "string",
         "signalFetchConfig": { ... }
      }
   ],
   "spoolingMode": "string",
   "startTime": number,
   "status": "string",
   "targetArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The Amazon Resource Name (ARN) of the campaign.

Type: String

collectionScheme

Information about the data collection scheme associated with the campaign.

Type: CollectionScheme object

Note: This object is a Union. Only one member of this object can be specified or returned.

compression

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

Type: String

Valid Values: OFF | SNAPPY

creationTime

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

Type: Timestamp

dataDestinationConfigs

The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

MQTT is the publish/subscribe messaging protocol used by AWS IoT to communicate with your devices.

Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

Type: Array of DataDestinationConfig objects

Array Members: Fixed number of 1 item.

dataExtraDimensions

A list of vehicle attributes associated with the campaign.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 150.

Pattern: [a-zA-Z0-9_.]+

dataPartitions

The data partitions associated with the signals collected from the vehicle.

Type: Array of DataPartition objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

description

The description of the campaign.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

diagnosticsMode

Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise.

Type: String

Valid Values: OFF | SEND_ACTIVE_DTCS

expiryTime

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.

Type: Timestamp

lastModificationTime

The last time the campaign was modified.

Type: Timestamp

name

The name of the campaign.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

postTriggerCollectionDuration

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

Type: Long

Valid Range: Minimum value of 0. Maximum value of 4294967295.

priority

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.

Type: Integer

Valid Range: Minimum value of 0.

signalCatalogArn

The ARN of a signal catalog.

Type: String

signalsToCollect

Information about a list of signals to collect data on.

Type: Array of SignalInformation objects

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

signalsToFetch

Information about a list of signals to fetch data from.

Type: Array of SignalFetchInformation objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

spoolingMode

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 AWS IoT FleetWise.

Type: String

Valid Values: OFF | TO_DISK

startTime

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

Type: Timestamp

status

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

Type: String

Valid Values: CREATING | WAITING_FOR_APPROVAL | RUNNING | SUSPENDED

targetArn

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 400

ThrottlingException

The request couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400