listPoolOriginationIdentities method

Future<ListPoolOriginationIdentitiesResult> listPoolOriginationIdentities({
  1. required String poolId,
  2. List<PoolOriginationIdentitiesFilter>? filters,
  3. int? maxResults,
  4. String? nextToken,
})

Lists all associated origination identities in your pool.

If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

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

Parameter poolId : The unique identifier for the pool. This value can be either the PoolId or PoolArn.

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

Implementation

Future<ListPoolOriginationIdentitiesResult> listPoolOriginationIdentities({
  required String poolId,
  List<PoolOriginationIdentitiesFilter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PinpointSMSVoiceV2.ListPoolOriginationIdentities'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'PoolId': poolId,
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return ListPoolOriginationIdentitiesResult.fromJson(jsonResponse.body);
}