2026/11/19 - Partner Central Marketing API - 23 new api methods
Changes Initial release of AWS Partner Central Marketing, which AWS Partners use to create co-branded marketing campaigns from AWS-authored templates, tailor and activate their emails, landing pages, documents and social posts, and export campaign assets.
Permanently deletes a campaign, its assets and their stored files.
A hard delete with no undo: the campaign leaves ListCampaigns and every read of it returns ResourceNotFoundException. Its tags are removed with it.
Refused with ConflictException while the campaign has a live asset ( CAMPAIGN_HAS_ACTIVE_ASSETS), because deleting the record would orphan what the delivery platform still serves or sends: deactivate those assets first. Also refused while an activation task is running ( CAMPAIGN_ACTIVATION_IN_PROGRESS). A completed campaign can be deleted.
Idempotent in effect: deleting a campaign that is already gone returns ResourceNotFoundException, and nothing is left behind by a retry.
See also: AWS API Documentation
Request Syntax
client.delete_campaign(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign to delete.
None
Lists assets for a campaign with pagination.
See also: AWS API Documentation
Request Syntax
client.list_campaign_assets(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
integer
Maximum results per page.
string
Pagination token.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Category': 'EMAIL'|'LANDING_PAGE'|'SOCIAL_POST'|'BANNER_AD'|'DOCUMENT',
'Name': 'string',
'LinkLabel': 'string',
'State': 'INACTIVE'|'ACTIVE',
'LastActivationStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'DeliveryStatus': 'PENDING'|'DELIVERED'|'FAILED',
'DeliveryStatusReason': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED',
'SourceAssetTemplateId': 'string',
'SocialPlatform': 'FACEBOOK'|'LINKEDIN'|'X',
'StartedAt': datetime(2015, 1, 1),
'FileFormat': 'PDF'|'DOCX'|'PPTX'|'HTML'|'IMAGE',
'SendMode': 'ON_ACTIVATION'|'SCHEDULED',
'ScheduledSendAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output for ListCampaignAssets operation.
Items (list) --
The list of results.
(dict) --
Summary representation of an asset for list operations.
Id (string) --
The asset identifier.
Category (string) --
The asset category.
Name (string) --
The display name.
LinkLabel (string) --
DOCUMENT only: the words a page uses for this document, such as "eBook". A client listing the candidates for an AssetLink field reads it here, so a preview can update on pick without a fetch.
State (string) --
Where the asset sits in its lifecycle.
LastActivationStatus (string) --
How the last hand-over to the delivery platform ended. Absent before the first activation.
DeliveryStatus (string) --
Whether the platform has delivered the asset.
DeliveryStatusReason (string) --
Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry.
SourceAssetTemplateId (string) --
The asset template this asset was created from. The same value CampaignAsset.SourceAssetTemplateId reports, and absent when it is.
SocialPlatform (string) --
SOCIAL_POST only: the platform the post goes to. Join it with ListSocialConnections' status for that platform to show a post that cannot activate (a connection missing, EXPIRED or PAGE_REQUIRED) before Start is pressed.
StartedAt (datetime) --
When the asset first went live, set once. Absent if it never has.
FileFormat (string) --
Concrete file format of the finished artifact.
SendMode (string) --
When this asset sends, as chosen with UpdateCampaignAsset. EMAIL and SOCIAL_POST only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports SEND_MODE_MISSING.
ScheduledSendAt (datetime) --
The send time, present only when SendMode is SCHEDULED. It reaches the delivery platform at the asset's next activation.
Was scheduleDate: UtcDate; retyped with the write member of the same name.
NextToken (string) --
Pagination token.
Creates a single-use URL the partner visits to authorize publishing on a platform. Serves a first connect, connecting a further account, and re-authorizing an expired one: consenting with an account that is already connected re-authorizes that connection and keeps its id; any other account adds a connection. Poll ListSocialConnections for the outcome. Deliberately not idempotent and takes no client token: every call must mint a fresh single-use URL, so replaying a cached response would hand back a dead one.
See also: AWS API Documentation
Request Syntax
client.create_social_connection_authorization_url(
Catalog='AWS'|'Sandbox',
Platform='FACEBOOK'|'LINKEDIN'|'X'
)
string
[REQUIRED]
Catalog the connection belongs to.
string
[REQUIRED]
Social platform to authorize.
dict
Response Syntax
{
'Platform': 'FACEBOOK'|'LINKEDIN'|'X',
'AuthorizationUrl': 'string'
}
Response Structure
(dict) --
Output for CreateSocialConnectionAuthorizationUrl.
Platform (string) --
Social platform the URL authorizes.
AuthorizationUrl (string) --
Fresh single-use URL the partner visits to grant authorization.
Removes tags from a Partner Central Marketing resource.
Idempotent: removing a key that is not present succeeds.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource to remove tags from.
list
[REQUIRED]
The tag keys to remove. Associated values are removed with them.
(string) --
A tag key.
The aws: prefix is reserved for AWS-applied system tags and is rejected for caller-supplied tags — enforced in the service rather than by this pattern, so the rejection carries a message explaining why rather than a bare constraint violation.
dict
Response Syntax
{}
Response Structure
(dict) --
Output for UntagResource.
Adds or replaces tags on a Partner Central Marketing resource.
Idempotent: applying a tag that is already present with the same value is a no-op, and supplying a key that already exists replaces its value.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ARN of the resource to tag.
list
[REQUIRED]
The tags to add or replace.
(dict) --
A key-value pair applied to a resource.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{}
Response Structure
(dict) --
Output for TagResource.
Searches and browses the AWS-authored campaign template catalog. With no SearchText it returns the whole catalog in the default order, so browse and keyword search share one shape; GetCampaignTemplate reads one template.
See also: AWS API Documentation
Request Syntax
client.search_campaign_templates(
Catalog='AWS'|'Sandbox',
SearchText='string',
Industry=[
'FINANCIAL_SERVICES'|'HEALTHCARE'|'MANUFACTURING'|'RETAIL'|'MEDIA_ENTERTAINMENT'|'ENERGY'|'EDUCATION'|'GOVERNMENT'|'TELECOMMUNICATIONS'|'AUTOMOTIVE'|'INSURANCE'|'OTHER',
],
UseCase=[
'string',
],
Language=[
'en'|'es'|'es-419'|'fr'|'de'|'it'|'pt-BR'|'id'|'tr'|'ja'|'ko'|'zh-Hans'|'zh-Hant'|'ar',
],
AwsServices=[
'string',
],
CustomerSegments=[
'ENTERPRISE'|'SMB'|'PUBLIC_SECTOR'|'ISV',
],
Themes=[
'AI'|'MIGRATION_MODERNIZATION'|'SECURITY'|'DATA_ANALYTICS'|'AWS_TRAINING_CERTIFICATION'|'AWS_MARKETPLACE'|'CONNECT'|'EVENTS',
],
Collection=[
'GENERAL'|'BUILD_WITH_AI',
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.
string
Free-text query matched against the template's name and description. Any word may match, and the last word matches as a prefix when it has 3 or more characters, so nov finds Amazon Nova. A template whose name holds the query as a phrase ranks first, then whole-word matches, then prefix-only ones. Omit to browse the whole catalog. Text analysis is derived from each template's own LanguageCode, never from the language filter.
list
Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
(string) --
Industry shape.
list
Restrict to templates with these campaign use cases. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
(string) --
Filter value for template use cases.
list
Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.
(string) --
A language a campaign is written and typeset in, as a BCP 47 tag.
A closed set rather than a free string: each value is one DG can render, and a document needs a font for it, so a tag outside the set could not be honoured.
list
Restrict to templates promoting these AWS services. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
(string) --
list
Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.
(string) --
The customer segment a campaign template is written for. Clients must tolerate values added later.
list
Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.
(string) --
The marketing theme of a campaign template. Clients must tolerate values added later.
list
Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.
(string) --
Which browsing context a campaign template belongs to. A classification of the template, not a resource: it decides where a client lists the template and grants nothing. Every partner may read and use a template in any collection. Clients must tolerate values added later.
integer
Maximum results per page.
string
Pagination token.
dict
Response Syntax
{
'TotalResults': 123,
'CampaignTemplates': [
{
'Id': 'string',
'Name': 'string',
'Industry': 'FINANCIAL_SERVICES'|'HEALTHCARE'|'MANUFACTURING'|'RETAIL'|'MEDIA_ENTERTAINMENT'|'ENERGY'|'EDUCATION'|'GOVERNMENT'|'TELECOMMUNICATIONS'|'AUTOMOTIVE'|'INSURANCE'|'OTHER',
'UseCase': 'string',
'Description': 'string',
'LanguageCode': 'en'|'es'|'es-419'|'fr'|'de'|'it'|'pt-BR'|'id'|'tr'|'ja'|'ko'|'zh-Hans'|'zh-Hant'|'ar',
'Collection': 'GENERAL'|'BUILD_WITH_AI',
'AwsServices': [
'string',
],
'CustomerSegments': [
'ENTERPRISE'|'SMB'|'PUBLIC_SECTOR'|'ISV',
],
'Themes': [
'AI'|'MIGRATION_MODERNIZATION'|'SECURITY'|'DATA_ANALYTICS'|'AWS_TRAINING_CERTIFICATION'|'AWS_MARKETPLACE'|'CONNECT'|'EVENTS',
],
'ThumbnailUrl': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output for SearchCampaignTemplates.
TotalResults (integer) --
Total count over the whole matching set, not just this page — for "over N results" display.
CampaignTemplates (list) --
This page of template summaries.
(dict) --
Summary representation of a campaign template, returned by search.
Id (string) --
The campaign template identifier.
Name (string) --
The display name.
Industry (string) --
Target industry for filtering or categorization.
UseCase (string) --
Campaign use case for filtering or categorization.
Description (string) --
The campaign overview. See CampaignTemplate$Description.
LanguageCode (string) --
Language the template is authored in. See CampaignTemplate$LanguageCode.
Collection (string) --
The browsing context the template is listed in. See CampaignTemplate$Collection.
AwsServices (list) --
AWS services the template promotes.
(string) --
CustomerSegments (list) --
The customer segments the template is written for. See CampaignTemplate$CustomerSegments.
(string) --
The customer segment a campaign template is written for. Clients must tolerate values added later.
Themes (list) --
The template's marketing themes. See CampaignTemplate$Themes.
(string) --
The marketing theme of a campaign template. Clients must tolerate values added later.
ThumbnailUrl (string) --
Thumbnail URL.
NextToken (string) --
Pagination token.
Permanently deletes a campaign asset.
See also: AWS API Documentation
Request Syntax
client.delete_campaign_asset(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
CampaignAssetIdentifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
string
[REQUIRED]
The asset identifier.
None
Activates 1–25 of a campaign's assets as one ordered unit, and returns a task to poll.
Takes a list because the service owns the ordering. Assets link to one another by URL — an email's call-to-action carries the landing page's URL, the landing page's download field carries the document's — and a URL does not exist until the asset it points at is activated. Those edges are derived by the service from the campaign's pinned template, so reconstructing and topologically sorting them is work the service has already done, and getting it wrong arms an email with a dead link. Name every asset you want live and the service sequences them; "activate everything" is the list with every id in it, which ListCampaignAssets already gave you.
Asynchronous, because activating an asset installs or arms behaviour that runs later and an email activation bulk-loads its audience into the delivery platform. Everything decidable without a write to the delivery platform is evaluated before this returns; everything else lands on the task.
A refusal that applies to one asset does not fail the request: that asset is on the task already FAILED, with its reason, and the rest run. A refusal that applies to the whole request — a malformed list, an unknown campaign, another task already running on this campaign, this service's service-linked role being deleted (ConflictException SERVICE_LINKED_ROLE_DELETION_IN_PROGRESS), a campaign setting an asset in the request needs (ValidationException CAMPAIGN_INCOMPLETE), a campaign sender that no longer passes CreateCampaign's sender rules while the request names an email (ValidationException with no FieldList, whose message ends with one Reason: <code> token per failed rule: PATTERN_MISMATCH, SENDER_DOMAIN_NOT_ALLIANCE_LEAD, or SENDER_DOMAIN_DKIM_MISSING and/or SENDER_DOMAIN_DMARC_MISSING) — is thrown, and nothing starts.
One task runs on a campaign at a time. A second concurrent call is refused with ConflictException / CAMPAIGN_ACTIVATION_IN_PROGRESS, whose ResourceId names the task already holding the campaign. Two tasks over disjoint asset sets are refused too: the guard is deliberately campaign-wide, because overlapping runs made the per-asset status misleading rather than merely contended.
See also: AWS API Documentation
Request Syntax
client.start_campaign_asset_activation_task(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
CampaignAssetIdentifiers=[
'string',
],
ClientToken='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier, which also authorizes the call.
list
[REQUIRED]
The assets to activate, in any order — the service derives the dependency order and ignores the order given here.
(string) --
A campaign asset's id: ast- and 13 lowercase letters or digits (DG-087). An asset has no ARN; it is named by its id within its campaign.
string
Idempotency token. Two requests carrying the same token are one request, and the second returns the first one's task rather than starting a second.
The deduplication window is the life of the task record, not a fixed number of hours: replaying a token after the task has expired starts a new task. Stated because a caller would otherwise assume the usual few-hour guarantee.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CampaignId': 'string',
'TaskId': 'string',
'TaskStatus': 'IN_PROGRESS'|'SUCCEEDED'|'PARTIAL_FAILURE'|'FAILED',
'StartedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'Assets': [
{
'CampaignAssetId': 'string',
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'Reason': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Output for StartCampaignAssetActivationTask: the task just created.
CampaignId (string) --
The campaign's id. Canonical: because CampaignIdentifier accepts an id or an ARN, echoing this tells a caller who passed an ARN what the id is. The task's own id is TaskId.
TaskId (string) --
Opaque correlation value for the task. Echoed so a caller can tell the task it started from a later one that superseded it. Never an input: the campaign is what addresses a task, because a campaign has at most one.
TaskStatus (string) --
The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
StartedAt (datetime) --
When the task was created.
EndedAt (datetime) --
When the task reached a terminal status. Absent while IN_PROGRESS.
Assets (list) --
One entry per asset the request named, in the order named. An asset refused up front is FAILED from the first response, with its reason.
(dict) --
How one asset named in a task is going.
CampaignAssetId (string) --
The asset this outcome belongs to.
Status (string) --
This asset's contribution to the task's status.
Reason (string) --
Why the activation did not succeed. Present when status is FAILED.
Message (string) --
A description of Reason for display. Don't parse it. For a mailing-credit shortfall it states the credits needed and remaining.
Revokes and deletes one social connection; other connections on the same platform are untouched. Idempotent: deleting an unknown or already-deleted connection succeeds rather than returning a not-found error.
See also: AWS API Documentation
Request Syntax
client.delete_social_connection(
Catalog='AWS'|'Sandbox',
Identifier='string',
ClientToken='string'
)
string
[REQUIRED]
Catalog the connection belongs to.
string
[REQUIRED]
Identifier or ARN of the social connection to delete.
string
Idempotency token.
This field is autopopulated if not provided.
None
Stops a live campaign asset: an email's scheduled send is withdrawn, a social post is removed before it publishes. On a completed campaign, it also removes a published document, banner or landing page.
Synchronous, and safe to repeat. Does not delete the asset record, so a stopped email or social post can be started again.
Not every asset can be stopped, and the reasons differ in kind. An email that has begun sending cannot be recalled: the send is gone. A document, a banner or a landing page is refused with ASSET_NOT_DEACTIVATABLE until the campaign has completed (the UTC date is after its EndOn). Until then the partner fixes one in place by updating it and activating it again, which keeps its URL, so every email that already linked to it keeps working.
Once the campaign has completed, the removal is permanent, because a completed campaign can't activate anything again:
A document's published PDF is deleted. Its URL stops serving within about a minute (the CDN revalidates), and PublicUrl is no longer returned. Anything that linked to it, such as a landing page's download button or a sent email, reaches an error page. The export still contains the document.
A banner's or landing page's published object is taken down at the delivery platform, and the images the partner put on it are deleted. A landing page stops capturing leads, and its PublicUrl is no longer returned. A partner site that embedded a banner shows nothing there. The platform's own CDN can keep serving a copy a visitor already cached, which collects nothing.
A landing page and a document it links to can be removed in either order.
See also: AWS API Documentation
Request Syntax
client.deactivate_campaign_asset(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
CampaignAssetIdentifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
string
[REQUIRED]
The asset identifier.
dict
Response Syntax
{
'Id': 'string',
'State': 'INACTIVE'|'ACTIVE',
'LastActivationStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'StateReason': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED'
}
Response Structure
(dict) --
Output for DeactivateCampaignAsset.
Synchronous, so the outcome of the stop is this response — there is no lastDeactivationStatus, and its absence is not an oversight. Activation is asynchronous and its outcome arrives long after the response, which is why that one has to be persisted where a partner can read it later.
Id (string) --
The asset identifier.
State (string) --
The asset's lifecycle position — INACTIVE once the stop is confirmed.
LastActivationStatus (string) --
How the most recent activation attempt ended, which a stop does not change. Read with state, it is what separates a stopped asset (INACTIVE + SUCCEEDED) from one never activated (INACTIVE, this member absent). Omitted until a first activation has been attempted.
StateReason (string) --
Why the asset sits where it does. Present when LastActivationStatus is FAILED, or on a deliberate INACTIVE.
Reads a campaign's current activation task.
Keyed on the campaign, with no task identifier, because a campaign has at most one activation task: runs are serialised, so there is no collection to address into. The caller always holds the task id anyway, because Start returned it — the id is a correlation value, not an address.
Returns the campaign's most recent task. A new task overwrites the previous one, so this is not a history: the durable per-asset record is on the assets themselves. Returns ResourceNotFoundException when the campaign has never had a task, or when its last one has expired.
See also: AWS API Documentation
Request Syntax
client.get_campaign_asset_activation_task(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign whose current task to read. This addresses the task, and also authorizes the call.
dict
Response Syntax
{
'CampaignId': 'string',
'TaskId': 'string',
'TaskStatus': 'IN_PROGRESS'|'SUCCEEDED'|'PARTIAL_FAILURE'|'FAILED',
'StartedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'Assets': [
{
'CampaignAssetId': 'string',
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'Reason': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Output for GetCampaignAssetActivationTask: the campaign's most recent task.
CampaignId (string) --
The campaign's id. Canonical: because CampaignIdentifier accepts an id or an ARN, echoing this tells a caller who passed an ARN what the id is. The task's own id is TaskId.
TaskId (string) --
Opaque correlation value for the task. Echoed so a caller can tell the task it started from a later one that superseded it. Never an input: the campaign is what addresses a task, because a campaign has at most one.
TaskStatus (string) --
The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
StartedAt (datetime) --
When the task was created.
EndedAt (datetime) --
When the task reached a terminal status. Absent while IN_PROGRESS.
Assets (list) --
One entry per asset the request named, in the order named. An asset refused up front is FAILED from the first response, with its reason.
(dict) --
How one asset named in a task is going.
CampaignAssetId (string) --
The asset this outcome belongs to.
Status (string) --
This asset's contribution to the task's status.
Reason (string) --
Why the activation did not succeed. Present when status is FAILED.
Message (string) --
A description of Reason for display. Don't parse it. For a mailing-credit shortfall it states the credits needed and remaining.
Lists the tags applied to a Partner Central Marketing resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The ARN of the resource whose tags should be returned.
dict
Response Syntax
{
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Output for ListTagsForResource.
ResourceArn (string) --
The ARN of the resource the tags belong to.
Tags (list) --
The tags currently applied. Absent rather than empty when the resource carries no tags.
(dict) --
A key-value pair applied to a resource.
Key (string) --
The tag key.
Value (string) --
The tag value.
Instantiates one or more of the campaign template's blueprints as assets of this campaign.
The only asset-create operation: DG-038 deleted the singular CreateCampaignAsset, and AWS Batch Operations makes exposing a singular alongside a batch optional ("which MAY actually be exposed in addition"). It also replaced kit instantiation -- CreateCampaign creates zero assets, so this is the only path by which an asset comes into existence.
Errors here are whole-request only, and nothing is written when one is thrown. Per-entry failures ride in the response's Errors list with a 200. ServiceQuotaExceededException is deliberately absent: a campaign holds at most one asset per blueprint (I-15), so the ceiling is the size of the bound kit and a request of unique valid entries cannot exceed it.
See also: AWS API Documentation
Request Syntax
client.batch_create_campaign_asset(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
Entries=[
{
'SourceAssetTemplateIdentifier': 'string'
},
]
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
list
[REQUIRED]
The blueprints to instantiate, one entry each.
(dict) --
One blueprint to instantiate.
Carries nothing but the blueprint's identity, and that is the point rather than a saving: category, name, FileFormat and platform are all derived from the named blueprint, so no caller has a member with which to contradict the pinned schema (asset design section 3.1).
There is deliberately no per-entry ClientToken. AWS Batch Operations requires a request identifier per entry -- "a request identifier CAN either be a resource identifier or a client idempotency token" -- and SourceAssetTemplateIdentifier is a resource identifier, unique across entries and echoed in this entry's error. Idempotency is structural rather than token-based: an asset id is derived from (CampaignId, SourceAssetTemplateId), so a replayed entry resolves to the same asset (I-16).
SourceAssetTemplateIdentifier (string) -- [REQUIRED]
The asset template to instantiate, as returned by GetCampaignTemplate in CampaignTemplate.AssetTemplates[].id.
Must belong to the campaign's own campaign template. An asset's editable field schema is copied from this blueprint at creation and pinned, so an asset without one could be neither validated on update nor made live.
Also this entry's request identifier: it MUST be unique across the request's entries, since a campaign holds at most one asset per blueprint (I-15) and two entries naming the same blueprint could not both succeed.
dict
Response Syntax
{
'Errors': [
{
'SourceAssetTemplateId': 'string',
'Code': 'string',
'Message': 'string'
},
],
'Successful': [
{
'SourceAssetTemplateId': 'string',
'Id': 'string',
'Layout': {
'Selected': 'string',
'Options': [
{
'Value': 'string',
'Label': 'string',
'FieldIds': [
'string',
],
'LayoutPreviews': [
{
'Format': 'HTML'|'PDF'|'IMAGE',
'Url': 'string',
'PageType': 'FORM'|'CONFIRMATION'
},
]
},
]
}
},
]
}
Response Structure
(dict) --
Output for BatchCreateCampaignAsset.
Per-entry, per AWS Batch Operations. Errors is required and is empty rather than absent on a fully successful call; Successful is the success list the standard makes optional, and DG returns it because a client otherwise cannot learn the ids that were created.
Status is 200 whenever entries were processed individually -- including when every entry failed, since the batch itself succeeded and the entries did not. A 4xx means the batch could not be attempted as a whole and nothing was written.
A partial batch is a real state and the recovery is to re-send the same entry list: an entry is idempotent by identity (I-15/I-16), so what landed no-ops and what did not gets created. An already-existing asset is therefore a Successful row, not an error -- were it an error, a client looping until Errors is empty would never terminate.
Errors (list) --
One entry per blueprint that could not be instantiated. Empty, never absent, when all entries succeeded.
(dict) --
Why one entry could not be instantiated.
SourceAssetTemplateId (string) --
The failing entry's request identifier, so a caller can match this error to the entry it sent.
Code (string) --
Error code -- ResourceNotFoundException when the blueprint is not on the campaign's bound template, InternalServerException otherwise. Throttling never appears here: DG throttles per operation, so a throttle fails the whole batch.
Message (string) --
Human-readable cause.
Successful (list) --
One entry per asset that exists as a result of this call, whether created here or already present.
(dict) --
One asset that exists as a result of this call.
SourceAssetTemplateId (string) --
The entry's request identifier.
Id (string) --
The asset's identifier, derived from (CampaignId, SourceAssetTemplateId) rather than minted, so the same entry always resolves to the same id.
Layout (dict) --
For a multi-layout blueprint, the asset's layout options, so a client can render the first layout picker without reading each asset back. Nothing is selected at creation. Absent for a single-layout blueprint.
Selected (string) --
The selected option's value. An asset is created with its first option selected; an asset created before that rule, with none stored, reports and activates its first option.
Options (list) --
Every option the asset was created with, in authored order.
(dict) --
One layout a multi-layout asset offers.
Value (string) --
The value that selects this option.
Label (string) --
Display label.
FieldIds (list) --
The fields this option uses: the FieldValues that stay in scope when it is selected. Lets a client show an option's form before selecting it.
(string) --
A field's slot name — the developer-readable key that matches a {{fieldId}} placeholder in the layout skeleton (e.g. "Headline", "CtaUrl"), or the form field name in a document template (e.g. "Page 2 Title"). Platform-assigned and semantic (not a service-generated opaque Id), so it has its own constrained shape rather than reusing Id.
Single spaces between words are allowed because document templates name their fields that way, and this shape is the input type for editing them. Leading, trailing and repeated spaces are not, so that "Title" and "Title " cannot be two different fields.
LayoutPreviews (list) --
This option's pages, in page order.
(dict) --
A rendering of an AWS-authored layout skeleton or placeholder image.
The url is a stable, cache-friendly CloudFront URL rather than a presigned GET, because the bytes are AWS marketing content that is already public. The key's random segment is the object's only protection, so the URL is a bearer credential for the object and is withheld entirely while a template is not yet effective — see CampaignTemplate.EffectiveDateBegin.
Format (string) --
The format of the referenced object.
Url (string) --
A stable URL serving the object. Not presigned, so it does not expire.
PageType (string) --
Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.
A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.
Retrieves a campaign asset export task by its identifier, reporting its status and, when the task is COMPLETED, a freshly minted short-lived presigned URL for downloading the ZIP archive.
The download URL is minted on each call and is valid for at most 15 minutes; clients should download promptly rather than caching it. When the task has FAILED, FailureReason explains why. Poll this operation (roughly every 2-5 seconds) until the task reaches a terminal state.
See also: AWS API Documentation
Request Syntax
client.get_campaign_asset_export_task(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
CampaignAssetExportTaskIdentifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign that owns the export task. Accepts the campaign id or ARN. Required so the read is authorized on campaign/{CampaignId}; the task must belong to this campaign or the request resolves to not-found.
string
[REQUIRED]
The export task to retrieve: the Id StartCampaignAssetExportTask returned ( etsk-…).
An id only. An export task has no ARN: none is returned, recorded or authorized on (the read authorizes on its campaign), so there is no ARN to accept (DG-063 D-35).
dict
Response Syntax
{
'Id': 'string',
'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
'CreatedAt': datetime(2015, 1, 1),
'DownloadUrl': 'string',
'ExpiresAt': datetime(2015, 1, 1),
'FailureReason': {
'Code': 'EXPORT_TIMEOUT'|'EXPORT_TOO_LARGE'|'PACKAGING_ERROR'|'SOURCE_OBJECT_MISSING'|'INTERNAL_ERROR',
'Message': 'string'
}
}
Response Structure
(dict) --
Output for GetCampaignAssetExportTask.
Id (string) --
The export task identifier.
Status (string) --
The task's state.
CreatedAt (datetime) --
When the task was created.
DownloadUrl (string) --
Presigned GET URL for the ZIP archive. Present only when status is COMPLETED. Freshly minted on each call and short-lived (<=15 minutes).
ExpiresAt (datetime) --
When DownloadUrl expires. Present only when status is COMPLETED.
FailureReason (dict) --
Why the task failed. Present only when status is FAILED.
Code (string) --
Machine-readable failure cause.
Message (string) --
Human-readable explanation.
Starts an asynchronous task that packages a campaign's assets into a single downloadable ZIP archive.
Fire-and-return: the campaign is validated (it must exist and not be cancelled), a task record is persisted, an asynchronous execution is started, and the task id is returned with status IN_PROGRESS. This operation does not inspect assets — all resolution, exclusion, and failure are determined by the execution and surfaced only by GetCampaignAssetExportTask.
Every campaign is exportable, including one never activated, because renderable assets are composed on demand at export time rather than requiring finished, launched deliverables.
See also: AWS API Documentation
Request Syntax
client.start_campaign_asset_export_task(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
ClientToken='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign whose assets are exported. Accepts the campaign id or ARN.
string
Idempotency token. Two requests carrying the same token within the dedup window are one request and return the same task id.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'
}
Response Structure
(dict) --
Output for StartCampaignAssetExportTask.
Returns the newly created task id and its status, which is always IN_PROGRESS on this synchronous return. Poll GetCampaignAssetExportTask for the outcome.
Id (string) --
The export task identifier.
Status (string) --
The task's state, always IN_PROGRESS at creation.
Retrieves full detail of one campaign template, including its ordered asset templates with their field schema and layout previews.
See also: AWS API Documentation
Request Syntax
client.get_campaign_template(
Catalog='AWS'|'Sandbox',
Identifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign template's id. A campaign template has no ARN (DG-084).
dict
Response Syntax
{
'CampaignTemplate': {
'Id': 'string',
'Name': 'string',
'Industry': 'FINANCIAL_SERVICES'|'HEALTHCARE'|'MANUFACTURING'|'RETAIL'|'MEDIA_ENTERTAINMENT'|'ENERGY'|'EDUCATION'|'GOVERNMENT'|'TELECOMMUNICATIONS'|'AUTOMOTIVE'|'INSURANCE'|'OTHER',
'UseCase': 'string',
'Description': 'string',
'LanguageCode': 'en'|'es'|'es-419'|'fr'|'de'|'it'|'pt-BR'|'id'|'tr'|'ja'|'ko'|'zh-Hans'|'zh-Hant'|'ar',
'Collection': 'GENERAL'|'BUILD_WITH_AI',
'AwsServices': [
'string',
],
'CustomerSegments': [
'ENTERPRISE'|'SMB'|'PUBLIC_SECTOR'|'ISV',
],
'Themes': [
'AI'|'MIGRATION_MODERNIZATION'|'SECURITY'|'DATA_ANALYTICS'|'AWS_TRAINING_CERTIFICATION'|'AWS_MARKETPLACE'|'CONNECT'|'EVENTS',
],
'SetupDuration': 'string',
'ThumbnailUrl': 'string',
'EffectiveDateBegin': datetime(2015, 1, 1),
'AssetTemplates': [
{
'Id': 'string',
'Type': 'EMAIL'|'SOCIAL_POST'|'LANDING_PAGE'|'BANNER_AD'|'DOCUMENT',
'Label': 'string',
'DisplayOrder': 123,
'Fields': [
{
'FieldId': 'string',
'Label': 'string',
'Description': 'string',
'Section': 'HEADER'|'BODY'|'FOOTER',
'Page': 123,
'Required': True|False,
'Type': {
'Text': {
'MinLength': 123,
'MaxLength': 123,
'Pattern': 'string',
'Placeholder': 'string'
},
'RichText': {
'MaxLength': 123,
'AllowedTags': [
'string',
],
'Placeholder': 'string'
},
'Image': {
'MaxSizeBytes': 123,
'AllowedFormats': [
'PNG'|'JPEG',
],
'DefaultValue': {
'Format': 'HTML'|'PDF'|'IMAGE',
'Url': 'string',
'PageType': 'FORM'|'CONFIRMATION'
},
'RecommendedWidthPixels': 123,
'RecommendedHeightPixels': 123
},
'AssetLink': {
'Category': 'EMAIL'|'LANDING_PAGE'|'SOCIAL_POST'|'BANNER_AD'|'DOCUMENT',
'LabelFieldId': 'string'
}
},
'CampaignSetting': 'SENDER_EMAIL'|'END_ON'|'EMAIL_TARGET'|'PRIVACY_POLICY_URL'|'PARTNER_ADDRESS'|'PARTNER_BADGE',
'PartnerProfileField': 'DISPLAY_NAME'|'WEBSITE_URL'|'LOGO'|'WEBSITE_DOMAIN'|'COPYRIGHT_LINE'|'PARTNER_DETAILS'|'COPYRIGHT_AND_DETAILS'|'COPYRIGHT_YEAR_LINE'
},
],
'LayoutPreviews': [
{
'Format': 'HTML'|'PDF'|'IMAGE',
'Url': 'string',
'PageType': 'FORM'|'CONFIRMATION'
},
],
'PrerequisiteAssetTemplateIds': [
'string',
],
'SocialPlatform': 'FACEBOOK'|'LINKEDIN'|'X'
},
],
'ReferenceMaterials': [
{
'Name': 'string',
'Url': 'string'
},
],
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Output for GetCampaignTemplate.
CampaignTemplate (dict) --
The campaign template, including its asset templates.
Id (string) --
The campaign template identifier.
Name (string) --
The display name.
Industry (string) --
Target industry for filtering or categorization.
UseCase (string) --
Campaign use case for filtering or categorization.
Description (string) --
A short overview of the campaign, as plain text in the template's language: no HTML and no character entities. Absent when the template has none; never an empty string.
LanguageCode (string) --
Language the template is authored in, which a campaign created from it takes. A template has one language; the same content in another language is another template.
Collection (string) --
The browsing context the template is listed in. Every template has exactly one.
AwsServices (list) --
AWS services the template promotes.
(string) --
CustomerSegments (list) --
The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search filter.
(string) --
The customer segment a campaign template is written for. Clients must tolerate values added later.
Themes (list) --
The template's marketing themes. Absent when the template names none, in which case it matches every Themes search filter.
(string) --
The marketing theme of a campaign template. Clients must tolerate values added later.
SetupDuration (string) --
Estimated setup time.
ThumbnailUrl (string) --
Thumbnail URL.
EffectiveDateBegin (datetime) --
The instant the template becomes available to partners. Until then the template does not exist to a partner: SearchCampaignTemplates omits it and GetCampaignTemplate returns ResourceNotFoundException.
AssetTemplates (list) --
The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
(dict) --
One asset blueprint inside a campaign template. The id is template-local — an asset template is not a standalone resource and has no ARN.
Id (string) --
The template-local asset template identifier.
Type (string) --
The kind of asset this blueprint instantiates as.
Label (string) --
Display label; becomes the instantiated asset's name.
DisplayOrder (integer) --
Ordering for preview and instantiation.
Fields (list) --
The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.
(dict) --
One slot in an asset template's layout: addressing key, placement, and the field kind carrying its own constraints, placeholder or default.
FieldId (string) --
The field identifier; matches a {{fieldId}} slot in the layout.
Label (string) --
Human-readable name for the field, for display. Authored in the template policy, never derived from the field id or the source layout's field name: the id is a slug ( Page_2_Title) and is not meant to be shown to a partner. Absent on fields imported before labels existed.
Description (string) --
What belongs in this field, in English: its role in the asset and what good content for it is (for example "Headline that names the customer and leads with a source-backed statistic"). AWS-authored with the template; never written by a partner. Absent when the template carries none, never empty. Pinned onto the asset with the field, so a corrected description reaches assets created after the correction.
Section (string) --
Layout section the field belongs to.
Page (integer) --
One-based page number, for paginated layouts (print documents).
Required (boolean) --
Whether the field must be filled before the asset can be activated. Derived from DG policy — never inherited from an upstream authoring system.
Required for activation, not for saving: UpdateCampaignAsset accepts partial content and may clear a required field. An unfilled required field appears in the asset's ActivationIssues as REQUIRED_FIELD_MISSING, and activation refuses the asset with the same code.
A text field is filled only by a non-blank value, and a rich-text field only by a value with non-blank text; a Placeholder never fills one. An image field is filled by the partner's image or by the template's DefaultValue. A field the campaign fills ( CampaignSetting) or the partner's profile fills ( PartnerProfileField) is never unfilled on the asset.
Type (dict) --
The field kind, with that kind's constraints, placeholder or default.
Text (dict) --
A plain-text field.
MinLength (integer) --
Minimum accepted length.
MaxLength (integer) --
Maximum accepted length.
Pattern (string) --
Regular expression the value must match — used for URL, email, phone and hex-colour fields.
Placeholder (string) --
Example text shown where the field is empty in a preview of the asset. Never the asset's value: it is not set on the asset at create, does not fill a required field, and is never published.
RichText (dict) --
A field whose value is a constrained HTML fragment.
MaxLength (integer) --
Maximum accepted length of the markup fragment.
AllowedTags (list) --
The HTML tags permitted in the value. Anything else is stripped.
(string) --
An HTML tag name, without angle brackets.
Placeholder (string) --
Example markup shown where the field is empty in a preview of the asset, restricted to AllowedTags. Never the asset's value: it is not set on the asset at create, does not fill a required field, and is never published.
Image (dict) --
An image field.
MaxSizeBytes (integer) --
Maximum accepted file size in bytes.
AllowedFormats (list) --
Accepted image formats.
(string) --
An accepted image format.
DefaultValue (dict) --
The AWS-authored image the asset uses until the partner sets one: shown in previews and published in an empty slot of an email, landing page, banner ad or social post. It fills a required image field. A document leaves an empty image slot blank.
Format (string) --
The format of the referenced object.
Url (string) --
A stable URL serving the object. Not presigned, so it does not expire.
PageType (string) --
Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.
A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.
RecommendedWidthPixels (integer) --
The image size, in pixels, that fills this slot and prints sharply, for example 1920 x 301 for a full-width header. Shown to the partner as "Recommended: W x H px".
Present, together with RecommendedHeightPixels, on document (PDF) image slots only, where the slot is a fixed rectangle. Such a slot is always filled: the image is scaled to cover it, centred, and clipped to it, the same as CSS object-fit: cover. An image whose shape is too far from W:H is refused with IMAGE_ASPECT_RATIO_MISMATCH; one narrower than W is accepted. A slot showing the partner's logo or badge, and a slot without the two members (every slot from before sizes existed), fits the image inside instead ( object-fit: contain): a logo or a badge is never cropped. Email and landing-page image slots are laid out by HTML and carry neither.
RecommendedHeightPixels (integer) --
The image height, in pixels, that fills this slot. Present exactly when RecommendedWidthPixels is.
AssetLink (dict) --
A link to another asset on the same campaign. The partner chooses which asset, by LinkedAssetId; at activation DG writes that asset's public URL into the field. A landing page's download button is one, naming a DOCUMENT.
Category (string) --
The category of asset the field may name. The value must be an asset of this category on the same campaign; list the candidates with ListCampaignAssets.
LabelFieldId (string) --
The text field on the same asset whose copy names the linked asset, such as the "Solution Brief" in "Your Solution Brief is ready to download!". When the partner picks an asset, fill this field with the picked asset's LinkLabel, in a preview and in the same save, unless the partner has edited it. The field stays editable. The service does the same when a save changes the link without setting this field and the partner has never written it.
CampaignSetting (string) --
The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.
A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.
PartnerProfileField (string) --
The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.
A client shows the field as "From your Partner Central profile" rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone; GetCampaign's Campaign$PartnerProfile carries the same three values.
LayoutPreviews (list) --
Previews of the AWS-authored layout skeleton.
(dict) --
A rendering of an AWS-authored layout skeleton or placeholder image.
The url is a stable, cache-friendly CloudFront URL rather than a presigned GET, because the bytes are AWS marketing content that is already public. The key's random segment is the object's only protection, so the URL is a bearer credential for the object and is withheld entirely while a template is not yet effective — see CampaignTemplate.EffectiveDateBegin.
Format (string) --
The format of the referenced object.
Url (string) --
A stable URL serving the object. Not presigned, so it does not expire.
PageType (string) --
Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.
A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.
PrerequisiteAssetTemplateIds (list) --
The asset templates this one embeds output from, such as an email's landing page. Each must be in the same BatchCreateCampaignAsset request or already an asset on the campaign, else the create is refused PREREQUISITE_ASSET_MISSING; include them when the partner picks this one. Absent when there are none. A link the partner chooses, such as a landing page's download button, is not listed here: it is an AssetLink field and needs nothing at create.
(string) --
Opaque identifier for output fields that name a blueprint (a template's asset). Max 64 bytes.
SocialPlatform (string) --
SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports as SocialPlatform. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type.
ReferenceMaterials (list) --
The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart from AssetTemplates because none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited a BatchCreateCampaignAsset that could only fail.
Absent when the template has none.
(dict) --
A reference material that comes with a campaign template: a file the partner downloads as-is.
Not a blueprint: it carries no fields, cannot be instantiated, and is not activated.
Not the ReferenceMaterial resource deleted on 2026-09-22 (its six operations, ARN and record are gone). That was partner-uploaded and addressable; this is AWS-authored template content with no identity of its own.
Name (string) --
The display name.
Url (string) --
A stable public CDN URL for the file. AWS-authored content, so it is not presigned and carries no expiry — the same treatment as LayoutPreview.url, and withheld on the same condition: absent while the template's EffectiveDateBegin is in the future.
CreatedAt (datetime) --
Creation timestamp.
UpdatedAt (datetime) --
Last update timestamp.
Edits a campaign in place.
Partial update: an omitted field is left unchanged, which is the standard meaning of an Update verb — a full replacement would be a Put. Change-only, with no way to clear a field back to empty, because the campaign's file members cannot round-trip: they are written as an s3:// reference and read back as a URL or as metadata, so a replacement payload could not resend an unchanged recipient list without re-uploading it.
Refused while an activation task runs ( CAMPAIGN_ACTIVATION_IN_PROGRESS) and once the campaign is completed ( CAMPAIGN_COMPLETED, the UTC date is after its EndOn).
Last-writer-wins, with no concurrency token: this is low-contention metadata owned by one partner.
See also: AWS API Documentation
Request Syntax
client.update_campaign(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
Name='string',
SenderEmail='string',
PrivacyPolicyUrl='string',
PartnerAddress='string',
PartnerBadge={
'S3Uri': 'string',
'VersionId': 'string'
},
EmailTarget={
'S3Uri': 'string',
'VersionId': 'string'
},
EmailTargetEngagementGroupIds=[
'string',
],
SocialConnections={
'string': [
'string',
]
},
EstimatedBudget={
'Amount': 'string',
'CurrencyCode': 'string'
},
TotalBudget={
'Amount': 'string',
'CurrencyCode': 'string'
},
TargetAudience={
'Industries': [
'FINANCIAL_SERVICES'|'HEALTHCARE'|'MANUFACTURING'|'RETAIL'|'MEDIA_ENTERTAINMENT'|'ENERGY'|'EDUCATION'|'GOVERNMENT'|'TELECOMMUNICATIONS'|'AUTOMOTIVE'|'INSURANCE'|'OTHER',
],
'CompanySizes': [
'STARTUP'|'SMALL_BUSINESS'|'MID_MARKET'|'ENTERPRISE'|'GLOBAL_ENTERPRISE',
],
'Countries': [
'string',
]
},
ClientToken='string',
StartOn='string',
EndOn='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
string
The display name.
string
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.
string
Sets or replaces the URL of the partner's privacy policy. Replaces, never clears.
string
Sets or replaces the partner's postal address. Replaces, never clears.
dict
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.
S3Uri (string) -- [REQUIRED]
The s3:// location of the file.
VersionId (string) -- [REQUIRED]
The version of the object to take: the VersionId the staging upload returned.
dict
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.
S3Uri (string) -- [REQUIRED]
The s3:// location of the file.
VersionId (string) -- [REQUIRED]
The version of the object to take: the VersionId the staging upload returned.
list
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).
(string) --
An engagement group's id, as ListEngagementGroups (AWS Partner Central Selling) returns it: eng-grp- and 14 lowercase alphanumerics. The same constraints as the Leads model's GroupId, whose pattern pins only the current shape: if Leads relaxes it, so does this.
dict
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.
(string) --
Social platform a connection authorizes publishing on.
(list) --
The connections chosen for one platform. Exactly one: a social post publishes from one account.
(string) --
Service-generated identifier of a social connection.
Stable for the life of the connection: it survives a revoke and a re-authorization of the same account, and is never reused once the connection is deleted. sc- and 13 lowercase letters or digits (DG-092).
dict
What the partner expects the campaign to cost.
Amount (string) -- [REQUIRED]
The amount, as a decimal string with at most two decimal places.
CurrencyCode (string) -- [REQUIRED]
The ISO 4217 currency the amount is denominated in.
dict
The campaign's total budget.
Amount (string) -- [REQUIRED]
The amount, as a decimal string with at most two decimal places.
CurrencyCode (string) -- [REQUIRED]
The ISO 4217 currency the amount is denominated in.
dict
Target audience configuration.
Industries (list) --
Target industries.
(string) --
Industry shape.
CompanySizes (list) --
Target company sizes.
(string) --
CompanySize shape.
Countries (list) --
Target countries, as ISO 3166-1 alpha-2 codes.
(string) --
An ISO 3166-1 alpha-2 country code.
string
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.
This field is autopopulated if not provided.
string
The first day of the campaign's run window. Not after EndOn ( ValidationException, INVALID_VALUE).
string
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.
dict
Response Syntax
{
'Id': 'string'
}
Response Structure
(dict) --
Output for UpdateCampaign.
Id (string) --
The campaign identifier.
Lists the partner's social connections, optionally filtered by platform.
See also: AWS API Documentation
Request Syntax
client.list_social_connections(
Catalog='AWS'|'Sandbox',
Platform='FACEBOOK'|'LINKEDIN'|'X',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Catalog to list connections from.
string
Restrict results to a single social platform.
integer
Maximum number of results to return per page.
string
Pagination token from a previous response.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Platform': 'FACEBOOK'|'LINKEDIN'|'X',
'Status': 'AUTHORIZED'|'EXPIRED'|'PAGE_REQUIRED',
'PageName': 'string',
'AccountName': 'string',
'ConnectedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output for ListSocialConnections.
Items (list) --
The social connections for this partner and catalog.
(dict) --
Summary of a social connection returned by ListSocialConnections.
Carries no ARN (owner ruling 2026-10-05): a connection is addressed by its Id. Social connections are not taggable, and every social operation authorizes on its action rather than on a resource ARN.
Id (string) --
Identifier of the social connection.
Platform (string) --
Social platform this connection authorizes.
Status (string) --
Authorization state.
PageName (string) --
The Facebook Page this connection publishes to. Absent where no Page applies.
AccountName (string) --
Display name of the account behind this connection. Absent when the execution backend reports none.
ConnectedAt (datetime) --
When the account was last authorized. Advances on every re-authorization.
ExpiresAt (datetime) --
When the authorization lapses. Absent where the platform reports no expiry (X never does). A connection past this time reads EXPIRED only once the backend notices, so treat this as a warning date, not a status.
NextToken (string) --
Pagination token for the next page, absent on the last page.
Creates a new marketing campaign.
Returns the identity of the new campaign, not the campaign. Growing a response is backward compatible and shrinking one is not, and the caller's next step is a GetCampaign anyway — a write that supplies an audience cannot report its scan verdict, because that is decided after it commits.
See also: AWS API Documentation
Request Syntax
client.create_campaign(
Catalog='AWS'|'Sandbox',
Name='string',
CampaignTemplateId='string',
SenderEmail='string',
PrivacyPolicyUrl='string',
PartnerAddress='string',
PartnerBadge={
'S3Uri': 'string',
'VersionId': 'string'
},
EmailTarget={
'S3Uri': 'string',
'VersionId': 'string'
},
EmailTargetEngagementGroupIds=[
'string',
],
TargetAudience={
'Industries': [
'FINANCIAL_SERVICES'|'HEALTHCARE'|'MANUFACTURING'|'RETAIL'|'MEDIA_ENTERTAINMENT'|'ENERGY'|'EDUCATION'|'GOVERNMENT'|'TELECOMMUNICATIONS'|'AUTOMOTIVE'|'INSURANCE'|'OTHER',
],
'CompanySizes': [
'STARTUP'|'SMALL_BUSINESS'|'MID_MARKET'|'ENTERPRISE'|'GLOBAL_ENTERPRISE',
],
'Countries': [
'string',
]
},
EstimatedBudget={
'Amount': 'string',
'CurrencyCode': 'string'
},
TotalBudget={
'Amount': 'string',
'CurrencyCode': 'string'
},
StartOn='string',
EndOn='string',
ClientToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The display name.
string
[REQUIRED]
The campaign template this campaign draws its assets from.
Binds the campaign to a single source template: every asset must come from this template's asset templates, and one from another template is refused at BatchCreateCampaignAsset. Immutable once set. Every campaign has one: a campaign's language and its assets' blueprints both come from its template.
Templates are AWS-authored and read-only — they are discovered through SearchCampaignTemplates and GetCampaignTemplate, and there is no create, update or delete operation for one.
The template's id only: a campaign template has no ARN (DG-084). The member keeps the Id name, which is the convention for referencing another resource from a body.
string
The address every email of this campaign is sent from.
Printable ASCII only, with no spaces or line breaks, or field code PATTERN_MISMATCH. Then three rules, all checked when the sender is set. Its domain must exactly match, ignoring case, the domain of the partner's alliance lead email in AWS Partner Central (a subdomain does not), or field code SENDER_DOMAIN_NOT_ALLIANCE_LEAD. Then, for a sender at example.com, DNS must hold the CNAME dkim._domainkey.example.com → dkim._domainkey.md02.com (field code SENDER_DOMAIN_DKIM_MISSING) and a DMARC record, one TXT _dmarc.example.com starting v=DMARC1 with a p of none, quarantine or reject (field code SENDER_DOMAIN_DMARC_MISSING). Both DNS codes are reported together when both records are missing.
A partner who can't satisfy them can't set a sender, so can't run email campaigns. A shared mail provider's domain, such as gmail.com, can't carry the records. Optional here: a campaign with no sender can be created and edited, but its email assets cannot be activated until one is set.
string
The URL of the partner's privacy policy, linked from every email and landing page footer. Optional here: a campaign whose emails or landing pages show it cannot activate them until one is set.
string
The partner's physical postal address, shown in every email footer and as a landing page's contact line. Optional here: an email that shows it cannot activate until one is set. A landing page that shows it publishes it empty when it is unset, and a document's footer then prints the partner's name alone.
dict
The partner's badge — a tier or designation badge from AWS Partner Badge Manager — shown in every badge slot of the campaign's emails, landing pages and documents. Optional: until one is set, every badge slot shows the Standalone AWS Partner badge.
A PNG or JPEG of at most 2 MB, staged like an asset image and checked the same way: it must have passed the staging scan (SCAN_REJECTED, or SCAN_IN_PROGRESS while it is pending), and its bytes must be the format its name says (IMAGE_FORMAT_NOT_SUPPORTED). Any shape is accepted: a badge is drawn whole, never cropped. Content moderation judges it when an asset that shows it is activated.
S3Uri (string) -- [REQUIRED]
The s3:// location of the file.
VersionId (string) -- [REQUIRED]
The version of the object to take: the VersionId the staging upload returned.
dict
The campaign's send audience — a CSV of recipient email addresses.
The campaign's target: who the campaign is sent to, as distinct from a CampaignAsset, which is the content that is sent. It sits on the campaign and not on the activation call because a partner assembles it in the same wizard flow that sets the name and the dates — and because attaching it here means it is validated, staged and resolved to a count before anything is activated, rather than at the last click.
Required format: a header row naming the email column Email, E-mail, Email Address or E-mail Address — compared without case, spaces or punctuation. Other columns are permitted and ignored, and with two email columns the first is used. A file without such a header is refused with field code EMAIL_COLUMN_MISSING: the address column is never guessed. The rows reach the delivery platform's importer as the partner wrote them — a partner's audience is never rewritten.
At most 5 MB, checked against the object's size before anything is copied, and at most 10,000 distinct addresses, refused with RECIPIENT_LIST_TOO_LARGE. A file with no valid address at all is refused with RECIPIENT_LIST_EMPTY; otherwise rows without a usable address are not a refusal: they are skipped and counted, and GetCampaign reports the counts. Optional here, because a campaign is a container and holds no state to be incomplete in — but an email asset cannot be activated without it, so the requirement moved to the point of activation.
Editable at any time, and an edit reaches the delivery platform only when an asset is activated after it. Each email activation loads the audience into a contact list of its own, so an address taken off the file is not sent to by the next activation.
The bytes are write-only. No response returns a URL or an S3Uri for this file; GetCampaign returns the scan verdict, when the list was attached and how its rows resolved, and nothing more.
S3Uri (string) -- [REQUIRED]
The s3:// location of the file.
VersionId (string) -- [REQUIRED]
The version of the object to take: the VersionId the staging upload returned.
list
Engagement groups whose contacts the campaign's emails will also go to: the Id``s ``ListEngagementGroups returns (AWS Partner Central Selling). 1–10, each named once.
Each group is named once: a repeated id is refused with field code INVALID_VALUE. Not checked against your groups when saved. StartCampaignAssetActivationTask resolves them to recipients. On a stage that can't resolve groups yet, Start refuses an email while groups are set (ENGAGEMENT_GROUPS_UNAVAILABLE), rather than send to EmailTarget alone.
(string) --
An engagement group's id, as ListEngagementGroups (AWS Partner Central Selling) returns it: eng-grp- and 14 lowercase alphanumerics. The same constraints as the Leads model's GroupId, whose pattern pins only the current shape: if Leads relaxes it, so does this.
dict
Advisory targeting metadata. Refined later, and not validated here.
Industries (list) --
Target industries.
(string) --
Industry shape.
CompanySizes (list) --
Target company sizes.
(string) --
CompanySize shape.
Countries (list) --
Target countries, as ISO 3166-1 alpha-2 codes.
(string) --
An ISO 3166-1 alpha-2 country code.
dict
What the partner expects the campaign to cost.
Amount (string) -- [REQUIRED]
The amount, as a decimal string with at most two decimal places.
CurrencyCode (string) -- [REQUIRED]
The ISO 4217 currency the amount is denominated in.
dict
The campaign's total budget.
Amount (string) -- [REQUIRED]
The amount, as a decimal string with at most two decimal places.
CurrencyCode (string) -- [REQUIRED]
The ISO 4217 currency the amount is denominated in.
string
The first day of the campaign's run window. Not after EndOn ( ValidationException, INVALID_VALUE).
string
The last day of the campaign's run window, inclusive and in UTC. Not in the past: the campaign completes at the UTC midnight after it (see CampaignState). A scheduled send must fall on or before it.
Optional here, but required before any asset activates: until it is set, GetCampaign's ActivationIssues reports END_ON_MISSING and StartCampaignAssetActivationTask refuses ( CAMPAIGN_INCOMPLETE). Set it with UpdateCampaign.
string
Idempotency token. Same token within 24h returns existing resource.
This field is autopopulated if not provided.
list
Tags to apply at creation.
Tag-on-create rather than create-then-tag is a Tagris requirement, not a convenience: it is what lets a tag-based access control policy govern the creation itself. A campaign created untagged and tagged a moment later is briefly outside any such policy.
A key beginning aws: (any case) is reserved for AWS-applied system tags and is refused with ValidationException, as is a key repeated in the list; nothing is created. The tags are recorded before the campaign is written, so a create that cannot record them fails and creates nothing. A retry with the same ClientToken returns the campaign the first attempt created and does not re-apply tags — use TagResource to change them afterwards. ListTagsForResource returns them.
(dict) --
A key-value pair applied to a resource.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Output for CreateCampaign.
Id (string) --
The new campaign's identifier.
Arn (string) --
The new campaign's ARN.
Retrieves a campaign by its identifier.
See also: AWS API Documentation
Request Syntax
client.get_campaign(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
dict
Response Syntax
{
'Campaign': {
'CampaignId': 'string',
'Arn': 'string',
'Name': 'string',
'State': 'DRAFT'|'ACTIVE'|'COMPLETED',
'CampaignTemplateId': 'string',
'Language': 'en'|'es'|'es-419'|'fr'|'de'|'it'|'pt-BR'|'id'|'tr'|'ja'|'ko'|'zh-Hans'|'zh-Hant'|'ar',
'PartnerProfile': {
'DisplayName': 'string',
'WebsiteUrl': 'string',
'LogoUrl': 'string',
'RefreshedAt': datetime(2015, 1, 1)
},
'SenderEmail': 'string',
'PrivacyPolicyUrl': 'string',
'PartnerAddress': 'string',
'PartnerBadge': {
'Url': 'string',
'AttachedAt': datetime(2015, 1, 1)
},
'EmailTarget': {
'ScanStatus': 'PENDING'|'CLEAN'|'REJECTED',
'AttachedAt': datetime(2015, 1, 1),
'ValidCount': 123,
'RejectedCount': 123,
'DuplicateCount': 123,
'FileName': 'string'
},
'EmailTargetEngagementGroupIds': [
'string',
],
'SocialConnections': {
'string': [
'string',
]
},
'EstimatedBudget': {
'Amount': 'string',
'CurrencyCode': 'string'
},
'TotalBudget': {
'Amount': 'string',
'CurrencyCode': 'string'
},
'TargetAudience': {
'Industries': [
'FINANCIAL_SERVICES'|'HEALTHCARE'|'MANUFACTURING'|'RETAIL'|'MEDIA_ENTERTAINMENT'|'ENERGY'|'EDUCATION'|'GOVERNMENT'|'TELECOMMUNICATIONS'|'AUTOMOTIVE'|'INSURANCE'|'OTHER',
],
'CompanySizes': [
'STARTUP'|'SMALL_BUSINESS'|'MID_MARKET'|'ENTERPRISE'|'GLOBAL_ENTERPRISE',
],
'Countries': [
'string',
]
},
'StartOn': 'string',
'EndOn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'ActivationIssues': [
{
'Code': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED',
'FieldId': 'string',
'CampaignSetting': 'SENDER_EMAIL'|'END_ON'|'EMAIL_TARGET'|'PRIVACY_POLICY_URL'|'PARTNER_ADDRESS'|'PARTNER_BADGE',
'PartnerProfileField': 'DISPLAY_NAME'|'WEBSITE_URL'|'LOGO'|'WEBSITE_DOMAIN'|'COPYRIGHT_LINE'|'PARTNER_DETAILS'|'COPYRIGHT_AND_DETAILS'|'COPYRIGHT_YEAR_LINE',
'AffectedAssetIds': [
'string',
],
'Message': 'string'
},
]
}
}
Response Structure
(dict) --
Output for GetCampaign.
Campaign (dict) --
The campaign.
CampaignId (string) --
The campaign identifier.
Arn (string) --
The campaign ARN.
Name (string) --
The display name.
State (string) --
The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
CampaignTemplateId (string) --
The campaign template this campaign draws its assets from. Set at create, immutable.
Language (string) --
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.
PartnerProfile (dict) --
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.
DisplayName (string) --
The profile's display name.
WebsiteUrl (string) --
The profile's website.
LogoUrl (string) --
The profile's logo URL, as AWS Partner Central serves it — the image every asset of the campaign shows. Absent when the profile names none.
Partner Central Marketing keeps no copy: the same URL is written into a published landing page and email, and fetched when a document is composed, so what a client renders from it is what is sent. Only a document fetches the image: one it cannot fetch and draw fails that asset with INTERNAL_ERROR, which a retry can clear. A landing page or email links the URL as given, so a logo that does not load shows as a broken image.
RefreshedAt (datetime) --
When this branding was last read from Partner Central. Earlier than the request when Partner Central could not be reached and Partner Central Marketing answered from its last copy.
SenderEmail (string) --
The address the campaign's emails are sent from. Absent until one is set.
PrivacyPolicyUrl (string) --
The URL of the partner's privacy policy. Absent until one is set.
PartnerAddress (string) --
The partner's postal address. Absent until one is set.
PartnerBadge (dict) --
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.
Url (string) --
A presigned GET of the badge, which expires one hour after the read: fetch it again with GetCampaign when it returns 403.
AttachedAt (datetime) --
When the badge was set.
EmailTarget (dict) --
The attached recipient list — metadata only. There is no read path for the addresses.
ScanStatus (string) --
The scan verdict for the attached list.
AttachedAt (datetime) --
When the list was attached.
ValidCount (integer) --
Distinct usable addresses — the recipients an email activation sends to.
RejectedCount (integer) --
Rows skipped because their email cell is not a usable address.
DuplicateCount (integer) --
Rows repeating an address already counted. Not an error: each address is sent to once.
FileName (string) --
The display name of the uploaded file, as the partner named it, with no path: for example Q4 leads.csv. Absent for a list attached before the service kept the name. There is no link to the file: the list is never downloadable from the campaign.
EmailTargetEngagementGroupIds (list) --
The engagement groups set by CreateCampaign / UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.
(string) --
An engagement group's id, as ListEngagementGroups (AWS Partner Central Selling) returns it: eng-grp- and 14 lowercase alphanumerics. The same constraints as the Leads model's GroupId, whose pattern pins only the current shape: if Leads relaxes it, so does this.
SocialConnections (dict) --
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.
(string) --
Social platform a connection authorizes publishing on.
(list) --
The connections chosen for one platform. Exactly one: a social post publishes from one account.
(string) --
Service-generated identifier of a social connection.
Stable for the life of the connection: it survives a revoke and a re-authorization of the same account, and is never reused once the connection is deleted. sc- and 13 lowercase letters or digits (DG-092).
EstimatedBudget (dict) --
What the partner expects the campaign to cost.
Amount (string) --
The amount, as a decimal string with at most two decimal places.
CurrencyCode (string) --
The ISO 4217 currency the amount is denominated in.
TotalBudget (dict) --
The campaign's total budget.
Amount (string) --
The amount, as a decimal string with at most two decimal places.
CurrencyCode (string) --
The ISO 4217 currency the amount is denominated in.
TargetAudience (dict) --
Target audience configuration.
Industries (list) --
Target industries.
(string) --
Industry shape.
CompanySizes (list) --
Target company sizes.
(string) --
CompanySize shape.
Countries (list) --
Target countries, as ISO 3166-1 alpha-2 codes.
(string) --
An ISO 3166-1 alpha-2 country code.
StartOn (string) --
The first day of the campaign's run window.
EndOn (string) --
The last day of the campaign's run window.
CreatedAt (datetime) --
Creation timestamp.
UpdatedAt (datetime) --
Last update timestamp.
ActivationIssues (list) --
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.
(dict) --
One thing that must be fixed before activation.
Code (string) --
What is wrong. Branch on this, not on Message.
FieldId (string) --
The asset field to fix. Present for asset-level issues, except SEND_MODE_MISSING and a CONTENT_REJECTED that refused the asset's text as a whole rather than one field.
CampaignSetting (string) --
The UpdateCampaign member to set. Present for campaign-level issues.
PartnerProfileField (string) --
The partner-profile value to set or shorten, in AWS Partner Central, or the derived value whose input it is. Present on PARTNER_PROFILE_FIELD_MISSING and PARTNER_PROFILE_FIELD_DOES_NOT_FIT.
AffectedAssetIds (list) --
The assets this campaign-level issue blocks.
(string) --
A campaign asset's id: ast- and 13 lowercase letters or digits (DG-087). An asset has no ARN; it is named by its id within its campaign.
Message (string) --
A description for display. Don't parse it.
Updates an asset's field values, layout or send time. Refused with ConflictException while the campaign's running activation task still owns the asset ( ASSET_START_IN_PROGRESS), and for a live email or social post ( ASSET_ALREADY_ACTIVE): deactivate it first.
See also: AWS API Documentation
Request Syntax
client.update_campaign_asset(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
CampaignAssetIdentifier='string',
FieldValues=[
{
'FieldId': 'string',
'Value': {
'Text': 'string',
'ImageReference': 'string',
'LinkedAssetId': 'string',
'CampaignAssetImage': {
'CampaignIdentifier': 'string',
'CampaignAssetIdentifier': 'string',
'FieldId': 'string'
}
}
},
],
Layout='string',
SendMode='ON_ACTIVATION'|'SCHEDULED',
ScheduledSendAt=datetime(2015, 1, 1),
ClientToken='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
string
[REQUIRED]
The asset identifier.
list
Value-only updates to the asset's pinned template fields, keyed by FieldId. The field schema (labels, descriptions, constraints, placeholders, image defaults) is service-owned and pinned at instantiation, so clients send only the values they are changing. Fields omitted keep their stored values; send the entry with Value omitted to clear one.
Named FieldValues to match the member it edits on CampaignAsset, which is the same concept read back. It was templateFieldUpdates; the two names for one concept were the defect, not the length.
(dict) --
A value-only update to one email template field. The write counterpart of CampaignAssetFieldValue: it carries just the addressing key and the new value, never the service-owned schema.
FieldId (string) -- [REQUIRED]
The field to update; must match a FieldId in the asset's stored schema.
Value (dict) --
The new value. Omit to clear the field.
Text (string) --
Text value — for both text and RichText fields. A RichText value is a markup fragment restricted to the field's AllowedTags.
ImageReference (string) --
Image reference (image fields).
On a write, one of exactly two forms:
the s3:// URI of a file you staged in the Partner Central file staging bucket. It is scanned, then copied into this asset.
the URL Build with AI returned for a suggested image, unchanged. It is copied into this asset and not scanned. Any other URL is refused with FILE_REFERENCE_INVALID, including one a read returned: to keep the current image, omit the field; to put it on another asset, use CampaignAssetImage.
On a read, a URL the caller can fetch: an image in the asset's own storage comes back as a presigned GET that expires one hour after the read, so fetch it again with GetCampaignAsset when it returns 403; an image already on DG's public CDN comes back as that stable URL. A stored reference outside this asset's storage, or not a raster image, is never signed, and the value is omitted. The signed URL serves the image as its image type, whatever the upload declared.
LinkedAssetId (string) --
The asset an AssetLink field names: the id of an asset on the same campaign, of the field's category. It is a prerequisite of this asset while linked, so it activates first, this asset cannot start until it is live, and it cannot be deleted.
CampaignAssetImage (dict) --
Write only. Copies an image stored on another of your assets into this image field. The image is checked against this field's constraints and not scanned again. Also requires partnercentral:GetCampaignAsset on the source campaign. Reads return the copy as ImageReference.
CampaignIdentifier (string) -- [REQUIRED]
The source campaign's id or ARN.
CampaignAssetIdentifier (string) -- [REQUIRED]
The source asset's id.
FieldId (string) -- [REQUIRED]
The source image field.
string
Selects a multi-layout asset's layout: one of the values in CampaignAsset.layout.options.
PATCH: omitted leaves the selection unchanged, and there is no way to clear it. A value that is not one of the asset's options — or any value on a single-layout asset — is a plain ValidationException, and nothing in the call is applied. Every pinned field stays writable whichever layout is selected.
string
When a sendable asset ( EMAIL, SOCIAL_POST) sends: on activation, or at ScheduledSendAt.
A mode beside a value rather than a union, on purpose: ScheduledSendAt stays a plain Timestamp, and the precedent is EventBridge Scheduler's FlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused with ValidationException ( INVALID_VALUE, naming the member) and applies nothing:
SCHEDULED requires ScheduledSendAt; a reschedule resends SCHEDULED with the new time;
ON_ACTIVATION forbids ScheduledSendAt, and drops any time already stored;
ScheduledSendAt without SendMode is refused.
PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports SEND_MODE_MISSING and does not activate: no default, because an unchosen send mails the real audience. Rejected with ValidationException ( NOT_SUPPORTED_FOR_CATEGORY) for a category that has no send ( LANDING_PAGE, DOCUMENT, BANNER_AD). Like every other edit, it reaches the delivery platform at the asset's next activation, and a live email or social post refuses it ( ASSET_ALREADY_ACTIVE): deactivate first.
datetime
The send time, with SendMode: SCHEDULED and only then. See SendMode.
Must be at least an hour out ( SEND_WINDOW_TOO_SOON), unless it is the time already stored: resending the stored mode and time changes nothing and is accepted, so a form that always resubmits does not trip the window.
Must also fall on or before the campaign's EndOn (by the end of that UTC day): refused with ValidationException ( INVALID_VALUE) otherwise, so nothing is scheduled to send after the campaign completes.
Was scheduleDate, a YYYY-MM-DD string. Retyped because a date alone cannot express a send time, which is the whole point of a schedule — and because the resource already spelled the same concept ScheduledSendAt on the activation responses. Two spellings of one concept on one resource was the defect.
string
Idempotency token. Retry-safety only — this is not a concurrency token, and sequential edits to one field are last-writer-wins.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'State': 'INACTIVE'|'ACTIVE',
'ActivationIssues': [
{
'Code': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED',
'FieldId': 'string',
'CampaignSetting': 'SENDER_EMAIL'|'END_ON'|'EMAIL_TARGET'|'PRIVACY_POLICY_URL'|'PARTNER_ADDRESS'|'PARTNER_BADGE',
'PartnerProfileField': 'DISPLAY_NAME'|'WEBSITE_URL'|'LOGO'|'WEBSITE_DOMAIN'|'COPYRIGHT_LINE'|'PARTNER_DETAILS'|'COPYRIGHT_AND_DETAILS'|'COPYRIGHT_YEAR_LINE',
'AffectedAssetIds': [
'string',
],
'Message': 'string'
},
]
}
Response Structure
(dict) --
Output for UpdateCampaignAsset.
A minimal acknowledgment, not an echo. Read GetCampaignAsset for the applied values ( FieldValues).
Id (string) --
The asset identifier.
State (string) --
The asset's state, unchanged.
An update never moves it, so a live asset stays ACTIVE while its edited values take effect for the next activation. There is no edit-outcome member: a 200 means every submitted value applied, and every failure is a refusal on the call itself (DG-040 Decision 11).
ActivationIssues (list) --
What must be fixed on this asset before it can be activated. Empty when the asset is ready.
Issues don't block saving: an asset can be saved incomplete and fixed over several updates. StartCampaignAssetActivationTask refuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix in FieldId. Fix it with UpdateCampaignAsset, then read this list again.
Besides the issues computed from the asset's content, the list carries what the last activation found: CONTENT_REJECTED and PARTNER_IMAGE_REJECTED when moderation refused a field. Editing that field removes its issue. A CONTENT_REJECTED without a FieldId means the text was refused as a whole; editing any text field removes it.
Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on Campaign.ActivationIssues, not here.
(dict) --
One thing that must be fixed before activation.
Code (string) --
What is wrong. Branch on this, not on Message.
FieldId (string) --
The asset field to fix. Present for asset-level issues, except SEND_MODE_MISSING and a CONTENT_REJECTED that refused the asset's text as a whole rather than one field.
CampaignSetting (string) --
The UpdateCampaign member to set. Present for campaign-level issues.
PartnerProfileField (string) --
The partner-profile value to set or shorten, in AWS Partner Central, or the derived value whose input it is. Present on PARTNER_PROFILE_FIELD_MISSING and PARTNER_PROFILE_FIELD_DOES_NOT_FIT.
AffectedAssetIds (list) --
The assets this campaign-level issue blocks.
(string) --
A campaign asset's id: ast- and 13 lowercase letters or digits (DG-087). An asset has no ARN; it is named by its id within its campaign.
Message (string) --
A description for display. Don't parse it.
Lists campaigns with optional filters and pagination.
See also: AWS API Documentation
Request Syntax
client.list_campaigns(
Catalog='AWS'|'Sandbox',
CampaignIdentifiers=[
'string',
],
Name='string',
States=[
'DRAFT'|'ACTIVE'|'COMPLETED',
],
Sort={
'SortBy': 'NAME'|'STATE'|'START_ON'|'CREATED_AT',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
list
Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.
(string) --
A campaign, named by its id or its ARN.
string
Only campaigns whose name contains this, compared case-insensitively.
list
Only campaigns in one of these states.
(string) --
A campaign's state, derived on every read from its EndOn and its assets:
COMPLETED once the UTC date is after EndOn (so a campaign ending today completes at the next UTC midnight). A campaign with no EndOn never completes, and cannot activate until it has one;
otherwise ACTIVE when any of its assets is ACTIVE;
otherwise DRAFT, including a campaign with no assets.
A summary of the assets, not a lifecycle: nothing transitions it, it is never stored, and it gates no operation by itself: the refusal on a completed campaign ( CAMPAIGN_COMPLETED) reads the same EndOn. Otherwise whether an asset can be edited, activated or deleted depends on that asset. So a scheduled email counts as ACTIVE once armed, before it sends; a campaign stays DRAFT during its first activation; deactivating its only active email or social post returns it to DRAFT; and a COMPLETED campaign can still have live landing pages.
dict
The order of the results. Default: CREATED_AT, DESCENDING.
SortBy (string) -- [REQUIRED]
The attribute to sort by.
SortOrder (string) -- [REQUIRED]
The direction.
integer
Maximum results per page.
string
Pagination token. Bound to the filters and sort it was issued for: a request that changes CampaignIdentifiers, Name, States or Sort between pages is refused with ValidationException. MaxResults may change.
dict
Response Syntax
{
'Items': [
{
'CampaignId': 'string',
'Arn': 'string',
'Name': 'string',
'State': 'DRAFT'|'ACTIVE'|'COMPLETED',
'Language': 'en'|'es'|'es-419'|'fr'|'de'|'it'|'pt-BR'|'id'|'tr'|'ja'|'ko'|'zh-Hans'|'zh-Hant'|'ar',
'StartOn': 'string',
'EndOn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output for ListCampaigns operation.
Items (list) --
The list of results.
(dict) --
Summary representation of a campaign for list operations.
CampaignId (string) --
The campaign identifier.
Arn (string) --
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 (string) --
The display name.
State (string) --
The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
Language (string) --
The language the campaign's assets are written and typeset in. See Campaign$Language.
StartOn (string) --
The first day of the campaign's run window.
EndOn (string) --
The last day of the campaign's run window.
CreatedAt (datetime) --
Creation timestamp. Present on the summary so a caller can order a list by recency without reading each campaign in full.
UpdatedAt (datetime) --
Last update timestamp. Present on the summary for the same reason as CreatedAt.
NextToken (string) --
Pagination token.
Retrieves an asset by its identifier.
See also: AWS API Documentation
Request Syntax
client.get_campaign_asset(
Catalog='AWS'|'Sandbox',
CampaignIdentifier='string',
CampaignAssetIdentifier='string'
)
string
[REQUIRED]
The catalog (AWS or Sandbox).
string
[REQUIRED]
The campaign identifier.
string
[REQUIRED]
The asset identifier.
dict
Response Syntax
{
'Asset': {
'Id': 'string',
'CampaignId': 'string',
'Category': 'EMAIL'|'LANDING_PAGE'|'SOCIAL_POST'|'BANNER_AD'|'DOCUMENT',
'Name': 'string',
'LinkLabel': 'string',
'State': 'INACTIVE'|'ACTIVE',
'LastActivationStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'DeliveryStatus': 'PENDING'|'DELIVERED'|'FAILED',
'DeliveryStatusReason': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED',
'SourceAssetTemplateId': 'string',
'SocialPlatform': 'FACEBOOK'|'LINKEDIN'|'X',
'FileFormat': 'PDF'|'DOCX'|'PPTX'|'HTML'|'IMAGE',
'SendMode': 'ON_ACTIVATION'|'SCHEDULED',
'ScheduledSendAt': datetime(2015, 1, 1),
'FieldValues': [
{
'Field': {
'FieldId': 'string',
'Label': 'string',
'Description': 'string',
'Section': 'HEADER'|'BODY'|'FOOTER',
'Page': 123,
'Required': True|False,
'Type': {
'Text': {
'MinLength': 123,
'MaxLength': 123,
'Pattern': 'string',
'Placeholder': 'string'
},
'RichText': {
'MaxLength': 123,
'AllowedTags': [
'string',
],
'Placeholder': 'string'
},
'Image': {
'MaxSizeBytes': 123,
'AllowedFormats': [
'PNG'|'JPEG',
],
'DefaultValue': {
'Format': 'HTML'|'PDF'|'IMAGE',
'Url': 'string',
'PageType': 'FORM'|'CONFIRMATION'
},
'RecommendedWidthPixels': 123,
'RecommendedHeightPixels': 123
},
'AssetLink': {
'Category': 'EMAIL'|'LANDING_PAGE'|'SOCIAL_POST'|'BANNER_AD'|'DOCUMENT',
'LabelFieldId': 'string'
}
},
'CampaignSetting': 'SENDER_EMAIL'|'END_ON'|'EMAIL_TARGET'|'PRIVACY_POLICY_URL'|'PARTNER_ADDRESS'|'PARTNER_BADGE',
'PartnerProfileField': 'DISPLAY_NAME'|'WEBSITE_URL'|'LOGO'|'WEBSITE_DOMAIN'|'COPYRIGHT_LINE'|'PARTNER_DETAILS'|'COPYRIGHT_AND_DETAILS'|'COPYRIGHT_YEAR_LINE'
},
'Value': {
'Text': 'string',
'ImageReference': 'string',
'LinkedAssetId': 'string',
'CampaignAssetImage': {
'CampaignIdentifier': 'string',
'CampaignAssetIdentifier': 'string',
'FieldId': 'string'
}
}
},
],
'LayoutPreviews': [
{
'Format': 'HTML'|'PDF'|'IMAGE',
'Url': 'string',
'PageType': 'FORM'|'CONFIRMATION'
},
],
'Layout': {
'Selected': 'string',
'Options': [
{
'Value': 'string',
'Label': 'string',
'FieldIds': [
'string',
],
'LayoutPreviews': [
{
'Format': 'HTML'|'PDF'|'IMAGE',
'Url': 'string',
'PageType': 'FORM'|'CONFIRMATION'
},
]
},
]
},
'ActivationIssues': [
{
'Code': 'ASSET_NOT_FOUND'|'ASSET_NOT_STARTABLE'|'ASSET_START_IN_PROGRESS'|'ASSET_ALREADY_ACTIVE'|'SEND_WINDOW_TOO_SOON'|'REQUIRED_FIELD_MISSING'|'RECIPIENT_LIST_MISSING'|'ENGAGEMENT_GROUPS_UNAVAILABLE'|'SENDER_EMAIL_MISSING'|'END_ON_MISSING'|'ASSET_CONTENT_MISSING'|'ASSET_NOT_ACTIVATABLE'|'TEMPLATE_CHANGED'|'PARTNER_IMAGE_REJECTED'|'PREREQUISITE_ASSET_NOT_ACTIVE'|'PARTNER_NOT_PROVISIONED'|'RECIPIENT_LIST_EMPTY'|'RECIPIENT_LIMIT_EXCEEDED'|'CONTACT_OPT_IN_REQUIRED'|'MAILING_CREDITS_EXHAUSTED'|'SENDER_EMAIL_INVALID'|'SOCIAL_CONNECTION_MISSING'|'SOCIAL_CONNECTION_EXPIRED'|'SOCIAL_CONNECTION_PAGE_REQUIRED'|'DELIVERY_FAILED'|'INTERNAL_ERROR'|'MAILING_CREDITS_INSUFFICIENT'|'PARTNER_PROFILE_FIELD_MISSING'|'PARTNER_PROFILE_FIELD_DOES_NOT_FIT'|'SOCIAL_CONNECTION_NOT_CHOSEN'|'PRIVACY_POLICY_URL_MISSING'|'PARTNER_ADDRESS_MISSING'|'SEND_MODE_MISSING'|'CONTENT_REJECTED'|'URL_NOT_ALLOWED'|'SENDER_NOT_APPROVED',
'FieldId': 'string',
'CampaignSetting': 'SENDER_EMAIL'|'END_ON'|'EMAIL_TARGET'|'PRIVACY_POLICY_URL'|'PARTNER_ADDRESS'|'PARTNER_BADGE',
'PartnerProfileField': 'DISPLAY_NAME'|'WEBSITE_URL'|'LOGO'|'WEBSITE_DOMAIN'|'COPYRIGHT_LINE'|'PARTNER_DETAILS'|'COPYRIGHT_AND_DETAILS'|'COPYRIGHT_YEAR_LINE',
'AffectedAssetIds': [
'string',
],
'Message': 'string'
},
],
'PublicUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Output for GetCampaignAsset.
Asset (dict) --
The asset resource.
Id (string) --
The asset identifier.
CampaignId (string) --
The campaign identifier.
Category (string) --
The asset category.
Name (string) --
The display name.
LinkLabel (string) --
DOCUMENT only: the words a page uses for this document, such as "eBook". Fill an AssetLink field's LabelFieldId with it when the partner picks this asset.
State (string) --
Whether the asset is live.
Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re-publication it stays ACTIVE, because the previously published content is still serving.
A stopped asset and one never started both read INACTIVE; LastActivationStatus tells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that member SUCCEEDED, never started is INACTIVE with it absent.
An update never moves this member.
LastActivationStatus (string) --
How the most recent hand-over to the delivery platform ended.
The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.
Read with State this is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.
There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.
Omitted before the first activation attempt.
DeliveryStatus (string) --
What the platform did with the artifact after accepting it.
EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.
DeliveryStatusReason (string) --
Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry.
SourceAssetTemplateId (string) --
The asset template this asset was created from: the SourceAssetTemplateIdentifier its BatchCreateCampaignAsset entry named, one of GetCampaignTemplate's CampaignTemplate.AssetTemplates[].Id. Set at create and never writable. Absent on an asset created before DG recorded it, which can't be activated either. A campaign holds at most one asset per asset template, so this is how a client matches a campaign's assets to its template's asset templates, for example to create the same assets in another campaign. Names don't identify one: two asset templates can share a name.
SocialPlatform (string) --
SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value CampaignAssetSummary.SocialPlatform reports. Absent for every other category.
FileFormat (string) --
Concrete file format of the finished artifact. For DOWNLOAD_ONLY this is the format of the object export copies through verbatim.
SendMode (string) --
When this asset sends, as chosen with UpdateCampaignAsset. EMAIL and SOCIAL_POST only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports SEND_MODE_MISSING.
ScheduledSendAt (datetime) --
The send time, present only when SendMode is SCHEDULED. It reaches the delivery platform at the asset's next activation.
Was scheduleDate: UtcDate; retyped with the write member of the same name.
FieldValues (list) --
The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.
(dict) --
One template field on an asset: the schema snapshot taken at instantiation plus the current value. The value is absent while the field is unfilled.
Schema and value are one shape rather than two lists because a client rendering an edit form needs both together, and because the pin (design section 3.1) is what an update validates against — separating them would let values outlive the schema they were checked against.
Addressed by the DG FieldId throughout. The delivery platform's own field-definition ids stay on the template record and are joined in at activation, so a vendor identifier never reaches an asset row or a response (DG-025 containment).
Field (dict) --
The field schema (snapshot from the template).
FieldId (string) --
The field identifier; matches a {{fieldId}} slot in the layout.
Label (string) --
Human-readable name for the field, for display. Authored in the template policy, never derived from the field id or the source layout's field name: the id is a slug ( Page_2_Title) and is not meant to be shown to a partner. Absent on fields imported before labels existed.
Description (string) --
What belongs in this field, in English: its role in the asset and what good content for it is (for example "Headline that names the customer and leads with a source-backed statistic"). AWS-authored with the template; never written by a partner. Absent when the template carries none, never empty. Pinned onto the asset with the field, so a corrected description reaches assets created after the correction.
Section (string) --
Layout section the field belongs to.
Page (integer) --
One-based page number, for paginated layouts (print documents).
Required (boolean) --
Whether the field must be filled before the asset can be activated. Derived from DG policy — never inherited from an upstream authoring system.
Required for activation, not for saving: UpdateCampaignAsset accepts partial content and may clear a required field. An unfilled required field appears in the asset's ActivationIssues as REQUIRED_FIELD_MISSING, and activation refuses the asset with the same code.
A text field is filled only by a non-blank value, and a rich-text field only by a value with non-blank text; a Placeholder never fills one. An image field is filled by the partner's image or by the template's DefaultValue. A field the campaign fills ( CampaignSetting) or the partner's profile fills ( PartnerProfileField) is never unfilled on the asset.
Type (dict) --
The field kind, with that kind's constraints, placeholder or default.
Text (dict) --
A plain-text field.
MinLength (integer) --
Minimum accepted length.
MaxLength (integer) --
Maximum accepted length.
Pattern (string) --
Regular expression the value must match — used for URL, email, phone and hex-colour fields.
Placeholder (string) --
Example text shown where the field is empty in a preview of the asset. Never the asset's value: it is not set on the asset at create, does not fill a required field, and is never published.
RichText (dict) --
A field whose value is a constrained HTML fragment.
MaxLength (integer) --
Maximum accepted length of the markup fragment.
AllowedTags (list) --
The HTML tags permitted in the value. Anything else is stripped.
(string) --
An HTML tag name, without angle brackets.
Placeholder (string) --
Example markup shown where the field is empty in a preview of the asset, restricted to AllowedTags. Never the asset's value: it is not set on the asset at create, does not fill a required field, and is never published.
Image (dict) --
An image field.
MaxSizeBytes (integer) --
Maximum accepted file size in bytes.
AllowedFormats (list) --
Accepted image formats.
(string) --
An accepted image format.
DefaultValue (dict) --
The AWS-authored image the asset uses until the partner sets one: shown in previews and published in an empty slot of an email, landing page, banner ad or social post. It fills a required image field. A document leaves an empty image slot blank.
Format (string) --
The format of the referenced object.
Url (string) --
A stable URL serving the object. Not presigned, so it does not expire.
PageType (string) --
Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.
A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.
RecommendedWidthPixels (integer) --
The image size, in pixels, that fills this slot and prints sharply, for example 1920 x 301 for a full-width header. Shown to the partner as "Recommended: W x H px".
Present, together with RecommendedHeightPixels, on document (PDF) image slots only, where the slot is a fixed rectangle. Such a slot is always filled: the image is scaled to cover it, centred, and clipped to it, the same as CSS object-fit: cover. An image whose shape is too far from W:H is refused with IMAGE_ASPECT_RATIO_MISMATCH; one narrower than W is accepted. A slot showing the partner's logo or badge, and a slot without the two members (every slot from before sizes existed), fits the image inside instead ( object-fit: contain): a logo or a badge is never cropped. Email and landing-page image slots are laid out by HTML and carry neither.
RecommendedHeightPixels (integer) --
The image height, in pixels, that fills this slot. Present exactly when RecommendedWidthPixels is.
AssetLink (dict) --
A link to another asset on the same campaign. The partner chooses which asset, by LinkedAssetId; at activation DG writes that asset's public URL into the field. A landing page's download button is one, naming a DOCUMENT.
Category (string) --
The category of asset the field may name. The value must be an asset of this category on the same campaign; list the candidates with ListCampaignAssets.
LabelFieldId (string) --
The text field on the same asset whose copy names the linked asset, such as the "Solution Brief" in "Your Solution Brief is ready to download!". When the partner picks an asset, fill this field with the picked asset's LinkLabel, in a preview and in the same save, unless the partner has edited it. The field stays editable. The service does the same when a save changes the link without setting this field and the partner has never written it.
CampaignSetting (string) --
The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.
A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.
PartnerProfileField (string) --
The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.
A client shows the field as "From your Partner Central profile" rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone; GetCampaign's Campaign$PartnerProfile carries the same three values.
Value (dict) --
The field's current value; the variant matches the field's type.
Text (string) --
Text value — for both text and RichText fields. A RichText value is a markup fragment restricted to the field's AllowedTags.
ImageReference (string) --
Image reference (image fields).
On a write, one of exactly two forms:
the s3:// URI of a file you staged in the Partner Central file staging bucket. It is scanned, then copied into this asset.
the URL Build with AI returned for a suggested image, unchanged. It is copied into this asset and not scanned. Any other URL is refused with FILE_REFERENCE_INVALID, including one a read returned: to keep the current image, omit the field; to put it on another asset, use CampaignAssetImage.
On a read, a URL the caller can fetch: an image in the asset's own storage comes back as a presigned GET that expires one hour after the read, so fetch it again with GetCampaignAsset when it returns 403; an image already on DG's public CDN comes back as that stable URL. A stored reference outside this asset's storage, or not a raster image, is never signed, and the value is omitted. The signed URL serves the image as its image type, whatever the upload declared.
LinkedAssetId (string) --
The asset an AssetLink field names: the id of an asset on the same campaign, of the field's category. It is a prerequisite of this asset while linked, so it activates first, this asset cannot start until it is live, and it cannot be deleted.
CampaignAssetImage (dict) --
Write only. Copies an image stored on another of your assets into this image field. The image is checked against this field's constraints and not scanned again. Also requires partnercentral:GetCampaignAsset on the source campaign. Reads return the copy as ImageReference.
CampaignIdentifier (string) --
The source campaign's id or ARN.
CampaignAssetIdentifier (string) --
The source asset's id.
FieldId (string) --
The source image field.
LayoutPreviews (list) --
The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.
The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).
One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.
On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.
(dict) --
A rendering of an AWS-authored layout skeleton or placeholder image.
The url is a stable, cache-friendly CloudFront URL rather than a presigned GET, because the bytes are AWS marketing content that is already public. The key's random segment is the object's only protection, so the URL is a bearer credential for the object and is withheld entirely while a template is not yet effective — see CampaignTemplate.EffectiveDateBegin.
Format (string) --
The format of the referenced object.
Url (string) --
A stable URL serving the object. Not presigned, so it does not expire.
PageType (string) --
Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.
A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.
Layout (dict) --
A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with. Absent for a single-layout asset.
FieldValues is always the union of every option's fields, selected or not, so a client can switch layouts without a round trip: each option lists its own FieldIds. The selection drives layout.selected and the top-level LayoutPreviews only.
Selected (string) --
The selected option's value. An asset is created with its first option selected; an asset created before that rule, with none stored, reports and activates its first option.
Options (list) --
Every option the asset was created with, in authored order.
(dict) --
One layout a multi-layout asset offers.
Value (string) --
The value that selects this option.
Label (string) --
Display label.
FieldIds (list) --
The fields this option uses: the FieldValues that stay in scope when it is selected. Lets a client show an option's form before selecting it.
(string) --
A field's slot name — the developer-readable key that matches a {{fieldId}} placeholder in the layout skeleton (e.g. "Headline", "CtaUrl"), or the form field name in a document template (e.g. "Page 2 Title"). Platform-assigned and semantic (not a service-generated opaque Id), so it has its own constrained shape rather than reusing Id.
Single spaces between words are allowed because document templates name their fields that way, and this shape is the input type for editing them. Leading, trailing and repeated spaces are not, so that "Title" and "Title " cannot be two different fields.
LayoutPreviews (list) --
This option's pages, in page order.
(dict) --
A rendering of an AWS-authored layout skeleton or placeholder image.
The url is a stable, cache-friendly CloudFront URL rather than a presigned GET, because the bytes are AWS marketing content that is already public. The key's random segment is the object's only protection, so the URL is a bearer credential for the object and is withheld entirely while a template is not yet effective — see CampaignTemplate.EffectiveDateBegin.
Format (string) --
The format of the referenced object.
Url (string) --
A stable URL serving the object. Not presigned, so it does not expire.
PageType (string) --
Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.
A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.
ActivationIssues (list) --
What must be fixed on this asset before it can be activated. Empty when the asset is ready.
Issues don't block saving: an asset can be saved incomplete and fixed over several updates. StartCampaignAssetActivationTask refuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix in FieldId. Fix it with UpdateCampaignAsset, then read this list again.
Besides the issues computed from the asset's content, the list carries what the last activation found: CONTENT_REJECTED and PARTNER_IMAGE_REJECTED when moderation refused a field. Editing that field removes its issue. A CONTENT_REJECTED without a FieldId means the text was refused as a whole; editing any text field removes it.
Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on Campaign.ActivationIssues, not here.
(dict) --
One thing that must be fixed before activation.
Code (string) --
What is wrong. Branch on this, not on Message.
FieldId (string) --
The asset field to fix. Present for asset-level issues, except SEND_MODE_MISSING and a CONTENT_REJECTED that refused the asset's text as a whole rather than one field.
CampaignSetting (string) --
The UpdateCampaign member to set. Present for campaign-level issues.
PartnerProfileField (string) --
The partner-profile value to set or shorten, in AWS Partner Central, or the derived value whose input it is. Present on PARTNER_PROFILE_FIELD_MISSING and PARTNER_PROFILE_FIELD_DOES_NOT_FIT.
AffectedAssetIds (list) --
The assets this campaign-level issue blocks.
(string) --
A campaign asset's id: ast- and 13 lowercase letters or digits (DG-087). An asset has no ARN; it is named by its id within its campaign.
Message (string) --
A description for display. Don't parse it.
PublicUrl (string) --
The live public address this asset's activation produced.
A landing page's page URL, read back from the delivery platform at activation and preserved across every convergence; a document's public CDN URL, composed on read from the key the publish wrote. Absent until the asset activates, and absent for EMAIL and SOCIAL_POST, which produce no partner-addressable URL of their own.
For a landing page this is the entire deliverable — without it a partner has no way to learn where their live page is. A WIDGET landing page reports none: it is embedded rather than standalone, so absence there is expected rather than a fault.
CreatedAt (datetime) --
Creation timestamp.
UpdatedAt (datetime) --
Last update timestamp.