NetworkManager

Table of Contents

Client

class NetworkManager.Client

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

client = session.create_client('networkmanager')

These are the available methods:

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. For more information, see Resources Defined by Amazon EC2 .

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

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.

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_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',
    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.

  • Description (string) --

    A description of the device.

    Length Constraints: Maximum length of 256 characters.

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

    The vendor of the device.

    Length Constraints: Maximum length of 128 characters.

  • Model (string) --

    The model of the device.

    Length Constraints: Maximum length of 128 characters.

  • SerialNumber (string) --

    The serial number of the device.

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

        Length Constraints: Maximum length of 128 characters.

      • Value (string) --

        The tag value.

        Length Constraints: Maximum length of 256 characters.

Return type

dict

Returns

Response Syntax

{
    'Device': {
        'DeviceId': 'string',
        'DeviceArn': 'string',
        'GlobalNetworkId': '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.

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

    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.

        Length Constraints: Maximum length of 128 characters.

      • Value (string) --

        The tag value.

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

    Length Constraints: Maximum length of 256 characters.

  • Type (string) --

    The type of the link.

    Constraints: Cannot include the following characters: | ^

    Length Constraints: Maximum length of 128 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: Cannot include the following characters: | ^

    Length Constraints: Maximum length of 128 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.

        Length Constraints: Maximum length of 128 characters.

      • Value (string) --

        The tag value.

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

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

        Length Constraints: Maximum length of 128 characters.

      • Value (string) --

        The tag value.

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

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.

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

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token for the next page of results.

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. For more information, see Resources Defined by Amazon EC2 .

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.

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.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

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). For more information, see Resources Defined by Amazon EC2 . 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.

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

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

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token for the next page of results.

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.

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.

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token for the next page of results.

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

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token for the next page of results.

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.

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

          Length Constraints: Maximum length of 128 characters.

        • Value (string) --

          The tag value.

          Length Constraints: Maximum length of 256 characters.

register_transit_gateway(**kwargs)

Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS 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. For more information, see Resources Defined by Amazon EC2 .

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.

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.

        Length Constraints: Maximum length of 128 characters.

      • Value (string) --

        The tag value.

        Length Constraints: Maximum length of 256 characters.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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

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

  • Description (string) --

    A description of the device.

    Length Constraints: Maximum length of 256 characters.

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

    The vendor of the device.

    Length Constraints: Maximum length of 128 characters.

  • Model (string) --

    The model of the device.

    Length Constraints: Maximum length of 128 characters.

  • SerialNumber (string) --

    The serial number of the device.

    Length 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',
        '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.

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

    Length Constraints: Maximum length of 256 characters.

  • Type (string) --

    The type of the link.

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

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

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

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

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.

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

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

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). For more information, see Resources Defined by Amazon EC2 . 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',
            '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.

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

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

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

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

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.

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

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.