DescribeOptedOutNumbersRequest ¶

class DescribeOptedOutNumbersRequest(TypedDict, closed=True):
    opt_out_list_name: (
        "capo_pinpoint_sms_voice_v2.types.opt_out_list_name_or_arn.OptOutListNameOrArn"
    )
    """<p>The OptOutListName or OptOutListArn of the OptOutList. You can use <a>DescribeOptOutLists</a> to find the values for OptOutListName and OptOutListArn.</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>"""
    opted_out_numbers: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.opted_out_number_list.OptedOutNumberList"
    ]
    """<p>An array of phone numbers to search for in the OptOutList.</p> <p>If you specify an opted out number that isn't valid, an exception is returned.</p>"""
    filters: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.opted_out_filter_list.OptedOutFilterList"
    ]
    """<p>An array of OptedOutFilter objects to filter the results on.</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>"""