Skip to content

DescribeOptedOutNumbersResult

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/describe_opted_out_numbers_result.py
class DescribeOptedOutNumbersResult(TypedDict, closed=True):
    opt_out_list_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the OptOutList.</p>"""
    opt_out_list_name: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.opt_out_list_name.OptOutListName"
    ]
    """<p>The name of the OptOutList.</p>"""
    opted_out_numbers: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.opted_out_number_information_list.OptedOutNumberInformationList"
    ]
    """<p>An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.</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. If this field is empty then there are no more results.</p>"""

next_token instance-attribute

next_token: NotRequired[NextToken]

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

opt_out_list_arn instance-attribute

opt_out_list_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the OptOutList.

opt_out_list_name instance-attribute

opt_out_list_name: NotRequired[OptOutListName]

The name of the OptOutList.

opted_out_numbers instance-attribute

opted_out_numbers: NotRequired[OptedOutNumberInformationList]

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.