describeVerifiedDestinationNumbers method

Future<DescribeVerifiedDestinationNumbersResult> describeVerifiedDestinationNumbers({
  1. List<String>? destinationPhoneNumbers,
  2. List<VerifiedDestinationNumberFilter>? filters,
  3. int? maxResults,
  4. String? nextToken,
  5. List<String>? verifiedDestinationNumberIds,
})

Retrieves the specified verified destination numbers.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter destinationPhoneNumbers : An array of verified destination phone number, in E.164 format.

Parameter filters : An array of VerifiedDestinationNumberFilter objects to filter the results.

Parameter maxResults : The maximum number of results to return per each request.

Parameter 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.

Parameter verifiedDestinationNumberIds : An array of VerifiedDestinationNumberid to retrieve.

Implementation

Future<DescribeVerifiedDestinationNumbersResult>
    describeVerifiedDestinationNumbers({
  List<String>? destinationPhoneNumbers,
  List<VerifiedDestinationNumberFilter>? filters,
  int? maxResults,
  String? nextToken,
  List<String>? verifiedDestinationNumberIds,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PinpointSMSVoiceV2.DescribeVerifiedDestinationNumbers'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (destinationPhoneNumbers != null)
        'DestinationPhoneNumbers': destinationPhoneNumbers,
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (verifiedDestinationNumberIds != null)
        'VerifiedDestinationNumberIds': verifiedDestinationNumberIds,
    },
  );

  return DescribeVerifiedDestinationNumbersResult.fromJson(jsonResponse.body);
}