Skip to content

EC2  >  Operations  >  get_coip_pool_usage

get_coip_pool_usage

Operation

get_coip_pool_usage async 

get_coip_pool_usage(input: GetCoipPoolUsageInput, plugins: list[Plugin] | None = None) -> GetCoipPoolUsageOutput

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

Parameters:

Name Type Description Default
input GetCoipPoolUsageInput

An instance of GetCoipPoolUsageInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetCoipPoolUsageOutput

An instance of GetCoipPoolUsageOutput.

Input

GetCoipPoolUsageInput dataclass

Bases: _SerdeShape

Dataclass for GetCoipPoolUsageInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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 class-attribute instance-attribute 
filters: list[Filter] | None = ...

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.

max_results class-attribute instance-attribute 
max_results: int | None = ...

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 class-attribute instance-attribute 
next_token: str | None = ...

The token for the next page of results.

pool_id class-attribute instance-attribute 
pool_id: str | None = ...

The ID of the address pool.

Output

GetCoipPoolUsageOutput dataclass

Bases: _SerdeShape

Dataclass for GetCoipPoolUsageOutput structure.

Attributes

coip_address_usages class-attribute instance-attribute 
coip_address_usages: list[CoipAddressUsage] | None = ...

Information about the address usage.

coip_pool_id class-attribute instance-attribute 
coip_pool_id: str | None = ...

The ID of the customer-owned address pool.

local_gateway_route_table_id class-attribute instance-attribute 
local_gateway_route_table_id: str | None = ...

The ID of the local gateway route table.

next_token class-attribute instance-attribute 
next_token: str | None = ...

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

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.