Skip to content

DescribeSenderIdsRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/describe_sender_ids_request.py
class DescribeSenderIdsRequest(TypedDict, closed=True):
    sender_ids: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.sender_id_list.SenderIdList"
    ]
    """<p>An array of SenderIdAndCountry objects to search for.</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>"""
    filters: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.sender_id_filter_list.SenderIdFilterList"
    ]
    """<p>An array of SenderIdFilter objects 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>"""
    owner: NotRequired["capo_pinpoint_sms_voice_v2.types.owner.Owner"]
    """<p>Use <code>SELF</code> to filter the list of Sender Ids to ones your account owns or use <code>SHARED</code> to filter on Sender Ids shared with your account. The <code>Owner</code> and <code>SenderIds</code> parameters can't be used at the same time. </p>"""

filters instance-attribute

filters: NotRequired[SenderIdFilterList]

An array of SenderIdFilter objects to filter the results.

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.

owner instance-attribute

owner: NotRequired[Owner]

Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

sender_ids instance-attribute

sender_ids: NotRequired[SenderIdList]

An array of SenderIdAndCountry objects to search for.

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