Skip to content

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

Description

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

Usage

ec2_describe_coip_pools(PoolIds, Filters, MaxResults, NextToken, DryRun)

Arguments

  • PoolIds

    The IDs of the address pools.

  • Filters

    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

    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

    The token for the next page of results.

  • 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.

Value

A list with the following syntax:

list(
  CoipPools = list(
    list(
      PoolId = "string",
      PoolCidrs = list(
        "string"
      ),
      LocalGatewayRouteTableId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      PoolArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_coip_pools(
  PoolIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)