[ aws . partnercentral-marketing ]

start-campaign-asset-activation-task

Description

Activates 1–25 of a campaign’s assets as one ordered unit, and returns a task to poll.

Takes a listbecause the service owns the ordering. Assets link to one another by URL — an email’s call-to-action carries the landing page’s URL, the landing page’s download field carries the document’s — and a URL does not exist until the asset it points at is activated. Those edges are derived by the service from the campaign’s pinned template, so reconstructing and topologically sorting them is work the service has already done, and getting it wrong arms an email with a dead link. Name every asset you want live and the service sequences them; “activate everything” is the list with every id in it, which ListCampaignAssets already gave you.

Asynchronous, because activating an asset installs or arms behaviour that runs later and an email activation bulk-loads its audience into the delivery platform. Everything decidable withouta write to the delivery platform is evaluated before this returns; everything else lands on the task.

A refusal that applies to one asset does not fail the request: that asset is on the task already FAILED, with its reason, and the rest run. A refusal that applies to the whole request — a malformed list, an unknown campaign, another task already running on this campaign, this service’s service-linked role being deleted (ConflictException SERVICE_LINKED_ROLE_DELETION_IN_PROGRESS ), a campaign setting an asset in the request needs (ValidationException CAMPAIGN_INCOMPLETE ), a campaign sender that no longer passes CreateCampaign ‘s sender rules while the request names an email (ValidationException with no FieldList , whose message ends with one Reason: <code> token per failed rule: PATTERN_MISMATCH , SENDER_DOMAIN_NOT_ALLIANCE_LEAD , or SENDER_DOMAIN_DKIM_MISSING and/or SENDER_DOMAIN_DMARC_MISSING ) — is thrown, and nothing starts.

One task runs on a campaign at a time. A second concurrent call is refused with ConflictException / CAMPAIGN_ACTIVATION_IN_PROGRESS, whose ResourceId names the task already holding the campaign. Two tasks over disjointasset sets are refused too: the guard is deliberately campaign-wide, because overlapping runs made the per-asset status misleading rather than merely contended.

See also: AWS API Documentation

Synopsis

  start-campaign-asset-activation-task
--catalog <value>
--campaign-identifier <value>
--campaign-asset-identifiers <value>
[--client-token <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

--campaign-identifier (string) [required]

The campaign identifier, which also authorizes the call.

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

The assets to activate, in any order — the service derives the dependency order and ignores the order given here.

Constraints:

  • min: 1
  • 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}

Syntax:

"string" "string" ...

--client-token (string)

Idempotency token. Two requests carrying the same token are one request, and the second returns the first one’s task rather than starting a second.

The deduplication window is the life of the task record, not a fixed number of hours: replaying a token after the task has expired starts a new task. Stated because a caller would otherwise assume the usual few-hour guarantee.

Constraints:

  • min: 1
  • max: 128
  • pattern: [\x21-\x7E]+

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

CampaignId -> (string)

The campaign’s id. Canonical: because CampaignIdentifier accepts an id or an ARN, echoing this tells a caller who passed an ARN what the id is. The task’s own id is TaskId .

Constraints:

  • min: 18
  • max: 18
  • pattern: camp-[A-Za-z0-9]{13}

TaskId -> (string)

Opaque correlation value for the task. Echoed so a caller can tell the task it started from a later one that superseded it. Never an input: the campaign is what addresses a task, because a campaign has at most one.

Constraints:

  • min: 18
  • max: 18
  • pattern: atsk-[A-Za-z0-9]{13}

TaskStatus -> (string)

The task’s status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.

Possible values:

  • IN_PROGRESS
  • SUCCEEDED
  • PARTIAL_FAILURE
  • FAILED

StartedAt -> (timestamp)

When the task was created.

EndedAt -> (timestamp)

When the task reached a terminal status. Absent while IN_PROGRESS.

Assets -> (list)

One entry per asset the request named, in the order named. An asset refused up front is FAILED from the first response, with its reason.

Constraints:

  • min: 0
  • max: 25

(structure)

How one asset named in a task is going.

CampaignAssetId -> (string) [required]

The asset this outcome belongs to.

Constraints:

  • min: 17
  • max: 17
  • pattern: ast-[0-9a-z]{13}

Status -> (string) [required]

This asset’s contribution to the task’s status.

Possible values:

  • IN_PROGRESS
  • SUCCEEDED
  • FAILED

Reason -> (string)

Why the activation did not succeed. Present when status is FAILED.

Possible values:

  • ASSET_NOT_FOUND
  • ASSET_NOT_STARTABLE
  • ASSET_START_IN_PROGRESS
  • ASSET_ALREADY_ACTIVE
  • SEND_WINDOW_TOO_SOON
  • REQUIRED_FIELD_MISSING
  • RECIPIENT_LIST_MISSING
  • ENGAGEMENT_GROUPS_UNAVAILABLE
  • SENDER_EMAIL_MISSING
  • END_ON_MISSING
  • ASSET_CONTENT_MISSING
  • ASSET_NOT_ACTIVATABLE
  • TEMPLATE_CHANGED
  • PARTNER_IMAGE_REJECTED
  • PREREQUISITE_ASSET_NOT_ACTIVE
  • PARTNER_NOT_PROVISIONED
  • RECIPIENT_LIST_EMPTY
  • RECIPIENT_LIMIT_EXCEEDED
  • CONTACT_OPT_IN_REQUIRED
  • MAILING_CREDITS_EXHAUSTED
  • SENDER_EMAIL_INVALID
  • SOCIAL_CONNECTION_MISSING
  • SOCIAL_CONNECTION_EXPIRED
  • SOCIAL_CONNECTION_PAGE_REQUIRED
  • DELIVERY_FAILED
  • INTERNAL_ERROR
  • MAILING_CREDITS_INSUFFICIENT
  • PARTNER_PROFILE_FIELD_MISSING
  • PARTNER_PROFILE_FIELD_DOES_NOT_FIT
  • SOCIAL_CONNECTION_NOT_CHOSEN
  • PRIVACY_POLICY_URL_MISSING
  • PARTNER_ADDRESS_MISSING
  • SEND_MODE_MISSING
  • CONTENT_REJECTED
  • URL_NOT_ALLOWED
  • SENDER_NOT_APPROVED

Message -> (string)

A description of Reason for display. Don’t parse it. For a mailing-credit shortfall it states the credits needed and remaining.

Constraints:

  • min: 1
  • max: 1024