CampaignSummary

Information about a campaign.

You can use the ListCampaigns API operation to return this information about multiple created campaigns.

creationTime

The time the campaign was created.

Type: Timestamp

Required: Yes

lastModificationTime

The last time the campaign was modified.

Type: Timestamp

Required: Yes

arn

The Amazon Resource Name (ARN) of a campaign.

Type: String

Required: No

description

The description of the campaign.

Type: String

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

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

Required: No

name

The name of a campaign.

Type: String

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

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

Required: No

signalCatalogArn

The ARN of the signal catalog associated with the campaign.

Type: String

Required: No

status

The state of a campaign. The status can be one of the following:

CREATING - AWS IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow AWS IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the UpdateCampaign API operation to approve the campaign.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the UpdateCampaign API operation.

Type: String

Valid Values: CREATING | WAITING_FOR_APPROVAL | RUNNING | SUSPENDED

Required: No

targetArn

The ARN of a vehicle or fleet to which the campaign is deployed.

Type: String

Required: No

Contents