[ aws . partnercentral-marketing ]

list-campaigns

Description

Lists campaigns with optional filters and pagination.

See also: AWS API Documentation

list-campaigns is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Items

Synopsis

  list-campaigns
--catalog <value>
[--campaign-identifiers <value>]
[--name <value>]
[--states <value>]
[--sort <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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-identifiers (list)

Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.

Constraints:

  • min: 1
  • max: 100

(string)

A campaign, named by its id or its ARN.

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}

Syntax:

"string" "string" ...

--name (string)

Only campaigns whose name contains this, compared case-insensitively.

Constraints:

  • min: 1
  • max: 100

--states (list)

Only campaigns in one of these states.

Constraints:

  • min: 1
  • max: 3

(string)

A campaign’s state, derived on every read from its EndOn and its assets:

  • COMPLETED once the UTC date is after EndOn (so a campaign ending today completes at the next UTC midnight). A campaign with no EndOn never completes, and cannot activate until it has one;
  • otherwise ACTIVE when any of its assets is ACTIVE ;
  • otherwise DRAFT , including a campaign with no assets.

A summary of the assets, not a lifecycle: nothing transitions it, it is never stored, and it gates no operation by itself: the refusal on a completed campaign (CAMPAIGN_COMPLETED ) reads the same EndOn . Otherwise whether an asset can be edited, activated or deleted depends on that asset. So a scheduled email counts as ACTIVE once armed, before it sends; a campaign stays DRAFT during its first activation; deactivating its only active email or social post returns it to DRAFT ; and a COMPLETED campaign can still have live landing pages.

Possible values:

  • DRAFT
  • ACTIVE
  • COMPLETED

Syntax:

"string" "string" ...

--sort (structure)

The order of the results. Default: CREATED_AT , DESCENDING .

SortBy -> (string) [required]

The attribute to sort by.

Possible values:

  • NAME
  • STATE
  • START_ON
  • CREATED_AT

SortOrder -> (string) [required]

The direction.

Possible values:

  • ASCENDING
  • DESCENDING

Shorthand Syntax:

SortBy=string,SortOrder=string

JSON Syntax:

{
  "SortBy": "NAME"|"STATE"|"START_ON"|"CREATED_AT",
  "SortOrder": "ASCENDING"|"DESCENDING"
}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Items -> (list)

The list of results.

Constraints:

  • min: 0
  • max: 100

(structure)

Summary representation of a campaign for list operations.

CampaignId -> (string) [required]

The campaign identifier.

Constraints:

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

Arn -> (string) [required]

The campaign ARN. Present on the summary so a caller can tag a campaign straight from a list result without a GetCampaign per row — the same reason the audit timestamps are here.

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

State -> (string) [required]

The campaign’s state, derived on every read from EndOn and its assets. See CampaignState .

Possible values:

  • DRAFT
  • ACTIVE
  • COMPLETED

Language -> (string)

The language the campaign’s assets are written and typeset in. See Campaign$Language .

Possible values:

  • en
  • es
  • es-419
  • fr
  • de
  • it
  • pt-BR
  • id
  • tr
  • ja
  • ko
  • zh-Hans
  • zh-Hant
  • ar

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. Present on the summary so a caller can order a list by recency without reading each campaign in full.

UpdatedAt -> (timestamp)

Last update timestamp. Present on the summary for the same reason as CreatedAt.

NextToken -> (string)

Pagination token.

Constraints:

  • min: 1
  • max: 8192