Skip to content

move_byoip_cidr_to_ipam

Operation

move_byoip_cidr_to_ipam

move_byoip_cidr_to_ipam(request: MoveByoipCidrToIpamInput | MoveByoipCidrToIpamInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[MoveByoipCidrToIpamInputDict]) -> MoveByoipCidrToIpamOutput

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

Parameters:

Name Type Description Default
request MoveByoipCidrToIpamInput | MoveByoipCidrToIpamInputDict | 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[MoveByoipCidrToIpamInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
MoveByoipCidrToIpamOutput

An instance of MoveByoipCidrToIpamOutput.

move_byoip_cidr_to_ipam async

move_byoip_cidr_to_ipam(request: MoveByoipCidrToIpamInput | MoveByoipCidrToIpamInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[MoveByoipCidrToIpamInputDict]) -> MoveByoipCidrToIpamOutput

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

Parameters:

Name Type Description Default
request MoveByoipCidrToIpamInput | MoveByoipCidrToIpamInputDict | 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[MoveByoipCidrToIpamInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
MoveByoipCidrToIpamOutput

An instance of MoveByoipCidrToIpamOutput.

Input

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

MoveByoipCidrToIpamInputDict

Bases: TypedDict

Dictionary form of MoveByoipCidrToIpamInput.

Attributes

cidr instance-attribute
cidr: Required[str]

The BYOIP CIDR.

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.

ipam_pool_id instance-attribute
ipam_pool_id: Required[str]

The IPAM pool ID.

ipam_pool_owner instance-attribute
ipam_pool_owner: Required[str]

The Amazon Web Services account ID of the owner of the IPAM pool.

MoveByoipCidrToIpamInput dataclass

Bases: _SerdeShape

Dataclass for MoveByoipCidrToIpamInput structure.

Attributes

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

The BYOIP CIDR.

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.

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

The IPAM pool ID.

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

The Amazon Web Services account ID of the owner of the IPAM pool.

Output

MoveByoipCidrToIpamOutput dataclass

Bases: _SerdeShape

Dataclass for MoveByoipCidrToIpamOutput structure.

Attributes

byoip_cidr class-attribute instance-attribute
byoip_cidr: ByoipCidr | None = ...

The BYOIP CIDR.

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.