GET

/#Action=DescribeCoipPools

http://ec2.{region}.amazonaws.com/#Action=DescribeCoipPools

Describes the specified customer-owned address pools or all of your customer-owned address pools.

Access Token Required: API Key

Query Params

PoolIdarray

The IDs of the address pools.

Filterarray

One or more filters. <ul> <li> <code>coip-pool.local-gateway-route-table-id</code> - The ID of the local gateway route table. </li> <li> <code>coip-pool.pool-id</code> - The ID of the address pool. </li> </ul>

MaxResultsinteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.

NextTokenstring

The token for the next page of results.

DryRunboolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

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://ec2.{region}.amazonaws.com/#Action=DescribeCoipPools' \
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}