PinpointSMSVoiceV2 / Client / describe_verified_destination_numbers
describe_verified_destination_numbers#
- PinpointSMSVoiceV2.Client.describe_verified_destination_numbers(**kwargs)#
Retrieves the specified verified destiona numbers.
See also: AWS API Documentation
Request Syntax
response = client.describe_verified_destination_numbers( VerifiedDestinationNumberIds=[ 'string', ], DestinationPhoneNumbers=[ 'string', ], Filters=[ { 'Name': 'status', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 )
- Parameters:
VerifiedDestinationNumberIds (list) –
An array of VerifiedDestinationNumberid to retreive.
(string) –
DestinationPhoneNumbers (list) –
An array of verified destination phone number, in E.164 format.
(string) –
Filters (list) –
An array of VerifiedDestinationNumberFilter objects to filter the results.
(dict) –
The filter definition for filtering verified destination phone numbers that meets a specified criteria.
Name (string) – [REQUIRED]
The name of the attribute to filter on.
Values (list) – [REQUIRED]
An array of values to filter on.
(string) –
NextToken (string) – 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.
MaxResults (integer) – The maximum number of results to return per each request.
- Return type:
dict
- Returns:
Response Syntax
{ 'VerifiedDestinationNumbers': [ { 'VerifiedDestinationNumberArn': 'string', 'VerifiedDestinationNumberId': 'string', 'DestinationPhoneNumber': 'string', 'Status': 'PENDING'|'VERIFIED', 'CreatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
VerifiedDestinationNumbers (list) –
An array of VerifiedDestinationNumberInformation objects
(dict) –
Provides information about the requested verified destintion phone number.
VerifiedDestinationNumberArn (string) –
The Amazon Resource Name (ARN) for the verified destination phone number.
VerifiedDestinationNumberId (string) –
The unique identifier for the verified destination phone number.
DestinationPhoneNumber (string) –
The verified destination phone number, in E.164 format.
Status (string) –
The status of the verified destination phone number.
PENDING
: The phone number hasn’t been verified yet.VERIFIED
: The phone number is verified and can receive messages.
CreatedTimestamp (datetime) –
The time when the destination phone number was created, in UNIX epoch time format.
NextToken (string) –
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.
Exceptions