AWS API Changes

2024/11/25 - AWS Network Manager - 3 new13 updated api methods

Changes This release adds native Direct Connect integration on Cloud WAN enabling customers to directly attach their Direct Connect gateways to Cloud WAN without the need for an intermediate Transit Gateway.

CreateDirectConnectGatewayAttachment (new)

Link ¶

Creates an Amazon Web Services Direct Connect gateway attachment

See also: AWS API Documentation

Request Syntax

client.create_direct_connect_gateway_attachment(
    CoreNetworkId='string',
    DirectConnectGatewayArn='string',
    EdgeLocations=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to.

type DirectConnectGatewayArn:

string

param DirectConnectGatewayArn:

[REQUIRED]

The ARN of the Direct Connect gateway attachment.

type EdgeLocations:

list

param EdgeLocations:

[REQUIRED]

One or more core network edge locations that the Direct Connect gateway attachment is associated with.

(string) --

type Tags:

list

param Tags:

The key value tags to apply to the Direct Connect gateway attachment during creation.

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

client token

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'DirectConnectGatewayAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'DirectConnectGatewayArn': 'string'
    }
}

Response Structure

(dict) --
- DirectConnectGatewayAttachment (dict) --
  
  Describes the details of a CreateDirectConnectGatewayAttachment request.
  - Attachment (dict) --
    
    Describes a core network attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - DirectConnectGatewayArn (string) --
    
    The Direct Connect gateway attachment ARN.

UpdateDirectConnectGatewayAttachment (new)

Link ¶

Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.

See also: AWS API Documentation

Request Syntax

client.update_direct_connect_gateway_attachment(
    AttachmentId='string',
    EdgeLocations=[
        'string',
    ]
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the Direct Connect gateway attachment for the updated edge locations.

type EdgeLocations:

list

param EdgeLocations:

One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations is only used for Direct Connect gateway attachments. Do

(string) --

rtype:

dict

returns:

Response Syntax

{
    'DirectConnectGatewayAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'DirectConnectGatewayArn': 'string'
    }
}

Response Structure

(dict) --
- DirectConnectGatewayAttachment (dict) --
  
  Returns details of the Direct Connect gateway attachment with the updated edge locations.
  - Attachment (dict) --
    
    Describes a core network attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - DirectConnectGatewayArn (string) --
    
    The Direct Connect gateway attachment ARN.

GetDirectConnectGatewayAttachment (new)

Link ¶

Returns information about a specific Amazon Web Services Direct Connect gateway attachment.

See also: AWS API Documentation

Request Syntax

client.get_direct_connect_gateway_attachment(
    AttachmentId='string'
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the Direct Connect gateway attachment that you want to see details about.

rtype:

dict

returns:

Response Syntax

{
    'DirectConnectGatewayAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'DirectConnectGatewayArn': 'string'
    }
}

Response Structure

(dict) --
- DirectConnectGatewayAttachment (dict) --
  
  Shows details about the Direct Connect gateway attachment.
  - Attachment (dict) --
    
    Describes a core network attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - DirectConnectGatewayArn (string) --
    
    The Direct Connect gateway attachment ARN.

AcceptAttachment (updated)

Link ¶
Changes (response)

{'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                'EdgeLocations': ['string'],
                'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                    'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                    'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}

Accepts a core network attachment request.

Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.

See also: AWS API Documentation

Request Syntax

client.accept_attachment(
    AttachmentId='string'
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment.

rtype:

dict

returns:

Response Syntax

{
    'Attachment': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'AttachmentId': 'string',
        'OwnerAccountId': 'string',
        'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
        'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
        'EdgeLocation': 'string',
        'EdgeLocations': [
            'string',
        ],
        'ResourceArn': 'string',
        'AttachmentPolicyRuleNumber': 123,
        'SegmentName': 'string',
        'NetworkFunctionGroupName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ProposedSegmentChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string'
        },
        'ProposedNetworkFunctionGroupChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'NetworkFunctionGroupName': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LastModificationErrors': [
            {
                'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                'Message': 'string',
                'ResourceArn': 'string',
                'RequestId': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Attachment (dict) --
  
  The response to the attachment request.
  - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
  - EdgeLocations (list) --
    
    The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
    - (string) --
  - ResourceArn (string) --
    
    The attachment resource ARN.
  - AttachmentPolicyRuleNumber (integer) --
    
    The policy rule number associated with the attachment.
  - SegmentName (string) --
    
    The name of the segment attachment.
  - NetworkFunctionGroupName (string) --
    
    The name of the network function group.
  - 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.
  - ProposedNetworkFunctionGroupChange (dict) --
    
    Describes a proposed change to a network function group associated with the attachment.
    - Tags (list) --
      
      The list of proposed changes to the key-value tags associated with the network function group.
      - (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 proposed new attachment policy rule number for the network function group.
    - NetworkFunctionGroupName (string) --
      
      The proposed name change for the network function group name.
  - CreatedAt (datetime) --
    
    The timestamp when the attachment was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the attachment was last updated.
  - LastModificationErrors (list) --
    
    Describes the error associated with the attachment request.
    - (dict) --
      
      Describes the error associated with an attachment request.
      - Code (string) --
        
        The error code for the attachment request.
      - Message (string) --
        
        The message associated with the error code.
      - ResourceArn (string) --
        
        The ARN of the requested attachment resource.
      - RequestId (string) --
        
        The ID of the attachment request.

CreateConnectAttachment (updated)

Link ¶
Changes (response)

{'ConnectAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                      'EdgeLocations': ['string'],
                                      'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                          'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                          'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        '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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - TransportAttachmentId (string) --
    
    The ID of the transport attachment.
  - Options (dict) --
    
    Options for connecting an attachment.
    - Protocol (string) --
      
      The protocol used for the attachment connection.

CreateSiteToSiteVpnAttachment (updated)

Link ¶
Changes (response)

{'SiteToSiteVpnAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                            'EdgeLocations': ['string'],
                                            'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                                'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                                'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

See also: AWS API Documentation

Request Syntax

client.create_site_to_site_vpn_attachment(
    CoreNetworkId='string',
    VpnConnectionArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of a core network where you're creating a site-to-site VPN attachment.

type VpnConnectionArn:

string

param VpnConnectionArn:

[REQUIRED]

The ARN identifying the VPN attachment.

type Tags:

list

param Tags:

The 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

{
    'SiteToSiteVpnAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'VpnConnectionArn': 'string'
    }
}

Response Structure

(dict) --
- SiteToSiteVpnAttachment (dict) --
  
  Details about a site-to-site VPN attachment.
  - Attachment (dict) --
    
    Provides details about a site-to-site VPN attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - VpnConnectionArn (string) --
    
    The ARN of the site-to-site VPN attachment.

CreateTransitGatewayRouteTableAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayRouteTableAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                                       'EdgeLocations': ['string'],
                                                       'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                                           'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                                           'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

Creates a transit gateway route table attachment.

See also: AWS API Documentation

Request Syntax

client.create_transit_gateway_route_table_attachment(
    PeeringId='string',
    TransitGatewayRouteTableArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

type PeeringId:

string

param PeeringId:

[REQUIRED]

The ID of the peer for the

type TransitGatewayRouteTableArn:

string

param TransitGatewayRouteTableArn:

[REQUIRED]

The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

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

{
    'TransitGatewayRouteTableAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'PeeringId': 'string',
        'TransitGatewayRouteTableArn': 'string'
    }
}

Response Structure

(dict) --
- TransitGatewayRouteTableAttachment (dict) --
  
  The route table associated with the create transit gateway route table attachment request.
  - Attachment (dict) --
    
    Describes a core network attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - PeeringId (string) --
    
    The ID of the peering attachment.
  - TransitGatewayRouteTableArn (string) --
    
    The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

CreateVpcAttachment (updated)

Link ¶
Changes (response)

{'VpcAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                  'EdgeLocations': ['string'],
                                  'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                      'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                      'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

Creates a VPC attachment on an edge location of a core network.

See also: AWS API Documentation

Request Syntax

client.create_vpc_attachment(
    CoreNetworkId='string',
    VpcArn='string',
    SubnetArns=[
        'string',
    ],
    Options={
        'Ipv6Support': True|False,
        'ApplianceModeSupport': True|False
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of a core network for the VPC attachment.

type VpcArn:

string

param VpcArn:

[REQUIRED]

The ARN of the VPC.

type SubnetArns:

list

param SubnetArns:

[REQUIRED]

The subnet ARN of the VPC attachment.

(string) --

type Options:

dict

param Options:

Options for the VPC attachment.

Ipv6Support (boolean) --

Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

type Tags:

list

param Tags:

The 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

{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': True|False,
            'ApplianceModeSupport': True|False
        }
    }
}

Response Structure

(dict) --
- VpcAttachment (dict) --
  
  Provides details about the VPC attachment.
  - Attachment (dict) --
    
    Provides details about the VPC attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - SubnetArns (list) --
    
    The subnet ARNs.
    - (string) --
  - Options (dict) --
    
    Provides details about the VPC attachment.
    - Ipv6Support (boolean) --
      
      Indicates whether IPv6 is supported.
    - ApplianceModeSupport (boolean) --
      
      Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

DeleteAttachment (updated)

Link ¶
Changes (response)

{'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                'EdgeLocations': ['string'],
                'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                    'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                    'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}

Deletes an attachment. Supports all attachment types.

See also: AWS API Documentation

Request Syntax

client.delete_attachment(
    AttachmentId='string'
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment to delete.

rtype:

dict

returns:

Response Syntax

{
    'Attachment': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'AttachmentId': 'string',
        'OwnerAccountId': 'string',
        'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
        'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
        'EdgeLocation': 'string',
        'EdgeLocations': [
            'string',
        ],
        'ResourceArn': 'string',
        'AttachmentPolicyRuleNumber': 123,
        'SegmentName': 'string',
        'NetworkFunctionGroupName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ProposedSegmentChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string'
        },
        'ProposedNetworkFunctionGroupChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'NetworkFunctionGroupName': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LastModificationErrors': [
            {
                'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                'Message': 'string',
                'ResourceArn': 'string',
                'RequestId': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Attachment (dict) --
  
  Information about the deleted attachment.
  - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
  - EdgeLocations (list) --
    
    The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
    - (string) --
  - ResourceArn (string) --
    
    The attachment resource ARN.
  - AttachmentPolicyRuleNumber (integer) --
    
    The policy rule number associated with the attachment.
  - SegmentName (string) --
    
    The name of the segment attachment.
  - NetworkFunctionGroupName (string) --
    
    The name of the network function group.
  - 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.
  - ProposedNetworkFunctionGroupChange (dict) --
    
    Describes a proposed change to a network function group associated with the attachment.
    - Tags (list) --
      
      The list of proposed changes to the key-value tags associated with the network function group.
      - (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 proposed new attachment policy rule number for the network function group.
    - NetworkFunctionGroupName (string) --
      
      The proposed name change for the network function group name.
  - CreatedAt (datetime) --
    
    The timestamp when the attachment was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the attachment was last updated.
  - LastModificationErrors (list) --
    
    Describes the error associated with the attachment request.
    - (dict) --
      
      Describes the error associated with an attachment request.
      - Code (string) --
        
        The error code for the attachment request.
      - Message (string) --
        
        The message associated with the error code.
      - ResourceArn (string) --
        
        The ARN of the requested attachment resource.
      - RequestId (string) --
        
        The ID of the attachment request.

GetConnectAttachment (updated)

Link ¶
Changes (response)

{'ConnectAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                      'EdgeLocations': ['string'],
                                      'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                          'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                          'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        '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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - TransportAttachmentId (string) --
    
    The ID of the transport attachment.
  - Options (dict) --
    
    Options for connecting an attachment.
    - Protocol (string) --
      
      The protocol used for the attachment connection.

GetSiteToSiteVpnAttachment (updated)

Link ¶
Changes (response)

{'SiteToSiteVpnAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                            'EdgeLocations': ['string'],
                                            'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                                'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                                'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

Returns information about a site-to-site VPN attachment.

See also: AWS API Documentation

Request Syntax

client.get_site_to_site_vpn_attachment(
    AttachmentId='string'
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment.

rtype:

dict

returns:

Response Syntax

{
    'SiteToSiteVpnAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'VpnConnectionArn': 'string'
    }
}

Response Structure

(dict) --
- SiteToSiteVpnAttachment (dict) --
  
  Describes the site-to-site attachment.
  - Attachment (dict) --
    
    Provides details about a site-to-site VPN attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - VpnConnectionArn (string) --
    
    The ARN of the site-to-site VPN attachment.

GetTransitGatewayRouteTableAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayRouteTableAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                                       'EdgeLocations': ['string'],
                                                       'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                                           'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                                           'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

Returns information about a transit gateway route table attachment.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_route_table_attachment(
    AttachmentId='string'
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the transit gateway route table attachment.

rtype:

dict

returns:

Response Syntax

{
    'TransitGatewayRouteTableAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'PeeringId': 'string',
        'TransitGatewayRouteTableArn': 'string'
    }
}

Response Structure

(dict) --
- TransitGatewayRouteTableAttachment (dict) --
  
  Returns information about the transit gateway route table attachment.
  - Attachment (dict) --
    
    Describes a core network attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - PeeringId (string) --
    
    The ID of the peering attachment.
  - TransitGatewayRouteTableArn (string) --
    
    The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

GetVpcAttachment (updated)

Link ¶
Changes (response)

{'VpcAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                  'EdgeLocations': ['string'],
                                  'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                      'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                      'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

Returns information about a VPC attachment.

See also: AWS API Documentation

Request Syntax

client.get_vpc_attachment(
    AttachmentId='string'
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment.

rtype:

dict

returns:

Response Syntax

{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': True|False,
            'ApplianceModeSupport': True|False
        }
    }
}

Response Structure

(dict) --
- VpcAttachment (dict) --
  
  Returns details about a VPC attachment.
  - Attachment (dict) --
    
    Provides details about the VPC attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - SubnetArns (list) --
    
    The subnet ARNs.
    - (string) --
  - Options (dict) --
    
    Provides details about the VPC attachment.
    - Ipv6Support (boolean) --
      
      Indicates whether IPv6 is supported.
    - ApplianceModeSupport (boolean) --
      
      Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

ListAttachments (updated)

Link ¶
Changes (request, response)
Request

{'AttachmentType': {'DIRECT_CONNECT_GATEWAY'}}

Response

{'Attachments': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                 'EdgeLocations': ['string'],
                 'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                     'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                     'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}

Returns a list of core network attachments.

See also: AWS API Documentation

Request Syntax

client.list_attachments(
    CoreNetworkId='string',
    AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
    EdgeLocation='string',
    State='REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
    MaxResults=123,
    NextToken='string'
)

type CoreNetworkId:

string

param CoreNetworkId:

The ID of a core network.

type AttachmentType:

string

param AttachmentType:

The type of attachment.

type EdgeLocation:

string

param EdgeLocation:

The Region where the edge is located.

type State:

string

param State:

The state 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

{
    'Attachments': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Attachments (list) --
  
  Describes the list of attachments.
  - (dict) --
    
    Describes a core network attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
- NextToken (string) --
  
  The token for the next page of results.

RejectAttachment (updated)

Link ¶
Changes (response)

{'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                'EdgeLocations': ['string'],
                'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                    'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                    'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}

Rejects a core network attachment request.

See also: AWS API Documentation

Request Syntax

client.reject_attachment(
    AttachmentId='string'
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment.

rtype:

dict

returns:

Response Syntax

{
    'Attachment': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'AttachmentId': 'string',
        'OwnerAccountId': 'string',
        'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
        'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
        'EdgeLocation': 'string',
        'EdgeLocations': [
            'string',
        ],
        'ResourceArn': 'string',
        'AttachmentPolicyRuleNumber': 123,
        'SegmentName': 'string',
        'NetworkFunctionGroupName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ProposedSegmentChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string'
        },
        'ProposedNetworkFunctionGroupChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'NetworkFunctionGroupName': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LastModificationErrors': [
            {
                'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                'Message': 'string',
                'ResourceArn': 'string',
                'RequestId': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Attachment (dict) --
  
  Describes the rejected attachment request.
  - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
  - EdgeLocations (list) --
    
    The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
    - (string) --
  - ResourceArn (string) --
    
    The attachment resource ARN.
  - AttachmentPolicyRuleNumber (integer) --
    
    The policy rule number associated with the attachment.
  - SegmentName (string) --
    
    The name of the segment attachment.
  - NetworkFunctionGroupName (string) --
    
    The name of the network function group.
  - 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.
  - ProposedNetworkFunctionGroupChange (dict) --
    
    Describes a proposed change to a network function group associated with the attachment.
    - Tags (list) --
      
      The list of proposed changes to the key-value tags associated with the network function group.
      - (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 proposed new attachment policy rule number for the network function group.
    - NetworkFunctionGroupName (string) --
      
      The proposed name change for the network function group name.
  - CreatedAt (datetime) --
    
    The timestamp when the attachment was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the attachment was last updated.
  - LastModificationErrors (list) --
    
    Describes the error associated with the attachment request.
    - (dict) --
      
      Describes the error associated with an attachment request.
      - Code (string) --
        
        The error code for the attachment request.
      - Message (string) --
        
        The message associated with the error code.
      - ResourceArn (string) --
        
        The ARN of the requested attachment resource.
      - RequestId (string) --
        
        The ID of the attachment request.

UpdateVpcAttachment (updated)

Link ¶
Changes (response)

{'VpcAttachment': {'Attachment': {'AttachmentType': {'DIRECT_CONNECT_GATEWAY'},
                                  'EdgeLocations': ['string'],
                                  'LastModificationErrors': {'Code': {'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS',
                                                                      'DIRECT_CONNECT_GATEWAY_NOT_FOUND',
                                                                      'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'}}}}}

Updates a VPC attachment.

See also: AWS API Documentation

Request Syntax

client.update_vpc_attachment(
    AttachmentId='string',
    AddSubnetArns=[
        'string',
    ],
    RemoveSubnetArns=[
        'string',
    ],
    Options={
        'Ipv6Support': True|False,
        'ApplianceModeSupport': True|False
    }
)

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment.

type AddSubnetArns:

list

param AddSubnetArns:

Adds a subnet ARN to the VPC attachment.

(string) --

type RemoveSubnetArns:

list

param RemoveSubnetArns:

Removes a subnet ARN from the attachment.

(string) --

type Options:

dict

param Options:

Additional options for updating the VPC attachment.

Ipv6Support (boolean) --

Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

rtype:

dict

returns:

Response Syntax

{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'EdgeLocations': [
                'string',
            ],
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'NetworkFunctionGroupName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'ProposedNetworkFunctionGroupChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'NetworkFunctionGroupName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LastModificationErrors': [
                {
                    'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': True|False,
            'ApplianceModeSupport': True|False
        }
    }
}

Response Structure

(dict) --
- VpcAttachment (dict) --
  
  Describes the updated VPC attachment.
  - Attachment (dict) --
    
    Provides details about the VPC attachment.
    - 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
    - EdgeLocations (list) --
      
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
      - (string) --
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - NetworkFunctionGroupName (string) --
      
      The name of the network function group.
    - 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.
    - ProposedNetworkFunctionGroupChange (dict) --
      
      Describes a proposed change to a network function group associated with the attachment.
      - Tags (list) --
        
        The list of proposed changes to the key-value tags associated with the network function group.
        
        (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 proposed new attachment policy rule number for the network function group.
      - NetworkFunctionGroupName (string) --
        
        The proposed name change for the network function group name.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
    - LastModificationErrors (list) --
      
      Describes the error associated with the attachment request.
      - (dict) --
        
        Describes the error associated with an attachment request.
        
        Code (string) --
        
        The error code for the attachment request.
        
        Message (string) --
        
        The message associated with the error code.
        
        ResourceArn (string) --
        
        The ARN of the requested attachment resource.
        
        RequestId (string) --
        
        The ID of the attachment request.
  - SubnetArns (list) --
    
    The subnet ARNs.
    - (string) --
  - Options (dict) --
    
    Provides details about the VPC attachment.
    - Ipv6Support (boolean) --
      
      Indicates whether IPv6 is supported.
    - ApplianceModeSupport (boolean) --
      
      Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.