AWS API Changes

2023/10/23 - AWS Network Manager - 6 updated api methods

Changes This release adds API support for Tunnel-less Connect (NoEncap Protocol) for AWS Cloud WAN

CreateConnectAttachment (updated)

Link ¶
Changes (request, response)
Request

{'Options': {'Protocol': {'NO_ENCAP'}}}

Response

{'ConnectAttachment': {'Options': {'Protocol': {'NO_ENCAP'}}}}

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

See also: AWS API Documentation

Request Syntax

client.create_connect_attachment(
    CoreNetworkId='string',
    EdgeLocation='string',
    TransportAttachmentId='string',
    Options={
        'Protocol': 'GRE'|'NO_ENCAP'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

type CoreNetworkId

string

param CoreNetworkId

[REQUIRED]

The ID of a core network where you want to create the attachment.

type EdgeLocation

string

param EdgeLocation

[REQUIRED]

The Region where the edge is located.

type TransportAttachmentId

string

param TransportAttachmentId

[REQUIRED]

The ID of the attachment between the two connections.

type Options

dict

param Options

[REQUIRED]

Options for creating an attachment.

Protocol (string) --

The protocol used for the attachment connection.

type Tags

list

param Tags

The list of key-value tags associated with the request.

(dict) --

Describes a tag.
- Key (string) --
  
  The tag key.
  
  Constraints: Maximum length of 128 characters.
- Value (string) --
  
  The tag value.
  
  Constraints: Maximum length of 256 characters.

type ClientToken

string

param ClientToken

The client token associated with the request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'ConnectAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'TransportAttachmentId': 'string',
        'Options': {
            'Protocol': 'GRE'|'NO_ENCAP'
        }
    }
}

Response Structure

(dict) --
- ConnectAttachment (dict) --
  
  The response to a Connect attachment request.
  - Attachment (dict) --
    
    The attachment details.
    - CoreNetworkId (string) --
      
      The ID of a core network.
    - CoreNetworkArn (string) --
      
      The ARN of a core network.
    - AttachmentId (string) --
      
      The ID of the attachment.
    - OwnerAccountId (string) --
      
      The ID of the attachment account owner.
    - AttachmentType (string) --
      
      The type of attachment.
    - State (string) --
      
      The state of the attachment.
    - EdgeLocation (string) --
      
      The Region where the edge is located.
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - Tags (list) --
      
      The tags associated with the attachment.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
    - ProposedSegmentChange (dict) --
      
      The attachment to move from one segment to another.
      - Tags (list) --
        
        The list of key-value tags that changed for the segment.
        
        (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
      - AttachmentPolicyRuleNumber (integer) --
        
        The rule number in the policy document that applies to this change.
      - SegmentName (string) --
        
        The name of the segment to change.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
  - TransportAttachmentId (string) --
    
    The ID of the transport attachment.
  - Options (dict) --
    
    Options for connecting an attachment.
    - Protocol (string) --
      
      The protocol used for the attachment connection.

CreateConnectPeer (updated)

Link ¶
Changes (request, response)
Request

{'SubnetArn': 'string'}

Response

{'ConnectPeer': {'Configuration': {'Protocol': {'NO_ENCAP'}},
                 'SubnetArn': 'string'}}

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

See also: AWS API Documentation

Request Syntax

client.create_connect_peer(
    ConnectAttachmentId='string',
    CoreNetworkAddress='string',
    PeerAddress='string',
    BgpOptions={
        'PeerAsn': 123
    },
    InsideCidrBlocks=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string',
    SubnetArn='string'
)

type ConnectAttachmentId

string

param ConnectAttachmentId

[REQUIRED]

The ID of the connection attachment.

type CoreNetworkAddress

string

param CoreNetworkAddress

A Connect peer core network address.

type PeerAddress

string

param PeerAddress

[REQUIRED]

The Connect peer address.

type BgpOptions

dict

param BgpOptions

The Connect peer BGP options.

PeerAsn (integer) --

The Peer ASN of the BGP.

type InsideCidrBlocks

list

param InsideCidrBlocks

The inside IP addresses used for BGP peering.

(string) --

type Tags

list

param Tags

The tags associated with the peer request.

(dict) --

Describes a tag.
- Key (string) --
  
  The tag key.
  
  Constraints: Maximum length of 128 characters.
- Value (string) --
  
  The tag value.
  
  Constraints: Maximum length of 256 characters.

type ClientToken

string

param ClientToken

The client token associated with the request.

This field is autopopulated if not provided.

type SubnetArn

string

param SubnetArn

The subnet ARN for the Connect peer.

rtype

dict

returns

Response Syntax

{
    'ConnectPeer': {
        'CoreNetworkId': 'string',
        'ConnectAttachmentId': 'string',
        'ConnectPeerId': 'string',
        'EdgeLocation': 'string',
        'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
        'CreatedAt': datetime(2015, 1, 1),
        'Configuration': {
            'CoreNetworkAddress': 'string',
            'PeerAddress': 'string',
            'InsideCidrBlocks': [
                'string',
            ],
            'Protocol': 'GRE'|'NO_ENCAP',
            'BgpConfigurations': [
                {
                    'CoreNetworkAsn': 123,
                    'PeerAsn': 123,
                    'CoreNetworkAddress': 'string',
                    'PeerAddress': 'string'
                },
            ]
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string'
    }
}

Response Structure

(dict) --
- ConnectPeer (dict) --
  
  The response to the request.
  - CoreNetworkId (string) --
    
    The ID of a core network.
  - ConnectAttachmentId (string) --
    
    The ID of the attachment to connect.
  - ConnectPeerId (string) --
    
    The ID of the Connect peer.
  - EdgeLocation (string) --
    
    The Connect peer Regions where edges are located.
  - State (string) --
    
    The state of the Connect peer.
  - CreatedAt (datetime) --
    
    The timestamp when the Connect peer was created.
  - Configuration (dict) --
    
    The configuration of the Connect peer.
    - CoreNetworkAddress (string) --
      
      The IP address of a core network.
    - PeerAddress (string) --
      
      The IP address of the Connect peer.
    - InsideCidrBlocks (list) --
      
      The inside IP addresses used for a Connect peer configuration.
      - (string) --
    - Protocol (string) --
      
      The protocol used for a Connect peer configuration.
    - BgpConfigurations (list) --
      
      The Connect peer BGP configurations.
      - (dict) --
        
        Describes a core network BGP configuration.
        
        CoreNetworkAsn (integer) --
        
        The ASN of the Coret Network.
        
        PeerAsn (integer) --
        
        The ASN of the Connect peer.
        
        CoreNetworkAddress (string) --
        
        The address of a core network.
        
        PeerAddress (string) --
        
        The address of a core network Connect peer.
  - Tags (list) --
    
    The list of key-value tags associated with the Connect peer.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
      - Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
  - SubnetArn (string) --
    
    The subnet ARN for the Connect peer.

DeleteConnectPeer (updated)

Link ¶
Changes (response)

{'ConnectPeer': {'Configuration': {'Protocol': {'NO_ENCAP'}},
                 'SubnetArn': 'string'}}

Deletes a Connect peer.

See also: AWS API Documentation

Request Syntax

client.delete_connect_peer(
    ConnectPeerId='string'
)

type ConnectPeerId

string

param ConnectPeerId

[REQUIRED]

The ID of the deleted Connect peer.

rtype

dict

returns

Response Syntax

{
    'ConnectPeer': {
        'CoreNetworkId': 'string',
        'ConnectAttachmentId': 'string',
        'ConnectPeerId': 'string',
        'EdgeLocation': 'string',
        'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
        'CreatedAt': datetime(2015, 1, 1),
        'Configuration': {
            'CoreNetworkAddress': 'string',
            'PeerAddress': 'string',
            'InsideCidrBlocks': [
                'string',
            ],
            'Protocol': 'GRE'|'NO_ENCAP',
            'BgpConfigurations': [
                {
                    'CoreNetworkAsn': 123,
                    'PeerAsn': 123,
                    'CoreNetworkAddress': 'string',
                    'PeerAddress': 'string'
                },
            ]
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string'
    }
}

Response Structure

(dict) --
- ConnectPeer (dict) --
  
  Information about the deleted Connect peer.
  - CoreNetworkId (string) --
    
    The ID of a core network.
  - ConnectAttachmentId (string) --
    
    The ID of the attachment to connect.
  - ConnectPeerId (string) --
    
    The ID of the Connect peer.
  - EdgeLocation (string) --
    
    The Connect peer Regions where edges are located.
  - State (string) --
    
    The state of the Connect peer.
  - CreatedAt (datetime) --
    
    The timestamp when the Connect peer was created.
  - Configuration (dict) --
    
    The configuration of the Connect peer.
    - CoreNetworkAddress (string) --
      
      The IP address of a core network.
    - PeerAddress (string) --
      
      The IP address of the Connect peer.
    - InsideCidrBlocks (list) --
      
      The inside IP addresses used for a Connect peer configuration.
      - (string) --
    - Protocol (string) --
      
      The protocol used for a Connect peer configuration.
    - BgpConfigurations (list) --
      
      The Connect peer BGP configurations.
      - (dict) --
        
        Describes a core network BGP configuration.
        
        CoreNetworkAsn (integer) --
        
        The ASN of the Coret Network.
        
        PeerAsn (integer) --
        
        The ASN of the Connect peer.
        
        CoreNetworkAddress (string) --
        
        The address of a core network.
        
        PeerAddress (string) --
        
        The address of a core network Connect peer.
  - Tags (list) --
    
    The list of key-value tags associated with the Connect peer.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
      - Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
  - SubnetArn (string) --
    
    The subnet ARN for the Connect peer.

GetConnectAttachment (updated)

Link ¶
Changes (response)

{'ConnectAttachment': {'Options': {'Protocol': {'NO_ENCAP'}}}}

Returns information about a core network Connect attachment.

See also: AWS API Documentation

Request Syntax

client.get_connect_attachment(
    AttachmentId='string'
)

type AttachmentId

string

param AttachmentId

[REQUIRED]

The ID of the attachment.

rtype

dict

returns

Response Syntax

{
    'ConnectAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'TransportAttachmentId': 'string',
        'Options': {
            'Protocol': 'GRE'|'NO_ENCAP'
        }
    }
}

Response Structure

(dict) --
- ConnectAttachment (dict) --
  
  Details about the Connect attachment.
  - Attachment (dict) --
    
    The attachment details.
    - CoreNetworkId (string) --
      
      The ID of a core network.
    - CoreNetworkArn (string) --
      
      The ARN of a core network.
    - AttachmentId (string) --
      
      The ID of the attachment.
    - OwnerAccountId (string) --
      
      The ID of the attachment account owner.
    - AttachmentType (string) --
      
      The type of attachment.
    - State (string) --
      
      The state of the attachment.
    - EdgeLocation (string) --
      
      The Region where the edge is located.
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - Tags (list) --
      
      The tags associated with the attachment.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
    - ProposedSegmentChange (dict) --
      
      The attachment to move from one segment to another.
      - Tags (list) --
        
        The list of key-value tags that changed for the segment.
        
        (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
      - AttachmentPolicyRuleNumber (integer) --
        
        The rule number in the policy document that applies to this change.
      - SegmentName (string) --
        
        The name of the segment to change.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
  - TransportAttachmentId (string) --
    
    The ID of the transport attachment.
  - Options (dict) --
    
    Options for connecting an attachment.
    - Protocol (string) --
      
      The protocol used for the attachment connection.

GetConnectPeer (updated)

Link ¶
Changes (response)

{'ConnectPeer': {'Configuration': {'Protocol': {'NO_ENCAP'}},
                 'SubnetArn': 'string'}}

Returns information about a core network Connect peer.

See also: AWS API Documentation

Request Syntax

client.get_connect_peer(
    ConnectPeerId='string'
)

type ConnectPeerId

string

param ConnectPeerId

[REQUIRED]

The ID of the Connect peer.

rtype

dict

returns

Response Syntax

{
    'ConnectPeer': {
        'CoreNetworkId': 'string',
        'ConnectAttachmentId': 'string',
        'ConnectPeerId': 'string',
        'EdgeLocation': 'string',
        'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
        'CreatedAt': datetime(2015, 1, 1),
        'Configuration': {
            'CoreNetworkAddress': 'string',
            'PeerAddress': 'string',
            'InsideCidrBlocks': [
                'string',
            ],
            'Protocol': 'GRE'|'NO_ENCAP',
            'BgpConfigurations': [
                {
                    'CoreNetworkAsn': 123,
                    'PeerAsn': 123,
                    'CoreNetworkAddress': 'string',
                    'PeerAddress': 'string'
                },
            ]
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string'
    }
}

Response Structure

(dict) --
- ConnectPeer (dict) --
  
  Returns information about a core network Connect peer.
  - CoreNetworkId (string) --
    
    The ID of a core network.
  - ConnectAttachmentId (string) --
    
    The ID of the attachment to connect.
  - ConnectPeerId (string) --
    
    The ID of the Connect peer.
  - EdgeLocation (string) --
    
    The Connect peer Regions where edges are located.
  - State (string) --
    
    The state of the Connect peer.
  - CreatedAt (datetime) --
    
    The timestamp when the Connect peer was created.
  - Configuration (dict) --
    
    The configuration of the Connect peer.
    - CoreNetworkAddress (string) --
      
      The IP address of a core network.
    - PeerAddress (string) --
      
      The IP address of the Connect peer.
    - InsideCidrBlocks (list) --
      
      The inside IP addresses used for a Connect peer configuration.
      - (string) --
    - Protocol (string) --
      
      The protocol used for a Connect peer configuration.
    - BgpConfigurations (list) --
      
      The Connect peer BGP configurations.
      - (dict) --
        
        Describes a core network BGP configuration.
        
        CoreNetworkAsn (integer) --
        
        The ASN of the Coret Network.
        
        PeerAsn (integer) --
        
        The ASN of the Connect peer.
        
        CoreNetworkAddress (string) --
        
        The address of a core network.
        
        PeerAddress (string) --
        
        The address of a core network Connect peer.
  - Tags (list) --
    
    The list of key-value tags associated with the Connect peer.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
      - Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
  - SubnetArn (string) --
    
    The subnet ARN for the Connect peer.

ListConnectPeers (updated)

Link ¶
Changes (response)

{'ConnectPeers': {'SubnetArn': 'string'}}

Returns a list of core network Connect peers.

See also: AWS API Documentation

Request Syntax

client.list_connect_peers(
    CoreNetworkId='string',
    ConnectAttachmentId='string',
    MaxResults=123,
    NextToken='string'
)

type CoreNetworkId

string

param CoreNetworkId

The ID of a core network.

type ConnectAttachmentId

string

param ConnectAttachmentId

The ID of the attachment.

type MaxResults

integer

param MaxResults

The maximum number of results to return.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'ConnectPeers': [
        {
            'CoreNetworkId': 'string',
            'ConnectAttachmentId': 'string',
            'ConnectPeerId': 'string',
            'EdgeLocation': 'string',
            'ConnectPeerState': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
            'CreatedAt': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SubnetArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConnectPeers (list) --
  
  Describes the Connect peers.
  - (dict) --
    
    Summary description of a Connect peer.
    - CoreNetworkId (string) --
      
      The ID of a core network.
    - ConnectAttachmentId (string) --
      
      The ID of a Connect peer attachment.
    - ConnectPeerId (string) --
      
      The ID of a Connect peer.
    - EdgeLocation (string) --
      
      The Region where the edge is located.
    - ConnectPeerState (string) --
      
      The state of a Connect peer.
    - CreatedAt (datetime) --
      
      The timestamp when a Connect peer was created.
    - Tags (list) --
      
      The list of key-value tags associated with the Connect peer summary.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
    - SubnetArn (string) --
      
      The subnet ARN for the Connect peer summary.
- NextToken (string) --
  
  The token for the next page of results.