[ aws . partnercentral-marketing ]
get-campaign
--catalog <value>
--campaign-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}
--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.
Campaign -> (structure)
The campaign.
CampaignId -> (string) [required]
The campaign identifier.
Constraints:
- min:
18- max:
18- pattern:
camp-[A-Za-z0-9]{13}Arn -> (string) [required]
The campaign ARN.
Constraints:
- min:
1- max:
1000- pattern:
arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/campaign/[\w+=,.@-]+Name -> (string) [required]
The display name.
Constraints:
- min:
1- max:
100State -> (string) [required]
The campaign’s state, derived on every read from
EndOnand its assets. SeeCampaignState.Possible values:
DRAFTACTIVECOMPLETEDCampaignTemplateId -> (string)
The campaign template this campaign draws its assets from. Set at create, immutable.
Constraints:
- min:
18- max:
18- pattern:
tmpl-[0-9a-z]{13}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.Possible values:
eneses-419frdeitpt-BRidtrjakozh-Hanszh-HantarPartnerProfile -> (structure)
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.
Constraints:
- min:
1- max:
2048- pattern:
https://[^\s]+RefreshedAt -> (timestamp) [required]
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.
Constraints:
- min:
3- max:
254- pattern:
[\x21-\x3F\x41-\x7E]+@[\x21-\x3F\x41-\x7E]+PrivacyPolicyUrl -> (string)
The URL of the partner’s privacy policy. Absent until one is set.
Constraints:
- min:
9- max:
2048- pattern:
https://[^\s"'()<>\\]+PartnerAddress -> (string)
The partner’s postal address. Absent until one is set.
Constraints:
- min:
1- max:
200PartnerBadge -> (structure)
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) [required]
A presigned GET of the badge, which expires one hour after the read: fetch it again withGetCampaignwhen it returns 403.AttachedAt -> (timestamp) [required]
When the badge was set.EmailTarget -> (structure)
The attached recipient list — metadata only. There is no read path for the addresses.
ScanStatus -> (string)
The scan verdict for the attached list.
Possible values:
PENDINGCLEANREJECTEDAttachedAt -> (timestamp)
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 exampleQ4 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.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}SocialConnections -> (map)
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.
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}EstimatedBudget -> (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}TotalBudget -> (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}TargetAudience -> (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}StartOn -> (string)
The first day of the campaign’s run window.
Constraints:
- pattern:
\d{4}-\d{2}-\d{2}EndOn -> (string)
The last day of the campaign’s run window.
Constraints:
- pattern:
\d{4}-\d{2}-\d{2}CreatedAt -> (timestamp)
Creation timestamp.UpdatedAt -> (timestamp)
Last update timestamp.ActivationIssues -> (list) [required]
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 withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.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.