GET

/v1/email/dedicated-ips

http://email.{region}.amazonaws.com/v1/email/dedicated-ips

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

Access Token Required: API Key

Query Params

PoolNamestring

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

NextTokenstring

A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the position of the dedicated IP pool in the list of IP pools.

PageSizeinteger

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://email.{region}.amazonaws.com/v1/email/dedicated-ips' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET