search_campaign_templates
¶
search_campaign_templates(
catalog: Catalog,
*,
config_overrides: Optional[PartnerCentralMarketingClientConfig] = None,
search_text: Optional[TemplateSearchText] = None,
industry: Optional[IndustryFilterList] = None,
use_case: Optional[UseCaseFilterList] = None,
language: Optional[LanguageFilterList] = None,
aws_services: Optional[AwsServiceFilterList] = None,
customer_segments: Optional[CustomerSegmentFilterList] = None,
themes: Optional[ThemeFilterList] = None,
collection: Optional[CampaignTemplateCollectionFilterList] = None,
max_results: Optional[MaxResults] = None,
next_token: Optional[NextToken] = None,
) -> SearchCampaignTemplatesResponse
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.
Parameters:
-
catalog(Catalog) –The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.
-
search_text(Optional[TemplateSearchText], default:None) –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. -
industry(Optional[IndustryFilterList], default:None) –Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
-
use_case(Optional[UseCaseFilterList], default:None) –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.
-
language(Optional[LanguageFilterList], default:None) –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. -
aws_services(Optional[AwsServiceFilterList], default:None) –Restrict to templates promoting these AWS services. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
-
customer_segments(Optional[CustomerSegmentFilterList], default:None) –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.
-
themes(Optional[ThemeFilterList], default:None) –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.
-
collection(Optional[CampaignTemplateCollectionFilterList], default:None) –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.
-
max_results(Optional[MaxResults], default:None) –Maximum results per page.
-
next_token(Optional[NextToken], default:None) –Pagination token.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action. An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. -
InternalServerException–An unexpected error occurred during the processing of the request.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by the service. A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. -
UnknownServiceError–The service returned an error code this client does not model.
Examples:
Browse the whole catalog
>>> client.search_campaign_templates(catalog='AWS', search_text='contact center', industry=['TELECOMMUNICATIONS'])
Browse the Build with AI collection in one language
Source code in docs_src/capo_partnercentral_marketing/_services/partner_central_marketing.py
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 | |