Skip to content

deprovision_byoip_cidr

Operation

deprovision_byoip_cidr

deprovision_byoip_cidr(request: DeprovisionByoipCidrInput | DeprovisionByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeprovisionByoipCidrInputDict]) -> DeprovisionByoipCidrOutput

Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it and you must not have any IP addresses allocated from its address range.

Parameters:

Name Type Description Default
request DeprovisionByoipCidrInput | DeprovisionByoipCidrInputDict | 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[DeprovisionByoipCidrInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeprovisionByoipCidrOutput

An instance of DeprovisionByoipCidrOutput.

deprovision_byoip_cidr async

deprovision_byoip_cidr(request: DeprovisionByoipCidrInput | DeprovisionByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeprovisionByoipCidrInputDict]) -> DeprovisionByoipCidrOutput

Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it and you must not have any IP addresses allocated from its address range.

Parameters:

Name Type Description Default
request DeprovisionByoipCidrInput | DeprovisionByoipCidrInputDict | 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[DeprovisionByoipCidrInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeprovisionByoipCidrOutput

An instance of DeprovisionByoipCidrOutput.

Input

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

DeprovisionByoipCidrInputDict

Bases: TypedDict

Dictionary form of DeprovisionByoipCidrInput.

Attributes

cidr instance-attribute
cidr: Required[str]

The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

dry_run instance-attribute
dry_run: bool | None

Checks 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.

DeprovisionByoipCidrInput dataclass

Bases: _SerdeShape

Dataclass for DeprovisionByoipCidrInput structure.

Attributes

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

The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks 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.

Output

DeprovisionByoipCidrOutput dataclass

Bases: _SerdeShape

Dataclass for DeprovisionByoipCidrOutput structure.

Attributes

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

Information about the address range.

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.