get_ipam_policy_organization_targets¶
Operation¶
get_ipam_policy_organization_targets
¶
get_ipam_policy_organization_targets(request: GetIpamPolicyOrganizationTargetsInput | GetIpamPolicyOrganizationTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPolicyOrganizationTargetsInputDict]) -> GetIpamPolicyOrganizationTargetsOutput
Gets the Amazon Web Services Organizations targets for an IPAM policy.
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.
A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIpamPolicyOrganizationTargetsInput | GetIpamPolicyOrganizationTargetsInputDict | 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[GetIpamPolicyOrganizationTargetsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIpamPolicyOrganizationTargetsOutput
|
An instance of |
get_ipam_policy_organization_targets
async
¶
get_ipam_policy_organization_targets(request: GetIpamPolicyOrganizationTargetsInput | GetIpamPolicyOrganizationTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPolicyOrganizationTargetsInputDict]) -> GetIpamPolicyOrganizationTargetsOutput
Gets the Amazon Web Services Organizations targets for an IPAM policy.
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.
A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIpamPolicyOrganizationTargetsInput | GetIpamPolicyOrganizationTargetsInputDict | 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[GetIpamPolicyOrganizationTargetsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIpamPolicyOrganizationTargetsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetIpamPolicyOrganizationTargetsInputDict
¶
Bases: TypedDict
Dictionary form of GetIpamPolicyOrganizationTargetsInput.
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 Amazon Web Services Organizations targets.
ipam_policy_id
instance-attribute
¶
The ID of the IPAM policy for which to get Amazon Web Services Organizations targets.
GetIpamPolicyOrganizationTargetsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamPolicyOrganizationTargetsInput 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 Amazon Web Services Organizations targets.
ipam_policy_id
class-attribute
instance-attribute
¶
ipam_policy_id: str | None = ...
The ID of the IPAM policy for which to get Amazon Web Services Organizations targets.
Output¶
GetIpamPolicyOrganizationTargetsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamPolicyOrganizationTargetsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results.
organization_targets
class-attribute
instance-attribute
¶
organization_targets: list[IpamPolicyOrganizationTarget] | None = ...
The IDs of the Amazon Web Services Organizations targets.
A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.
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.