describe_ipams¶
Operation¶
describe_ipams
async
¶
describe_ipams(request: DescribeIpamsInput | DescribeIpamsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeIpamsOutput
describe_ipams(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamsInputDict]) -> DescribeIpamsOutput
Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
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 |
|---|---|
DescribeIpamsOutput
|
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¶
DescribeIpamsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeIpamsInput 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_ids
class-attribute
instance-attribute
¶
The IDs of the IPAMs you want information on.
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¶
DescribeIpamsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeIpamsInput.
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_ids
instance-attribute
¶
The IDs of the IPAMs you want information on.
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¶
DescribeIpamsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeIpamsOutput structure.
Attributes¶
ipams
class-attribute
instance-attribute
¶
Information about the IPAMs.
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.