Skip to content

SearchMessageTemplatesRequest

Source code in docs_src/capo_qconnect/types/search_message_templates_request.py
class SearchMessageTemplatesRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    search_expression: "capo_qconnect.types.message_template_search_expression.MessageTemplateSearchExpression"
    """<p>The search expression for querying the message template.</p>"""
    next_token: NotRequired["capo_qconnect.types.next_token.NextToken"]
    """<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"""
    max_results: NotRequired["capo_qconnect.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per page.</p>"""

knowledge_base_id instance-attribute

knowledge_base_id: UuidOrArn

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return per page.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

search_expression instance-attribute

The search expression for querying the message template.