get_ipam_pool_allocations¶
Operation¶
get_ipam_pool_allocations
async
¶
get_ipam_pool_allocations(request: GetIpamPoolAllocationsInput | GetIpamPoolAllocationsInputDict, /, *, plugins: list[Plugin] | None = None) -> GetIpamPoolAllocationsOutput
get_ipam_pool_allocations(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPoolAllocationsInputDict]) -> GetIpamPoolAllocationsOutput
Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
Note
If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
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 |
|---|---|
GetIpamPoolAllocationsOutput
|
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¶
GetIpamPoolAllocationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamPoolAllocationsInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
A check for 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 for the request. For more information about filtering, see Filtering CLI output.
ipam_pool_allocation_id
class-attribute
instance-attribute
¶
ipam_pool_allocation_id: str | None = ...
The ID of the allocation.
ipam_pool_id
class-attribute
instance-attribute
¶
ipam_pool_id: str | None = ...
The ID of the IPAM pool you want to see the allocations for.
Dictionaries¶
GetIpamPoolAllocationsInputDict
¶
Bases: TypedDict
Dictionary form of GetIpamPoolAllocationsInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
A check for 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 for the request. For more information about filtering, see Filtering CLI output.
ipam_pool_allocation_id
instance-attribute
¶
ipam_pool_allocation_id: str | None
The ID of the allocation.
ipam_pool_id
instance-attribute
¶
The ID of the IPAM pool you want to see the allocations for.
Output¶
GetIpamPoolAllocationsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamPoolAllocationsOutput structure.
Attributes¶
ipam_pool_allocations
class-attribute
instance-attribute
¶
ipam_pool_allocations: list[IpamPoolAllocation] | None = ...
The IPAM pool allocations you want information on.
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.