Skip to content

Describes the allocations from the specified customer-owned address pool

Description

Describes the allocations from the specified customer-owned address pool.

Usage

ec2_get_coip_pool_usage(PoolId, Filters, MaxResults, NextToken, DryRun)

Arguments

  • PoolId

    [required] The ID of the address pool.

  • Filters

    One or more filters.

    • coip-address-usage.allocation-id - The allocation ID of the address.
    • coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
    • coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
    • coip-address-usage.co-ip - The customer-owned IP address.
  • 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(
  CoipPoolId = "string",
  CoipAddressUsages = list(
    list(
      AllocationId = "string",
      AwsAccountId = "string",
      AwsService = "string",
      CoIp = "string"
    )
  ),
  LocalGatewayRouteTableId = "string",
  NextToken = "string"
)

Request syntax

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