getDedicatedIps method

Future<GetDedicatedIpsResponse> getDedicatedIps({ String? nextToken, int? pageSize, String? poolName, })

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

May throw TooManyRequestsException. May throw NotFoundException. May throw BadRequestException.

Parameter nextToken : A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

Parameter pageSize : The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Parameter poolName : The name of the IP pool that the dedicated IP address is associated with.

Implementation

Future<GetDedicatedIpsResponse> getDedicatedIps({
  String? nextToken,
  int? pageSize,
  String? poolName,
}) async {
  final $query = <String, List<String>>{
    if (nextToken != null) 'NextToken': [nextToken],
    if (pageSize != null) 'PageSize': [pageSize.toString()],
    if (poolName != null) 'PoolName': [poolName],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/v1/email/dedicated-ips',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetDedicatedIpsResponse.fromJson(response);
}