Skip to content

assign_private_nat_gateway_address

Operation

assign_private_nat_gateway_address

assign_private_nat_gateway_address(request: AssignPrivateNatGatewayAddressInput | AssignPrivateNatGatewayAddressInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssignPrivateNatGatewayAddressInputDict]) -> AssignPrivateNatGatewayAddressOutput

Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.

Parameters:

Name Type Description Default
request AssignPrivateNatGatewayAddressInput | AssignPrivateNatGatewayAddressInputDict | 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[AssignPrivateNatGatewayAddressInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssignPrivateNatGatewayAddressOutput

An instance of AssignPrivateNatGatewayAddressOutput.

assign_private_nat_gateway_address async

assign_private_nat_gateway_address(request: AssignPrivateNatGatewayAddressInput | AssignPrivateNatGatewayAddressInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssignPrivateNatGatewayAddressInputDict]) -> AssignPrivateNatGatewayAddressOutput

Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.

Parameters:

Name Type Description Default
request AssignPrivateNatGatewayAddressInput | AssignPrivateNatGatewayAddressInputDict | 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[AssignPrivateNatGatewayAddressInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssignPrivateNatGatewayAddressOutput

An instance of AssignPrivateNatGatewayAddressOutput.

Input

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

AssignPrivateNatGatewayAddressInputDict

Bases: TypedDict

Dictionary form of AssignPrivateNatGatewayAddressInput.

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.

nat_gateway_id instance-attribute
nat_gateway_id: Required[str]

The ID of the NAT gateway.

private_ip_address_count instance-attribute
private_ip_address_count: int | None

The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses.

private_ip_addresses instance-attribute
private_ip_addresses: Sequence[str] | None

The private IPv4 addresses you want to assign to the private NAT gateway.

AssignPrivateNatGatewayAddressInput dataclass

Bases: _SerdeShape

Dataclass for AssignPrivateNatGatewayAddressInput 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.

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

The ID of the NAT gateway.

private_ip_address_count class-attribute instance-attribute
private_ip_address_count: int | None = ...

The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses.

private_ip_addresses class-attribute instance-attribute
private_ip_addresses: list[str] | None = ...

The private IPv4 addresses you want to assign to the private NAT gateway.

Output

AssignPrivateNatGatewayAddressOutput dataclass

Bases: _SerdeShape

Dataclass for AssignPrivateNatGatewayAddressOutput structure.

Attributes

nat_gateway_addresses class-attribute instance-attribute
nat_gateway_addresses: list[NatGatewayAddress] | None = ...

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