AWS API Changes

2017/09/07 - Amazon Elastic Compute Cloud - 2 updated api methods

Changes With Tagging support, you can add Key and Value metadata to search, filter and organize your NAT Gateways according to your organization's needs.

CreateNatGateway (updated)

Link ¶
Changes (response)

{'NatGateway': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_nat_gateway(
    AllocationId='string',
    ClientToken='string',
    SubnetId='string'
)

type AllocationId

string

param AllocationId

[REQUIRED]

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

type SubnetId

string

param SubnetId

[REQUIRED]

The subnet in which to create the NAT gateway.

rtype

dict

returns

Response Syntax

{
    'ClientToken': 'string',
    'NatGateway': {
        'CreateTime': datetime(2015, 1, 1),
        'DeleteTime': datetime(2015, 1, 1),
        'FailureCode': 'string',
        'FailureMessage': 'string',
        'NatGatewayAddresses': [
            {
                'AllocationId': 'string',
                'NetworkInterfaceId': 'string',
                'PrivateIp': 'string',
                'PublicIp': 'string'
            },
        ],
        'NatGatewayId': 'string',
        'ProvisionedBandwidth': {
            'ProvisionTime': datetime(2015, 1, 1),
            'Provisioned': 'string',
            'RequestTime': datetime(2015, 1, 1),
            'Requested': 'string',
            'Status': 'string'
        },
        'State': 'pending'|'failed'|'available'|'deleting'|'deleted',
        'SubnetId': 'string',
        'VpcId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --

Contains the output of CreateNatGateway.
- ClientToken (string) --
  
  Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
- NatGateway (dict) --
  
  Information about the NAT gateway.
  - CreateTime (datetime) --
    
    The date and time the NAT gateway was created.
  - DeleteTime (datetime) --
    
    The date and time the NAT gateway was deleted, if applicable.
  - FailureCode (string) --
    
    If the NAT gateway could not be created, specifies the error code for the failure. ( InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound )
  - FailureMessage (string) --
    
    If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
    - For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
    - For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
    - For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
    - For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
    - For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
    - For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
  - NatGatewayAddresses (list) --
    
    Information about the IP addresses and network interface associated with the NAT gateway.
    - (dict) --
      
      Describes the IP addresses and network interface associated with a NAT gateway.
      - AllocationId (string) --
        
        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 Elastic IP address.
      - PublicIp (string) --
        
        The Elastic IP address associated with the NAT gateway.
  - NatGatewayId (string) --
    
    The ID of the NAT gateway.
  - ProvisionedBandwidth (dict) --
    
    Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
    - ProvisionTime (datetime) --
      
      Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
    - Provisioned (string) --
      
      Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
    - RequestTime (datetime) --
      
      Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
    - Requested (string) --
      
      Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
    - Status (string) --
      
      Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
  - State (string) --
    
    The state of the NAT gateway.
    - pending : The NAT gateway is being created and is not ready to process traffic.
    - failed : The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
    - available : The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
    - deleting : The NAT gateway is in the process of being terminated and may still be processing traffic.
    - deleted : The NAT gateway has been terminated and is no longer processing traffic.
  - SubnetId (string) --
    
    The ID of the subnet in which the NAT gateway is located.
  - VpcId (string) --
    
    The ID of the VPC in which the NAT gateway is located.
  - Tags (list) --
    
    The tags for the NAT gateway.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
      - Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

DescribeNatGateways (updated)

Link ¶
Changes (response)

{'NatGateways': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Describes one or more of the your NAT gateways.

See also: AWS API Documentation

Request Syntax

client.describe_nat_gateways(
    Filter=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NatGatewayIds=[
        'string',
    ],
    NextToken='string'
)

type Filter

list

param Filter

One or more filters.

nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway ( pending | failed | available | deleting | deleted ).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag :key =*value* - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =*value* filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC in which the NAT gateway resides.

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

type NatGatewayIds

list

param NatGatewayIds

One or more NAT gateway IDs.

(string) --

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'NatGateways': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'DeleteTime': datetime(2015, 1, 1),
            'FailureCode': 'string',
            'FailureMessage': 'string',
            'NatGatewayAddresses': [
                {
                    'AllocationId': 'string',
                    'NetworkInterfaceId': 'string',
                    'PrivateIp': 'string',
                    'PublicIp': 'string'
                },
            ],
            'NatGatewayId': 'string',
            'ProvisionedBandwidth': {
                'ProvisionTime': datetime(2015, 1, 1),
                'Provisioned': 'string',
                'RequestTime': datetime(2015, 1, 1),
                'Requested': 'string',
                'Status': 'string'
            },
            'State': 'pending'|'failed'|'available'|'deleting'|'deleted',
            'SubnetId': 'string',
            'VpcId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Contains the output of DescribeNatGateways.
- NatGateways (list) --
  
  Information about the NAT gateways.
  - (dict) --
    
    Describes a NAT gateway.
    - CreateTime (datetime) --
      
      The date and time the NAT gateway was created.
    - DeleteTime (datetime) --
      
      The date and time the NAT gateway was deleted, if applicable.
    - FailureCode (string) --
      
      If the NAT gateway could not be created, specifies the error code for the failure. ( InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound )
    - FailureMessage (string) --
      
      If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
      - For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
      - For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
      - For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
      - For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
      - For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
      - For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
    - NatGatewayAddresses (list) --
      
      Information about the IP addresses and network interface associated with the NAT gateway.
      - (dict) --
        
        Describes the IP addresses and network interface associated with a NAT gateway.
        
        AllocationId (string) --
        
        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 Elastic IP address.
        
        PublicIp (string) --
        
        The Elastic IP address associated with the NAT gateway.
    - NatGatewayId (string) --
      
      The ID of the NAT gateway.
    - ProvisionedBandwidth (dict) --
      
      Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
      - ProvisionTime (datetime) --
        
        Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
      - Provisioned (string) --
        
        Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
      - RequestTime (datetime) --
        
        Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
      - Requested (string) --
        
        Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
      - Status (string) --
        
        Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
    - State (string) --
      
      The state of the NAT gateway.
      - pending : The NAT gateway is being created and is not ready to process traffic.
      - failed : The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
      - available : The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
      - deleting : The NAT gateway is in the process of being terminated and may still be processing traffic.
      - deleted : The NAT gateway has been terminated and is no longer processing traffic.
    - SubnetId (string) --
      
      The ID of the subnet in which the NAT gateway is located.
    - VpcId (string) --
      
      The ID of the VPC in which the NAT gateway is located.
    - Tags (list) --
      
      The tags for the NAT gateway.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
        
        Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.