EC2 / Client / assign_private_nat_gateway_address

assign_private_nat_gateway_address#

EC2.Client.assign_private_nat_gateway_address(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.assign_private_nat_gateway_address(
    NatGatewayId='string',
    PrivateIpAddresses=[
        'string',
    ],
    PrivateIpAddressCount=123,
    DryRun=True|False
)
Parameters:

  • NatGatewayId (string) –

    [REQUIRED]

    The ID of the NAT gateway.

  • PrivateIpAddresses (list) –

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

    • (string) –

  • PrivateIpAddressCount (integer) – The number of private IP addresses to assign to the NAT gateway. You can’t specify this parameter when also specifying private IP addresses.

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NatGatewayId': 'string',
    'NatGatewayAddresses': [
        {
            'AllocationId': 'string',
            'NetworkInterfaceId': 'string',
            'PrivateIp': 'string',
            'PublicIp': 'string',
            'AssociationId': 'string',
            'IsPrimary': True|False,
            'FailureMessage': 'string',
            'Status': 'assigning'|'unassigning'|'associating'|'disassociating'|'succeeded'|'failed'
        },
    ]
}

Response Structure

  • (dict) –

    • NatGatewayId (string) –

      The ID of the NAT gateway.

    • NatGatewayAddresses (list) –

      NAT gateway IP addresses.

      • (dict) –

        Describes the IP addresses and network interface associated with a NAT gateway.

        • AllocationId (string) –

          [Public NAT gateway only] The allocation ID of the Elastic IP address that’s associated with the NAT gateway.

        • NetworkInterfaceId (string) –

          The ID of the network interface associated with the NAT gateway.

        • PrivateIp (string) –

          The private IP address associated with the NAT gateway.

        • PublicIp (string) –

          [Public NAT gateway only] The Elastic IP address associated with the NAT gateway.

        • AssociationId (string) –

          [Public NAT gateway only] The association ID of the Elastic IP address that’s associated with the NAT gateway.

        • IsPrimary (boolean) –

          Defines if the IP address is the primary address.

        • FailureMessage (string) –

          The address failure message.

        • Status (string) –

          The address status.