[ aws . partnercentral-marketing ]
Stops a live campaign asset: an email’s scheduled send is withdrawn, a social post is removed before it publishes. On a completed campaign, it also removes a published document, banner or landing page.
Synchronous, and safe to repeat. Does not delete the asset record, so a stopped email or social post can be started again.
Not every asset can be stopped, and the reasons differ in kind. An email that has begun sending cannotbe recalled: the send is gone. A document, a banner or a landing page is refusedwith ASSET_NOT_DEACTIVATABLE until the campaign has completed (the UTC date is after its EndOn ). Until then the partner fixes one in place by updating it and activating it again, which keeps its URL, so every email that already linked to it keeps working.
Once the campaign has completed, the removal is permanent, because a completed campaign can’t activate anything again:
PublicUrl is no longer returned. Anything that linked to it, such as a landing page’s download button or a sent email, reaches an error page. The export still contains the document.PublicUrl is no longer returned. A partner site that embedded a banner shows nothing there. The platform’s own CDN can keep serving a copy a visitor already cached, which collects nothing.A landing page and a document it links to can be removed in either order.
See also: AWS API Documentation
deactivate-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.
Id -> (string)
The asset identifier.
Constraints:
- min:
17- max:
17- pattern:
ast-[0-9a-z]{13}
State -> (string)
The asset’s lifecycle position — INACTIVE once the stop is confirmed.
Possible values:
INACTIVEACTIVE
LastActivationStatus -> (string)
How the most recent activationattempt ended, which a stop does not change. Read with state, it is what separates a stopped asset (INACTIVE + SUCCEEDED) from one never activated (INACTIVE, this member absent). Omitted until a first activation has been attempted.
Possible values:
IN_PROGRESSSUCCEEDEDFAILED
StateReason -> (string)
Why the asset sits where it does. Present when LastActivationStatus is FAILED, or on a deliberate INACTIVE.
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_APPROVED