Skip to content

DescribeKeywordsRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/describe_keywords_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DescribeKeywordsRequest(TypedDict, closed=True):
    origination_identity: (
        "capo_pinpoint_sms_voice_v2.types.phone_or_pool_id_or_arn.PhoneOrPoolIdOrArn"
    )
    """<p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <a>DescribePhoneNumbers</a> to find the values for PhoneNumberId and PhoneNumberArn while <a>DescribeSenderIds</a> can be used to get the values for SenderId and SenderIdArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>"""
    keywords: NotRequired["capo_pinpoint_sms_voice_v2.types.keyword_list.KeywordList"]
    """<p>An array of keywords to search for.</p>"""
    filters: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.keyword_filter_list.KeywordFilterList"
    ]
    """<p>An array of keyword filters to filter the results.</p>"""
    next_token: NotRequired["capo_pinpoint_sms_voice_v2.types.next_token.NextToken"]
    """<p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>"""
    max_results: NotRequired["capo_pinpoint_sms_voice_v2.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per each request.</p>"""

filters instance-attribute 

filters: NotRequired[KeywordFilterList]

An array of keyword filters to filter the results.

keywords instance-attribute 

keywords: NotRequired[KeywordList]

An array of keywords to search for.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per each request.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

origination_identity instance-attribute 

origination_identity: PhoneOrPoolIdOrArn

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).