describe_coip_pools¶
Operation¶
describe_coip_pools
async
¶
describe_coip_pools(request: DescribeCoipPoolsInput | DescribeCoipPoolsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCoipPoolsOutput
describe_coip_pools(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCoipPoolsInputDict]) -> DescribeCoipPoolsOutput
Describes the specified customer-owned address pools or all of your customer-owned address pools.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
DescribeCoipPoolsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeCoipPoolsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCoipPoolsInput 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
¶
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.
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.
Dictionaries¶
DescribeCoipPoolsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeCoipPoolsInput.
Attributes¶
dry_run
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
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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.
Output¶
DescribeCoipPoolsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCoipPoolsOutput structure.
Attributes¶
coip_pools
class-attribute
instance-attribute
¶
Information about the address pools.
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
¶
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.