get-coip-pool-usage¶

Description¶

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

Synopsis¶

  get-coip-pool-usage
--pool-id <value>
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--pool-id (string)

The ID of the address pool.

--filters (list)

The filters. The following are the possible values:

coip-address-usage.allocation-id

coip-address-usage.aws-account-id

coip-address-usage.aws-service

coip-address-usage.co-ip

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--max-results (integer)

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

--next-token (string)

The token for the next page of results.

--dry-run | --no-dry-run (boolean)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get customer-owned IP address pool usage

The following get-coip-pool-usage example gets the usage details for the specified customer-owned IP address pool.

aws ec2 get-coip-pool-usage \
    --pool-id ipv4pool-coip-123a45678bEXAMPLE

Output:

{
    "CoipPoolId": "ipv4pool-coip-123a45678bEXAMPLE",
    "CoipAddressUsages": [
        {
            "CoIp": "0.0.0.0"
        },
        {
            "AllocationId": "eipalloc-123ab45c6dEXAMPLE",
            "AwsAccountId": "123456789012",
            "CoIp": "0.0.0.0"
        },
        {
            "AllocationId": "eipalloc-123ab45c6dEXAMPLE",
            "AwsAccountId": "123456789111",
            "CoIp": "0.0.0.0"
        }
    ],
    "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE"
}

For more information, see Customer-owned IP addresses in the AWS Outposts User Guide.

Output¶

CoipPoolId -> (string)

The ID of the customer-owned address pool.

CoipAddressUsages -> (list)

Information about the address usage.

(structure)

Describes address usage for a customer-owned address pool.

AllocationId -> (string)

The allocation ID of the address.

AwsAccountId -> (string)

The AWS account ID.

AwsService -> (string)

The AWS service.

CoIp -> (string)

The customer-owned IP address.

LocalGatewayRouteTableId -> (string)

The ID of the local gateway route table.

Table of Contents

Feedback

User Guide