describeSenderIds method

Future<DescribeSenderIdsResult> describeSenderIds({
  1. List<SenderIdFilter>? filters,
  2. int? maxResults,
  3. String? nextToken,
  4. Owner? owner,
  5. List<SenderIdAndCountry>? senderIds,
})

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn't valid, an error is returned.

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

Parameter filters : An array of SenderIdFilter 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 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.

Parameter senderIds : An array of SenderIdAndCountry objects to search for.

Implementation

Future<DescribeSenderIdsResult> describeSenderIds({
  List<SenderIdFilter>? filters,
  int? maxResults,
  String? nextToken,
  Owner? owner,
  List<SenderIdAndCountry>? senderIds,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PinpointSMSVoiceV2.DescribeSenderIds'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (owner != null) 'Owner': owner.value,
      if (senderIds != null) 'SenderIds': senderIds,
    },
  );

  return DescribeSenderIdsResult.fromJson(jsonResponse.body);
}