Skip to content

describe_ipam_policies

Operation

describe_ipam_policies

describe_ipam_policies(request: DescribeIpamPoliciesInput | DescribeIpamPoliciesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamPoliciesInputDict]) -> DescribeIpamPoliciesOutput

Describes one or more IPAM policies.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

Parameters:

Name Type Description Default
request DescribeIpamPoliciesInput | DescribeIpamPoliciesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeIpamPoliciesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamPoliciesOutput

An instance of DescribeIpamPoliciesOutput.

describe_ipam_policies async

describe_ipam_policies(request: DescribeIpamPoliciesInput | DescribeIpamPoliciesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamPoliciesInputDict]) -> DescribeIpamPoliciesOutput

Describes one or more IPAM policies.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

Parameters:

Name Type Description Default
request DescribeIpamPoliciesInput | DescribeIpamPoliciesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeIpamPoliciesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamPoliciesOutput

An instance of DescribeIpamPoliciesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeIpamPoliciesInputDict

Bases: TypedDict

Dictionary form of DescribeIpamPoliciesInput.

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 IPAM policy description.

ipam_policy_ids instance-attribute
ipam_policy_ids: Sequence[str] | None

The IDs of the IPAM policies to describe.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in a single call.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

DescribeIpamPoliciesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamPoliciesInput 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
filters: list[Filter] | None = ...

One or more filters for the IPAM policy description.

ipam_policy_ids class-attribute instance-attribute
ipam_policy_ids: list[str] | None = ...

The IDs of the IPAM policies to describe.

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

The maximum number of results to return in a single call.

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

The token for the next page of results.

Output

DescribeIpamPoliciesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamPoliciesOutput structure.

Attributes

ipam_policies class-attribute instance-attribute
ipam_policies: list[IpamPolicy] | None = ...

Information about the IPAM policies.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

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.