Skip to content

UpdateCampaignResponse

Source code in docs_src/capo_iotfleetwise/types/update_campaign_response.py 
13
14
15
16
17
18
19
class UpdateCampaignResponse(TypedDict, closed=True):
    arn: NotRequired["capo_iotfleetwise.types.campaign_arn.campaignArn"]
    """<p> The Amazon Resource Name (ARN) of the campaign. </p>"""
    name: NotRequired["capo_iotfleetwise.types.campaign_name.campaignName"]
    """<p>The name of the updated campaign.</p>"""
    status: NotRequired["capo_iotfleetwise.types.campaign_status.CampaignStatus"]
    """<p>The state of a campaign. The status can be one of:</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 you create a campaign, it enters this state. Use the API operation to approve the campaign for deployment to the target vehicle or fleet. </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>"""

arn instance-attribute 

arn: NotRequired[campaignArn]

The Amazon Resource Name (ARN) of the campaign.

name instance-attribute 

name: NotRequired[campaignName]

The name of the updated campaign.

status instance-attribute 

status: NotRequired[CampaignStatus]

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

  • CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

  • WAITING_FOR_APPROVAL - After you create a campaign, it enters this state. Use the API operation to approve the campaign for deployment to the target vehicle or fleet.

  • RUNNING - The campaign is active.

  • SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.