[ aws . partnercentral-marketing ]
get-campaign-asset
--catalog <value>
--campaign-identifier <value>
--campaign-asset-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
--catalog (string) [required]
The catalog (AWS or Sandbox).
Possible values:
AWSSandbox
--campaign-identifier (string) [required]
The campaign identifier.
Constraints:
- min:
18- max:
200- pattern:
(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z]+/campaign/)?camp-[A-Za-z0-9]{13}
--campaign-asset-identifier (string) [required]
The asset identifier.
Constraints:
- min:
17- max:
17- pattern:
ast-[0-9a-z]{13}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
--help (boolean)
Display help for the command/subcommand.
Asset -> (structure)
The asset resource.
Id -> (string) [required]
The asset identifier.
Constraints:
- min:
17- max:
17- pattern:
ast-[0-9a-z]{13}CampaignId -> (string) [required]
The campaign identifier.
Constraints:
- min:
18- max:
18- pattern:
camp-[A-Za-z0-9]{13}Category -> (string) [required]
The asset category.
Possible values:
LANDING_PAGESOCIAL_POSTBANNER_ADDOCUMENTName -> (string) [required]
The display name.
Constraints:
- min:
1- max:
200LinkLabel -> (string)
DOCUMENT only: the words a page uses for this document, such as “eBook”. Fill an
AssetLinkfield’sLabelFieldIdwith it when the partner picks this asset.Constraints:
- min:
1- max:
100State -> (string) [required]
Whether the asset is live.
Reports current truth only, and nothing else on this shape overrides it. During an initialpublication 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;
LastActivationStatustells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that memberSUCCEEDED, never started is INACTIVE with it absent.An update never moves this member.
Possible values:
INACTIVEACTIVELastActivationStatus -> (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 isthe schedule; landing page: create plus publish-personalisation; document: bytes written.Read with
Statethis 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 activationwent.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.
Possible values:
IN_PROGRESSSUCCEEDEDFAILEDDeliveryStatus -> (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.
Possible values:
PENDINGDELIVEREDFAILEDDeliveryStatusReason -> (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.
Possible values:
ASSET_NOT_FOUNDASSET_NOT_STARTABLEASSET_START_IN_PROGRESSASSET_ALREADY_ACTIVESEND_WINDOW_TOO_SOONREQUIRED_FIELD_MISSINGRECIPIENT_LIST_MISSINGENGAGEMENT_GROUPS_UNAVAILABLESENDER_EMAIL_MISSINGEND_ON_MISSINGASSET_CONTENT_MISSINGASSET_NOT_ACTIVATABLETEMPLATE_CHANGEDPARTNER_IMAGE_REJECTEDPREREQUISITE_ASSET_NOT_ACTIVEPARTNER_NOT_PROVISIONEDRECIPIENT_LIST_EMPTYRECIPIENT_LIMIT_EXCEEDEDCONTACT_OPT_IN_REQUIREDMAILING_CREDITS_EXHAUSTEDSENDER_EMAIL_INVALIDSOCIAL_CONNECTION_MISSINGSOCIAL_CONNECTION_EXPIREDSOCIAL_CONNECTION_PAGE_REQUIREDDELIVERY_FAILEDINTERNAL_ERRORMAILING_CREDITS_INSUFFICIENTPARTNER_PROFILE_FIELD_MISSINGPARTNER_PROFILE_FIELD_DOES_NOT_FITSOCIAL_CONNECTION_NOT_CHOSENPRIVACY_POLICY_URL_MISSINGPARTNER_ADDRESS_MISSINGSEND_MODE_MISSINGCONTENT_REJECTEDURL_NOT_ALLOWEDSENDER_NOT_APPROVEDSourceAssetTemplateId -> (string)
The asset template this asset was created from: the
SourceAssetTemplateIdentifieritsBatchCreateCampaignAssetentry named, one ofGetCampaignTemplate‘sCampaignTemplate.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.Constraints:
- min:
1- max:
64SocialPlatform -> (string)
SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value
CampaignAssetSummary.SocialPlatformreports. Absent for every other category.Possible values:
XFileFormat -> (string)
Concrete file format of the finished artifact. For
DOWNLOAD_ONLYthis is the format of the object export copies through verbatim.Possible values:
DOCXPPTXHTMLIMAGESendMode -> (string)
When this asset sends, as chosen with UpdateCampaignAsset.
SOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING.Possible values:
ON_ACTIVATIONSCHEDULEDScheduledSendAt -> (timestamp)
The send time, present only when
SendModeisSCHEDULED. 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.
Constraints:
- min:
0- max:
150(structure)
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 DGFieldId 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 -> (structure) [required]
The field schema (snapshot from the template).
FieldId -> (string) [required]
The field identifier; matches a {{fieldId}} slot in the layout.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z][A-Za-z0-9_]*( [A-Za-z0-9_]+)*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.Constraints:
- min:
1- max:
200Description -> (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.
Constraints:
- min:
1- max:
300Section -> (string)
Layout section the field belongs to.
Possible values:
HEADERBODYFOOTERPage -> (integer)
One-based page number, for paginated layouts (print documents).
Constraints:
- min:
1Required -> (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:
UpdateCampaignAssetaccepts partial content and may clear a required field. An unfilled required field appears in the asset’sActivationIssuesasREQUIRED_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
Placeholdernever fills one. An image field is filled by the partner’s image or by the template’sDefaultValue. A field the campaign fills (CampaignSetting) or the partner’s profile fills (PartnerProfileField) is never unfilled on the asset.Type -> (tagged union structure) [required]
The field kind, with that kind’s constraints, placeholder or default.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Text,RichText,Image,AssetLink.Text -> (structure)
A plain-text field.
MinLength -> (integer)
Minimum accepted length.
Constraints:
- min:
0MaxLength -> (integer)
Maximum accepted length.
Constraints:
- min:
1Pattern -> (string)
Regular expression the value must match — used for URL, email, phone and hex-colour fields.
Constraints:
- min:
1- max:
256Placeholder -> (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.
Constraints:
- min:
1- max:
100000RichText -> (structure)
A field whose value is a constrained HTML fragment.
MaxLength -> (integer)
Maximum accepted length of the markup fragment.
Constraints:
- min:
1AllowedTags -> (list) [required]
The HTML tags permitted in the value. Anything else is stripped.
Constraints:
- min:
1- max:
40(string)
An HTML tag name, without angle brackets.
Constraints:
- min:
1- max:
16- pattern:
[a-z][a-z0-9]*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.
Constraints:
- min:
1- max:
100000Image -> (structure)
An image field.
MaxSizeBytes -> (long)
Maximum accepted file size in bytes.
Constraints:
- min:
1AllowedFormats -> (list)
Accepted image formats.
Constraints:
- min:
0- max:
10(string)
An accepted image format.
Possible values:
PNGJPEGDefaultValue -> (structure)
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) [required]
The format of the referenced object.
Possible values:
HTMLIMAGEUrl -> (string) [required]
A stable URL serving the object. Not presigned, so it does not expire.
Constraints:
- min:
1- max:
2048PageType -> (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.
Possible values:
FORMCONFIRMATIONRecommendedWidthPixels -> (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 CSSobject-fit: cover. An image whose shape is too far from W:H is refused withIMAGE_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.Constraints:
- min:
1RecommendedHeightPixels -> (integer)
The image height, in pixels, that fills this slot. Present exactly when
RecommendedWidthPixelsis.Constraints:
- min:
1AssetLink -> (structure)
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 aDOCUMENT.Category -> (string) [required]
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.Possible values:
LANDING_PAGESOCIAL_POSTBANNER_ADDOCUMENTLabelFieldId -> (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.Constraints:
- min:
1- max:
64- pattern:
[A-Za-z][A-Za-z0-9_]*( [A-Za-z0-9_]+)*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.
UpdateCampaignAssetrefuses a value for it withFIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member ofGetCampaign‘sCampaign.Possible values:
SENDER_EMAILEND_ONEMAIL_TARGETPRIVACY_POLICY_URLPARTNER_ADDRESSPARTNER_BADGEPartnerProfileField -> (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.
UpdateCampaignAssetrefuses a value for it withFIELD_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‘sCampaign$PartnerProfilecarries the same three values.Possible values:
DISPLAY_NAMEWEBSITE_URLLOGOWEBSITE_DOMAINCOPYRIGHT_LINEPARTNER_DETAILSCOPYRIGHT_AND_DETAILSCOPYRIGHT_YEAR_LINEValue -> (tagged union structure)
The field’s current value; the variant matches the field’s type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Text,ImageReference,LinkedAssetId,CampaignAssetImage.Text -> (string)
Text value — for both text and RichText fields. A RichText value is a markup fragment restricted to the field’s AllowedTags.
Constraints:
- min:
1- max:
100000ImageReference -> (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, useCampaignAssetImage.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
GetCampaignAssetwhen 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.Constraints:
- min:
1- max:
4096LinkedAssetId -> (string)
The asset an
AssetLinkfield 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.Constraints:
- min:
17- max:
17- pattern:
ast-[0-9a-z]{13}CampaignAssetImage -> (structure)
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:GetCampaignAsseton the source campaign. Reads return the copy asImageReference.CampaignIdentifier -> (string) [required]
The source campaign’s id or ARN.
Constraints:
- min:
18- max:
200- pattern:
(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z]+/campaign/)?camp-[A-Za-z0-9]{13}CampaignAssetIdentifier -> (string) [required]
The source asset’s id.
Constraints:
- min:
17- max:
17- pattern:
ast-[0-9a-z]{13}FieldId -> (string) [required]
The source image field.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z][A-Za-z0-9_]*( [A-Za-z0-9_]+)*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.
Constraints:
- min:
0- max:
20(structure)
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) [required]
The format of the referenced object.
Possible values:
HTMLIMAGEUrl -> (string) [required]
A stable URL serving the object. Not presigned, so it does not expire.
Constraints:
- min:
1- max:
2048PageType -> (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.
Possible values:
FORMCONFIRMATIONLayout -> (structure)
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.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z][A-Za-z0-9_]*Options -> (list) [required]
Every option the asset was created with, in authored order.
Constraints:
- min:
0- max:
10(structure)
One layout a multi-layout asset offers.
Value -> (string) [required]
The value that selects this option.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z][A-Za-z0-9_]*Label -> (string)
Display label.
Constraints:
- min:
1- max:
200FieldIds -> (list) [required]
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.
Constraints:
- min:
0- max:
150(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.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z][A-Za-z0-9_]*( [A-Za-z0-9_]+)*LayoutPreviews -> (list)
This option’s pages, in page order.
Constraints:
- min:
0- max:
20(structure)
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) [required]
The format of the referenced object.
Possible values:
HTMLIMAGEUrl -> (string) [required]
A stable URL serving the object. Not presigned, so it does not expire.
Constraints:
- min:
1- max:
2048PageType -> (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.
Possible values:
FORMCONFIRMATIONActivationIssues -> (list) [required]
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.
StartCampaignAssetActivationTaskrefuses 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 inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset’s content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans 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.Constraints:
- min:
0- max:
150(structure)
One thing that must be fixed before activation.
Code -> (string) [required]
What is wrong. Branch on this, not on
Message.Possible values:
ASSET_NOT_FOUNDASSET_NOT_STARTABLEASSET_START_IN_PROGRESSASSET_ALREADY_ACTIVESEND_WINDOW_TOO_SOONREQUIRED_FIELD_MISSINGRECIPIENT_LIST_MISSINGENGAGEMENT_GROUPS_UNAVAILABLESENDER_EMAIL_MISSINGEND_ON_MISSINGASSET_CONTENT_MISSINGASSET_NOT_ACTIVATABLETEMPLATE_CHANGEDPARTNER_IMAGE_REJECTEDPREREQUISITE_ASSET_NOT_ACTIVEPARTNER_NOT_PROVISIONEDRECIPIENT_LIST_EMPTYRECIPIENT_LIMIT_EXCEEDEDCONTACT_OPT_IN_REQUIREDMAILING_CREDITS_EXHAUSTEDSENDER_EMAIL_INVALIDSOCIAL_CONNECTION_MISSINGSOCIAL_CONNECTION_EXPIREDSOCIAL_CONNECTION_PAGE_REQUIREDDELIVERY_FAILEDINTERNAL_ERRORMAILING_CREDITS_INSUFFICIENTPARTNER_PROFILE_FIELD_MISSINGPARTNER_PROFILE_FIELD_DOES_NOT_FITSOCIAL_CONNECTION_NOT_CHOSENPRIVACY_POLICY_URL_MISSINGPARTNER_ADDRESS_MISSINGSEND_MODE_MISSINGCONTENT_REJECTEDURL_NOT_ALLOWEDSENDER_NOT_APPROVEDFieldId -> (string)
The asset field to fix. Present for asset-level issues, except
SEND_MODE_MISSINGand aCONTENT_REJECTEDthat refused the asset’s text as a whole rather than one field.Constraints:
- min:
1- max:
64- pattern:
[A-Za-z][A-Za-z0-9_]*( [A-Za-z0-9_]+)*CampaignSetting -> (string)
The
UpdateCampaignmember to set. Present for campaign-level issues.Possible values:
SENDER_EMAILEND_ONEMAIL_TARGETPRIVACY_POLICY_URLPARTNER_ADDRESSPARTNER_BADGEPartnerProfileField -> (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_MISSINGandPARTNER_PROFILE_FIELD_DOES_NOT_FIT.Possible values:
DISPLAY_NAMEWEBSITE_URLLOGOWEBSITE_DOMAINCOPYRIGHT_LINEPARTNER_DETAILSCOPYRIGHT_AND_DETAILSCOPYRIGHT_YEAR_LINEAffectedAssetIds -> (list)
The assets this campaign-level issue blocks.
Constraints:
- min:
0- max:
25(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.Constraints:
- min:
17- max:
17- pattern:
ast-[0-9a-z]{13}Message -> (string) [required]
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.
Constraints:
- min:
1- max:
2048CreatedAt -> (timestamp)
Creation timestamp.UpdatedAt -> (timestamp)
Last update timestamp.