[ aws . partnercentral-marketing ]
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
create-campaign
--catalog <value>
--name <value>
--campaign-template-id <value>
[--sender-email <value>]
[--privacy-policy-url <value>]
[--partner-address <value>]
[--partner-badge <value>]
[--email-target <value>]
[--email-target-engagement-group-ids <value>]
[--target-audience <value>]
[--estimated-budget <value>]
[--total-budget <value>]
[--start-on <value>]
[--end-on <value>]
[--client-token <value>]
[--tags <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
--name (string) [required]
The display name.
Constraints:
- min:
1- max:
100
--campaign-template-id (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.
Constraints:
- min:
18- max:
18- pattern:
tmpl-[0-9a-z]{13}
--sender-email (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.
Constraints:
- min:
3- max:
254- pattern:
[\x21-\x3F\x41-\x7E]+@[\x21-\x3F\x41-\x7E]+
--privacy-policy-url (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.
Constraints:
- min:
9- max:
2048- pattern:
https://[^\s"'()<>\\]+
--partner-address (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.
Constraints:
- min:
1- max:
200
--partner-badge (structure)
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.Constraints:
- min:
1- max:
1024- pattern:
s3://[^\s]+VersionId -> (string) [required]
The version of the object to take: the
VersionIdthe staging upload returned.Constraints:
- min:
1- max:
1024
Shorthand Syntax:
S3Uri=string,VersionId=string
JSON Syntax:
{
"S3Uri": "string",
"VersionId": "string"
}
--email-target (structure)
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.Constraints:
- min:
1- max:
1024- pattern:
s3://[^\s]+VersionId -> (string) [required]
The version of the object to take: the
VersionIdthe staging upload returned.Constraints:
- min:
1- max:
1024
Shorthand Syntax:
S3Uri=string,VersionId=string
JSON Syntax:
{
"S3Uri": "string",
"VersionId": "string"
}
--email-target-engagement-group-ids (list)
Engagement groups whose contacts the campaign’s emails will also go to: the
IdsListEngagementGroupsreturns (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.
Constraints:
- min:
1- max:
10(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’sGroupId, whose pattern pins only the current shape: if Leads relaxes it, so does this.Constraints:
- min:
1- max:
64- pattern:
eng-grp-[0-9a-z]{14}
Syntax:
"string" "string" ...
--target-audience (structure)
Advisory targeting metadata. Refined later, and not validated here.
Industries -> (list)
Target industries.
Constraints:
- min:
1- max:
20(string)
Industry shape.
Possible values:
FINANCIAL_SERVICESHEALTHCAREMANUFACTURINGRETAILMEDIA_ENTERTAINMENTENERGYEDUCATIONGOVERNMENTTELECOMMUNICATIONSAUTOMOTIVEINSURANCEOTHERCompanySizes -> (list)
Target company sizes.
Constraints:
- min:
1- max:
10(string)
CompanySize shape.
Possible values:
STARTUPSMALL_BUSINESSMID_MARKETENTERPRISEGLOBAL_ENTERPRISECountries -> (list)
Target countries, as ISO 3166-1 alpha-2 codes.
Constraints:
- min:
1- max:
100(string)
An ISO 3166-1 alpha-2 country code.
Constraints:
- min:
2- max:
2- pattern:
[A-Z]{2}
Shorthand Syntax:
Industries=string,string,CompanySizes=string,string,Countries=string,string
JSON Syntax:
{
"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", ...]
}
--estimated-budget (structure)
What the partner expects the campaign to cost.
Amount -> (string) [required]
The amount, as a decimal string with at most two decimal places.
Constraints:
- min:
1- max:
20- pattern:
\d+(\.\d{1,2})?CurrencyCode -> (string) [required]
The ISO 4217 currency the amount is denominated in.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]{3}
Shorthand Syntax:
Amount=string,CurrencyCode=string
JSON Syntax:
{
"Amount": "string",
"CurrencyCode": "string"
}
--total-budget (structure)
The campaign’s total budget.
Amount -> (string) [required]
The amount, as a decimal string with at most two decimal places.
Constraints:
- min:
1- max:
20- pattern:
\d+(\.\d{1,2})?CurrencyCode -> (string) [required]
The ISO 4217 currency the amount is denominated in.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]{3}
Shorthand Syntax:
Amount=string,CurrencyCode=string
JSON Syntax:
{
"Amount": "string",
"CurrencyCode": "string"
}
--start-on (string)
The first day of the campaign’s run window. Not after
EndOn(ValidationException,INVALID_VALUE).Constraints:
- pattern:
\d{4}-\d{2}-\d{2}
--end-on (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
ActivationIssuesreportsEND_ON_MISSINGand StartCampaignAssetActivationTask refuses (CAMPAIGN_INCOMPLETE). Set it with UpdateCampaign.Constraints:
- pattern:
\d{4}-\d{2}-\d{2}
--client-token (string)
Idempotency token. Same token within 24h returns existing resource.
Constraints:
- min:
1- max:
128- pattern:
[\x21-\x7E]+
--tags (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.
Constraints:
- min:
1- max:
200(structure)
A key-value pair applied to a resource.
Key -> (string) [required]
The tag key.
Constraints:
- min:
1- max:
128- pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value -> (string) [required]
The tag value.
Constraints:
- min:
0- max:
256- pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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.
Id -> (string)
The new campaign’s identifier.
Constraints:
- min:
18- max:
18- pattern:
camp-[A-Za-z0-9]{13}
Arn -> (string)
The new campaign’s ARN.
Constraints:
- min:
1- max:
1000- pattern:
arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/campaign/[\w+=,.@-]+