[ aws . partnercentral-marketing ]

get-campaign-template

Description

Retrieves full detail of one campaign template, including its ordered asset templates with their field schema and layout previews.

See also: AWS API Documentation

Synopsis

  get-campaign-template
--catalog <value>
--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]

Options

--catalog (string) [required]

The catalog (AWS or Sandbox).

Possible values:

  • AWS
  • Sandbox

--identifier (string) [required]

The campaign template’s id. A campaign template has no ARN (DG-084).

Constraints:

  • min: 18
  • max: 18
  • pattern: tmpl-[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.

Global Options

--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.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--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.

  • on
  • off
  • auto

--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.

  • base64
  • raw-in-base64-out

--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.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

CampaignTemplate -> (structure)

The campaign template, including its asset templates.

Id -> (string) [required]

The campaign template identifier.

Constraints:

  • min: 18
  • max: 18
  • pattern: tmpl-[0-9a-z]{13}

Name -> (string) [required]

The display name.

Constraints:

  • min: 1
  • max: 200

Industry -> (string)

Target industry for filtering or categorization.

Possible values:

  • FINANCIAL_SERVICES
  • HEALTHCARE
  • MANUFACTURING
  • RETAIL
  • MEDIA_ENTERTAINMENT
  • ENERGY
  • EDUCATION
  • GOVERNMENT
  • TELECOMMUNICATIONS
  • AUTOMOTIVE
  • INSURANCE
  • OTHER

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.

Constraints:

  • min: 1
  • max: 300

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.

Possible values:

  • en
  • es
  • es-419
  • fr
  • de
  • it
  • pt-BR
  • id
  • tr
  • ja
  • ko
  • zh-Hans
  • zh-Hant
  • ar

Collection -> (string) [required]

The browsing context the template is listed in. Every template has exactly one.

Possible values:

  • GENERAL
  • BUILD_WITH_AI

AwsServices -> (list)

AWS services the template promotes.

Constraints:

  • min: 0
  • max: 20

(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.

Constraints:

  • min: 0
  • max: 20

(string)

The customer segment a campaign template is written for. Clients must tolerate values added later.

Possible values:

  • ENTERPRISE
  • SMB
  • PUBLIC_SECTOR
  • ISV

Themes -> (list)

The template’s marketing themes. Absent when the template names none, in which case it matches every Themes search filter.

Constraints:

  • min: 0
  • max: 20

(string)

The marketing theme of a campaign template. Clients must tolerate values added later.

Possible values:

  • AI
  • MIGRATION_MODERNIZATION
  • SECURITY
  • DATA_ANALYTICS
  • AWS_TRAINING_CERTIFICATION
  • AWS_MARKETPLACE
  • CONNECT
  • EVENTS

SetupDuration -> (string)

Estimated setup time.

ThumbnailUrl -> (string)

Thumbnail URL.

EffectiveDateBegin -> (timestamp)

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.

Constraints:

  • min: 0
  • max: 25

(structure)

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) [required]

The template-local asset template identifier.

Constraints:

  • min: 1
  • max: 64

Type -> (string) [required]

The kind of asset this blueprint instantiates as.

Possible values:

  • EMAIL
  • SOCIAL_POST
  • LANDING_PAGE
  • BANNER_AD
  • DOCUMENT

Label -> (string) [required]

Display label; becomes the instantiated asset’s name.

Constraints:

  • min: 1
  • max: 200

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.

Constraints:

  • min: 0
  • max: 150

(structure)

One slot in an asset template’s layout: addressing key, placement, and the field kind carrying its own constraints, placeholder or default.

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: 200

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.

Constraints:

  • min: 1
  • max: 300

Section -> (string)

Layout section the field belongs to.

Possible values:

  • HEADER
  • BODY
  • FOOTER

Page -> (integer)

One-based page number, for paginated layouts (print documents).

Constraints:

  • min: 1

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 -> (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: 0

MaxLength -> (integer)

Maximum accepted length.

Constraints:

  • min: 1

Pattern -> (string)

Regular expression the value must match — used for URL, email, phone and hex-colour fields.

Constraints:

  • min: 1
  • max: 256

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.

Constraints:

  • min: 1
  • max: 100000

RichText -> (structure)

A field whose value is a constrained HTML fragment.

MaxLength -> (integer)

Maximum accepted length of the markup fragment.

Constraints:

  • min: 1

AllowedTags -> (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: 100000

Image -> (structure)

An image field.

MaxSizeBytes -> (long)

Maximum accepted file size in bytes.

Constraints:

  • min: 1

AllowedFormats -> (list)

Accepted image formats.

Constraints:

  • min: 0
  • max: 10

(string)

An accepted image format.

Possible values:

  • PNG
  • JPEG

DefaultValue -> (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:

  • HTML
  • PDF
  • IMAGE

Url -> (string) [required]

A stable URL serving the object. Not presigned, so it does not expire.

Constraints:

  • min: 1
  • max: 2048

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.

Possible values:

  • FORM
  • CONFIRMATION

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.

Constraints:

  • min: 1

RecommendedHeightPixels -> (integer)

The image height, in pixels, that fills this slot. Present exactly when RecommendedWidthPixels is.

Constraints:

  • min: 1

AssetLink -> (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 a DOCUMENT .

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:

  • EMAIL
  • LANDING_PAGE
  • SOCIAL_POST
  • BANNER_AD
  • DOCUMENT

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.

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. 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 .

Possible values:

  • SENDER_EMAIL
  • END_ON
  • EMAIL_TARGET
  • PRIVACY_POLICY_URL
  • PARTNER_ADDRESS
  • PARTNER_BADGE

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.

Possible values:

  • DISPLAY_NAME
  • WEBSITE_URL
  • LOGO
  • WEBSITE_DOMAIN
  • COPYRIGHT_LINE
  • PARTNER_DETAILS
  • COPYRIGHT_AND_DETAILS
  • COPYRIGHT_YEAR_LINE

LayoutPreviews -> (list)

Previews of the AWS-authored layout skeleton.

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:

  • HTML
  • PDF
  • IMAGE

Url -> (string) [required]

A stable URL serving the object. Not presigned, so it does not expire.

Constraints:

  • min: 1
  • max: 2048

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.

Possible values:

  • FORM
  • CONFIRMATION

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.

Constraints:

  • min: 0
  • max: 5

(string)

Opaque identifier for output fields that name a blueprint (a template’s asset). Max 64 bytes.

Constraints:

  • min: 1
  • max: 64

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.

Possible values:

  • FACEBOOK
  • LINKEDIN
  • X

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.

Constraints:

  • min: 0
  • max: 30

(structure)

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) [required]

The display name.

Constraints:

  • min: 1
  • max: 200

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 -> (timestamp)

Creation timestamp.

UpdatedAt -> (timestamp)

Last update timestamp.