Skip to content

withdraw_byoip_cidr

Operation

withdraw_byoip_cidr

withdraw_byoip_cidr(request: WithdrawByoipCidrInput | WithdrawByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[WithdrawByoipCidrInputDict]) -> WithdrawByoipCidrOutput

Stops advertising an address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.

Parameters:

Name Type Description Default
request WithdrawByoipCidrInput | WithdrawByoipCidrInputDict | 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[WithdrawByoipCidrInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
WithdrawByoipCidrOutput

An instance of WithdrawByoipCidrOutput.

withdraw_byoip_cidr async

withdraw_byoip_cidr(request: WithdrawByoipCidrInput | WithdrawByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[WithdrawByoipCidrInputDict]) -> WithdrawByoipCidrOutput

Stops advertising an address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.

Parameters:

Name Type Description Default
request WithdrawByoipCidrInput | WithdrawByoipCidrInputDict | 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[WithdrawByoipCidrInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
WithdrawByoipCidrOutput

An instance of WithdrawByoipCidrOutput.

Input

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

WithdrawByoipCidrInputDict

Bases: TypedDict

Dictionary form of WithdrawByoipCidrInput.

Attributes

cidr instance-attribute
cidr: Required[str]

The address range, in CIDR notation.

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.

WithdrawByoipCidrInput dataclass

Bases: _SerdeShape

Dataclass for WithdrawByoipCidrInput structure.

Attributes

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

The address range, in CIDR notation.

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

WithdrawByoipCidrOutput dataclass

Bases: _SerdeShape

Dataclass for WithdrawByoipCidrOutput structure.

Attributes

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

Information about the address pool.

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.