Request Parameters Response Elements Errors See Also

DescribeCoipPools

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

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

Filter.N

One or more filters.

coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.

Type: Array of Filter objects

Required: No

MaxResults

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

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 1000.

Required: No

NextToken

The token for the next page of results.

Type: String

Required: No

PoolId.N

The IDs of the address pools.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

coipPoolSet

Information about the address pools.

Type: Array of CoipPool objects

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.