Skip to content

ListTemplatesRequest

Source code in docs_src/capo_pinpoint/types/list_templates_request.py 
11
12
13
14
15
16
17
18
19
class ListTemplatesRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>"""
    page_size: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>"""
    prefix: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.</p>"""
    template_type: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</p>"""

next_token instance-attribute 

next_token: NotRequired[__string]

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

page_size instance-attribute 

page_size: NotRequired[__string]

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

prefix instance-attribute 

prefix: NotRequired[__string]

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

template_type instance-attribute 

template_type: NotRequired[__string]

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.