CampaignSummary ¶

class CampaignSummary(TypedDict, closed=True):
    arn: NotRequired["capo_iotfleetwise.types.campaign_arn.campaignArn"]
    """<p>The Amazon Resource Name (ARN) of a campaign.</p>"""
    name: NotRequired["capo_iotfleetwise.types.campaign_name.campaignName"]
    """<p>The name of a campaign.</p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>The description of the campaign.</p>"""
    signal_catalog_arn: NotRequired["capo_iotfleetwise.types.arn.arn"]
    """<p>The ARN of the signal catalog associated with the campaign.</p>"""
    target_arn: NotRequired["capo_iotfleetwise.types.arn.arn"]
    """<p>The ARN of a vehicle or fleet to which the campaign is deployed.</p>"""
    status: NotRequired["capo_iotfleetwise.types.campaign_status.CampaignStatus"]
    """<p>The state of a campaign. The status can be one of the following:</p> <ul> <li> <p> <code>CREATING</code> - Amazon Web Services IoT FleetWise is processing your request to create the campaign.</p> </li> <li> <p> <code>WAITING_FOR_APPROVAL</code> - After a campaign is created, it enters the <code>WAITING_FOR_APPROVAL</code> state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign. </p> </li> <li> <p> <code>RUNNING</code> - The campaign is active. </p> </li> <li> <p> <code>SUSPENDED</code> - The campaign is suspended. To resume the campaign, use the API operation. </p> </li> </ul>"""
    creation_time: "capo_iotfleetwise.types.timestamp.timestamp"
    """<p>The time the campaign was created.</p>"""
    last_modification_time: "capo_iotfleetwise.types.timestamp.timestamp"
    """<p>The last time the campaign was modified.</p>"""