NetworkManager

Client

class NetworkManager.Client

A low-level client representing AWS Network Manager (NetworkManager)

Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your Amazon Web Services and on-premises networks that are built around transit gateways.

client = session.create_client('networkmanager')

These are the available methods:

accept_attachment(**kwargs)

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

response = client.accept_attachment(
    AttachmentId='string'
)
Parameters
AttachmentId (string) --

[REQUIRED]

The ID of the attachment.

Return type
dict
Returns
Response Syntax
{
    'Attachment': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'AttachmentId': 'string',
        'OwnerAccountId': 'string',
        'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
        '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) --

        A core network ID.

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

Exceptions

associate_connect_peer(**kwargs)

Associates a core network Connect peer with a device and optionally, with a link.

If you specify a link, it must be associated with the specified device. You can only associate core network Connect peers that have been created on a core network Connect attachment on a core network.

See also: AWS API Documentation

Request Syntax

response = client.associate_connect_peer(
    GlobalNetworkId='string',
    ConnectPeerId='string',
    DeviceId='string',
    LinkId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of your global network.

  • ConnectPeerId (string) --

    [REQUIRED]

    The ID of the Connect peer.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the device.

  • LinkId (string) -- The ID of the link.
Return type

dict

Returns

Response Syntax

{
    'ConnectPeerAssociation': {
        'ConnectPeerId': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • ConnectPeerAssociation (dict) --

      The response to the Connect peer request.

      • ConnectPeerId (string) --

        The ID of the Connect peer.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device to connect to.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The state of the Connect peer association.

Exceptions

associate_customer_gateway(**kwargs)

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id .

You cannot associate a customer gateway with more than one device and link.

See also: AWS API Documentation

Request Syntax

response = client.associate_customer_gateway(
    CustomerGatewayArn='string',
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string'
)
Parameters
  • CustomerGatewayArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the customer gateway.

  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the device.

  • LinkId (string) -- The ID of the link.
Return type

dict

Returns

Response Syntax

{
    'CustomerGatewayAssociation': {
        'CustomerGatewayArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • CustomerGatewayAssociation (dict) --

      The customer gateway association.

      • CustomerGatewayArn (string) --

        The Amazon Resource Name (ARN) of the customer gateway.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The association state.

Exceptions

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

See also: AWS API Documentation

Request Syntax

response = client.associate_link(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the device.

  • LinkId (string) --

    [REQUIRED]

    The ID of the link.

Return type

dict

Returns

Response Syntax

{
    'LinkAssociation': {
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • LinkAssociation (dict) --

      The link association.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The device ID for the link association.

      • LinkId (string) --

        The ID of the link.

      • LinkAssociationState (string) --

        The state of the association.

Exceptions

associate_transit_gateway_connect_peer(**kwargs)

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

See also: AWS API Documentation

Request Syntax

response = client.associate_transit_gateway_connect_peer(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArn='string',
    DeviceId='string',
    LinkId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayConnectPeerArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Connect peer.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the device.

  • LinkId (string) -- The ID of the link.
Return type

dict

Returns

Response Syntax

{
    'TransitGatewayConnectPeerAssociation': {
        'TransitGatewayConnectPeerArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • TransitGatewayConnectPeerAssociation (dict) --

      The transit gateway Connect peer association.

      • TransitGatewayConnectPeerArn (string) --

        The Amazon Resource Name (ARN) of the transit gateway Connect peer.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The state of the association.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_connect_attachment(**kwargs)

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

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

    [REQUIRED]

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

  • EdgeLocation (string) --

    [REQUIRED]

    The Region where the edge is located.

  • TransportAttachmentId (string) --

    [REQUIRED]

    The ID of the attachment between the two connections.

  • Options (dict) --

    [REQUIRED]

    Options for creating an attachment.

    • Protocol (string) --

      The protocol used for the attachment connection.

  • Tags (list) --

    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.

  • ClientToken (string) --

    The client token associated with the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ConnectAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

create_connect_peer(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of the connection attachment.

  • CoreNetworkAddress (string) -- A Connect peer core network address.
  • PeerAddress (string) --

    [REQUIRED]

    The Connect peer address.

  • BgpOptions (dict) --

    The Connect peer BGP options.

    • PeerAsn (integer) --

      The Peer ASN of the BGP.

  • InsideCidrBlocks (list) --

    [REQUIRED]

    The inside IP addresses used for BGP peering.

    • (string) --
  • Tags (list) --

    The tags associated with the peer request.

    • (dict) --

      Describes a tag.

      • Key (string) --

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value (string) --

        The tag value.

        Constraints: Maximum length of 256 characters.

  • ClientToken (string) --

    The client token associated with the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • ConnectPeer (dict) --

      The response to the request.

      • CoreNetworkId (string) --

        The ID of a core network.

      • ConnectAttachmentId (string) --

        The ID of the attachment to connect.

      • ConnectPeerId (string) --

        The ID of the Connect peer.

      • EdgeLocation (string) --

        The Connect peer Regions where edges are located.

      • State (string) --

        The state of the Connect peer.

      • CreatedAt (datetime) --

        The timestamp when the Connect peer was created.

      • Configuration (dict) --

        The configuration of the Connect peer.

        • CoreNetworkAddress (string) --

          The IP address of a core network.

        • PeerAddress (string) --

          The IP address of the Connect peer.

        • InsideCidrBlocks (list) --

          The inside IP addresses used for a Connect peer configuration.

          • (string) --
        • Protocol (string) --

          The protocol used for a Connect peer configuration.

        • BgpConfigurations (list) --

          The Connect peer BGP configurations.

          • (dict) --

            Describes a core network BGP configuration.

            • CoreNetworkAsn (integer) --

              The ASN of the Coret Network.

            • PeerAsn (integer) --

              The ASN of the Connect peer.

            • CoreNetworkAddress (string) --

              The address of a core network.

            • PeerAddress (string) --

              The address of a core network Connect peer.

      • Tags (list) --

        The tags associated with the Connect peer.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Constraints: Maximum length of 256 characters.

Exceptions

create_connection(**kwargs)

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

See also: AWS API Documentation

Request Syntax

response = client.create_connection(
    GlobalNetworkId='string',
    DeviceId='string',
    ConnectedDeviceId='string',
    LinkId='string',
    ConnectedLinkId='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the first device in the connection.

  • ConnectedDeviceId (string) --

    [REQUIRED]

    The ID of the second device in the connection.

  • LinkId (string) -- The ID of the link for the first device.
  • ConnectedLinkId (string) -- The ID of the link for the second device.
  • Description (string) --

    A description of the connection.

    Length Constraints: Maximum length of 256 characters.

  • Tags (list) --

    The tags to apply to the resource 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.

Return type

dict

Returns

Response Syntax

{
    'Connection': {
        'ConnectionId': 'string',
        'ConnectionArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'ConnectedDeviceId': 'string',
        'LinkId': 'string',
        'ConnectedLinkId': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Connection (dict) --

      Information about the connection.

      • ConnectionId (string) --

        The ID of the connection.

      • ConnectionArn (string) --

        The Amazon Resource Name (ARN) of the connection.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the first device in the connection.

      • ConnectedDeviceId (string) --

        The ID of the second device in the connection.

      • LinkId (string) --

        The ID of the link for the first device in the connection.

      • ConnectedLinkId (string) --

        The ID of the link for the second device in the connection.

      • Description (string) --

        The description of the connection.

      • CreatedAt (datetime) --

        The date and time that the connection was created.

      • State (string) --

        The state of the connection.

      • Tags (list) --

        The tags for the connection.

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

Exceptions

create_core_network(**kwargs)

Creates a core network as part of your global network, and optionally, with a core network policy.

See also: AWS API Documentation

Request Syntax

response = client.create_core_network(
    GlobalNetworkId='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    PolicyDocument='string',
    ClientToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network that a core network will be a part of.

  • Description (string) -- The description of a core network.
  • Tags (list) --

    Key-value tags associated with a core network 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.

  • PolicyDocument (string) -- The policy document for creating a core network.
  • ClientToken (string) --

    The client token associated with a core network request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'CoreNetwork': {
        'GlobalNetworkId': 'string',
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
        'Segments': [
            {
                'Name': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ]
            },
        ],
        'Edges': [
            {
                'EdgeLocation': 'string',
                'Asn': 123,
                'InsideCidrBlocks': [
                    'string',
                ]
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • CoreNetwork (dict) --

      Returns details about a core network.

      • GlobalNetworkId (string) --

        The ID of the global network that your core network is a part of.

      • CoreNetworkId (string) --

        The ID of a core network.

      • CoreNetworkArn (string) --

        The ARN of a core network.

      • Description (string) --

        The description of a core network.

      • CreatedAt (datetime) --

        The timestamp when a core network was created.

      • State (string) --

        The current state of a core network.

      • Segments (list) --

        The segments within a core network.

        • (dict) --

          Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

          • Name (string) --

            The name of a core network segment.

          • EdgeLocations (list) --

            The Regions where the edges are located.

            • (string) --
          • SharedSegments (list) --

            The shared segments of a core network.

            • (string) --
      • Edges (list) --

        The edges within a core network.

        • (dict) --

          Describes a core network edge.

          • EdgeLocation (string) --

            The Region where a core network edge is located.

          • Asn (integer) --

            The ASN of a core network edge.

          • InsideCidrBlocks (list) --

            The inside IP addresses used for core network edges.

            • (string) --
      • Tags (list) --

        The tags associated with a core network.

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

Exceptions

create_device(**kwargs)

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

See also: AWS API Documentation

Request Syntax

response = client.create_device(
    GlobalNetworkId='string',
    AWSLocation={
        'Zone': 'string',
        'SubnetArn': 'string'
    },
    Description='string',
    Type='string',
    Vendor='string',
    Model='string',
    SerialNumber='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    },
    SiteId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • AWSLocation (dict) --

    The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

    • Zone (string) --

      The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

    • SubnetArn (string) --

      The Amazon Resource Name (ARN) of the subnet that the device is located in.

  • Description (string) --

    A description of the device.

    Constraints: Maximum length of 256 characters.

  • Type (string) -- The type of the device.
  • Vendor (string) --

    The vendor of the device.

    Constraints: Maximum length of 128 characters.

  • Model (string) --

    The model of the device.

    Constraints: Maximum length of 128 characters.

  • SerialNumber (string) --

    The serial number of the device.

    Constraints: Maximum length of 128 characters.

  • Location (dict) --

    The location of the device.

    • Address (string) --

      The physical address.

    • Latitude (string) --

      The latitude.

    • Longitude (string) --

      The longitude.

  • SiteId (string) -- The ID of the site.
  • Tags (list) --

    The tags to apply to the resource 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.

Return type

dict

Returns

Response Syntax

{
    'Device': {
        'DeviceId': 'string',
        'DeviceArn': 'string',
        'GlobalNetworkId': 'string',
        'AWSLocation': {
            'Zone': 'string',
            'SubnetArn': 'string'
        },
        'Description': 'string',
        'Type': 'string',
        'Vendor': 'string',
        'Model': 'string',
        'SerialNumber': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'SiteId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Device (dict) --

      Information about the device.

      • DeviceId (string) --

        The ID of the device.

      • DeviceArn (string) --

        The Amazon Resource Name (ARN) of the device.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • AWSLocation (dict) --

        The Amazon Web Services location of the device.

        • Zone (string) --

          The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

        • SubnetArn (string) --

          The Amazon Resource Name (ARN) of the subnet that the device is located in.

      • Description (string) --

        The description of the device.

      • Type (string) --

        The device type.

      • Vendor (string) --

        The device vendor.

      • Model (string) --

        The device model.

      • SerialNumber (string) --

        The device serial number.

      • Location (dict) --

        The site location.

        • Address (string) --

          The physical address.

        • Latitude (string) --

          The latitude.

        • Longitude (string) --

          The longitude.

      • SiteId (string) --

        The site ID.

      • CreatedAt (datetime) --

        The date and time that the site was created.

      • State (string) --

        The device state.

      • Tags (list) --

        The tags for the device.

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

Exceptions

create_global_network(**kwargs)

Creates a new, empty global network.

See also: AWS API Documentation

Request Syntax

response = client.create_global_network(
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Description (string) --

    A description of the global network.

    Constraints: Maximum length of 256 characters.

  • Tags (list) --

    The tags to apply to the resource 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.

Return type

dict

Returns

Response Syntax

{
    'GlobalNetwork': {
        'GlobalNetworkId': 'string',
        'GlobalNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • GlobalNetwork (dict) --

      Information about the global network object.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • GlobalNetworkArn (string) --

        The Amazon Resource Name (ARN) of the global network.

      • Description (string) --

        The description of the global network.

      • CreatedAt (datetime) --

        The date and time that the global network was created.

      • State (string) --

        The state of the global network.

      • Tags (list) --

        The tags for the global network.

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

Exceptions

Creates a new link for a specified site.

See also: AWS API Documentation

Request Syntax

response = client.create_link(
    GlobalNetworkId='string',
    Description='string',
    Type='string',
    Bandwidth={
        'UploadSpeed': 123,
        'DownloadSpeed': 123
    },
    Provider='string',
    SiteId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • Description (string) --

    A description of the link.

    Constraints: Maximum length of 256 characters.

  • Type (string) --

    The type of the link.

    Constraints: Maximum length of 128 characters. Cannot include the following characters: | ^

  • Bandwidth (dict) --

    [REQUIRED]

    The upload speed and download speed in Mbps.

    • UploadSpeed (integer) --

      Upload speed in Mbps.

    • DownloadSpeed (integer) --

      Download speed in Mbps.

  • Provider (string) --

    The provider of the link.

    Constraints: Maximum length of 128 characters. Cannot include the following characters: | ^

  • SiteId (string) --

    [REQUIRED]

    The ID of the site.

  • Tags (list) --

    The tags to apply to the resource 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.

Return type

dict

Returns

Response Syntax

{
    'Link': {
        'LinkId': 'string',
        'LinkArn': 'string',
        'GlobalNetworkId': 'string',
        'SiteId': 'string',
        'Description': 'string',
        'Type': 'string',
        'Bandwidth': {
            'UploadSpeed': 123,
            'DownloadSpeed': 123
        },
        'Provider': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Link (dict) --

      Information about the link.

      • LinkId (string) --

        The ID of the link.

      • LinkArn (string) --

        The Amazon Resource Name (ARN) of the link.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • SiteId (string) --

        The ID of the site.

      • Description (string) --

        The description of the link.

      • Type (string) --

        The type of the link.

      • Bandwidth (dict) --

        The bandwidth for the link.

        • UploadSpeed (integer) --

          Upload speed in Mbps.

        • DownloadSpeed (integer) --

          Download speed in Mbps.

      • Provider (string) --

        The provider of the link.

      • CreatedAt (datetime) --

        The date and time that the link was created.

      • State (string) --

        The state of the link.

      • Tags (list) --

        The tags for the link.

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

Exceptions

create_site(**kwargs)

Creates a new site in a global network.

See also: AWS API Documentation

Request Syntax

response = client.create_site(
    GlobalNetworkId='string',
    Description='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • Description (string) --

    A description of your site.

    Constraints: Maximum length of 256 characters.

  • Location (dict) --

    The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

    • Address : The physical address of the site.
    • Latitude : The latitude of the site.
    • Longitude : The longitude of the site.
    • Address (string) --

      The physical address.

    • Latitude (string) --

      The latitude.

    • Longitude (string) --

      The longitude.

  • Tags (list) --

    The tags to apply to the resource 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.

Return type

dict

Returns

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'SiteArn': 'string',
        'GlobalNetworkId': 'string',
        'Description': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Site (dict) --

      Information about the site.

      • SiteId (string) --

        The ID of the site.

      • SiteArn (string) --

        The Amazon Resource Name (ARN) of the site.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • Description (string) --

        The description of the site.

      • Location (dict) --

        The location of the site.

        • Address (string) --

          The physical address.

        • Latitude (string) --

          The latitude.

        • Longitude (string) --

          The longitude.

      • CreatedAt (datetime) --

        The date and time that the site was created.

      • State (string) --

        The state of the site.

      • Tags (list) --

        The tags for the site.

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

Exceptions

create_site_to_site_vpn_attachment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • VpnConnectionArn (string) --

    [REQUIRED]

    The ARN identifying the VPN attachment.

  • Tags (list) --

    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.

  • ClientToken (string) --

    The client token associated with the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'SiteToSiteVpnAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

create_vpc_attachment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of a core network for the VPC attachment.

  • VpcArn (string) --

    [REQUIRED]

    The ARN of the VPC.

  • SubnetArns (list) --

    [REQUIRED]

    The subnet ARN of the VPC attachment.

    • (string) --
  • Options (dict) --

    Options for the VPC attachment.

    • Ipv6Support (boolean) --

      Indicates whether IPv6 is supported.

  • Tags (list) --

    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.

  • ClientToken (string) --

    The client token associated with the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

delete_attachment(**kwargs)

Deletes an attachment. Supports all attachment types.

See also: AWS API Documentation

Request Syntax

response = client.delete_attachment(
    AttachmentId='string'
)
Parameters
AttachmentId (string) --

[REQUIRED]

The ID of the attachment to delete.

Return type
dict
Returns
Response Syntax
{
    'Attachment': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'AttachmentId': 'string',
        'OwnerAccountId': 'string',
        'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
        '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) --

        A core network ID.

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

Exceptions

delete_connect_peer(**kwargs)

Deletes a Connect peer.

See also: AWS API Documentation

Request Syntax

response = client.delete_connect_peer(
    ConnectPeerId='string'
)
Parameters
ConnectPeerId (string) --

[REQUIRED]

The ID of the deleted Connect peer.

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

Response Structure

  • (dict) --
    • ConnectPeer (dict) --

      Information about the deleted Connect peer.

      • CoreNetworkId (string) --

        The ID of a core network.

      • ConnectAttachmentId (string) --

        The ID of the attachment to connect.

      • ConnectPeerId (string) --

        The ID of the Connect peer.

      • EdgeLocation (string) --

        The Connect peer Regions where edges are located.

      • State (string) --

        The state of the Connect peer.

      • CreatedAt (datetime) --

        The timestamp when the Connect peer was created.

      • Configuration (dict) --

        The configuration of the Connect peer.

        • CoreNetworkAddress (string) --

          The IP address of a core network.

        • PeerAddress (string) --

          The IP address of the Connect peer.

        • InsideCidrBlocks (list) --

          The inside IP addresses used for a Connect peer configuration.

          • (string) --
        • Protocol (string) --

          The protocol used for a Connect peer configuration.

        • BgpConfigurations (list) --

          The Connect peer BGP configurations.

          • (dict) --

            Describes a core network BGP configuration.

            • CoreNetworkAsn (integer) --

              The ASN of the Coret Network.

            • PeerAsn (integer) --

              The ASN of the Connect peer.

            • CoreNetworkAddress (string) --

              The address of a core network.

            • PeerAddress (string) --

              The address of a core network Connect peer.

      • Tags (list) --

        The tags associated with the Connect peer.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Constraints: Maximum length of 256 characters.

Exceptions

delete_connection(**kwargs)

Deletes the specified connection in your global network.

See also: AWS API Documentation

Request Syntax

response = client.delete_connection(
    GlobalNetworkId='string',
    ConnectionId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ConnectionId (string) --

    [REQUIRED]

    The ID of the connection.

Return type

dict

Returns

Response Syntax

{
    'Connection': {
        'ConnectionId': 'string',
        'ConnectionArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'ConnectedDeviceId': 'string',
        'LinkId': 'string',
        'ConnectedLinkId': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Connection (dict) --

      Information about the connection.

      • ConnectionId (string) --

        The ID of the connection.

      • ConnectionArn (string) --

        The Amazon Resource Name (ARN) of the connection.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the first device in the connection.

      • ConnectedDeviceId (string) --

        The ID of the second device in the connection.

      • LinkId (string) --

        The ID of the link for the first device in the connection.

      • ConnectedLinkId (string) --

        The ID of the link for the second device in the connection.

      • Description (string) --

        The description of the connection.

      • CreatedAt (datetime) --

        The date and time that the connection was created.

      • State (string) --

        The state of the connection.

      • Tags (list) --

        The tags for the connection.

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

Exceptions

delete_core_network(**kwargs)

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

See also: AWS API Documentation

Request Syntax

response = client.delete_core_network(
    CoreNetworkId='string'
)
Parameters
CoreNetworkId (string) --

[REQUIRED]

The network ID of the deleted core network.

Return type
dict
Returns
Response Syntax
{
    'CoreNetwork': {
        'GlobalNetworkId': 'string',
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
        'Segments': [
            {
                'Name': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ]
            },
        ],
        'Edges': [
            {
                'EdgeLocation': 'string',
                'Asn': 123,
                'InsideCidrBlocks': [
                    'string',
                ]
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • CoreNetwork (dict) --

      Information about the deleted core network.

      • GlobalNetworkId (string) --

        The ID of the global network that your core network is a part of.

      • CoreNetworkId (string) --

        The ID of a core network.

      • CoreNetworkArn (string) --

        The ARN of a core network.

      • Description (string) --

        The description of a core network.

      • CreatedAt (datetime) --

        The timestamp when a core network was created.

      • State (string) --

        The current state of a core network.

      • Segments (list) --

        The segments within a core network.

        • (dict) --

          Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

          • Name (string) --

            The name of a core network segment.

          • EdgeLocations (list) --

            The Regions where the edges are located.

            • (string) --
          • SharedSegments (list) --

            The shared segments of a core network.

            • (string) --
      • Edges (list) --

        The edges within a core network.

        • (dict) --

          Describes a core network edge.

          • EdgeLocation (string) --

            The Region where a core network edge is located.

          • Asn (integer) --

            The ASN of a core network edge.

          • InsideCidrBlocks (list) --

            The inside IP addresses used for core network edges.

            • (string) --
      • Tags (list) --

        The tags associated with a core network.

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

Exceptions

delete_core_network_policy_version(**kwargs)

Deletes a policy version from a core network. You can't delete the current LIVE policy.

See also: AWS API Documentation

Request Syntax

response = client.delete_core_network_policy_version(
    CoreNetworkId='string',
    PolicyVersionId=123
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network for the deleted policy.

  • PolicyVersionId (integer) --

    [REQUIRED]

    The version ID of the deleted policy.

Return type

dict

Returns

Response Syntax

{
    'CoreNetworkPolicy': {
        'CoreNetworkId': 'string',
        'PolicyVersionId': 123,
        'Alias': 'LIVE'|'LATEST',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
        'PolicyErrors': [
            {
                'ErrorCode': 'string',
                'Message': 'string',
                'Path': 'string'
            },
        ],
        'PolicyDocument': 'string'
    }
}

Response Structure

  • (dict) --

    • CoreNetworkPolicy (dict) --

      Returns information about the deleted policy version.

      • CoreNetworkId (string) --

        The ID of a core network.

      • PolicyVersionId (integer) --

        The ID of the policy version.

      • Alias (string) --

        Whether a core network policy is the current LIVE policy or the most recently submitted policy.

      • Description (string) --

        The description of a core network policy.

      • CreatedAt (datetime) --

        The timestamp when a core network policy was created.

      • ChangeSetState (string) --

        The state of a core network policy.

      • PolicyErrors (list) --

        Describes any errors in a core network policy.

        • (dict) --

          Provides details about an error in a core network policy.

          • ErrorCode (string) --

            The error code associated with a core network policy error.

          • Message (string) --

            The message associated with a core network policy error code.

          • Path (string) --

            The JSON path where the error was discovered in the policy document.

      • PolicyDocument (string) --

        Describes a core network policy.

Exceptions

delete_device(**kwargs)

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

See also: AWS API Documentation

Request Syntax

response = client.delete_device(
    GlobalNetworkId='string',
    DeviceId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the device.

Return type

dict

Returns

Response Syntax

{
    'Device': {
        'DeviceId': 'string',
        'DeviceArn': 'string',
        'GlobalNetworkId': 'string',
        'AWSLocation': {
            'Zone': 'string',
            'SubnetArn': 'string'
        },
        'Description': 'string',
        'Type': 'string',
        'Vendor': 'string',
        'Model': 'string',
        'SerialNumber': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'SiteId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Device (dict) --

      Information about the device.

      • DeviceId (string) --

        The ID of the device.

      • DeviceArn (string) --

        The Amazon Resource Name (ARN) of the device.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • AWSLocation (dict) --

        The Amazon Web Services location of the device.

        • Zone (string) --

          The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

        • SubnetArn (string) --

          The Amazon Resource Name (ARN) of the subnet that the device is located in.

      • Description (string) --

        The description of the device.

      • Type (string) --

        The device type.

      • Vendor (string) --

        The device vendor.

      • Model (string) --

        The device model.

      • SerialNumber (string) --

        The device serial number.

      • Location (dict) --

        The site location.

        • Address (string) --

          The physical address.

        • Latitude (string) --

          The latitude.

        • Longitude (string) --

          The longitude.

      • SiteId (string) --

        The site ID.

      • CreatedAt (datetime) --

        The date and time that the site was created.

      • State (string) --

        The device state.

      • Tags (list) --

        The tags for the device.

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

Exceptions

delete_global_network(**kwargs)

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.

See also: AWS API Documentation

Request Syntax

response = client.delete_global_network(
    GlobalNetworkId='string'
)
Parameters
GlobalNetworkId (string) --

[REQUIRED]

The ID of the global network.

Return type
dict
Returns
Response Syntax
{
    'GlobalNetwork': {
        'GlobalNetworkId': 'string',
        'GlobalNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • GlobalNetwork (dict) --

      Information about the global network.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • GlobalNetworkArn (string) --

        The Amazon Resource Name (ARN) of the global network.

      • Description (string) --

        The description of the global network.

      • CreatedAt (datetime) --

        The date and time that the global network was created.

      • State (string) --

        The state of the global network.

      • Tags (list) --

        The tags for the global network.

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

Exceptions

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

See also: AWS API Documentation

Request Syntax

response = client.delete_link(
    GlobalNetworkId='string',
    LinkId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • LinkId (string) --

    [REQUIRED]

    The ID of the link.

Return type

dict

Returns

Response Syntax

{
    'Link': {
        'LinkId': 'string',
        'LinkArn': 'string',
        'GlobalNetworkId': 'string',
        'SiteId': 'string',
        'Description': 'string',
        'Type': 'string',
        'Bandwidth': {
            'UploadSpeed': 123,
            'DownloadSpeed': 123
        },
        'Provider': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Link (dict) --

      Information about the link.

      • LinkId (string) --

        The ID of the link.

      • LinkArn (string) --

        The Amazon Resource Name (ARN) of the link.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • SiteId (string) --

        The ID of the site.

      • Description (string) --

        The description of the link.

      • Type (string) --

        The type of the link.

      • Bandwidth (dict) --

        The bandwidth for the link.

        • UploadSpeed (integer) --

          Upload speed in Mbps.

        • DownloadSpeed (integer) --

          Download speed in Mbps.

      • Provider (string) --

        The provider of the link.

      • CreatedAt (datetime) --

        The date and time that the link was created.

      • State (string) --

        The state of the link.

      • Tags (list) --

        The tags for the link.

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

Exceptions

delete_resource_policy(**kwargs)

Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_policy(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The ARN of the policy to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_site(**kwargs)

Deletes an existing site. The site cannot be associated with any device or link.

See also: AWS API Documentation

Request Syntax

response = client.delete_site(
    GlobalNetworkId='string',
    SiteId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • SiteId (string) --

    [REQUIRED]

    The ID of the site.

Return type

dict

Returns

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'SiteArn': 'string',
        'GlobalNetworkId': 'string',
        'Description': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Site (dict) --

      Information about the site.

      • SiteId (string) --

        The ID of the site.

      • SiteArn (string) --

        The Amazon Resource Name (ARN) of the site.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • Description (string) --

        The description of the site.

      • Location (dict) --

        The location of the site.

        • Address (string) --

          The physical address.

        • Latitude (string) --

          The latitude.

        • Longitude (string) --

          The longitude.

      • CreatedAt (datetime) --

        The date and time that the site was created.

      • State (string) --

        The state of the site.

      • Tags (list) --

        The tags for the site.

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

Exceptions

deregister_transit_gateway(**kwargs)

Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

See also: AWS API Documentation

Request Syntax

response = client.deregister_transit_gateway(
    GlobalNetworkId='string',
    TransitGatewayArn='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the transit gateway.

Return type

dict

Returns

Response Syntax

{
    'TransitGatewayRegistration': {
        'GlobalNetworkId': 'string',
        'TransitGatewayArn': 'string',
        'State': {
            'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
            'Message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • TransitGatewayRegistration (dict) --

      The transit gateway registration information.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • TransitGatewayArn (string) --

        The Amazon Resource Name (ARN) of the transit gateway.

      • State (dict) --

        The state of the transit gateway registration.

        • Code (string) --

          The code for the state reason.

        • Message (string) --

          The message for the state reason.

Exceptions

describe_global_networks(**kwargs)

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations .

See also: AWS API Documentation

Request Syntax

response = client.describe_global_networks(
    GlobalNetworkIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkIds (list) --

    The IDs of one or more global networks. The maximum is 10.

    • (string) --
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'GlobalNetworks': [
        {
            'GlobalNetworkId': 'string',
            'GlobalNetworkArn': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • GlobalNetworks (list) --

      Information about the global networks.

      • (dict) --

        Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-manged Core Network.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • GlobalNetworkArn (string) --

          The Amazon Resource Name (ARN) of the global network.

        • Description (string) --

          The description of the global network.

        • CreatedAt (datetime) --

          The date and time that the global network was created.

        • State (string) --

          The state of the global network.

        • Tags (list) --

          The tags for the global network.

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

    • NextToken (string) --

      The token for the next page of results.

Exceptions

disassociate_connect_peer(**kwargs)

Disassociates a core network Connect peer from a device and a link.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_connect_peer(
    GlobalNetworkId='string',
    ConnectPeerId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ConnectPeerId (string) --

    [REQUIRED]

    The ID of the Connect peer to disassociate from a device.

Return type

dict

Returns

Response Syntax

{
    'ConnectPeerAssociation': {
        'ConnectPeerId': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • ConnectPeerAssociation (dict) --

      Describes the Connect peer association.

      • ConnectPeerId (string) --

        The ID of the Connect peer.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device to connect to.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The state of the Connect peer association.

Exceptions

disassociate_customer_gateway(**kwargs)

Disassociates a customer gateway from a device and a link.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_customer_gateway(
    GlobalNetworkId='string',
    CustomerGatewayArn='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CustomerGatewayArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the customer gateway.

Return type

dict

Returns

Response Syntax

{
    'CustomerGatewayAssociation': {
        'CustomerGatewayArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • CustomerGatewayAssociation (dict) --

      Information about the customer gateway association.

      • CustomerGatewayArn (string) --

        The Amazon Resource Name (ARN) of the customer gateway.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The association state.

Exceptions

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_link(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the device.

  • LinkId (string) --

    [REQUIRED]

    The ID of the link.

Return type

dict

Returns

Response Syntax

{
    'LinkAssociation': {
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • LinkAssociation (dict) --

      Information about the link association.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The device ID for the link association.

      • LinkId (string) --

        The ID of the link.

      • LinkAssociationState (string) --

        The state of the association.

Exceptions

disassociate_transit_gateway_connect_peer(**kwargs)

Disassociates a transit gateway Connect peer from a device and link.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_transit_gateway_connect_peer(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArn='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayConnectPeerArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the transit gateway Connect peer.

Return type

dict

Returns

Response Syntax

{
    'TransitGatewayConnectPeerAssociation': {
        'TransitGatewayConnectPeerArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • TransitGatewayConnectPeerAssociation (dict) --

      The transit gateway Connect peer association.

      • TransitGatewayConnectPeerArn (string) --

        The Amazon Resource Name (ARN) of the transit gateway Connect peer.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The state of the association.

Exceptions

execute_core_network_change_set(**kwargs)

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

See also: AWS API Documentation

Request Syntax

response = client.execute_core_network_change_set(
    CoreNetworkId='string',
    PolicyVersionId=123
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • PolicyVersionId (integer) --

    [REQUIRED]

    The ID of the policy version.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

get_connect_attachment(**kwargs)

Returns information about a core network Connect attachment.

See also: AWS API Documentation

Request Syntax

response = client.get_connect_attachment(
    AttachmentId='string'
)
Parameters
AttachmentId (string) --

[REQUIRED]

The ID of the attachment.

Return type
dict
Returns
Response Syntax
{
    'ConnectAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

get_connect_peer(**kwargs)

Returns information about a core network Connect peer.

See also: AWS API Documentation

Request Syntax

response = client.get_connect_peer(
    ConnectPeerId='string'
)
Parameters
ConnectPeerId (string) --

[REQUIRED]

The ID of the Connect peer.

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

Response Structure

  • (dict) --
    • ConnectPeer (dict) --

      Returns information about a core network Connect peer.

      • CoreNetworkId (string) --

        The ID of a core network.

      • ConnectAttachmentId (string) --

        The ID of the attachment to connect.

      • ConnectPeerId (string) --

        The ID of the Connect peer.

      • EdgeLocation (string) --

        The Connect peer Regions where edges are located.

      • State (string) --

        The state of the Connect peer.

      • CreatedAt (datetime) --

        The timestamp when the Connect peer was created.

      • Configuration (dict) --

        The configuration of the Connect peer.

        • CoreNetworkAddress (string) --

          The IP address of a core network.

        • PeerAddress (string) --

          The IP address of the Connect peer.

        • InsideCidrBlocks (list) --

          The inside IP addresses used for a Connect peer configuration.

          • (string) --
        • Protocol (string) --

          The protocol used for a Connect peer configuration.

        • BgpConfigurations (list) --

          The Connect peer BGP configurations.

          • (dict) --

            Describes a core network BGP configuration.

            • CoreNetworkAsn (integer) --

              The ASN of the Coret Network.

            • PeerAsn (integer) --

              The ASN of the Connect peer.

            • CoreNetworkAddress (string) --

              The address of a core network.

            • PeerAddress (string) --

              The address of a core network Connect peer.

      • Tags (list) --

        The tags associated with the Connect peer.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Constraints: Maximum length of 256 characters.

Exceptions

get_connect_peer_associations(**kwargs)

Returns information about a core network Connect peer associations.

See also: AWS API Documentation

Request Syntax

response = client.get_connect_peer_associations(
    GlobalNetworkId='string',
    ConnectPeerIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ConnectPeerIds (list) --

    The IDs of the Connect peers.

    • (string) --
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'ConnectPeerAssociations': [
        {
            'ConnectPeerId': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ConnectPeerAssociations (list) --

      Displays a list of Connect peer associations.

      • (dict) --

        Describes a core network Connect peer association.

        • ConnectPeerId (string) --

          The ID of the Connect peer.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the device to connect to.

        • LinkId (string) --

          The ID of the link.

        • State (string) --

          The state of the Connect peer association.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_connections(**kwargs)

Gets information about one or more of your connections in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_connections(
    GlobalNetworkId='string',
    ConnectionIds=[
        'string',
    ],
    DeviceId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ConnectionIds (list) --

    One or more connection IDs.

    • (string) --
  • DeviceId (string) -- The ID of the device.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Connections': [
        {
            'ConnectionId': 'string',
            'ConnectionArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'ConnectedDeviceId': 'string',
            'LinkId': 'string',
            'ConnectedLinkId': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Connections (list) --

      Information about the connections.

      • (dict) --

        Describes a connection.

        • ConnectionId (string) --

          The ID of the connection.

        • ConnectionArn (string) --

          The Amazon Resource Name (ARN) of the connection.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the first device in the connection.

        • ConnectedDeviceId (string) --

          The ID of the second device in the connection.

        • LinkId (string) --

          The ID of the link for the first device in the connection.

        • ConnectedLinkId (string) --

          The ID of the link for the second device in the connection.

        • Description (string) --

          The description of the connection.

        • CreatedAt (datetime) --

          The date and time that the connection was created.

        • State (string) --

          The state of the connection.

        • Tags (list) --

          The tags for the connection.

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

    • NextToken (string) --

      The token to use for the next page of results.

Exceptions

get_core_network(**kwargs)

Returns information about a core network. By default it returns the LIVE policy.

See also: AWS API Documentation

Request Syntax

response = client.get_core_network(
    CoreNetworkId='string'
)
Parameters
CoreNetworkId (string) --

[REQUIRED]

The ID of a core network.

Return type
dict
Returns
Response Syntax
{
    'CoreNetwork': {
        'GlobalNetworkId': 'string',
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
        'Segments': [
            {
                'Name': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ]
            },
        ],
        'Edges': [
            {
                'EdgeLocation': 'string',
                'Asn': 123,
                'InsideCidrBlocks': [
                    'string',
                ]
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • CoreNetwork (dict) --

      Details about a core network.

      • GlobalNetworkId (string) --

        The ID of the global network that your core network is a part of.

      • CoreNetworkId (string) --

        The ID of a core network.

      • CoreNetworkArn (string) --

        The ARN of a core network.

      • Description (string) --

        The description of a core network.

      • CreatedAt (datetime) --

        The timestamp when a core network was created.

      • State (string) --

        The current state of a core network.

      • Segments (list) --

        The segments within a core network.

        • (dict) --

          Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

          • Name (string) --

            The name of a core network segment.

          • EdgeLocations (list) --

            The Regions where the edges are located.

            • (string) --
          • SharedSegments (list) --

            The shared segments of a core network.

            • (string) --
      • Edges (list) --

        The edges within a core network.

        • (dict) --

          Describes a core network edge.

          • EdgeLocation (string) --

            The Region where a core network edge is located.

          • Asn (integer) --

            The ASN of a core network edge.

          • InsideCidrBlocks (list) --

            The inside IP addresses used for core network edges.

            • (string) --
      • Tags (list) --

        The tags associated with a core network.

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

Exceptions

get_core_network_change_set(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_core_network_change_set(
    CoreNetworkId='string',
    PolicyVersionId=123,
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • PolicyVersionId (integer) --

    [REQUIRED]

    The ID of the policy version.

  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'CoreNetworkChanges': [
        {
            'Type': 'CORE_NETWORK_SEGMENT'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC',
            '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',
                ]
            }
        },
    ],
    '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) --
    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_core_network_policy(**kwargs)

Gets details about a core network policy. You can get details about your current live policy or any previous policy version.

See also: AWS API Documentation

Request Syntax

response = client.get_core_network_policy(
    CoreNetworkId='string',
    PolicyVersionId=123,
    Alias='LIVE'|'LATEST'
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • PolicyVersionId (integer) -- The ID of a core network policy version.
  • Alias (string) -- The alias of a core network policy
Return type

dict

Returns

Response Syntax

{
    'CoreNetworkPolicy': {
        'CoreNetworkId': 'string',
        'PolicyVersionId': 123,
        'Alias': 'LIVE'|'LATEST',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
        'PolicyErrors': [
            {
                'ErrorCode': 'string',
                'Message': 'string',
                'Path': 'string'
            },
        ],
        'PolicyDocument': 'string'
    }
}

Response Structure

  • (dict) --

    • CoreNetworkPolicy (dict) --

      The details about a core network policy.

      • CoreNetworkId (string) --

        The ID of a core network.

      • PolicyVersionId (integer) --

        The ID of the policy version.

      • Alias (string) --

        Whether a core network policy is the current LIVE policy or the most recently submitted policy.

      • Description (string) --

        The description of a core network policy.

      • CreatedAt (datetime) --

        The timestamp when a core network policy was created.

      • ChangeSetState (string) --

        The state of a core network policy.

      • PolicyErrors (list) --

        Describes any errors in a core network policy.

        • (dict) --

          Provides details about an error in a core network policy.

          • ErrorCode (string) --

            The error code associated with a core network policy error.

          • Message (string) --

            The message associated with a core network policy error code.

          • Path (string) --

            The JSON path where the error was discovered in the policy document.

      • PolicyDocument (string) --

        Describes a core network policy.

Exceptions

get_customer_gateway_associations(**kwargs)

Gets the association information for customer gateways that are associated with devices and links in your global network.

See also: AWS API Documentation

Request Syntax

response = client.get_customer_gateway_associations(
    GlobalNetworkId='string',
    CustomerGatewayArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CustomerGatewayArns (list) --

    One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

    • (string) --
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'CustomerGatewayAssociations': [
        {
            'CustomerGatewayArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CustomerGatewayAssociations (list) --

      The customer gateway associations.

      • (dict) --

        Describes the association between a customer gateway, a device, and a link.

        • CustomerGatewayArn (string) --

          The Amazon Resource Name (ARN) of the customer gateway.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the device.

        • LinkId (string) --

          The ID of the link.

        • State (string) --

          The association state.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_devices(**kwargs)

Gets information about one or more of your devices in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_devices(
    GlobalNetworkId='string',
    DeviceIds=[
        'string',
    ],
    SiteId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceIds (list) --

    One or more device IDs. The maximum is 10.

    • (string) --
  • SiteId (string) -- The ID of the site.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Devices': [
        {
            'DeviceId': 'string',
            'DeviceArn': 'string',
            'GlobalNetworkId': 'string',
            'AWSLocation': {
                'Zone': 'string',
                'SubnetArn': 'string'
            },
            'Description': 'string',
            'Type': 'string',
            'Vendor': 'string',
            'Model': 'string',
            'SerialNumber': 'string',
            'Location': {
                'Address': 'string',
                'Latitude': 'string',
                'Longitude': 'string'
            },
            'SiteId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Devices (list) --

      The devices.

      • (dict) --

        Describes a device.

        • DeviceId (string) --

          The ID of the device.

        • DeviceArn (string) --

          The Amazon Resource Name (ARN) of the device.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • AWSLocation (dict) --

          The Amazon Web Services location of the device.

          • Zone (string) --

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn (string) --

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

        • Description (string) --

          The description of the device.

        • Type (string) --

          The device type.

        • Vendor (string) --

          The device vendor.

        • Model (string) --

          The device model.

        • SerialNumber (string) --

          The device serial number.

        • Location (dict) --

          The site location.

          • Address (string) --

            The physical address.

          • Latitude (string) --

            The latitude.

          • Longitude (string) --

            The longitude.

        • SiteId (string) --

          The site ID.

        • CreatedAt (datetime) --

          The date and time that the site was created.

        • State (string) --

          The device state.

        • Tags (list) --

          The tags for the device.

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

    • NextToken (string) --

      The token for the next page of results.

Exceptions

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

See also: AWS API Documentation

Request Syntax

response = client.get_link_associations(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) -- The ID of the device.
  • LinkId (string) -- The ID of the link.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'LinkAssociations': [
        {
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LinkAssociations (list) --

      The link associations.

      • (dict) --

        Describes the association between a device and a link.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The device ID for the link association.

        • LinkId (string) --

          The ID of the link.

        • LinkAssociationState (string) --

          The state of the association.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

See also: AWS API Documentation

Request Syntax

response = client.get_links(
    GlobalNetworkId='string',
    LinkIds=[
        'string',
    ],
    SiteId='string',
    Type='string',
    Provider='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • LinkIds (list) --

    One or more link IDs. The maximum is 10.

    • (string) --
  • SiteId (string) -- The ID of the site.
  • Type (string) -- The link type.
  • Provider (string) -- The link provider.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Links': [
        {
            'LinkId': 'string',
            'LinkArn': 'string',
            'GlobalNetworkId': 'string',
            'SiteId': 'string',
            'Description': 'string',
            'Type': 'string',
            'Bandwidth': {
                'UploadSpeed': 123,
                'DownloadSpeed': 123
            },
            'Provider': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Links (list) --

      The links.

      • (dict) --

        Describes a link.

        • LinkId (string) --

          The ID of the link.

        • LinkArn (string) --

          The Amazon Resource Name (ARN) of the link.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • SiteId (string) --

          The ID of the site.

        • Description (string) --

          The description of the link.

        • Type (string) --

          The type of the link.

        • Bandwidth (dict) --

          The bandwidth for the link.

          • UploadSpeed (integer) --

            Upload speed in Mbps.

          • DownloadSpeed (integer) --

            Download speed in Mbps.

        • Provider (string) --

          The provider of the link.

        • CreatedAt (datetime) --

          The date and time that the link was created.

        • State (string) --

          The state of the link.

        • Tags (list) --

          The tags for the link.

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

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_network_resource_counts(**kwargs)

Gets the count of network resources, by resource type, for the specified global network.

See also: AWS API Documentation

Request Syntax

response = client.get_network_resource_counts(
    GlobalNetworkId='string',
    ResourceType='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon
    • dx-gateway
    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection
    • device
    • link
    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway
    • transit-gateway
    • transit-gateway-attachment
    • transit-gateway-connect-peer
    • transit-gateway-route-table
    • vpn-connection
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'NetworkResourceCounts': [
        {
            'ResourceType': 'string',
            'Count': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • NetworkResourceCounts (list) --

      The count of resources.

      • (dict) --

        Describes a resource count.

        • ResourceType (string) --

          The resource type.

        • Count (integer) --

          The resource count.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_network_resource_relationships(**kwargs)

Gets the network resource relationships for the specified global network.

See also: AWS API Documentation

Request Syntax

response = client.get_network_resource_relationships(
    GlobalNetworkId='string',
    CoreNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CoreNetworkId (string) -- The ID of a core network.
  • RegisteredGatewayArn (string) -- The ARN of the registered gateway.
  • AwsRegion (string) -- The Amazon Web Services Region.
  • AccountId (string) -- The Amazon Web Services account ID.
  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon
    • dx-gateway
    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection
    • device
    • link
    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway
    • transit-gateway
    • transit-gateway-attachment
    • transit-gateway-connect-peer
    • transit-gateway-route-table
    • vpn-connection
  • ResourceArn (string) -- The ARN of the gateway.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Relationships': [
        {
            'From': 'string',
            'To': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Relationships (list) --

      The resource relationships.

      • (dict) --

        Describes a resource relationship.

        • From (string) --

          The ARN of the resource.

        • To (string) --

          The ARN of the resource.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_network_resources(**kwargs)

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

See also: AWS API Documentation

Request Syntax

response = client.get_network_resources(
    GlobalNetworkId='string',
    CoreNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CoreNetworkId (string) -- The ID of a core network.
  • RegisteredGatewayArn (string) -- The ARN of the gateway.
  • AwsRegion (string) -- The Amazon Web Services Region.
  • AccountId (string) -- The Amazon Web Services account ID.
  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    The following are the supported resource types for Network Manager:

    • connection - The definition model is Connection .
    • device - The definition model is Device .
    • link - The definition model is Link .
    • site - The definition model is Site .

    The following are the supported resource types for Amazon VPC:

  • ResourceArn (string) -- The ARN of the resource.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'NetworkResources': [
        {
            'RegisteredGatewayArn': 'string',
            'CoreNetworkId': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Definition': 'string',
            'DefinitionTimestamp': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Metadata': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • NetworkResources (list) --

      The network resources.

      • (dict) --

        Describes a network resource.

        • RegisteredGatewayArn (string) --

          The ARN of the gateway.

        • CoreNetworkId (string) --

          a core network ID.

        • AwsRegion (string) --

          The Amazon Web Services Region.

        • AccountId (string) --

          The Amazon Web Services account ID.

        • ResourceType (string) --

          The resource type.

          The following are the supported resource types for Direct Connect:

          • dxcon
          • dx-gateway
          • dx-vif

          The following are the supported resource types for Network Manager:

          • connection
          • device
          • link
          • site

          The following are the supported resource types for Amazon VPC:

          • customer-gateway
          • transit-gateway
          • transit-gateway-attachment
          • transit-gateway-connect-peer
          • transit-gateway-route-table
          • vpn-connection
        • ResourceId (string) --

          The ID of the resource.

        • ResourceArn (string) --

          The ARN of the resource.

        • Definition (string) --

          Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

        • DefinitionTimestamp (datetime) --

          The time that the resource definition was retrieved.

        • Tags (list) --

          The tags.

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

        • Metadata (dict) --

          The resource metadata.

          • (string) --
            • (string) --
    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_network_routes(**kwargs)

Gets the network routes of the specified global network.

See also: AWS API Documentation

Request Syntax

response = client.get_network_routes(
    GlobalNetworkId='string',
    RouteTableIdentifier={
        'TransitGatewayRouteTableArn': 'string',
        'CoreNetworkSegmentEdge': {
            'CoreNetworkId': 'string',
            'SegmentName': 'string',
            'EdgeLocation': 'string'
        }
    },
    ExactCidrMatches=[
        'string',
    ],
    LongestPrefixMatches=[
        'string',
    ],
    SubnetOfMatches=[
        'string',
    ],
    SupernetOfMatches=[
        'string',
    ],
    PrefixListIds=[
        'string',
    ],
    States=[
        'ACTIVE'|'BLACKHOLE',
    ],
    Types=[
        'PROPAGATED'|'STATIC',
    ],
    DestinationFilters={
        'string': [
            'string',
        ]
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • RouteTableIdentifier (dict) --

    [REQUIRED]

    The ID of the route table.

    • TransitGatewayRouteTableArn (string) --

      The ARN of the transit gateway route table.

    • CoreNetworkSegmentEdge (dict) --

      The segment edge in a core network.

      • CoreNetworkId (string) --

        The ID of a core network.

      • SegmentName (string) --

        The name of the segment edge.

      • EdgeLocation (string) --

        The Region where the segment edge is located.

  • ExactCidrMatches (list) --

    An exact CIDR block.

    • (string) --
  • LongestPrefixMatches (list) --

    The most specific route that matches the traffic (longest prefix match).

    • (string) --
  • SubnetOfMatches (list) --

    The routes with a subnet that match the specified CIDR filter.

    • (string) --
  • SupernetOfMatches (list) --

    The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

    • (string) --
  • PrefixListIds (list) --

    The IDs of the prefix lists.

    • (string) --
  • States (list) --

    The route states.

    • (string) --
  • Types (list) --

    The route types.

    • (string) --
  • DestinationFilters (dict) --

    Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

    • (string) --
      • (list) --
        • (string) --
Return type

dict

Returns

Response Syntax

{
    'RouteTableArn': 'string',
    'CoreNetworkSegmentEdge': {
        'CoreNetworkId': 'string',
        'SegmentName': 'string',
        'EdgeLocation': 'string'
    },
    'RouteTableType': 'TRANSIT_GATEWAY_ROUTE_TABLE'|'CORE_NETWORK_SEGMENT',
    'RouteTableTimestamp': datetime(2015, 1, 1),
    'NetworkRoutes': [
        {
            'DestinationCidrBlock': 'string',
            'Destinations': [
                {
                    'CoreNetworkAttachmentId': 'string',
                    'TransitGatewayAttachmentId': 'string',
                    'SegmentName': 'string',
                    'EdgeLocation': 'string',
                    'ResourceType': 'string',
                    'ResourceId': 'string'
                },
            ],
            'PrefixListId': 'string',
            'State': 'ACTIVE'|'BLACKHOLE',
            'Type': 'PROPAGATED'|'STATIC'
        },
    ]
}

Response Structure

  • (dict) --

    • RouteTableArn (string) --

      The ARN of the route table.

    • CoreNetworkSegmentEdge (dict) --

      Describes a core network segment edge.

      • CoreNetworkId (string) --

        The ID of a core network.

      • SegmentName (string) --

        The name of the segment edge.

      • EdgeLocation (string) --

        The Region where the segment edge is located.

    • RouteTableType (string) --

      The route table type.

    • RouteTableTimestamp (datetime) --

      The route table creation time.

    • NetworkRoutes (list) --

      The network routes.

      • (dict) --

        Describes a network route.

        • DestinationCidrBlock (string) --

          A unique identifier for the route, such as a CIDR block.

        • Destinations (list) --

          The destinations.

          • (dict) --

            Describes the destination of a network route.

            • CoreNetworkAttachmentId (string) --

              The ID of a core network attachment.

            • TransitGatewayAttachmentId (string) --

              The ID of the transit gateway attachment.

            • SegmentName (string) --

              The name of the segment.

            • EdgeLocation (string) --

              The edge location for the network destination.

            • ResourceType (string) --

              The resource type.

            • ResourceId (string) --

              The ID of the resource.

        • PrefixListId (string) --

          The ID of the prefix list.

        • State (string) --

          The route state. The possible values are active and blackhole .

        • Type (string) --

          The route type. The possible values are propagated and static .

Exceptions

get_network_telemetry(**kwargs)

Gets the network telemetry of the specified global network.

See also: AWS API Documentation

Request Syntax

response = client.get_network_telemetry(
    GlobalNetworkId='string',
    CoreNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CoreNetworkId (string) -- The ID of a core network.
  • RegisteredGatewayArn (string) -- The ARN of the gateway.
  • AwsRegion (string) -- The Amazon Web Services Region.
  • AccountId (string) -- The Amazon Web Services account ID.
  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon
    • dx-gateway
    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection
    • device
    • link
    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway
    • transit-gateway
    • transit-gateway-attachment
    • transit-gateway-connect-peer
    • transit-gateway-route-table
    • vpn-connection
  • ResourceArn (string) -- The ARN of the resource.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'NetworkTelemetry': [
        {
            'RegisteredGatewayArn': 'string',
            'CoreNetworkId': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Address': 'string',
            'Health': {
                'Type': 'BGP'|'IPSEC',
                'Status': 'UP'|'DOWN',
                'Timestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • NetworkTelemetry (list) --

      The network telemetry.

      • (dict) --

        Describes the telemetry information for a resource.

        • RegisteredGatewayArn (string) --

          The ARN of the gateway.

        • CoreNetworkId (string) --

          The ID of a core network.

        • AwsRegion (string) --

          The Amazon Web Services Region.

        • AccountId (string) --

          The Amazon Web Services account ID.

        • ResourceType (string) --

          The resource type.

        • ResourceId (string) --

          The ID of the resource.

        • ResourceArn (string) --

          The ARN of the resource.

        • Address (string) --

          The address.

        • Health (dict) --

          The connection health.

          • Type (string) --

            The connection type.

          • Status (string) --

            The connection status.

          • Timestamp (datetime) --

            The time the status was last updated.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_resource_policy(**kwargs)

Returns information about a resource policy.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_policy(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The ARN of the resource.

Return type
dict
Returns
Response Syntax
{
    'PolicyDocument': 'string'
}

Response Structure

  • (dict) --
    • PolicyDocument (string) --

      The resource policy document.

Exceptions

get_route_analysis(**kwargs)

Gets information about the specified route analysis.

See also: AWS API Documentation

Request Syntax

response = client.get_route_analysis(
    GlobalNetworkId='string',
    RouteAnalysisId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • RouteAnalysisId (string) --

    [REQUIRED]

    The ID of the route analysis.

Return type

dict

Returns

Response Syntax

{
    'RouteAnalysis': {
        'GlobalNetworkId': 'string',
        'OwnerAccountId': 'string',
        'RouteAnalysisId': 'string',
        'StartTimestamp': datetime(2015, 1, 1),
        'Status': 'RUNNING'|'COMPLETED'|'FAILED',
        'Source': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'Destination': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'IncludeReturnPath': True|False,
        'UseMiddleboxes': True|False,
        'ForwardPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        },
        'ReturnPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    • RouteAnalysis (dict) --

      The route analysis.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • OwnerAccountId (string) --

        The ID of the AWS account that created the route analysis.

      • RouteAnalysisId (string) --

        The ID of the route analysis.

      • StartTimestamp (datetime) --

        The time that the analysis started.

      • Status (string) --

        The status of the route analysis.

      • Source (dict) --

        The source.

        • TransitGatewayAttachmentArn (string) --

          The ARN of the transit gateway attachment.

        • TransitGatewayArn (string) --

          The ARN of the transit gateway.

        • IpAddress (string) --

          The IP address.

      • Destination (dict) --

        The destination.

        • TransitGatewayAttachmentArn (string) --

          The ARN of the transit gateway attachment.

        • TransitGatewayArn (string) --

          The ARN of the transit gateway.

        • IpAddress (string) --

          The IP address.

      • IncludeReturnPath (boolean) --

        Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

      • UseMiddleboxes (boolean) --

        Indicates whether to include the location of middlebox appliances in the route analysis.

      • ForwardPath (dict) --

        The forward path.

        • CompletionStatus (dict) --

          The status of the analysis at completion.

          • ResultCode (string) --

            The result of the analysis. If the status is NOT_CONNECTED , check the reason code.

          • ReasonCode (string) --

            The reason code. Available only if a connection is not found.

            • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
            • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
            • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
            • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
            • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
            • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
            • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
            • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
            • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
          • ReasonContext (dict) --

            Additional information about the path. Available only if a connection is not found.

            • (string) --
              • (string) --
        • Path (list) --

          The route analysis path.

          • (dict) --

            Describes a path component.

            • Sequence (integer) --

              The sequence number in the path. The destination is 0.

            • Resource (dict) --

              The resource.

              • RegisteredGatewayArn (string) --

                The ARN of the gateway.

              • ResourceArn (string) --

                The ARN of the resource.

              • ResourceType (string) --

                The resource type.

              • Definition (string) --

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag (string) --

                The value for the Name tag.

              • IsMiddlebox (boolean) --

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock (string) --

              The destination CIDR block in the route table.

      • ReturnPath (dict) --

        The return path.

        • CompletionStatus (dict) --

          The status of the analysis at completion.

          • ResultCode (string) --

            The result of the analysis. If the status is NOT_CONNECTED , check the reason code.

          • ReasonCode (string) --

            The reason code. Available only if a connection is not found.

            • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
            • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
            • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
            • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
            • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
            • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
            • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
            • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
            • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
          • ReasonContext (dict) --

            Additional information about the path. Available only if a connection is not found.

            • (string) --
              • (string) --
        • Path (list) --

          The route analysis path.

          • (dict) --

            Describes a path component.

            • Sequence (integer) --

              The sequence number in the path. The destination is 0.

            • Resource (dict) --

              The resource.

              • RegisteredGatewayArn (string) --

                The ARN of the gateway.

              • ResourceArn (string) --

                The ARN of the resource.

              • ResourceType (string) --

                The resource type.

              • Definition (string) --

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag (string) --

                The value for the Name tag.

              • IsMiddlebox (boolean) --

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock (string) --

              The destination CIDR block in the route table.

Exceptions

get_site_to_site_vpn_attachment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_site_to_site_vpn_attachment(
    AttachmentId='string'
)
Parameters
AttachmentId (string) --

[REQUIRED]

The ID of the attachment.

Return type
dict
Returns
Response Syntax
{
    'SiteToSiteVpnAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

get_sites(**kwargs)

Gets information about one or more of your sites in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_sites(
    GlobalNetworkId='string',
    SiteIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • SiteIds (list) --

    One or more site IDs. The maximum is 10.

    • (string) --
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Sites': [
        {
            'SiteId': 'string',
            'SiteArn': 'string',
            'GlobalNetworkId': 'string',
            'Description': 'string',
            'Location': {
                'Address': 'string',
                'Latitude': 'string',
                'Longitude': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Sites (list) --

      The sites.

      • (dict) --

        Describes a site.

        • SiteId (string) --

          The ID of the site.

        • SiteArn (string) --

          The Amazon Resource Name (ARN) of the site.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • Description (string) --

          The description of the site.

        • Location (dict) --

          The location of the site.

          • Address (string) --

            The physical address.

          • Latitude (string) --

            The latitude.

          • Longitude (string) --

            The longitude.

        • CreatedAt (datetime) --

          The date and time that the site was created.

        • State (string) --

          The state of the site.

        • Tags (list) --

          The tags for the site.

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

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_transit_gateway_connect_peer_associations(**kwargs)

Gets information about one or more of your transit gateway Connect peer associations in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_transit_gateway_connect_peer_associations(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayConnectPeerArns (list) --

    One or more transit gateway Connect peer Amazon Resource Names (ARNs).

    • (string) --
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'TransitGatewayConnectPeerAssociations': [
        {
            'TransitGatewayConnectPeerArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • TransitGatewayConnectPeerAssociations (list) --

      Information about the transit gateway Connect peer associations.

      • (dict) --

        Describes a transit gateway Connect peer association.

        • TransitGatewayConnectPeerArn (string) --

          The Amazon Resource Name (ARN) of the transit gateway Connect peer.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the device.

        • LinkId (string) --

          The ID of the link.

        • State (string) --

          The state of the association.

    • NextToken (string) --

      The token to use for the next page of results.

Exceptions

get_transit_gateway_registrations(**kwargs)

Gets information about the transit gateway registrations in a specified global network.

See also: AWS API Documentation

Request Syntax

response = client.get_transit_gateway_registrations(
    GlobalNetworkId='string',
    TransitGatewayArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayArns (list) --

    The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

    • (string) --
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'TransitGatewayRegistrations': [
        {
            'GlobalNetworkId': 'string',
            'TransitGatewayArn': 'string',
            'State': {
                'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • TransitGatewayRegistrations (list) --

      The transit gateway registrations.

      • (dict) --

        Describes the registration of a transit gateway to a global network.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • TransitGatewayArn (string) --

          The Amazon Resource Name (ARN) of the transit gateway.

        • State (dict) --

          The state of the transit gateway registration.

          • Code (string) --

            The code for the state reason.

          • Message (string) --

            The message for the state reason.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

get_vpc_attachment(**kwargs)

Returns information about a VPC attachment.

See also: AWS API Documentation

Request Syntax

response = client.get_vpc_attachment(
    AttachmentId='string'
)
Parameters
AttachmentId (string) --

[REQUIRED]

The ID of the attachment.

Return type
dict
Returns
Response Syntax
{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_attachments(**kwargs)

Returns a list of core network attachments.

See also: AWS API Documentation

Request Syntax

response = client.list_attachments(
    CoreNetworkId='string',
    AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
    EdgeLocation='string',
    State='REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CoreNetworkId (string) -- The ID of a core network.
  • AttachmentType (string) -- The type of attachment.
  • EdgeLocation (string) -- The Region where the edge is located.
  • State (string) -- The state of the attachment.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Attachments': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

list_connect_peers(**kwargs)

Returns a list of core network Connect peers.

See also: AWS API Documentation

Request Syntax

response = client.list_connect_peers(
    CoreNetworkId='string',
    ConnectAttachmentId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CoreNetworkId (string) -- The ID of a core network.
  • ConnectAttachmentId (string) -- The ID of the attachment.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • ConnectPeers (list) --

      Describes the Connect peers.

      • (dict) --

        Summary description of a Connect peer.

        • CoreNetworkId (string) --

          The ID of a core network.

        • ConnectAttachmentId (string) --

          The ID of a Connect peer attachment.

        • ConnectPeerId (string) --

          The ID of a Connect peer.

        • EdgeLocation (string) --

          The Region where the edge is located.

        • ConnectPeerState (string) --

          The state of a Connect peer.

        • CreatedAt (datetime) --

          The timestamp when a Connect peer was created.

        • Tags (list) --

          The tags associated with a Connect peer summary.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

list_core_network_policy_versions(**kwargs)

Returns a list of core network policy versions.

See also: AWS API Documentation

Request Syntax

response = client.list_core_network_policy_versions(
    CoreNetworkId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'CoreNetworkPolicyVersions': [
        {
            'CoreNetworkId': 'string',
            'PolicyVersionId': 123,
            'Alias': 'LIVE'|'LATEST',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworkPolicyVersions (list) --

      Describes core network policy versions.

      • (dict) --

        Describes a core network policy version.

        • CoreNetworkId (string) --

          The ID of a core network.

        • PolicyVersionId (integer) --

          The ID of the policy version.

        • Alias (string) --

          Whether a core network policy is the current policy or the most recently submitted policy.

        • Description (string) --

          The description of a core network policy version.

        • CreatedAt (datetime) --

          The timestamp when a core network policy version was created.

        • ChangeSetState (string) --

          The status of the policy version change set.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

list_core_networks(**kwargs)

Returns a list of owned and shared core networks.

See also: AWS API Documentation

Request Syntax

response = client.list_core_networks(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'CoreNetworks': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'GlobalNetworkId': 'string',
            'OwnerAccountId': 'string',
            'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CoreNetworks (list) --

      Describes the list of core networks.

      • (dict) --

        Returns summary information about a core network.

        • CoreNetworkId (string) --

          The ID of a core network.

        • CoreNetworkArn (string) --

          a core network ARN.

        • GlobalNetworkId (string) --

          The global network ID.

        • OwnerAccountId (string) --

          The ID of the account owner.

        • State (string) --

          The state of a core network.

        • Description (string) --

          The description of a core network.

        • Tags (list) --

          The key-value tags associated with a core network summary.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags for a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • TagList (list) --

      The list of tags.

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

Exceptions

put_core_network_policy(**kwargs)

Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.

See also: AWS API Documentation

Request Syntax

response = client.put_core_network_policy(
    CoreNetworkId='string',
    PolicyDocument='string',
    Description='string',
    LatestVersionId=123,
    ClientToken='string'
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • PolicyDocument (string) --

    [REQUIRED]

    The policy document.

  • Description (string) -- a core network policy description.
  • LatestVersionId (integer) -- The ID of a core network policy.
  • ClientToken (string) --

    The client token associated with the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'CoreNetworkPolicy': {
        'CoreNetworkId': 'string',
        'PolicyVersionId': 123,
        'Alias': 'LIVE'|'LATEST',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
        'PolicyErrors': [
            {
                'ErrorCode': 'string',
                'Message': 'string',
                'Path': 'string'
            },
        ],
        'PolicyDocument': 'string'
    }
}

Response Structure

  • (dict) --

    • CoreNetworkPolicy (dict) --

      Describes the changed core network policy.

      • CoreNetworkId (string) --

        The ID of a core network.

      • PolicyVersionId (integer) --

        The ID of the policy version.

      • Alias (string) --

        Whether a core network policy is the current LIVE policy or the most recently submitted policy.

      • Description (string) --

        The description of a core network policy.

      • CreatedAt (datetime) --

        The timestamp when a core network policy was created.

      • ChangeSetState (string) --

        The state of a core network policy.

      • PolicyErrors (list) --

        Describes any errors in a core network policy.

        • (dict) --

          Provides details about an error in a core network policy.

          • ErrorCode (string) --

            The error code associated with a core network policy error.

          • Message (string) --

            The message associated with a core network policy error code.

          • Path (string) --

            The JSON path where the error was discovered in the policy document.

      • PolicyDocument (string) --

        Describes a core network policy.

Exceptions

put_resource_policy(**kwargs)

Creates or updates a resource policy.

See also: AWS API Documentation

Request Syntax

response = client.put_resource_policy(
    PolicyDocument='string',
    ResourceArn='string'
)
Parameters
  • PolicyDocument (string) --

    [REQUIRED]

    The JSON resource policy document.

  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource policy.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

register_transit_gateway(**kwargs)

Registers a transit gateway in your global network. The transit gateway can be in any Amazon Web Services Region, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.

See also: AWS API Documentation

Request Syntax

response = client.register_transit_gateway(
    GlobalNetworkId='string',
    TransitGatewayArn='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the transit gateway.

Return type

dict

Returns

Response Syntax

{
    'TransitGatewayRegistration': {
        'GlobalNetworkId': 'string',
        'TransitGatewayArn': 'string',
        'State': {
            'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
            'Message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • TransitGatewayRegistration (dict) --

      Information about the transit gateway registration.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • TransitGatewayArn (string) --

        The Amazon Resource Name (ARN) of the transit gateway.

      • State (dict) --

        The state of the transit gateway registration.

        • Code (string) --

          The code for the state reason.

        • Message (string) --

          The message for the state reason.

Exceptions

reject_attachment(**kwargs)

Rejects a core network attachment request.

See also: AWS API Documentation

Request Syntax

response = client.reject_attachment(
    AttachmentId='string'
)
Parameters
AttachmentId (string) --

[REQUIRED]

The ID of the attachment.

Return type
dict
Returns
Response Syntax
{
    'Attachment': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'AttachmentId': 'string',
        'OwnerAccountId': 'string',
        'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
        '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) --

        A core network ID.

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

Exceptions

restore_core_network_policy_version(**kwargs)

Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.

See also: AWS API Documentation

Request Syntax

response = client.restore_core_network_policy_version(
    CoreNetworkId='string',
    PolicyVersionId=123
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • PolicyVersionId (integer) --

    [REQUIRED]

    The ID of the policy version to restore.

Return type

dict

Returns

Response Syntax

{
    'CoreNetworkPolicy': {
        'CoreNetworkId': 'string',
        'PolicyVersionId': 123,
        'Alias': 'LIVE'|'LATEST',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
        'PolicyErrors': [
            {
                'ErrorCode': 'string',
                'Message': 'string',
                'Path': 'string'
            },
        ],
        'PolicyDocument': 'string'
    }
}

Response Structure

  • (dict) --

    • CoreNetworkPolicy (dict) --

      Describes the restored core network policy.

      • CoreNetworkId (string) --

        The ID of a core network.

      • PolicyVersionId (integer) --

        The ID of the policy version.

      • Alias (string) --

        Whether a core network policy is the current LIVE policy or the most recently submitted policy.

      • Description (string) --

        The description of a core network policy.

      • CreatedAt (datetime) --

        The timestamp when a core network policy was created.

      • ChangeSetState (string) --

        The state of a core network policy.

      • PolicyErrors (list) --

        Describes any errors in a core network policy.

        • (dict) --

          Provides details about an error in a core network policy.

          • ErrorCode (string) --

            The error code associated with a core network policy error.

          • Message (string) --

            The message associated with a core network policy error code.

          • Path (string) --

            The JSON path where the error was discovered in the policy document.

      • PolicyDocument (string) --

        Describes a core network policy.

Exceptions

start_route_analysis(**kwargs)

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer .

See also: AWS API Documentation

Request Syntax

response = client.start_route_analysis(
    GlobalNetworkId='string',
    Source={
        'TransitGatewayAttachmentArn': 'string',
        'IpAddress': 'string'
    },
    Destination={
        'TransitGatewayAttachmentArn': 'string',
        'IpAddress': 'string'
    },
    IncludeReturnPath=True|False,
    UseMiddleboxes=True|False
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • Source (dict) --

    [REQUIRED]

    The source from which traffic originates.

    • TransitGatewayAttachmentArn (string) --

      The ARN of the transit gateway attachment.

    • IpAddress (string) --

      The IP address.

  • Destination (dict) --

    [REQUIRED]

    The destination.

    • TransitGatewayAttachmentArn (string) --

      The ARN of the transit gateway attachment.

    • IpAddress (string) --

      The IP address.

  • IncludeReturnPath (boolean) -- Indicates whether to analyze the return path. The default is false .
  • UseMiddleboxes (boolean) -- Indicates whether to include the location of middlebox appliances in the route analysis. The default is false .
Return type

dict

Returns

Response Syntax

{
    'RouteAnalysis': {
        'GlobalNetworkId': 'string',
        'OwnerAccountId': 'string',
        'RouteAnalysisId': 'string',
        'StartTimestamp': datetime(2015, 1, 1),
        'Status': 'RUNNING'|'COMPLETED'|'FAILED',
        'Source': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'Destination': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'IncludeReturnPath': True|False,
        'UseMiddleboxes': True|False,
        'ForwardPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        },
        'ReturnPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    • RouteAnalysis (dict) --

      The route analysis.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • OwnerAccountId (string) --

        The ID of the AWS account that created the route analysis.

      • RouteAnalysisId (string) --

        The ID of the route analysis.

      • StartTimestamp (datetime) --

        The time that the analysis started.

      • Status (string) --

        The status of the route analysis.

      • Source (dict) --

        The source.

        • TransitGatewayAttachmentArn (string) --

          The ARN of the transit gateway attachment.

        • TransitGatewayArn (string) --

          The ARN of the transit gateway.

        • IpAddress (string) --

          The IP address.

      • Destination (dict) --

        The destination.

        • TransitGatewayAttachmentArn (string) --

          The ARN of the transit gateway attachment.

        • TransitGatewayArn (string) --

          The ARN of the transit gateway.

        • IpAddress (string) --

          The IP address.

      • IncludeReturnPath (boolean) --

        Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

      • UseMiddleboxes (boolean) --

        Indicates whether to include the location of middlebox appliances in the route analysis.

      • ForwardPath (dict) --

        The forward path.

        • CompletionStatus (dict) --

          The status of the analysis at completion.

          • ResultCode (string) --

            The result of the analysis. If the status is NOT_CONNECTED , check the reason code.

          • ReasonCode (string) --

            The reason code. Available only if a connection is not found.

            • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
            • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
            • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
            • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
            • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
            • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
            • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
            • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
            • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
          • ReasonContext (dict) --

            Additional information about the path. Available only if a connection is not found.

            • (string) --
              • (string) --
        • Path (list) --

          The route analysis path.

          • (dict) --

            Describes a path component.

            • Sequence (integer) --

              The sequence number in the path. The destination is 0.

            • Resource (dict) --

              The resource.

              • RegisteredGatewayArn (string) --

                The ARN of the gateway.

              • ResourceArn (string) --

                The ARN of the resource.

              • ResourceType (string) --

                The resource type.

              • Definition (string) --

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag (string) --

                The value for the Name tag.

              • IsMiddlebox (boolean) --

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock (string) --

              The destination CIDR block in the route table.

      • ReturnPath (dict) --

        The return path.

        • CompletionStatus (dict) --

          The status of the analysis at completion.

          • ResultCode (string) --

            The result of the analysis. If the status is NOT_CONNECTED , check the reason code.

          • ReasonCode (string) --

            The reason code. Available only if a connection is not found.

            • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
            • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
            • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
            • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
            • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
            • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
            • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
            • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
            • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
          • ReasonContext (dict) --

            Additional information about the path. Available only if a connection is not found.

            • (string) --
              • (string) --
        • Path (list) --

          The route analysis path.

          • (dict) --

            Describes a path component.

            • Sequence (integer) --

              The sequence number in the path. The destination is 0.

            • Resource (dict) --

              The resource.

              • RegisteredGatewayArn (string) --

                The ARN of the gateway.

              • ResourceArn (string) --

                The ARN of the resource.

              • ResourceType (string) --

                The resource type.

              • Definition (string) --

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag (string) --

                The value for the Name tag.

              • IsMiddlebox (boolean) --

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock (string) --

              The destination CIDR block in the route table.

Exceptions

tag_resource(**kwargs)

Tags a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • Tags (list) --

    [REQUIRED]

    The tags to apply to the specified resource.

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes tags from a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys to remove from the specified resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_connection(**kwargs)

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

Request Syntax

response = client.update_connection(
    GlobalNetworkId='string',
    ConnectionId='string',
    LinkId='string',
    ConnectedLinkId='string',
    Description='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ConnectionId (string) --

    [REQUIRED]

    The ID of the connection.

  • LinkId (string) -- The ID of the link for the first device in the connection.
  • ConnectedLinkId (string) -- The ID of the link for the second device in the connection.
  • Description (string) --

    A description of the connection.

    Length Constraints: Maximum length of 256 characters.

Return type

dict

Returns

Response Syntax

{
    'Connection': {
        'ConnectionId': 'string',
        'ConnectionArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'ConnectedDeviceId': 'string',
        'LinkId': 'string',
        'ConnectedLinkId': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Connection (dict) --

      Information about the connection.

      • ConnectionId (string) --

        The ID of the connection.

      • ConnectionArn (string) --

        The Amazon Resource Name (ARN) of the connection.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the first device in the connection.

      • ConnectedDeviceId (string) --

        The ID of the second device in the connection.

      • LinkId (string) --

        The ID of the link for the first device in the connection.

      • ConnectedLinkId (string) --

        The ID of the link for the second device in the connection.

      • Description (string) --

        The description of the connection.

      • CreatedAt (datetime) --

        The date and time that the connection was created.

      • State (string) --

        The state of the connection.

      • Tags (list) --

        The tags for the connection.

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

Exceptions

update_core_network(**kwargs)

Updates the description of a core network.

See also: AWS API Documentation

Request Syntax

response = client.update_core_network(
    CoreNetworkId='string',
    Description='string'
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • Description (string) -- The description of the update.
Return type

dict

Returns

Response Syntax

{
    'CoreNetwork': {
        'GlobalNetworkId': 'string',
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
        'Segments': [
            {
                'Name': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ]
            },
        ],
        'Edges': [
            {
                'EdgeLocation': 'string',
                'Asn': 123,
                'InsideCidrBlocks': [
                    'string',
                ]
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • CoreNetwork (dict) --

      Returns information about a core network update.

      • GlobalNetworkId (string) --

        The ID of the global network that your core network is a part of.

      • CoreNetworkId (string) --

        The ID of a core network.

      • CoreNetworkArn (string) --

        The ARN of a core network.

      • Description (string) --

        The description of a core network.

      • CreatedAt (datetime) --

        The timestamp when a core network was created.

      • State (string) --

        The current state of a core network.

      • Segments (list) --

        The segments within a core network.

        • (dict) --

          Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

          • Name (string) --

            The name of a core network segment.

          • EdgeLocations (list) --

            The Regions where the edges are located.

            • (string) --
          • SharedSegments (list) --

            The shared segments of a core network.

            • (string) --
      • Edges (list) --

        The edges within a core network.

        • (dict) --

          Describes a core network edge.

          • EdgeLocation (string) --

            The Region where a core network edge is located.

          • Asn (integer) --

            The ASN of a core network edge.

          • InsideCidrBlocks (list) --

            The inside IP addresses used for core network edges.

            • (string) --
      • Tags (list) --

        The tags associated with a core network.

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

Exceptions

update_device(**kwargs)

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

Request Syntax

response = client.update_device(
    GlobalNetworkId='string',
    DeviceId='string',
    AWSLocation={
        'Zone': 'string',
        'SubnetArn': 'string'
    },
    Description='string',
    Type='string',
    Vendor='string',
    Model='string',
    SerialNumber='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    },
    SiteId='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) --

    [REQUIRED]

    The ID of the device.

  • AWSLocation (dict) --

    The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

    • Zone (string) --

      The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

    • SubnetArn (string) --

      The Amazon Resource Name (ARN) of the subnet that the device is located in.

  • Description (string) --

    A description of the device.

    Constraints: Maximum length of 256 characters.

  • Type (string) -- The type of the device.
  • Vendor (string) --

    The vendor of the device.

    Constraints: Maximum length of 128 characters.

  • Model (string) --

    The model of the device.

    Constraints: Maximum length of 128 characters.

  • SerialNumber (string) --

    The serial number of the device.

    Constraints: Maximum length of 128 characters.

  • Location (dict) --

    Describes a location.

    • Address (string) --

      The physical address.

    • Latitude (string) --

      The latitude.

    • Longitude (string) --

      The longitude.

  • SiteId (string) -- The ID of the site.
Return type

dict

Returns

Response Syntax

{
    'Device': {
        'DeviceId': 'string',
        'DeviceArn': 'string',
        'GlobalNetworkId': 'string',
        'AWSLocation': {
            'Zone': 'string',
            'SubnetArn': 'string'
        },
        'Description': 'string',
        'Type': 'string',
        'Vendor': 'string',
        'Model': 'string',
        'SerialNumber': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'SiteId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Device (dict) --

      Information about the device.

      • DeviceId (string) --

        The ID of the device.

      • DeviceArn (string) --

        The Amazon Resource Name (ARN) of the device.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • AWSLocation (dict) --

        The Amazon Web Services location of the device.

        • Zone (string) --

          The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

        • SubnetArn (string) --

          The Amazon Resource Name (ARN) of the subnet that the device is located in.

      • Description (string) --

        The description of the device.

      • Type (string) --

        The device type.

      • Vendor (string) --

        The device vendor.

      • Model (string) --

        The device model.

      • SerialNumber (string) --

        The device serial number.

      • Location (dict) --

        The site location.

        • Address (string) --

          The physical address.

        • Latitude (string) --

          The latitude.

        • Longitude (string) --

          The longitude.

      • SiteId (string) --

        The site ID.

      • CreatedAt (datetime) --

        The date and time that the site was created.

      • State (string) --

        The device state.

      • Tags (list) --

        The tags for the device.

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

Exceptions

update_global_network(**kwargs)

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

Request Syntax

response = client.update_global_network(
    GlobalNetworkId='string',
    Description='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of your global network.

  • Description (string) --

    A description of the global network.

    Constraints: Maximum length of 256 characters.

Return type

dict

Returns

Response Syntax

{
    'GlobalNetwork': {
        'GlobalNetworkId': 'string',
        'GlobalNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • GlobalNetwork (dict) --

      Information about the global network object.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • GlobalNetworkArn (string) --

        The Amazon Resource Name (ARN) of the global network.

      • Description (string) --

        The description of the global network.

      • CreatedAt (datetime) --

        The date and time that the global network was created.

      • State (string) --

        The state of the global network.

      • Tags (list) --

        The tags for the global network.

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

Exceptions

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

Request Syntax

response = client.update_link(
    GlobalNetworkId='string',
    LinkId='string',
    Description='string',
    Type='string',
    Bandwidth={
        'UploadSpeed': 123,
        'DownloadSpeed': 123
    },
    Provider='string'
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • LinkId (string) --

    [REQUIRED]

    The ID of the link.

  • Description (string) --

    A description of the link.

    Constraints: Maximum length of 256 characters.

  • Type (string) --

    The type of the link.

    Constraints: Maximum length of 128 characters.

  • Bandwidth (dict) --

    The upload and download speed in Mbps.

    • UploadSpeed (integer) --

      Upload speed in Mbps.

    • DownloadSpeed (integer) --

      Download speed in Mbps.

  • Provider (string) --

    The provider of the link.

    Constraints: Maximum length of 128 characters.

Return type

dict

Returns

Response Syntax

{
    'Link': {
        'LinkId': 'string',
        'LinkArn': 'string',
        'GlobalNetworkId': 'string',
        'SiteId': 'string',
        'Description': 'string',
        'Type': 'string',
        'Bandwidth': {
            'UploadSpeed': 123,
            'DownloadSpeed': 123
        },
        'Provider': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Link (dict) --

      Information about the link.

      • LinkId (string) --

        The ID of the link.

      • LinkArn (string) --

        The Amazon Resource Name (ARN) of the link.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • SiteId (string) --

        The ID of the site.

      • Description (string) --

        The description of the link.

      • Type (string) --

        The type of the link.

      • Bandwidth (dict) --

        The bandwidth for the link.

        • UploadSpeed (integer) --

          Upload speed in Mbps.

        • DownloadSpeed (integer) --

          Download speed in Mbps.

      • Provider (string) --

        The provider of the link.

      • CreatedAt (datetime) --

        The date and time that the link was created.

      • State (string) --

        The state of the link.

      • Tags (list) --

        The tags for the link.

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

Exceptions

update_network_resource_metadata(**kwargs)

Updates the resource metadata for the specified global network.

See also: AWS API Documentation

Request Syntax

response = client.update_network_resource_metadata(
    GlobalNetworkId='string',
    ResourceArn='string',
    Metadata={
        'string': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource.

  • Metadata (dict) --

    [REQUIRED]

    The resource metadata.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'ResourceArn': 'string',
    'Metadata': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • ResourceArn (string) --

      The ARN of the resource.

    • Metadata (dict) --

      The updated resource metadata.

      • (string) --
        • (string) --

Exceptions

update_site(**kwargs)

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

Request Syntax

response = client.update_site(
    GlobalNetworkId='string',
    SiteId='string',
    Description='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • SiteId (string) --

    [REQUIRED]

    The ID of your site.

  • Description (string) --

    A description of your site.

    Constraints: Maximum length of 256 characters.

  • Location (dict) --

    The site location:

    • Address : The physical address of the site.
    • Latitude : The latitude of the site.
    • Longitude : The longitude of the site.
    • Address (string) --

      The physical address.

    • Latitude (string) --

      The latitude.

    • Longitude (string) --

      The longitude.

Return type

dict

Returns

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'SiteArn': 'string',
        'GlobalNetworkId': 'string',
        'Description': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Site (dict) --

      Information about the site.

      • SiteId (string) --

        The ID of the site.

      • SiteArn (string) --

        The Amazon Resource Name (ARN) of the site.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • Description (string) --

        The description of the site.

      • Location (dict) --

        The location of the site.

        • Address (string) --

          The physical address.

        • Latitude (string) --

          The latitude.

        • Longitude (string) --

          The longitude.

      • CreatedAt (datetime) --

        The date and time that the site was created.

      • State (string) --

        The state of the site.

      • Tags (list) --

        The tags for the site.

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

Exceptions

update_vpc_attachment(**kwargs)

Updates a VPC attachment.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of the attachment.

  • AddSubnetArns (list) --

    Adds a subnet ARN to the VPC attachment.

    • (string) --
  • RemoveSubnetArns (list) --

    Removes a subnet ARN from the attachment.

    • (string) --
  • Options (dict) --

    Additional options for updating the VPC attachment.

    • Ipv6Support (boolean) --

      Indicates whether IPv6 is supported.

Return type

dict

Returns

Response Syntax

{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

          A core network ID.

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

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class NetworkManager.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class NetworkManager.Client.exceptions.ConflictException

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

    • Message (string) --

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The resource type.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class NetworkManager.Client.exceptions.CoreNetworkPolicyException

Describes a core network policy exception.

Example

try:
  ...
except client.exceptions.CoreNetworkPolicyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Errors': [
        {
            'ErrorCode': 'string',
            'Message': 'string',
            'Path': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Describes a core network policy exception.

    • Message (string) --

    • Errors (list) --

      Describes a core network policy exception.

      • (dict) --

        Provides details about an error in a core network policy.

        • ErrorCode (string) --

          The error code associated with a core network policy error.

        • Message (string) --

          The message associated with a core network policy error code.

        • Path (string) --

          The JSON path where the error was discovered in the policy document.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class NetworkManager.Client.exceptions.InternalServerException

The request has failed due to an internal error.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'RetryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request has failed due to an internal error.

    • Message (string) --

    • RetryAfterSeconds (integer) --

      Indicates when to retry the request.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class NetworkManager.Client.exceptions.ResourceNotFoundException

The specified resource could not be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Context': {
        'string': 'string'
    },
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource could not be found.

    • Message (string) --

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The resource type.

    • Context (dict) --

      The specified resource could not be found.

      • (string) --
        • (string) --
    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class NetworkManager.Client.exceptions.ServiceQuotaExceededException

A service limit was exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'LimitCode': 'string',
    'ServiceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A service limit was exceeded.

    • Message (string) --

      The error message.

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The resource type.

    • LimitCode (string) --

      The limit code.

    • ServiceCode (string) --

      The service code.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class NetworkManager.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'RetryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • Message (string) --

    • RetryAfterSeconds (integer) --

      Indicates when to retry the request.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class NetworkManager.Client.exceptions.ValidationException

The input fails to satisfy the constraints.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Reason': 'UnknownOperation'|'CannotParse'|'FieldValidationFailed'|'Other',
    'Fields': [
        {
            'Name': 'string',
            'Message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy the constraints.

    • Message (string) --

    • Reason (string) --

      The reason for the error.

    • Fields (list) --

      The fields that caused the error, if applicable.

      • (dict) --

        Describes a validation exception for a field.

        • Name (string) --

          The name of the field.

        • Message (string) --

          The message for the field.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class NetworkManager.Paginator.DescribeGlobalNetworks
paginator = client.get_paginator('describe_global_networks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.describe_global_networks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkIds (list) --

    The IDs of one or more global networks. The maximum is 10.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'GlobalNetworks': [
        {
            'GlobalNetworkId': 'string',
            'GlobalNetworkArn': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • GlobalNetworks (list) --

      Information about the global networks.

      • (dict) --

        Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-manged Core Network.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • GlobalNetworkArn (string) --

          The Amazon Resource Name (ARN) of the global network.

        • Description (string) --

          The description of the global network.

        • CreatedAt (datetime) --

          The date and time that the global network was created.

        • State (string) --

          The state of the global network.

        • Tags (list) --

          The tags for the global network.

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

class NetworkManager.Paginator.GetConnectPeerAssociations
paginator = client.get_paginator('get_connect_peer_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_connect_peer_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    ConnectPeerIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ConnectPeerIds (list) --

    The IDs of the Connect peers.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ConnectPeerAssociations': [
        {
            'ConnectPeerId': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],

}

Response Structure

  • (dict) --

    • ConnectPeerAssociations (list) --

      Displays a list of Connect peer associations.

      • (dict) --

        Describes a core network Connect peer association.

        • ConnectPeerId (string) --

          The ID of the Connect peer.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the device to connect to.

        • LinkId (string) --

          The ID of the link.

        • State (string) --

          The state of the Connect peer association.

class NetworkManager.Paginator.GetConnections
paginator = client.get_paginator('get_connections')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_connections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    ConnectionIds=[
        'string',
    ],
    DeviceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ConnectionIds (list) --

    One or more connection IDs.

    • (string) --
  • DeviceId (string) -- The ID of the device.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Connections': [
        {
            'ConnectionId': 'string',
            'ConnectionArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'ConnectedDeviceId': 'string',
            'LinkId': 'string',
            'ConnectedLinkId': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • Connections (list) --

      Information about the connections.

      • (dict) --

        Describes a connection.

        • ConnectionId (string) --

          The ID of the connection.

        • ConnectionArn (string) --

          The Amazon Resource Name (ARN) of the connection.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the first device in the connection.

        • ConnectedDeviceId (string) --

          The ID of the second device in the connection.

        • LinkId (string) --

          The ID of the link for the first device in the connection.

        • ConnectedLinkId (string) --

          The ID of the link for the second device in the connection.

        • Description (string) --

          The description of the connection.

        • CreatedAt (datetime) --

          The date and time that the connection was created.

        • State (string) --

          The state of the connection.

        • Tags (list) --

          The tags for the connection.

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

class NetworkManager.Paginator.GetCoreNetworkChangeSet
paginator = client.get_paginator('get_core_network_change_set')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_core_network_change_set().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CoreNetworkId='string',
    PolicyVersionId=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • PolicyVersionId (integer) --

    [REQUIRED]

    The ID of the policy version.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'CoreNetworkChanges': [
        {
            'Type': 'CORE_NETWORK_SEGMENT'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC',
            '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',
                ]
            }
        },
    ],

}

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

class NetworkManager.Paginator.GetCustomerGatewayAssociations
paginator = client.get_paginator('get_customer_gateway_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_customer_gateway_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    CustomerGatewayArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CustomerGatewayArns (list) --

    One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'CustomerGatewayAssociations': [
        {
            'CustomerGatewayArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],

}

Response Structure

  • (dict) --

    • CustomerGatewayAssociations (list) --

      The customer gateway associations.

      • (dict) --

        Describes the association between a customer gateway, a device, and a link.

        • CustomerGatewayArn (string) --

          The Amazon Resource Name (ARN) of the customer gateway.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the device.

        • LinkId (string) --

          The ID of the link.

        • State (string) --

          The association state.

class NetworkManager.Paginator.GetDevices
paginator = client.get_paginator('get_devices')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_devices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    DeviceIds=[
        'string',
    ],
    SiteId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceIds (list) --

    One or more device IDs. The maximum is 10.

    • (string) --
  • SiteId (string) -- The ID of the site.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Devices': [
        {
            'DeviceId': 'string',
            'DeviceArn': 'string',
            'GlobalNetworkId': 'string',
            'AWSLocation': {
                'Zone': 'string',
                'SubnetArn': 'string'
            },
            'Description': 'string',
            'Type': 'string',
            'Vendor': 'string',
            'Model': 'string',
            'SerialNumber': 'string',
            'Location': {
                'Address': 'string',
                'Latitude': 'string',
                'Longitude': 'string'
            },
            'SiteId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • Devices (list) --

      The devices.

      • (dict) --

        Describes a device.

        • DeviceId (string) --

          The ID of the device.

        • DeviceArn (string) --

          The Amazon Resource Name (ARN) of the device.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • AWSLocation (dict) --

          The Amazon Web Services location of the device.

          • Zone (string) --

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn (string) --

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

        • Description (string) --

          The description of the device.

        • Type (string) --

          The device type.

        • Vendor (string) --

          The device vendor.

        • Model (string) --

          The device model.

        • SerialNumber (string) --

          The device serial number.

        • Location (dict) --

          The site location.

          • Address (string) --

            The physical address.

          • Latitude (string) --

            The latitude.

          • Longitude (string) --

            The longitude.

        • SiteId (string) --

          The site ID.

        • CreatedAt (datetime) --

          The date and time that the site was created.

        • State (string) --

          The device state.

        • Tags (list) --

          The tags for the device.

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

class NetworkManager.Paginator.GetLinkAssociations
paginator = client.get_paginator('get_link_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_link_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) -- The ID of the device.
  • LinkId (string) -- The ID of the link.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'LinkAssociations': [
        {
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],

}

Response Structure

  • (dict) --

    • LinkAssociations (list) --

      The link associations.

      • (dict) --

        Describes the association between a device and a link.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The device ID for the link association.

        • LinkId (string) --

          The ID of the link.

        • LinkAssociationState (string) --

          The state of the association.

paginator = client.get_paginator('get_links')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_links().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    LinkIds=[
        'string',
    ],
    SiteId='string',
    Type='string',
    Provider='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • LinkIds (list) --

    One or more link IDs. The maximum is 10.

    • (string) --
  • SiteId (string) -- The ID of the site.
  • Type (string) -- The link type.
  • Provider (string) -- The link provider.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Links': [
        {
            'LinkId': 'string',
            'LinkArn': 'string',
            'GlobalNetworkId': 'string',
            'SiteId': 'string',
            'Description': 'string',
            'Type': 'string',
            'Bandwidth': {
                'UploadSpeed': 123,
                'DownloadSpeed': 123
            },
            'Provider': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • Links (list) --

      The links.

      • (dict) --

        Describes a link.

        • LinkId (string) --

          The ID of the link.

        • LinkArn (string) --

          The Amazon Resource Name (ARN) of the link.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • SiteId (string) --

          The ID of the site.

        • Description (string) --

          The description of the link.

        • Type (string) --

          The type of the link.

        • Bandwidth (dict) --

          The bandwidth for the link.

          • UploadSpeed (integer) --

            Upload speed in Mbps.

          • DownloadSpeed (integer) --

            Download speed in Mbps.

        • Provider (string) --

          The provider of the link.

        • CreatedAt (datetime) --

          The date and time that the link was created.

        • State (string) --

          The state of the link.

        • Tags (list) --

          The tags for the link.

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

class NetworkManager.Paginator.GetNetworkResourceCounts
paginator = client.get_paginator('get_network_resource_counts')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_resource_counts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    ResourceType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon
    • dx-gateway
    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection
    • device
    • link
    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway
    • transit-gateway
    • transit-gateway-attachment
    • transit-gateway-connect-peer
    • transit-gateway-route-table
    • vpn-connection
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'NetworkResourceCounts': [
        {
            'ResourceType': 'string',
            'Count': 123
        },
    ],

}

Response Structure

  • (dict) --

    • NetworkResourceCounts (list) --

      The count of resources.

      • (dict) --

        Describes a resource count.

        • ResourceType (string) --

          The resource type.

        • Count (integer) --

          The resource count.

class NetworkManager.Paginator.GetNetworkResourceRelationships
paginator = client.get_paginator('get_network_resource_relationships')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_resource_relationships().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    CoreNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CoreNetworkId (string) -- The ID of a core network.
  • RegisteredGatewayArn (string) -- The ARN of the registered gateway.
  • AwsRegion (string) -- The Amazon Web Services Region.
  • AccountId (string) -- The Amazon Web Services account ID.
  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon
    • dx-gateway
    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection
    • device
    • link
    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway
    • transit-gateway
    • transit-gateway-attachment
    • transit-gateway-connect-peer
    • transit-gateway-route-table
    • vpn-connection
  • ResourceArn (string) -- The ARN of the gateway.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Relationships': [
        {
            'From': 'string',
            'To': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • Relationships (list) --

      The resource relationships.

      • (dict) --

        Describes a resource relationship.

        • From (string) --

          The ARN of the resource.

        • To (string) --

          The ARN of the resource.

class NetworkManager.Paginator.GetNetworkResources
paginator = client.get_paginator('get_network_resources')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    CoreNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CoreNetworkId (string) -- The ID of a core network.
  • RegisteredGatewayArn (string) -- The ARN of the gateway.
  • AwsRegion (string) -- The Amazon Web Services Region.
  • AccountId (string) -- The Amazon Web Services account ID.
  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    The following are the supported resource types for Network Manager:

    • connection - The definition model is Connection .
    • device - The definition model is Device .
    • link - The definition model is Link .
    • site - The definition model is Site .

    The following are the supported resource types for Amazon VPC:

  • ResourceArn (string) -- The ARN of the resource.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'NetworkResources': [
        {
            'RegisteredGatewayArn': 'string',
            'CoreNetworkId': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Definition': 'string',
            'DefinitionTimestamp': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Metadata': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --

    • NetworkResources (list) --

      The network resources.

      • (dict) --

        Describes a network resource.

        • RegisteredGatewayArn (string) --

          The ARN of the gateway.

        • CoreNetworkId (string) --

          a core network ID.

        • AwsRegion (string) --

          The Amazon Web Services Region.

        • AccountId (string) --

          The Amazon Web Services account ID.

        • ResourceType (string) --

          The resource type.

          The following are the supported resource types for Direct Connect:

          • dxcon
          • dx-gateway
          • dx-vif

          The following are the supported resource types for Network Manager:

          • connection
          • device
          • link
          • site

          The following are the supported resource types for Amazon VPC:

          • customer-gateway
          • transit-gateway
          • transit-gateway-attachment
          • transit-gateway-connect-peer
          • transit-gateway-route-table
          • vpn-connection
        • ResourceId (string) --

          The ID of the resource.

        • ResourceArn (string) --

          The ARN of the resource.

        • Definition (string) --

          Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

        • DefinitionTimestamp (datetime) --

          The time that the resource definition was retrieved.

        • Tags (list) --

          The tags.

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

        • Metadata (dict) --

          The resource metadata.

          • (string) --
            • (string) --

class NetworkManager.Paginator.GetNetworkTelemetry
paginator = client.get_paginator('get_network_telemetry')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_telemetry().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    CoreNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • CoreNetworkId (string) -- The ID of a core network.
  • RegisteredGatewayArn (string) -- The ARN of the gateway.
  • AwsRegion (string) -- The Amazon Web Services Region.
  • AccountId (string) -- The Amazon Web Services account ID.
  • ResourceType (string) --

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon
    • dx-gateway
    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection
    • device
    • link
    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway
    • transit-gateway
    • transit-gateway-attachment
    • transit-gateway-connect-peer
    • transit-gateway-route-table
    • vpn-connection
  • ResourceArn (string) -- The ARN of the resource.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'NetworkTelemetry': [
        {
            'RegisteredGatewayArn': 'string',
            'CoreNetworkId': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Address': 'string',
            'Health': {
                'Type': 'BGP'|'IPSEC',
                'Status': 'UP'|'DOWN',
                'Timestamp': datetime(2015, 1, 1)
            }
        },
    ],

}

Response Structure

  • (dict) --

    • NetworkTelemetry (list) --

      The network telemetry.

      • (dict) --

        Describes the telemetry information for a resource.

        • RegisteredGatewayArn (string) --

          The ARN of the gateway.

        • CoreNetworkId (string) --

          The ID of a core network.

        • AwsRegion (string) --

          The Amazon Web Services Region.

        • AccountId (string) --

          The Amazon Web Services account ID.

        • ResourceType (string) --

          The resource type.

        • ResourceId (string) --

          The ID of the resource.

        • ResourceArn (string) --

          The ARN of the resource.

        • Address (string) --

          The address.

        • Health (dict) --

          The connection health.

          • Type (string) --

            The connection type.

          • Status (string) --

            The connection status.

          • Timestamp (datetime) --

            The time the status was last updated.

class NetworkManager.Paginator.GetSites
paginator = client.get_paginator('get_sites')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_sites().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    SiteIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • SiteIds (list) --

    One or more site IDs. The maximum is 10.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Sites': [
        {
            'SiteId': 'string',
            'SiteArn': 'string',
            'GlobalNetworkId': 'string',
            'Description': 'string',
            'Location': {
                'Address': 'string',
                'Latitude': 'string',
                'Longitude': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • Sites (list) --

      The sites.

      • (dict) --

        Describes a site.

        • SiteId (string) --

          The ID of the site.

        • SiteArn (string) --

          The Amazon Resource Name (ARN) of the site.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • Description (string) --

          The description of the site.

        • Location (dict) --

          The location of the site.

          • Address (string) --

            The physical address.

          • Latitude (string) --

            The latitude.

          • Longitude (string) --

            The longitude.

        • CreatedAt (datetime) --

          The date and time that the site was created.

        • State (string) --

          The state of the site.

        • Tags (list) --

          The tags for the site.

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

class NetworkManager.Paginator.GetTransitGatewayConnectPeerAssociations
paginator = client.get_paginator('get_transit_gateway_connect_peer_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_transit_gateway_connect_peer_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayConnectPeerArns (list) --

    One or more transit gateway Connect peer Amazon Resource Names (ARNs).

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TransitGatewayConnectPeerAssociations': [
        {
            'TransitGatewayConnectPeerArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],

}

Response Structure

  • (dict) --

    • TransitGatewayConnectPeerAssociations (list) --

      Information about the transit gateway Connect peer associations.

      • (dict) --

        Describes a transit gateway Connect peer association.

        • TransitGatewayConnectPeerArn (string) --

          The Amazon Resource Name (ARN) of the transit gateway Connect peer.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the device.

        • LinkId (string) --

          The ID of the link.

        • State (string) --

          The state of the association.

class NetworkManager.Paginator.GetTransitGatewayRegistrations
paginator = client.get_paginator('get_transit_gateway_registrations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_transit_gateway_registrations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    TransitGatewayArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayArns (list) --

    The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TransitGatewayRegistrations': [
        {
            'GlobalNetworkId': 'string',
            'TransitGatewayArn': 'string',
            'State': {
                'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
                'Message': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --

    • TransitGatewayRegistrations (list) --

      The transit gateway registrations.

      • (dict) --

        Describes the registration of a transit gateway to a global network.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • TransitGatewayArn (string) --

          The Amazon Resource Name (ARN) of the transit gateway.

        • State (dict) --

          The state of the transit gateway registration.

          • Code (string) --

            The code for the state reason.

          • Message (string) --

            The message for the state reason.

class NetworkManager.Paginator.ListAttachments
paginator = client.get_paginator('list_attachments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.list_attachments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CoreNetworkId='string',
    AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
    EdgeLocation='string',
    State='REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • CoreNetworkId (string) -- The ID of a core network.
  • AttachmentType (string) -- The type of attachment.
  • EdgeLocation (string) -- The Region where the edge is located.
  • State (string) -- The state of the attachment.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Attachments': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
            '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) --

    • Attachments (list) --

      Describes the list of attachments.

      • (dict) --

        Describes a core network attachment.

        • CoreNetworkId (string) --

          A core network ID.

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

class NetworkManager.Paginator.ListConnectPeers
paginator = client.get_paginator('list_connect_peers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.list_connect_peers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CoreNetworkId='string',
    ConnectAttachmentId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • CoreNetworkId (string) -- The ID of a core network.
  • ConnectAttachmentId (string) -- The ID of the attachment.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

}

Response Structure

  • (dict) --

    • ConnectPeers (list) --

      Describes the Connect peers.

      • (dict) --

        Summary description of a Connect peer.

        • CoreNetworkId (string) --

          The ID of a core network.

        • ConnectAttachmentId (string) --

          The ID of a Connect peer attachment.

        • ConnectPeerId (string) --

          The ID of a Connect peer.

        • EdgeLocation (string) --

          The Region where the edge is located.

        • ConnectPeerState (string) --

          The state of a Connect peer.

        • CreatedAt (datetime) --

          The timestamp when a Connect peer was created.

        • Tags (list) --

          The tags associated with a Connect peer summary.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

class NetworkManager.Paginator.ListCoreNetworkPolicyVersions
paginator = client.get_paginator('list_core_network_policy_versions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.list_core_network_policy_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CoreNetworkId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'CoreNetworkPolicyVersions': [
        {
            'CoreNetworkId': 'string',
            'PolicyVersionId': 123,
            'Alias': 'LIVE'|'LATEST',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE'
        },
    ],

}

Response Structure

  • (dict) --

    • CoreNetworkPolicyVersions (list) --

      Describes core network policy versions.

      • (dict) --

        Describes a core network policy version.

        • CoreNetworkId (string) --

          The ID of a core network.

        • PolicyVersionId (integer) --

          The ID of the policy version.

        • Alias (string) --

          Whether a core network policy is the current policy or the most recently submitted policy.

        • Description (string) --

          The description of a core network policy version.

        • CreatedAt (datetime) --

          The timestamp when a core network policy version was created.

        • ChangeSetState (string) --

          The status of the policy version change set.

class NetworkManager.Paginator.ListCoreNetworks
paginator = client.get_paginator('list_core_networks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.list_core_networks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'CoreNetworks': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'GlobalNetworkId': 'string',
            'OwnerAccountId': 'string',
            'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --
    • CoreNetworks (list) --

      Describes the list of core networks.

      • (dict) --

        Returns summary information about a core network.

        • CoreNetworkId (string) --

          The ID of a core network.

        • CoreNetworkArn (string) --

          a core network ARN.

        • GlobalNetworkId (string) --

          The global network ID.

        • OwnerAccountId (string) --

          The ID of the account owner.

        • State (string) --

          The state of a core network.

        • Description (string) --

          The description of a core network.

        • Tags (list) --

          The key-value tags associated with a core network summary.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.