AWS API Changes

2017/10/10 - Amazon Elastic Compute Cloud - 2 updated api methods

Changes This release includes updates to AWS Virtual Private Gateway.

CreateVpnGateway (updated)

Link ¶
Changes (request, response)
Request

{'AmazonSideAsn': 'long'}

Response

{'VpnGateway': {'AmazonSideAsn': 'long'}}

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_vpn_gateway(
    AvailabilityZone='string',
    Type='ipsec.1',
    AmazonSideAsn=123,
    DryRun=True|False
)

type AvailabilityZone

string

param AvailabilityZone

The Availability Zone for the virtual private gateway.

type Type

string

param Type

[REQUIRED]

The type of VPN connection this virtual private gateway supports.

type AmazonSideAsn

integer

param AmazonSideAsn

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

type DryRun

boolean

param DryRun

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 .

rtype

dict

returns

Response Syntax

{
    'VpnGateway': {
        'AvailabilityZone': 'string',
        'State': 'pending'|'available'|'deleting'|'deleted',
        'Type': 'ipsec.1',
        'VpcAttachments': [
            {
                'State': 'attaching'|'attached'|'detaching'|'detached',
                'VpcId': 'string'
            },
        ],
        'VpnGatewayId': 'string',
        'AmazonSideAsn': 123,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --

Contains the output of CreateVpnGateway.
- VpnGateway (dict) --
  
  Information about the virtual private gateway.
  - AvailabilityZone (string) --
    
    The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
  - State (string) --
    
    The current state of the virtual private gateway.
  - Type (string) --
    
    The type of VPN connection the virtual private gateway supports.
  - VpcAttachments (list) --
    
    Any VPCs attached to the virtual private gateway.
    - (dict) --
      
      Describes an attachment between a virtual private gateway and a VPC.
      - State (string) --
        
        The current state of the attachment.
      - VpcId (string) --
        
        The ID of the VPC.
  - VpnGatewayId (string) --
    
    The ID of the virtual private gateway.
  - AmazonSideAsn (integer) --
    
    The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
  - Tags (list) --
    
    Any tags assigned to the virtual private 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.

DescribeVpnGateways (updated)

Link ¶
Changes (response)

{'VpnGateways': {'AmazonSideAsn': 'long'}}

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_vpn_gateways(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    VpnGatewayIds=[
        'string',
    ],
    DryRun=True|False
)

type Filters

list

param Filters

One or more filters.

amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached ).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway ( pending | available | deleting | deleted ).
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.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1 .
vpn-gateway-id - The ID of the virtual private gateway.

(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 VpnGatewayIds