Skip to content

DescribePhoneNumbersRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/describe_phone_numbers_request.py
class DescribePhoneNumbersRequest(TypedDict, closed=True):
    phone_number_ids: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.phone_number_id_list.PhoneNumberIdList"
    ]
    """<p>The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.</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.phone_number_filter_list.PhoneNumberFilterList"
    ]
    """<p>An array of PhoneNumberFilter 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 phone numbers to ones your account owns or use <code>SHARED</code> to filter on phone numbers shared with your account. The <code>Owner</code> and <code>PhoneNumberIds</code> parameters can't be used at the same time.</p>"""

filters instance-attribute

filters: NotRequired[PhoneNumberFilterList]

An array of PhoneNumberFilter 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 phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.

phone_number_ids instance-attribute

phone_number_ids: NotRequired[PhoneNumberIdList]

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

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