Skip to content

Campaign

Source code in docs_src/capo_partnercentral_marketing/types/campaign.py
class Campaign(TypedDict, closed=True):
    campaign_id: "capo_partnercentral_marketing.types.campaign_id.CampaignId"
    """The campaign identifier."""
    arn: "capo_partnercentral_marketing.types.taggable_resource_arn.TaggableResourceArn"
    """The campaign ARN."""
    name: "capo_partnercentral_marketing.types.campaign_name.CampaignName"
    """The display name."""
    state: "capo_partnercentral_marketing.types.campaign_state.CampaignState"
    """The campaign's state, derived on every read from `EndOn` and its assets. See `CampaignState`."""
    campaign_template_id: NotRequired[
        "capo_partnercentral_marketing.types.campaign_template_id.CampaignTemplateId"
    ]
    """The campaign template this campaign draws its assets from. Set at create, immutable."""
    language: NotRequired[
        "capo_partnercentral_marketing.types.asset_language.AssetLanguage"
    ]
    """The language the campaign's assets are written and typeset in: its template's `LanguageCode`, set at create. To work in another language, create the campaign from that language's template."""
    partner_profile: NotRequired[
        "capo_partnercentral_marketing.types.partner_profile_branding.PartnerProfileBranding"
    ]
    """The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign. Read-only here: the partner edits it in Partner Central, and the next activation or export uses the change. Absent only when the partner has no profile."""
    sender_email: NotRequired[
        "capo_partnercentral_marketing.types.sender_email.SenderEmail"
    ]
    """The address the campaign's emails are sent from. Absent until one is set."""
    privacy_policy_url: NotRequired[
        "capo_partnercentral_marketing.types.privacy_policy_url.PrivacyPolicyUrl"
    ]
    """The URL of the partner's privacy policy. Absent until one is set."""
    partner_address: NotRequired[
        "capo_partnercentral_marketing.types.partner_address.PartnerAddress"
    ]
    """The partner's postal address. Absent until one is set."""
    partner_badge: NotRequired[
        "capo_partnercentral_marketing.types.partner_badge_detail.PartnerBadgeDetail"
    ]
    """The partner's badge. Absent until one is set, and every badge slot shows the Standalone AWS Partner badge while the partner's primary AWS Partner path is at stage Validated or Differentiated. Below that, no badge is shown."""
    email_target: NotRequired[
        "capo_partnercentral_marketing.types.email_target_detail.EmailTargetDetail"
    ]
    """The attached recipient list — metadata only. There is no read path for the addresses."""
    email_target_engagement_group_ids: NotRequired[
        "capo_partnercentral_marketing.types.engagement_group_id_list.EngagementGroupIdList"
    ]
    """The engagement groups set by `CreateCampaign` / `UpdateCampaign`. Absent until set. Resolved to recipients at Start, where the stage can."""
    social_connections: NotRequired[
        "capo_partnercentral_marketing.types.campaign_social_connections.CampaignSocialConnections"
    ]
    """The account the campaign's social posts publish from, per platform, as set by `UpdateCampaign`. Absent until one is set. <p>Needed only for a platform where you hold two or more connections. With none set, a post uses your one connection on its platform, and fails `SOCIAL_CONNECTION_NOT_CHOSEN` when you hold several. A choice that no longer names a connection on its platform fails `SOCIAL_CONNECTION_MISSING`. Join with `ListSocialConnections` for each connection's status."""
    estimated_budget: NotRequired[
        "capo_partnercentral_marketing.types.monetary_value.MonetaryValue"
    ]
    """What the partner expects the campaign to cost."""
    total_budget: NotRequired[
        "capo_partnercentral_marketing.types.monetary_value.MonetaryValue"
    ]
    """The campaign's total budget."""
    target_audience: NotRequired[
        "capo_partnercentral_marketing.types.target_audience.TargetAudience"
    ]
    """Target audience configuration."""
    start_on: NotRequired["capo_partnercentral_marketing.types.utc_date.UtcDate"]
    """The first day of the campaign's run window."""
    end_on: NotRequired["capo_partnercentral_marketing.types.utc_date.UtcDate"]
    """The last day of the campaign's run window."""
    created_at: NotRequired["capo_partnercentral_marketing.types.timestamp.Timestamp"]
    """Creation timestamp."""
    updated_at: NotRequired["capo_partnercentral_marketing.types.timestamp.Timestamp"]
    """Last update timestamp."""
    activation_issues: (
        "capo_partnercentral_marketing.types.activation_issue_list.ActivationIssueList"
    )
    """Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing. Each issue names the setting in `CampaignSetting` — set it with `UpdateCampaign` — or the profile value in `PartnerProfileField` — set it in Partner Central — and the assets it blocks in `AffectedAssetIds`. `StartCampaignAssetActivationTask` refuses with `ValidationException` (`CAMPAIGN_INCOMPLETE`) while a requested asset is affected."""

activation_issues instance-attribute

activation_issues: ActivationIssueList

Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing. Each issue names the setting in CampaignSetting — set it with UpdateCampaign — or the profile value in PartnerProfileField — set it in Partner Central — and the assets it blocks in AffectedAssetIds. StartCampaignAssetActivationTask refuses with ValidationException (CAMPAIGN_INCOMPLETE) while a requested asset is affected.

arn instance-attribute

The campaign ARN.

campaign_id instance-attribute

campaign_id: CampaignId

The campaign identifier.

campaign_template_id instance-attribute

campaign_template_id: NotRequired[CampaignTemplateId]

The campaign template this campaign draws its assets from. Set at create, immutable.

created_at instance-attribute

created_at: NotRequired[Timestamp]

Creation timestamp.

email_target instance-attribute

email_target: NotRequired[EmailTargetDetail]

The attached recipient list — metadata only. There is no read path for the addresses.

email_target_engagement_group_ids instance-attribute

email_target_engagement_group_ids: NotRequired[EngagementGroupIdList]

The engagement groups set by CreateCampaign / UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.

end_on instance-attribute

end_on: NotRequired[UtcDate]

The last day of the campaign's run window.

estimated_budget instance-attribute

estimated_budget: NotRequired[MonetaryValue]

What the partner expects the campaign to cost.

language instance-attribute

language: NotRequired[AssetLanguage]

The language the campaign's assets are written and typeset in: its template's LanguageCode, set at create. To work in another language, create the campaign from that language's template.

name instance-attribute

The display name.

partner_address instance-attribute

partner_address: NotRequired[PartnerAddress]

The partner's postal address. Absent until one is set.

partner_badge instance-attribute

partner_badge: NotRequired[PartnerBadgeDetail]

The partner's badge. Absent until one is set, and every badge slot shows the Standalone AWS Partner badge while the partner's primary AWS Partner path is at stage Validated or Differentiated. Below that, no badge is shown.

partner_profile instance-attribute

partner_profile: NotRequired[PartnerProfileBranding]

The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign. Read-only here: the partner edits it in Partner Central, and the next activation or export uses the change. Absent only when the partner has no profile.

privacy_policy_url instance-attribute

privacy_policy_url: NotRequired[PrivacyPolicyUrl]

The URL of the partner's privacy policy. Absent until one is set.

sender_email instance-attribute

sender_email: NotRequired[SenderEmail]

The address the campaign's emails are sent from. Absent until one is set.

social_connections instance-attribute

social_connections: NotRequired[CampaignSocialConnections]

The account the campaign's social posts publish from, per platform, as set by UpdateCampaign. Absent until one is set.

Needed only for a platform where you hold two or more connections. With none set, a post uses your one connection on its platform, and fails SOCIAL_CONNECTION_NOT_CHOSEN when you hold several. A choice that no longer names a connection on its platform fails SOCIAL_CONNECTION_MISSING. Join with ListSocialConnections for each connection's status.

start_on instance-attribute

start_on: NotRequired[UtcDate]

The first day of the campaign's run window.

state instance-attribute

The campaign's state, derived on every read from EndOn and its assets. See CampaignState.

target_audience instance-attribute

target_audience: NotRequired[TargetAudience]

Target audience configuration.

total_budget instance-attribute

total_budget: NotRequired[MonetaryValue]

The campaign's total budget.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

Last update timestamp.