[ aws . partnercentral-marketing ]
Searches and browses the AWS-authored campaign template catalog. With no SearchText it returns the whole catalog in the default order, so browse and keyword search share one shape; GetCampaignTemplate reads one template.
See also: AWS API Documentation
search-campaign-templates 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: CampaignTemplates
search-campaign-templates
--catalog <value>
[--search-text <value>]
[--industry <value>]
[--use-case <value>]
[--language <value>]
[--aws-services <value>]
[--customer-segments <value>]
[--themes <value>]
[--collection <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]
--catalog (string) [required]
The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.
Possible values:
AWSSandbox
--search-text (string)
Free-text query matched against the template’s name and description. Any word may match, and the last word matches as a prefix when it has 3 or more characters, so
novfinds Amazon Nova. A template whose name holds the query as a phrase ranks first, then whole-word matches, then prefix-only ones. Omit to browse the whole catalog. Text analysis is derived from each template’s own LanguageCode, never from the language filter.Constraints:
- min:
1- max:
512- pattern:
[^\n\r]+
--industry (list)
Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
Constraints:
- min:
1- max:
50(string)
Industry shape.
Possible values:
FINANCIAL_SERVICESHEALTHCAREMANUFACTURINGRETAILMEDIA_ENTERTAINMENTENERGYEDUCATIONGOVERNMENTTELECOMMUNICATIONSAUTOMOTIVEINSURANCEOTHER
Syntax:
"string" "string" ...
--use-case (list)
Restrict to templates with these campaign use cases. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
Constraints:
- min:
1- max:
50(string)
Filter value for template use cases.
Constraints:
- min:
1- max:
100
Syntax:
"string" "string" ...
--language (list)
Restrict to templates in these language(s), matched by each template’s
LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.Constraints:
- min:
1- max:
50(string)
A language a campaign is written and typeset in, as a BCP 47 tag.
A closed set rather than a free string: each value is one DG can render, and a document needs a font for it, so a tag outside the set could not be honoured.
Possible values:
eneses-419frdeitpt-BRidtrjakozh-Hanszh-Hantar
Syntax:
"string" "string" ...
--aws-services (list)
Restrict to templates promoting these AWS services. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
Constraints:
- min:
1- max:
50(string)
Syntax:
"string" "string" ...
--customer-segments (list)
Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.
Constraints:
- min:
1- max:
50(string)
The customer segment a campaign template is written for. Clients must tolerate values added later.
Possible values:
ENTERPRISESMBPUBLIC_SECTORISV
Syntax:
"string" "string" ...
--themes (list)
Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.
Constraints:
- min:
1- max:
50(string)
The marketing theme of a campaign template. Clients must tolerate values added later.
Possible values:
AIMIGRATION_MODERNIZATIONSECURITYDATA_ANALYTICSAWS_TRAINING_CERTIFICATIONAWS_MARKETPLACECONNECTEVENTS
Syntax:
"string" "string" ...
--collection (list)
Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.
Constraints:
- min:
1- max:
50(string)
Which browsing context a campaign template belongs to. A classification of the template, not a resource: it decides where a client lists the template and grants nothing. Every partner may read and use a template in any collection. Clients must tolerate values added later.
Possible values:
GENERALBUILD_WITH_AI
Syntax:
"string" "string" ...
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom 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
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse 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.
--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.
TotalResults -> (integer)
Total count over the whole matching set, not just this page — for “over N results” display.
CampaignTemplates -> (list)
This page of template summaries.
Constraints:
- min:
0- max:
100(structure)
Summary representation of a campaign template, returned by search.
Id -> (string) [required]
The campaign template identifier.
Constraints:
- min:
18- max:
18- pattern:
tmpl-[0-9a-z]{13}Name -> (string) [required]
The display name.
Constraints:
- min:
1- max:
200Industry -> (string)
Target industry for filtering or categorization.
Possible values:
FINANCIAL_SERVICESHEALTHCAREMANUFACTURINGRETAILMEDIA_ENTERTAINMENTENERGYEDUCATIONGOVERNMENTTELECOMMUNICATIONSAUTOMOTIVEINSURANCEOTHERUseCase -> (string)
Campaign use case for filtering or categorization.Description -> (string)
The campaign overview. See
CampaignTemplate$Description.Constraints:
- min:
1- max:
300LanguageCode -> (string)
Language the template is authored in. See
CampaignTemplate$LanguageCode.Possible values:
eneses-419frdeitpt-BRidtrjakozh-Hanszh-HantarCollection -> (string) [required]
The browsing context the template is listed in. See
CampaignTemplate$Collection.Possible values:
GENERALBUILD_WITH_AIAwsServices -> (list)
AWS services the template promotes.
Constraints:
- min:
0- max:
20(string)
CustomerSegments -> (list)
The customer segments the template is written for. See
CampaignTemplate$CustomerSegments.Constraints:
- min:
0- max:
20(string)
The customer segment a campaign template is written for. Clients must tolerate values added later.
Possible values:
ENTERPRISESMBPUBLIC_SECTORISVThemes -> (list)
The template’s marketing themes. See
CampaignTemplate$Themes.Constraints:
- min:
0- max:
20(string)
The marketing theme of a campaign template. Clients must tolerate values added later.
Possible values:
AIMIGRATION_MODERNIZATIONSECURITYDATA_ANALYTICSAWS_TRAINING_CERTIFICATIONAWS_MARKETPLACECONNECTEVENTSThumbnailUrl -> (string)
Thumbnail URL.
NextToken -> (string)
Pagination token.
Constraints:
- min:
1- max:
8192