EC2 / Client / get_coip_pool_usage

get_coip_pool_usage

EC2.Client.get_coip_pool_usage(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_coip_pool_usage(
    PoolId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• PoolId (string) –

  [REQUIRED]

  The ID of the address pool.

• Filters (list) –

  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.

  • (dict) –

    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.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

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

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

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

• NextToken (string) – The token for the next page of results.

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

Return type:

dict

Returns:

Response Syntax

{
    'CoipPoolId': 'string',
    'CoipAddressUsages': [
        {
            'AllocationId': 'string',
            'AwsAccountId': 'string',
            'AwsService': 'string',
            'CoIp': 'string'
        },
    ],
    'LocalGatewayRouteTableId': 'string',
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • CoipPoolId (string) –

    The ID of the customer-owned address pool.

  • CoipAddressUsages (list) –

    Information about the address usage.

    • (dict) –

      Describes address usage for a customer-owned address pool.

      • AllocationId (string) –

        The allocation ID of the address.

      • AwsAccountId (string) –

        The Amazon Web Services account ID.

      • AwsService (string) –

        The Amazon Web Services service.

      • CoIp (string) –

        The customer-owned IP address.

  • LocalGatewayRouteTableId (string) –

    The ID of the local gateway route table.

  • NextToken (string) –

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