UpdateCampaignRequest
¶
Source code in docs_src/capo_partnercentral_marketing/types/update_campaign_request.py
campaign_identifier
instance-attribute
¶
campaign_identifier: CampaignIdentifier
The campaign identifier.
client_token
instance-attribute
¶
client_token: NotRequired[ClientToken]
Idempotency token. Accepted and not stored: this is a change-only partial update with last-writer-wins, so re-applying the same call produces the same result and the same response. There is nothing a replay cache would protect.
email_target
instance-attribute
¶
email_target: NotRequired[FileRef]
Replaces the campaign's attached recipient list.
The referenced object is copied and pinned again on every call that supplies it, so the pinned copy always reflects the last UpdateCampaign that named one. Editing the source object in your own bucket without calling this operation again has no effect.
Replaces, never detaches: a partner can swap the list but cannot remove it.
email_target_engagement_group_ids
instance-attribute
¶
email_target_engagement_group_ids: NotRequired[EngagementGroupIdList]
Engagement groups whose contacts the campaign's emails will also go to (see CreateCampaign). Replaces the stored list; never clears it.
As on CreateCampaign: each group once (INVALID_VALUE otherwise), not checked against your groups when saved, and resolved at Start where the stage can (ENGAGEMENT_GROUPS_UNAVAILABLE where it can't).
end_on
instance-attribute
¶
end_on: NotRequired[UtcDate]
The last day of the campaign's run window, inclusive and in UTC. Editable only while the campaign is open, like everything else here: once the stored EndOn has passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused with ValidationException (INVALID_VALUE) when it is in the past, or earlier than the day of a scheduled send on one of the campaign's assets: move or cancel that send first. Setting it to today ends the campaign at the next UTC midnight.
estimated_budget
instance-attribute
¶
estimated_budget: NotRequired[MonetaryValue]
What the partner expects the campaign to cost.
partner_address
instance-attribute
¶
partner_address: NotRequired[PartnerAddress]
Sets or replaces the partner's postal address. Replaces, never clears.
partner_badge
instance-attribute
¶
partner_badge: NotRequired[FileRef]
Sets or replaces the partner's badge, checked exactly as on CreateCampaign. Replaces, never clears: upload the Standalone AWS Partner badge to show it again. The badge an asset already published keeps showing on it until that asset is activated again.
privacy_policy_url
instance-attribute
¶
privacy_policy_url: NotRequired[PrivacyPolicyUrl]
Sets or replaces the URL of the partner's privacy policy. Replaces, never clears.
sender_email
instance-attribute
¶
sender_email: NotRequired[SenderEmail]
Sets or replaces the address the campaign's emails are sent from. Checked by the same three rules as on CreateCampaign, with the same codes, but only when it differs, ignoring case, from the stored sender: re-sending the stored one is not checked, and StartCampaignAssetActivationTask re-checks it before an email activates.
Replaces, never clears: like every member of this operation, an omitted value leaves the sender as it was, and there is no way to remove one once set.
social_connections
instance-attribute
¶
social_connections: NotRequired[CampaignSocialConnections]
Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.
Not checked against your connections here: a connection can be deleted at any time, so the activation checks the choice. See Campaign$SocialConnections.
start_on
instance-attribute
¶
start_on: NotRequired[UtcDate]
The first day of the campaign's run window. Not after EndOn (ValidationException, INVALID_VALUE).
target_audience
instance-attribute
¶
target_audience: NotRequired[TargetAudience]
Target audience configuration.
total_budget
instance-attribute
¶
total_budget: NotRequired[MonetaryValue]
The campaign's total budget.