[ aws . partnercentral-marketing ]
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
update-campaign
--catalog <value>
--campaign-identifier <value>
[--name <value>]
[--sender-email <value>]
[--privacy-policy-url <value>]
[--partner-address <value>]
[--partner-badge <value>]
[--email-target <value>]
[--email-target-engagement-group-ids <value>]
[--social-connections <value>]
[--estimated-budget <value>]
[--total-budget <value>]
[--target-audience <value>]
[--client-token <value>]
[--start-on <value>]
[--end-on <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}
--name (string)
The display name.
Constraints:
- min:
1- max:
100
--sender-email (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, andStartCampaignAssetActivationTaskre-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.
Constraints:
- min:
3- max:
254- pattern:
[\x21-\x3F\x41-\x7E]+@[\x21-\x3F\x41-\x7E]+
--privacy-policy-url (string)
Sets or replaces the URL of the partner’s privacy policy. Replaces, never clears.
Constraints:
- min:
9- max:
2048- pattern:
https://[^\s"'()<>\\]+
--partner-address (string)
Sets or replaces the partner’s postal address. Replaces, never clears.
Constraints:
- min:
1- max:
200
--partner-badge (structure)
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.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)
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.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 (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).
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" ...
--social-connections (map)
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.
key -> (string)
Social platform a connection authorizes publishing on.
Possible values:
Xvalue -> (list)
The connections chosen for one platform. Exactly one: a social post publishes from one account.
Constraints:
- min:
1- max:
1(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).Constraints:
- min:
16- max:
16- pattern:
sc-[0-9a-z]{13}
Shorthand Syntax:
KeyName1=string,string,KeyName2=string,string
Where valid key names are:
FACEBOOK
LINKEDIN
X
JSON Syntax:
{"FACEBOOK"|"LINKEDIN"|"X": ["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"
}
--target-audience (structure)
Target audience configuration.
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", ...]
}
--client-token (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.
Constraints:
- min:
1- max:
128- pattern:
[\x21-\x7E]+
--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.
Editable only while the campaign is open, like everything else here: once the stored
EndOnhas passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused withValidationException(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.Constraints:
- pattern:
\d{4}-\d{2}-\d{2}
--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 campaign identifier.
Constraints:
- min:
18- max:
18- pattern:
camp-[A-Za-z0-9]{13}