AWS Network Manager

2022/07/12 - AWS Network Manager - 7 new 12 updated api methods

Changes  This release adds general availability API support for AWS Cloud WAN.

CreateTransitGatewayRouteTableAttachment (new) Link ¶

Creates a transit gateway route table attachment.

See also: AWS API Documentation

Request Syntax

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

string

param PeeringId

[REQUIRED]

The ID of the peer for the

type TransitGatewayRouteTableArn

string

param TransitGatewayRouteTableArn

[REQUIRED]

The ARN of the transit gateway route table for the attachment request.

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        '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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • PeeringId (string) --

        The ID of the peering attachment.

      • TransitGatewayRouteTableArn (string) --

        The ARN of the transit gateway attachment route table.

CreateTransitGatewayPeering (new) Link ¶

Creates a transit gateway peering connection.

See also: AWS API Documentation

Request Syntax

client.create_transit_gateway_peering(
    CoreNetworkId='string',
    TransitGatewayArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
type CoreNetworkId

string

param CoreNetworkId

[REQUIRED]

The ID of a core network.

type TransitGatewayArn

string

param TransitGatewayArn

[REQUIRED]

The ARN of the transit gateway for the peering request.

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

{
    'TransitGatewayPeering': {
        'Peering': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'PeeringId': 'string',
            'OwnerAccountId': 'string',
            'PeeringType': 'TRANSIT_GATEWAY',
            'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'CreatedAt': datetime(2015, 1, 1)
        },
        'TransitGatewayArn': 'string'
    }
}

Response Structure

  • (dict) --

    • TransitGatewayPeering (dict) --

      Returns information about the transit gateway peering connection request.

      • Peering (dict) --

        Describes a transit gateway peer connection.

        • CoreNetworkId (string) --

          The ID of the core network for the peering request.

        • CoreNetworkArn (string) --

          The ARN of a core network.

        • PeeringId (string) --

          The ID of the peering attachment.

        • OwnerAccountId (string) --

          The ID of the account owner.

        • PeeringType (string) --

          The type of peering. This will be TRANSIT_GATEWAY .

        • State (string) --

          The current state of the peering connection.

        • EdgeLocation (string) --

          The edge location for the peer.

        • ResourceArn (string) --

          The resource ARN of the peer.

        • Tags (list) --

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

          • (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.

        • CreatedAt (datetime) --

          The timestamp when the attachment peer was created.

      • TransitGatewayArn (string) --

        The ARN of the transit gateway.

GetTransitGatewayPeering (new) Link ¶

Returns information about a transit gateway peer.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_peering(
    PeeringId='string'
)
type PeeringId

string

param PeeringId

[REQUIRED]

The ID of the peering request.

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPeering': {
        'Peering': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'PeeringId': 'string',
            'OwnerAccountId': 'string',
            'PeeringType': 'TRANSIT_GATEWAY',
            'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'CreatedAt': datetime(2015, 1, 1)
        },
        'TransitGatewayArn': 'string'
    }
}

Response Structure

  • (dict) --

    • TransitGatewayPeering (dict) --

      Returns information about a transit gateway peering.

      • Peering (dict) --

        Describes a transit gateway peer connection.

        • CoreNetworkId (string) --

          The ID of the core network for the peering request.

        • CoreNetworkArn (string) --

          The ARN of a core network.

        • PeeringId (string) --

          The ID of the peering attachment.

        • OwnerAccountId (string) --

          The ID of the account owner.

        • PeeringType (string) --

          The type of peering. This will be TRANSIT_GATEWAY .

        • State (string) --

          The current state of the peering connection.

        • EdgeLocation (string) --

          The edge location for the peer.

        • ResourceArn (string) --

          The resource ARN of the peer.

        • Tags (list) --

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

          • (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.

        • CreatedAt (datetime) --

          The timestamp when the attachment peer was created.

      • TransitGatewayArn (string) --

        The ARN of the transit gateway.

ListPeerings (new) Link ¶

Lists the peerings for a core network.

See also: AWS API Documentation

Request Syntax

client.list_peerings(
    CoreNetworkId='string',
    PeeringType='TRANSIT_GATEWAY',
    EdgeLocation='string',
    State='CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
    MaxResults=123,
    NextToken='string'
)
type CoreNetworkId

string

param CoreNetworkId

The ID of a core network.

type PeeringType

string

param PeeringType

Returns a list of a peering requests.

type EdgeLocation

string

param EdgeLocation

Returns a list edge locations for the

type State

string

param State

Returns a list of the peering request states.

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

{
    'Peerings': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'PeeringId': 'string',
            'OwnerAccountId': 'string',
            'PeeringType': 'TRANSIT_GATEWAY',
            'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Peerings (list) --

      Lists the transit gateway peerings for the ListPeerings request.

      • (dict) --

        Describes a peering connection.

        • CoreNetworkId (string) --

          The ID of the core network for the peering request.

        • CoreNetworkArn (string) --

          The ARN of a core network.

        • PeeringId (string) --

          The ID of the peering attachment.

        • OwnerAccountId (string) --

          The ID of the account owner.

        • PeeringType (string) --

          The type of peering. This will be TRANSIT_GATEWAY .

        • State (string) --

          The current state of the peering connection.

        • EdgeLocation (string) --

          The edge location for the peer.

        • ResourceArn (string) --

          The resource ARN of the peer.

        • Tags (list) --

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

          • (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.

        • CreatedAt (datetime) --

          The timestamp when the attachment peer was created.

    • NextToken (string) --

      The token for the next page of results.

GetTransitGatewayRouteTableAttachment (new) Link ¶

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        '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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • PeeringId (string) --

        The ID of the peering attachment.

      • TransitGatewayRouteTableArn (string) --

        The ARN of the transit gateway attachment route table.

DeletePeering (new) Link ¶

Deletes an existing peering connection.

See also: AWS API Documentation

Request Syntax

client.delete_peering(
    PeeringId='string'
)
type PeeringId

string

param PeeringId

[REQUIRED]

The ID of the peering connection to delete.

rtype

dict

returns

Response Syntax

{
    'Peering': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'PeeringId': 'string',
        'OwnerAccountId': 'string',
        'PeeringType': 'TRANSIT_GATEWAY',
        'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
        'EdgeLocation': 'string',
        'ResourceArn': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'CreatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Peering (dict) --

      Information about a deleted peering connection.

      • CoreNetworkId (string) --

        The ID of the core network for the peering request.

      • CoreNetworkArn (string) --

        The ARN of a core network.

      • PeeringId (string) --

        The ID of the peering attachment.

      • OwnerAccountId (string) --

        The ID of the account owner.

      • PeeringType (string) --

        The type of peering. This will be TRANSIT_GATEWAY .

      • State (string) --

        The current state of the peering connection.

      • EdgeLocation (string) --

        The edge location for the peer.

      • ResourceArn (string) --

        The resource ARN of the peer.

      • Tags (list) --

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

        • (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.

      • CreatedAt (datetime) --

        The timestamp when the attachment peer was created.

GetCoreNetworkChangeEvents (new) Link ¶

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'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'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',
                'SegmentName': 'string',
                'AttachmentId': 'string',
                'Cidr': '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.

          • SegmentName (string) --

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

          • 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.

    • NextToken (string) --

      The token for the next page of results.

AcceptAttachment (updated) Link ¶
Changes (response) 
{'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
        'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
        'EdgeLocation': 'string',
        'ResourceArn': 'string',
        'AttachmentPolicyRuleNumber': 123,
        'SegmentName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ProposedSegmentChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

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.

      • ResourceArn (string) --

        The attachment resource ARN.

      • AttachmentPolicyRuleNumber (integer) --

        The policy rule number associated with the attachment.

      • SegmentName (string) --

        The name of the segment attachment.

      • Tags (list) --

        The tags associated with the attachment.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Constraints: Maximum length of 256 characters.

      • ProposedSegmentChange (dict) --

        The attachment to move from one segment to another.

        • Tags (list) --

          The list of key-value tags that changed for the segment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • AttachmentPolicyRuleNumber (integer) --

          The rule number in the policy document that applies to this change.

        • SegmentName (string) --

          The name of the segment to change.

      • CreatedAt (datetime) --

        The timestamp when the attachment was created.

      • UpdatedAt (datetime) --

        The timestamp when the attachment was last updated.

CreateConnectAttachment (updated) Link ¶
Changes (response) 
{'ConnectAttachment': {'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}}

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

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

See also: AWS API Documentation

Request Syntax

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

string

param CoreNetworkId

[REQUIRED]

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

type EdgeLocation

string

param EdgeLocation

[REQUIRED]

The Region where the edge is located.

type TransportAttachmentId

string

param TransportAttachmentId

[REQUIRED]

The ID of the attachment between the two connections.

type Options

dict

param Options

[REQUIRED]

Options for creating an attachment.

  • Protocol (string) --

    The protocol used for the attachment connection.

type Tags

list

param Tags

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

  • (dict) --

    Describes a tag.

    • Key (string) --

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value (string) --

      The tag value.

      Constraints: Maximum length of 256 characters.

type ClientToken

string

param ClientToken

The client token associated with the request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • ConnectAttachment (dict) --

      The response to a Connect attachment request.

      • Attachment (dict) --

        The attachment details.

        • CoreNetworkId (string) --

          The ID of a core network.

        • CoreNetworkArn (string) --

          The ARN of a core network.

        • AttachmentId (string) --

          The ID of the attachment.

        • OwnerAccountId (string) --

          The ID of the attachment account owner.

        • AttachmentType (string) --

          The type of attachment.

        • State (string) --

          The state of the attachment.

        • EdgeLocation (string) --

          The Region where the edge is located.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • TransportAttachmentId (string) --

        The ID of the transport attachment.

      • Options (dict) --

        Options for connecting an attachment.

        • Protocol (string) --

          The protocol used for the attachment connection.

CreateSiteToSiteVpnAttachment (updated) Link ¶
Changes (response) 
{'SiteToSiteVpnAttachment': {'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}}

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

See also: AWS API Documentation

Request Syntax

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

string

param CoreNetworkId

[REQUIRED]

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

type VpnConnectionArn

string

param VpnConnectionArn

[REQUIRED]

The ARN identifying the VPN attachment.

type Tags

list

param Tags

The tags associated with the request.

  • (dict) --

    Describes a tag.

    • Key (string) --

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value (string) --

      The tag value.

      Constraints: Maximum length of 256 characters.

type ClientToken

string

param ClientToken

The client token associated with the request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'SiteToSiteVpnAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        '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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • VpnConnectionArn (string) --

        The ARN of the site-to-site VPN attachment.

CreateVpcAttachment (updated) Link ¶
Changes (response) 
{'VpcAttachment': {'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}}

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
    },
    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.

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': 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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • SubnetArns (list) --

        The subnet ARNs.

        • (string) --

      • Options (dict) --

        Provides details about the VPC attachment.

        • Ipv6Support (boolean) --

          Indicates whether IPv6 is supported.

DeleteAttachment (updated) Link ¶
Changes (response) 
{'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
        'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
        'EdgeLocation': 'string',
        'ResourceArn': 'string',
        'AttachmentPolicyRuleNumber': 123,
        'SegmentName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ProposedSegmentChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

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.

      • ResourceArn (string) --

        The attachment resource ARN.

      • AttachmentPolicyRuleNumber (integer) --

        The policy rule number associated with the attachment.

      • SegmentName (string) --

        The name of the segment attachment.

      • Tags (list) --

        The tags associated with the attachment.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Constraints: Maximum length of 256 characters.

      • ProposedSegmentChange (dict) --

        The attachment to move from one segment to another.

        • Tags (list) --

          The list of key-value tags that changed for the segment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • AttachmentPolicyRuleNumber (integer) --

          The rule number in the policy document that applies to this change.

        • SegmentName (string) --

          The name of the segment to change.

      • CreatedAt (datetime) --

        The timestamp when the attachment was created.

      • UpdatedAt (datetime) --

        The timestamp when the attachment was last updated.

GetConnectAttachment (updated) Link ¶
Changes (response) 
{'ConnectAttachment': {'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}}

Returns information about a core network Connect attachment.

See also: AWS API Documentation

Request Syntax

client.get_connect_attachment(
    AttachmentId='string'
)
type AttachmentId

string

param AttachmentId

[REQUIRED]

The ID of the attachment.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • ConnectAttachment (dict) --

      Details about the Connect attachment.

      • Attachment (dict) --

        The attachment details.

        • CoreNetworkId (string) --

          The ID of a core network.

        • CoreNetworkArn (string) --

          The ARN of a core network.

        • AttachmentId (string) --

          The ID of the attachment.

        • OwnerAccountId (string) --

          The ID of the attachment account owner.

        • AttachmentType (string) --

          The type of attachment.

        • State (string) --

          The state of the attachment.

        • EdgeLocation (string) --

          The Region where the edge is located.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • TransportAttachmentId (string) --

        The ID of the transport attachment.

      • Options (dict) --

        Options for connecting an attachment.

        • Protocol (string) --

          The protocol used for the attachment connection.

GetCoreNetworkChangeSet (updated) Link ¶
Changes (response) 
{'CoreNetworkChanges': {'IdentifierPath': 'string',
                        'Type': {'ATTACHMENT_POLICIES_CONFIGURATION',
                                 'CORE_NETWORK_CONFIGURATION',
                                 'SEGMENTS_CONFIGURATION',
                                 'SEGMENT_ACTIONS_CONFIGURATION'}}}

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'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'CORE_NETWORK_CONFIGURATION'|'SEGMENTS_CONFIGURATION'|'SEGMENT_ACTIONS_CONFIGURATION'|'ATTACHMENT_POLICIES_CONFIGURATION',
            'Action': 'ADD'|'MODIFY'|'REMOVE',
            'Identifier': 'string',
            'PreviousValues': {
                'SegmentName': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'Asn': 123,
                'Cidr': 'string',
                'DestinationIdentifier': 'string',
                'InsideCidrBlocks': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ]
            },
            'NewValues': {
                'SegmentName': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'Asn': 123,
                'Cidr': 'string',
                'DestinationIdentifier': 'string',
                'InsideCidrBlocks': [
                    '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.

          • 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) --

        • NewValues (dict) --

          The new value for a core network

          • SegmentName (string) --

            The names of the segments in a core network.

          • 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) --

        • 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.

GetSiteToSiteVpnAttachment (updated) Link ¶
Changes (response) 
{'SiteToSiteVpnAttachment': {'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}}

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        '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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • VpnConnectionArn (string) --

        The ARN of the site-to-site VPN attachment.

GetVpcAttachment (updated) Link ¶
Changes (response) 
{'VpcAttachment': {'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}}

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': 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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • SubnetArns (list) --

        The subnet ARNs.

        • (string) --

      • Options (dict) --

        Provides details about the VPC attachment.

        • Ipv6Support (boolean) --

          Indicates whether IPv6 is supported.

ListAttachments (updated) Link ¶
Changes (request, response)
Request 
{'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}
Response 
{'Attachments': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}

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'|'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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    '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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

    • NextToken (string) --

      The token for the next page of results.

RejectAttachment (updated) Link ¶
Changes (response) 
{'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}

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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
        'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
        'EdgeLocation': 'string',
        'ResourceArn': 'string',
        'AttachmentPolicyRuleNumber': 123,
        'SegmentName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ProposedSegmentChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

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.

      • ResourceArn (string) --

        The attachment resource ARN.

      • AttachmentPolicyRuleNumber (integer) --

        The policy rule number associated with the attachment.

      • SegmentName (string) --

        The name of the segment attachment.

      • Tags (list) --

        The tags associated with the attachment.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Constraints: Maximum length of 256 characters.

      • ProposedSegmentChange (dict) --

        The attachment to move from one segment to another.

        • Tags (list) --

          The list of key-value tags that changed for the segment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • AttachmentPolicyRuleNumber (integer) --

          The rule number in the policy document that applies to this change.

        • SegmentName (string) --

          The name of the segment to change.

      • CreatedAt (datetime) --

        The timestamp when the attachment was created.

      • UpdatedAt (datetime) --

        The timestamp when the attachment was last updated.

UpdateVpcAttachment (updated) Link ¶
Changes (response) 
{'VpcAttachment': {'Attachment': {'AttachmentType': {'TRANSIT_GATEWAY_ROUTE_TABLE'}}}}

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
    }
)
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.

rtype

dict

returns

Response Syntax

{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': 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.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • SubnetArns (list) --

        The subnet ARNs.

        • (string) --

      • Options (dict) --

        Provides details about the VPC attachment.

        • Ipv6Support (boolean) --

          Indicates whether IPv6 is supported.