AWS Network Manager

2025/11/20 - AWS Network Manager - 7 new18 updated api methods

Changes  This release adds support for Cloud WAN Routing Policy providing customers sophisticated routing controls to better manage their global networks

PutAttachmentRoutingPolicyLabel (new) Link ¶

Applies a routing policy label to an attachment for traffic routing decisions.

See also: AWS API Documentation

Request Syntax

client.put_attachment_routing_policy_label(
    CoreNetworkId='string',
    AttachmentId='string',
    RoutingPolicyLabel='string',
    ClientToken='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the core network containing the attachment.

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment to apply the routing policy label to.

type RoutingPolicyLabel:

string

param RoutingPolicyLabel:

[REQUIRED]

The routing policy label to apply to the attachment.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'CoreNetworkId': 'string',
    'AttachmentId': 'string',
    'RoutingPolicyLabel': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkId (string) --

      The ID of the core network containing the attachment.

    • AttachmentId (string) --

      The ID of the attachment that received the routing policy label.

    • RoutingPolicyLabel (string) --

      The routing policy label that was applied to the attachment.

ListCoreNetworkPrefixListAssociations (new) Link ¶

Lists the prefix list associations for a core network.

See also: AWS API Documentation

Request Syntax

client.list_core_network_prefix_list_associations(
    CoreNetworkId='string',
    PrefixListArn='string',
    MaxResults=123,
    NextToken='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the core network to list prefix list associations for.

type PrefixListArn:

string

param PrefixListArn:

The ARN of a specific prefix list to filter the associations.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single page.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'PrefixListAssociations': [
        {
            'CoreNetworkId': 'string',
            'PrefixListArn': 'string',
            'PrefixListAlias': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PrefixListAssociations (list) --

      The list of prefix list associations for the core network.

      • (dict) --

        Information about a prefix list association with a core network.

        • CoreNetworkId (string) --

          The core network id in the association.

        • PrefixListArn (string) --

          The ARN of the prefix list in the association.

        • PrefixListAlias (string) --

          The alias of the prefix list in the association.

    • NextToken (string) --

      The token for the next page of results.

ListCoreNetworkRoutingInformation (new) Link ¶

Lists routing information for a core network, including routes and their attributes.

See also: AWS API Documentation

Request Syntax

client.list_core_network_routing_information(
    CoreNetworkId='string',
    SegmentName='string',
    EdgeLocation='string',
    NextHopFilters={
        'string': [
            'string',
        ]
    },
    LocalPreferenceMatches=[
        'string',
    ],
    ExactAsPathMatches=[
        'string',
    ],
    MedMatches=[
        'string',
    ],
    CommunityMatches=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the core network to retrieve routing information for.

type SegmentName:

string

param SegmentName:

[REQUIRED]

The name of the segment to filter routing information by.

type EdgeLocation:

string

param EdgeLocation:

[REQUIRED]

The edge location to filter routing information by.

type NextHopFilters:

dict

param NextHopFilters:

Filters to apply based on next hop information.

  • (string) --

    • (list) --

      • (string) --

type LocalPreferenceMatches:

list

param LocalPreferenceMatches:

Local preference values to match when filtering routing information.

  • (string) --

type ExactAsPathMatches:

list

param ExactAsPathMatches:

Exact AS path values to match when filtering routing information.

  • (string) --

type MedMatches:

list

param MedMatches:

Multi-Exit Discriminator (MED) values to match when filtering routing information.

  • (string) --

type CommunityMatches:

list

param CommunityMatches:

BGP community values to match when filtering routing information.

  • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of routing information entries to return in a single page.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'CoreNetworkRoutingInformation': [
        {
            'Prefix': 'string',
            'NextHop': {
                'IpAddress': 'string',
                'CoreNetworkAttachmentId': 'string',
                'ResourceId': 'string',
                'ResourceType': 'string',
                'SegmentName': 'string',
                'EdgeLocation': 'string'
            },
            'LocalPreference': 'string',
            'Med': 'string',
            'AsPath': [
                'string',
            ],
            'Communities': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkRoutingInformation (list) --

      The list of routing information for the core network.

      • (dict) --

        Routing information for a core network, including route details and BGP attributes.

        • Prefix (string) --

          The IP prefix for the route.

        • NextHop (dict) --

          The next hop information for the route.

          • IpAddress (string) --

            The IP address of the next hop.

          • CoreNetworkAttachmentId (string) --

            The ID of the core network attachment for the next hop.

          • ResourceId (string) --

            The ID of the resource for the next hop.

          • ResourceType (string) --

            The type of resource for the next hop.

          • SegmentName (string) --

            The name of the segment for the next hop.

          • EdgeLocation (string) --

            The edge location for the next hop.

        • LocalPreference (string) --

          The BGP local preference value for the route.

        • Med (string) --

          The BGP Multi-Exit Discriminator (MED) value for the route.

        • AsPath (list) --

          The BGP AS path for the route.

          • (string) --

        • Communities (list) --

          The BGP community values for the route.

          • (string) --

    • NextToken (string) --

      The token for the next page of results.

CreateCoreNetworkPrefixListAssociation (new) Link ¶

Creates an association between a core network and a prefix list for routing control.

See also: AWS API Documentation

Request Syntax

client.create_core_network_prefix_list_association(
    CoreNetworkId='string',
    PrefixListArn='string',
    PrefixListAlias='string',
    ClientToken='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the core network to associate with the prefix list.

type PrefixListArn:

string

param PrefixListArn:

[REQUIRED]

The ARN of the prefix list to associate with the core network.

type PrefixListAlias:

string

param PrefixListAlias:

[REQUIRED]

An optional alias for the prefix list association.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'CoreNetworkId': 'string',
    'PrefixListArn': 'string',
    'PrefixListAlias': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkId (string) --

      The ID of the core network associated with the prefix list.

    • PrefixListArn (string) --

      The ARN of the prefix list that was associated with the core network.

    • PrefixListAlias (string) --

      The alias of the prefix list association, if provided.

DeleteCoreNetworkPrefixListAssociation (new) Link ¶

Deletes an association between a core network and a prefix list.

See also: AWS API Documentation

Request Syntax

client.delete_core_network_prefix_list_association(
    CoreNetworkId='string',
    PrefixListArn='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the core network from which to delete the prefix list association.

type PrefixListArn:

string

param PrefixListArn:

[REQUIRED]

The ARN of the prefix list to disassociate from the core network.

rtype:

dict

returns:

Response Syntax

{
    'CoreNetworkId': 'string',
    'PrefixListArn': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkId (string) --

      The ID of the core network from which the prefix list association was deleted.

    • PrefixListArn (string) --

      The ARN of the prefix list that was disassociated from the core network.

RemoveAttachmentRoutingPolicyLabel (new) Link ¶

Removes a routing policy label from an attachment.

See also: AWS API Documentation

Request Syntax

client.remove_attachment_routing_policy_label(
    CoreNetworkId='string',
    AttachmentId='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the core network containing the attachment.

type AttachmentId:

string

param AttachmentId:

[REQUIRED]

The ID of the attachment to remove the routing policy label from.

rtype:

dict

returns:

Response Syntax

{
    'CoreNetworkId': 'string',
    'AttachmentId': 'string',
    'RoutingPolicyLabel': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkId (string) --

      The ID of the core network containing the attachment.

    • AttachmentId (string) --

      The ID of the attachment from which the routing policy label was removed.

    • RoutingPolicyLabel (string) --

      The routing policy label that was removed from the attachment.

ListAttachmentRoutingPolicyAssociations (new) Link ¶

Lists the routing policy associations for attachments in a core network.

See also: AWS API Documentation

Request Syntax

client.list_attachment_routing_policy_associations(
    CoreNetworkId='string',
    AttachmentId='string',
    MaxResults=123,
    NextToken='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of the core network to list attachment routing policy associations for.

type AttachmentId:

string

param AttachmentId:

The ID of a specific attachment to filter the routing policy associations.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single page.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'AttachmentRoutingPolicyAssociations': [
        {
            'AttachmentId': 'string',
            'PendingRoutingPolicies': [
                'string',
            ],
            'AssociatedRoutingPolicies': [
                'string',
            ],
            'RoutingPolicyLabel': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AttachmentRoutingPolicyAssociations (list) --

      The list of attachment routing policy associations.

      • (dict) --

        Summary information about routing policy associations for an attachment.

        • AttachmentId (string) --

          The ID of the attachment associated with the routing policy.

        • PendingRoutingPolicies (list) --

          The list of routing policies that are pending association with the attachment.

          • (string) --

        • AssociatedRoutingPolicies (list) --

          The list of routing policies currently associated with the attachment.

          • (string) --

        • RoutingPolicyLabel (string) --

          The routing policy label associated with the attachment.

    • NextToken (string) --

      The token for the next page of results.

AcceptAttachment (updated) Link ¶
Changes (response)
{'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                    'VPN_EXISTING_ASSOCIATIONS'}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                '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 (request, response)
Request
{'RoutingPolicyLabel': 'string'}
Response
{'ConnectAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                          'VPN_EXISTING_ASSOCIATIONS'}}}}}

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',
    RoutingPolicyLabel='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 RoutingPolicyLabel:

string

param RoutingPolicyLabel:

The routing policy label to apply to the Connect attachment for traffic routing decisions.

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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.

CreateDirectConnectGatewayAttachment (updated) Link ¶
Changes (request, response)
Request
{'RoutingPolicyLabel': 'string'}
Response
{'DirectConnectGatewayAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                                       'VPN_EXISTING_ASSOCIATIONS'}}}}}

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',
    RoutingPolicyLabel='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 RoutingPolicyLabel:

string

param RoutingPolicyLabel:

The routing policy label to apply to the Direct Connect Gateway attachment for traffic routing decisions.

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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.

CreateSiteToSiteVpnAttachment (updated) Link ¶
Changes (request, response)
Request
{'RoutingPolicyLabel': 'string'}
Response
{'SiteToSiteVpnAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                                'VPN_EXISTING_ASSOCIATIONS'}}}}}

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',
    RoutingPolicyLabel='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 RoutingPolicyLabel:

string

param RoutingPolicyLabel:

The routing policy label to apply to the Site-to-Site VPN attachment for traffic routing decisions.

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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 (request, response)
Request
{'RoutingPolicyLabel': 'string'}
Response
{'TransitGatewayRouteTableAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                                           'VPN_EXISTING_ASSOCIATIONS'}}}}}

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',
    RoutingPolicyLabel='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 RoutingPolicyLabel:

string

param RoutingPolicyLabel:

The routing policy label to apply to the Transit Gateway route table attachment for traffic routing decisions.

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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 (request, response)
Request
{'RoutingPolicyLabel': 'string'}
Response
{'VpcAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                      'VPN_EXISTING_ASSOCIATIONS'}}}}}

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,
        'DnsSupport': True|False,
        'SecurityGroupReferencingSupport': True|False
    },
    RoutingPolicyLabel='string',
    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.

  • DnsSupport (boolean) --

    Indicates whether DNS is supported.

  • SecurityGroupReferencingSupport (boolean) --

    Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.

type RoutingPolicyLabel:

string

param RoutingPolicyLabel:

The routing policy label to apply to the VPC attachment for traffic routing decisions.

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': True|False,
            'ApplianceModeSupport': True|False,
            'DnsSupport': True|False,
            'SecurityGroupReferencingSupport': 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.

        • DnsSupport (boolean) --

          Indicates whether DNS is supported.

        • SecurityGroupReferencingSupport (boolean) --

          Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.

DeleteAttachment (updated) Link ¶
Changes (response)
{'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                    'VPN_EXISTING_ASSOCIATIONS'}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                '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': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                          'VPN_EXISTING_ASSOCIATIONS'}}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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.

GetCoreNetworkChangeEvents (updated) Link ¶
Changes (response)
{'CoreNetworkChangeEvents': {'Type': {'ROUTING_POLICY',
                                      'ROUTING_POLICY_ATTACHMENT_ASSOCIATION',
                                      'ROUTING_POLICY_EDGE_ASSOCIATION',
                                      'ROUTING_POLICY_SEGMENT_ASSOCIATION'},
                             'Values': {'PeerEdgeLocation': 'string',
                                        'RoutingPolicyAssociationDetails': [{'RoutingPolicyNames': ['string'],
                                                                             'SharedSegments': ['string']}],
                                        'RoutingPolicyDirection': 'inbound | '
                                                                  'outbound'}}}

Returns information about a core network change event.

See also: AWS API Documentation

Request Syntax

client.get_core_network_change_events(
    CoreNetworkId='string',
    PolicyVersionId=123,
    MaxResults=123,
    NextToken='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of a core network.

type PolicyVersionId:

integer

param PolicyVersionId:

[REQUIRED]

The ID of the policy version.

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

{
    'CoreNetworkChangeEvents': [
        {
            'Type': 'CORE_NETWORK_SEGMENT'|'NETWORK_FUNCTION_GROUP'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'ROUTING_POLICY'|'ROUTING_POLICY_SEGMENT_ASSOCIATION'|'ROUTING_POLICY_EDGE_ASSOCIATION'|'ROUTING_POLICY_ATTACHMENT_ASSOCIATION'|'CORE_NETWORK_CONFIGURATION'|'SEGMENTS_CONFIGURATION'|'SEGMENT_ACTIONS_CONFIGURATION'|'ATTACHMENT_POLICIES_CONFIGURATION',
            'Action': 'ADD'|'MODIFY'|'REMOVE',
            'IdentifierPath': 'string',
            'EventTime': datetime(2015, 1, 1),
            'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED',
            'Values': {
                'EdgeLocation': 'string',
                'PeerEdgeLocation': 'string',
                'RoutingPolicyDirection': 'inbound'|'outbound',
                'SegmentName': 'string',
                'NetworkFunctionGroupName': 'string',
                'AttachmentId': 'string',
                'Cidr': 'string',
                'RoutingPolicyAssociationDetails': [
                    {
                        'RoutingPolicyNames': [
                            'string',
                        ],
                        'SharedSegments': [
                            'string',
                        ]
                    },
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkChangeEvents (list) --

      The response to GetCoreNetworkChangeEventsRequest.

      • (dict) --

        Describes a core network change event. This can be a change to a segment, attachment, route, etc.

        • Type (string) --

          Describes the type of change event.

        • Action (string) --

          The action taken for the change event.

        • IdentifierPath (string) --

          Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

        • EventTime (datetime) --

          The timestamp for an event change in status.

        • Status (string) --

          The status of the core network change event.

        • Values (dict) --

          Details of the change event.

          • EdgeLocation (string) --

            The edge location for the core network change event.

          • PeerEdgeLocation (string) --

            The edge location of the peer in a core network change event.

          • RoutingPolicyDirection (string) --

            The routing policy direction (inbound/outbound) in a core network change event.

          • SegmentName (string) --

            The segment name if the change event is associated with a segment.

          • NetworkFunctionGroupName (string) --

            The changed network function group name.

          • AttachmentId (string) --

            The ID of the attachment if the change event is associated with an attachment.

          • Cidr (string) --

            For a STATIC_ROUTE event, this is the IP address.

          • RoutingPolicyAssociationDetails (list) --

            The names of the routing policies and other association details in the core network change values.

            • (dict) --

              Information about a routing policy association.

              • RoutingPolicyNames (list) --

                The names of the routing policies in the association.

                • (string) --

              • SharedSegments (list) --

                The names of the segments that are shared with each other in the association.

                • (string) --

    • NextToken (string) --

      The token for the next page of results.

GetCoreNetworkChangeSet (updated) Link ¶
Changes (response)
{'CoreNetworkChanges': {'NewValues': {'AttachmentId': 'string',
                                      'PeerEdgeLocations': ['string'],
                                      'RoutingPolicy': 'string',
                                      'RoutingPolicyAssociationDetails': [{'RoutingPolicyNames': ['string'],
                                                                           'SharedSegments': ['string']}],
                                      'RoutingPolicyDirection': 'inbound | '
                                                                'outbound'},
                        'PreviousValues': {'AttachmentId': 'string',
                                           'PeerEdgeLocations': ['string'],
                                           'RoutingPolicy': 'string',
                                           'RoutingPolicyAssociationDetails': [{'RoutingPolicyNames': ['string'],
                                                                                'SharedSegments': ['string']}],
                                           'RoutingPolicyDirection': 'inbound '
                                                                     '| '
                                                                     'outbound'},
                        'Type': {'ROUTING_POLICY',
                                 'ROUTING_POLICY_ATTACHMENT_ASSOCIATION',
                                 'ROUTING_POLICY_EDGE_ASSOCIATION',
                                 'ROUTING_POLICY_SEGMENT_ASSOCIATION'}}}

Returns a change set between the LIVE core network policy and a submitted policy.

See also: AWS API Documentation

Request Syntax

client.get_core_network_change_set(
    CoreNetworkId='string',
    PolicyVersionId=123,
    MaxResults=123,
    NextToken='string'
)
type CoreNetworkId:

string

param CoreNetworkId:

[REQUIRED]

The ID of a core network.

type PolicyVersionId:

integer

param PolicyVersionId:

[REQUIRED]

The ID of the policy version.

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

{
    'CoreNetworkChanges': [
        {
            'Type': 'CORE_NETWORK_SEGMENT'|'NETWORK_FUNCTION_GROUP'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'ROUTING_POLICY'|'ROUTING_POLICY_SEGMENT_ASSOCIATION'|'ROUTING_POLICY_EDGE_ASSOCIATION'|'ROUTING_POLICY_ATTACHMENT_ASSOCIATION'|'CORE_NETWORK_CONFIGURATION'|'SEGMENTS_CONFIGURATION'|'SEGMENT_ACTIONS_CONFIGURATION'|'ATTACHMENT_POLICIES_CONFIGURATION',
            'Action': 'ADD'|'MODIFY'|'REMOVE',
            'Identifier': 'string',
            'PreviousValues': {
                'SegmentName': 'string',
                'NetworkFunctionGroupName': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'Asn': 123,
                'Cidr': 'string',
                'DestinationIdentifier': 'string',
                'InsideCidrBlocks': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ],
                'ServiceInsertionActions': [
                    {
                        'Action': 'send-via'|'send-to',
                        'Mode': 'dual-hop'|'single-hop',
                        'WhenSentTo': {
                            'WhenSentToSegmentsList': [
                                'string',
                            ]
                        },
                        'Via': {
                            'NetworkFunctionGroups': [
                                {
                                    'Name': 'string'
                                },
                            ],
                            'WithEdgeOverrides': [
                                {
                                    'EdgeSets': [
                                        [
                                            'string',
                                        ],
                                    ],
                                    'UseEdge': 'string'
                                },
                            ]
                        }
                    },
                ],
                'VpnEcmpSupport': True|False,
                'DnsSupport': True|False,
                'SecurityGroupReferencingSupport': True|False,
                'RoutingPolicyDirection': 'inbound'|'outbound',
                'RoutingPolicy': 'string',
                'PeerEdgeLocations': [
                    'string',
                ],
                'AttachmentId': 'string',
                'RoutingPolicyAssociationDetails': [
                    {
                        'RoutingPolicyNames': [
                            'string',
                        ],
                        'SharedSegments': [
                            'string',
                        ]
                    },
                ]
            },
            'NewValues': {
                'SegmentName': 'string',
                'NetworkFunctionGroupName': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'Asn': 123,
                'Cidr': 'string',
                'DestinationIdentifier': 'string',
                'InsideCidrBlocks': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ],
                'ServiceInsertionActions': [
                    {
                        'Action': 'send-via'|'send-to',
                        'Mode': 'dual-hop'|'single-hop',
                        'WhenSentTo': {
                            'WhenSentToSegmentsList': [
                                'string',
                            ]
                        },
                        'Via': {
                            'NetworkFunctionGroups': [
                                {
                                    'Name': 'string'
                                },
                            ],
                            'WithEdgeOverrides': [
                                {
                                    'EdgeSets': [
                                        [
                                            'string',
                                        ],
                                    ],
                                    'UseEdge': 'string'
                                },
                            ]
                        }
                    },
                ],
                'VpnEcmpSupport': True|False,
                'DnsSupport': True|False,
                'SecurityGroupReferencingSupport': True|False,
                'RoutingPolicyDirection': 'inbound'|'outbound',
                'RoutingPolicy': 'string',
                'PeerEdgeLocations': [
                    'string',
                ],
                'AttachmentId': 'string',
                'RoutingPolicyAssociationDetails': [
                    {
                        'RoutingPolicyNames': [
                            'string',
                        ],
                        'SharedSegments': [
                            'string',
                        ]
                    },
                ]
            },
            'IdentifierPath': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkChanges (list) --

      Describes a core network changes.

      • (dict) --

        Details describing a core network change.

        • Type (string) --

          The type of change.

        • Action (string) --

          The action to take for a core network.

        • Identifier (string) --

          The resource identifier.

        • PreviousValues (dict) --

          The previous values for a core network.

          • SegmentName (string) --

            The names of the segments in a core network.

          • NetworkFunctionGroupName (string) --

            The network function group name if the change event is associated with a network function group.

          • EdgeLocations (list) --

            The Regions where edges are located in a core network.

            • (string) --

          • Asn (integer) --

            The ASN of a core network.

          • Cidr (string) --

            The IP addresses used for a core network.

          • DestinationIdentifier (string) --

            The ID of the destination.

          • InsideCidrBlocks (list) --

            The inside IP addresses used for core network change values.

            • (string) --

          • SharedSegments (list) --

            The shared segments for a core network change value.

            • (string) --

          • ServiceInsertionActions (list) --

            Describes the service insertion action.

            • (dict) --

              Describes the action that the service insertion will take for any segments associated with it.

              • Action (string) --

                The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.

              • Mode (string) --

                Describes the mode packets take for the send-via action. This is not used when the action is send-to. dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop, packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.

              • WhenSentTo (dict) --

                The list of destination segments if the service insertion action is send-via.

                • WhenSentToSegmentsList (list) --

                  The list of destination segments when the service insertion action is send-to.

                  • (string) --

              • Via (dict) --

                The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via.

                • NetworkFunctionGroups (list) --

                  The list of network function groups associated with the service insertion action.

                  • (dict) --

                    Describes a network function group for service insertion.

                    • Name (string) --

                      The name of the network function group.

                • WithEdgeOverrides (list) --

                  Describes any edge overrides. An edge override is a specific edge to be used for traffic.

                  • (dict) --

                    Describes the edge that's used for the override.

                    • EdgeSets (list) --

                      The list of edge locations.

                      • (list) --

                        • (string) --

                    • UseEdge (string) --

                      The edge that should be used when overriding the current edge order.

          • VpnEcmpSupport (boolean) --

            Indicates whether Equal Cost Multipath (ECMP) is enabled for the core network.

          • DnsSupport (boolean) --

            Indicates whether public DNS support is supported. The default is true.

          • SecurityGroupReferencingSupport (boolean) --

            Indicates whether security group referencing is enabled for the core network.

          • RoutingPolicyDirection (string) --

            The routing policy direction (inbound/outbound) in a core network change event.

          • RoutingPolicy (string) --

            The routing policy configuration in the core network change values.

          • PeerEdgeLocations (list) --

            The edge locations of peers in the core network change values.

            • (string) --

          • AttachmentId (string) --

            The attachment identifier in the core network change values.

          • RoutingPolicyAssociationDetails (list) --

            The names of the routing policies and other association details in the core network change values.

            • (dict) --

              Information about a routing policy association.

              • RoutingPolicyNames (list) --

                The names of the routing policies in the association.

                • (string) --

              • SharedSegments (list) --

                The names of the segments that are shared with each other in the association.

                • (string) --

        • NewValues (dict) --

          The new value for a core network

          • SegmentName (string) --

            The names of the segments in a core network.

          • NetworkFunctionGroupName (string) --

            The network function group name if the change event is associated with a network function group.

          • EdgeLocations (list) --

            The Regions where edges are located in a core network.

            • (string) --

          • Asn (integer) --

            The ASN of a core network.

          • Cidr (string) --

            The IP addresses used for a core network.

          • DestinationIdentifier (string) --

            The ID of the destination.

          • InsideCidrBlocks (list) --

            The inside IP addresses used for core network change values.

            • (string) --

          • SharedSegments (list) --

            The shared segments for a core network change value.

            • (string) --

          • ServiceInsertionActions (list) --

            Describes the service insertion action.

            • (dict) --

              Describes the action that the service insertion will take for any segments associated with it.

              • Action (string) --

                The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.

              • Mode (string) --

                Describes the mode packets take for the send-via action. This is not used when the action is send-to. dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop, packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.

              • WhenSentTo (dict) --

                The list of destination segments if the service insertion action is send-via.

                • WhenSentToSegmentsList (list) --

                  The list of destination segments when the service insertion action is send-to.

                  • (string) --

              • Via (dict) --

                The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via.

                • NetworkFunctionGroups (list) --

                  The list of network function groups associated with the service insertion action.

                  • (dict) --

                    Describes a network function group for service insertion.

                    • Name (string) --

                      The name of the network function group.

                • WithEdgeOverrides (list) --

                  Describes any edge overrides. An edge override is a specific edge to be used for traffic.

                  • (dict) --

                    Describes the edge that's used for the override.

                    • EdgeSets (list) --

                      The list of edge locations.

                      • (list) --

                        • (string) --

                    • UseEdge (string) --

                      The edge that should be used when overriding the current edge order.

          • VpnEcmpSupport (boolean) --

            Indicates whether Equal Cost Multipath (ECMP) is enabled for the core network.

          • DnsSupport (boolean) --

            Indicates whether public DNS support is supported. The default is true.

          • SecurityGroupReferencingSupport (boolean) --

            Indicates whether security group referencing is enabled for the core network.

          • RoutingPolicyDirection (string) --

            The routing policy direction (inbound/outbound) in a core network change event.

          • RoutingPolicy (string) --

            The routing policy configuration in the core network change values.

          • PeerEdgeLocations (list) --

            The edge locations of peers in the core network change values.

            • (string) --

          • AttachmentId (string) --

            The attachment identifier in the core network change values.

          • RoutingPolicyAssociationDetails (list) --

            The names of the routing policies and other association details in the core network change values.

            • (dict) --

              Information about a routing policy association.

              • RoutingPolicyNames (list) --

                The names of the routing policies in the association.

                • (string) --

              • SharedSegments (list) --

                The names of the segments that are shared with each other in the association.

                • (string) --

        • IdentifierPath (string) --

          Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

    • NextToken (string) --

      The token for the next page of results.

GetDirectConnectGatewayAttachment (updated) Link ¶
Changes (response)
{'DirectConnectGatewayAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                                       'VPN_EXISTING_ASSOCIATIONS'}}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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.

GetSiteToSiteVpnAttachment (updated) Link ¶
Changes (response)
{'SiteToSiteVpnAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                                'VPN_EXISTING_ASSOCIATIONS'}}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                                           'VPN_EXISTING_ASSOCIATIONS'}}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                      'VPN_EXISTING_ASSOCIATIONS'}}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': True|False,
            'ApplianceModeSupport': True|False,
            'DnsSupport': True|False,
            'SecurityGroupReferencingSupport': 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.

        • DnsSupport (boolean) --

          Indicates whether DNS is supported.

        • SecurityGroupReferencingSupport (boolean) --

          Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.

ListAttachments (updated) Link ¶
Changes (response)
{'Attachments': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                     'VPN_EXISTING_ASSOCIATIONS'}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                    'VPN_EXISTING_ASSOCIATIONS'}}}}

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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                '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.

UpdateDirectConnectGatewayAttachment (updated) Link ¶
Changes (response)
{'DirectConnectGatewayAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                                       'VPN_EXISTING_ASSOCIATIONS'}}}}}

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.

  • (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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    '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.

UpdateVpcAttachment (updated) Link ¶
Changes (response)
{'VpcAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'VPC_UNSUPPORTED_FEATURES',
                                                                      'VPN_EXISTING_ASSOCIATIONS'}}}}}

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,
        'DnsSupport': True|False,
        'SecurityGroupReferencingSupport': 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.

  • DnsSupport (boolean) --

    Indicates whether DNS is supported.

  • SecurityGroupReferencingSupport (boolean) --

    Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to 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'|'VPN_EXISTING_ASSOCIATIONS'|'VPC_UNSUPPORTED_FEATURES',
                    'Message': 'string',
                    'ResourceArn': 'string',
                    'RequestId': 'string'
                },
            ]
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': True|False,
            'ApplianceModeSupport': True|False,
            'DnsSupport': True|False,
            'SecurityGroupReferencingSupport': 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.

        • DnsSupport (boolean) --

          Indicates whether DNS is supported.

        • SecurityGroupReferencingSupport (boolean) --

          Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.