DescribeCoipPoolsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeCoipPoolsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeCoipPoolsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeCoipPoolsRequest
  PoolIds: [ // CoipPoolIdSet
    "STRING_VALUE",
  ],
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  DryRun: true || false,
};
const command = new DescribeCoipPoolsCommand(input);
const response = await client.send(command);
// { // DescribeCoipPoolsResult
//   CoipPools: [ // CoipPoolSet
//     { // CoipPool
//       PoolId: "STRING_VALUE",
//       PoolCidrs: [ // ValueStringList
//         "STRING_VALUE",
//       ],
//       LocalGatewayRouteTableId: "STRING_VALUE",
//       Tags: [ // TagList
//         { // Tag
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       PoolArn: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeCoipPoolsCommand Input

See DescribeCoipPoolsCommandInput for more details

Parameter
Type
Description
DryRun
boolean | undefined

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.

Filters
Filter[] | undefined

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.

MaxResults
number | undefined

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

NextToken
string | undefined

The token for the next page of results.

PoolIds
string[] | undefined

The IDs of the address pools.

DescribeCoipPoolsCommand Output

See DescribeCoipPoolsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CoipPools
CoipPool[] | undefined

Information about the address pools.

NextToken
string | undefined

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

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.