Skip to content

CampaignSummary

Source code in docs_src/capo_partnercentral_marketing/types/campaign_summary.py
class CampaignSummary(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. Present on the summary so a caller can tag a campaign straight from a list result without a GetCampaign per row — the same reason the audit timestamps are here."""
    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`."""
    language: NotRequired[
        "capo_partnercentral_marketing.types.asset_language.AssetLanguage"
    ]
    """The language the campaign's assets are written and typeset in. See `Campaign$Language`."""
    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. Present on the summary so a caller can order a list by recency without reading each campaign in full."""
    updated_at: NotRequired["capo_partnercentral_marketing.types.timestamp.Timestamp"]
    """Last update timestamp. Present on the summary for the same reason as CreatedAt."""

arn instance-attribute

The campaign ARN. Present on the summary so a caller can tag a campaign straight from a list result without a GetCampaign per row — the same reason the audit timestamps are here.

campaign_id instance-attribute

campaign_id: CampaignId

The campaign identifier.

created_at instance-attribute

created_at: NotRequired[Timestamp]

Creation timestamp. Present on the summary so a caller can order a list by recency without reading each campaign in full.

end_on instance-attribute

end_on: NotRequired[UtcDate]

The last day of the campaign's run window.

language instance-attribute

language: NotRequired[AssetLanguage]

The language the campaign's assets are written and typeset in. See Campaign$Language.

name instance-attribute

The display name.

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.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

Last update timestamp. Present on the summary for the same reason as CreatedAt.