describe_ipam_pool_allocations¶
Operation¶
describe_ipam_pool_allocations
async
¶
describe_ipam_pool_allocations(request: DescribeIpamPoolAllocationsInput | DescribeIpamPoolAllocationsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeIpamPoolAllocationsOutput
describe_ipam_pool_allocations(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamPoolAllocationsInputDict]) -> DescribeIpamPoolAllocationsOutput
Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID.
If you specify IpamPoolAllocationIds, the results include only the
specified allocations. If you do not specify IpamPoolAllocationIds,
the results include all allocations owned by you. You can use Filters
to narrow the results.
Note
This action returns only allocations directly owned by you. To view all allocations in a pool you own or that has been shared with you, including allocations owned by other accounts, use GetIpamPoolAllocations.
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 |
|---|---|
DescribeIpamPoolAllocationsOutput
|
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¶
DescribeIpamPoolAllocationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeIpamPoolAllocationsInput 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_ids
class-attribute
instance-attribute
¶
The IDs of the IPAM pool allocations you want to describe.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Dictionaries¶
DescribeIpamPoolAllocationsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeIpamPoolAllocationsInput.
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_ids
instance-attribute
¶
The IDs of the IPAM pool allocations you want to describe.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Output¶
DescribeIpamPoolAllocationsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeIpamPoolAllocationsOutput structure.
Attributes¶
ipam_pool_allocations
class-attribute
instance-attribute
¶
ipam_pool_allocations: list[IpamPoolAllocation] | None = ...
Information about the IPAM pool allocations.
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.