unassign_private_nat_gateway_address¶
Operation¶
unassign_private_nat_gateway_address
¶
unassign_private_nat_gateway_address(request: UnassignPrivateNatGatewayAddressInput | UnassignPrivateNatGatewayAddressInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnassignPrivateNatGatewayAddressInputDict]) -> UnassignPrivateNatGatewayAddressOutput
Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UnassignPrivateNatGatewayAddressInput | UnassignPrivateNatGatewayAddressInputDict | 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[UnassignPrivateNatGatewayAddressInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UnassignPrivateNatGatewayAddressOutput
|
An instance of |
unassign_private_nat_gateway_address
async
¶
unassign_private_nat_gateway_address(request: UnassignPrivateNatGatewayAddressInput | UnassignPrivateNatGatewayAddressInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnassignPrivateNatGatewayAddressInputDict]) -> UnassignPrivateNatGatewayAddressOutput
Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UnassignPrivateNatGatewayAddressInput | UnassignPrivateNatGatewayAddressInputDict | 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[UnassignPrivateNatGatewayAddressInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UnassignPrivateNatGatewayAddressOutput
|
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.
UnassignPrivateNatGatewayAddressInputDict
¶
Bases: TypedDict
Dictionary form of UnassignPrivateNatGatewayAddressInput.
Attributes¶
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.
UnassignPrivateNatGatewayAddressInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UnassignPrivateNatGatewayAddressInput structure.
Attributes¶
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.
max_drain_duration_seconds
class-attribute
instance-attribute
¶
max_drain_duration_seconds: int | None = ...
The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
Output¶
UnassignPrivateNatGatewayAddressOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UnassignPrivateNatGatewayAddressOutput structure.
Attributes¶
nat_gateway_addresses
class-attribute
instance-attribute
¶
nat_gateway_addresses: list[NatGatewayAddress] | None = ...
Information about the NAT gateway IP addresses.
nat_gateway_id
class-attribute
instance-attribute
¶
nat_gateway_id: str | None = ...
The ID of the NAT gateway.
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.