Networkmanager
This page documents function available when using the Networkmanager module, created with @service Networkmanager.
Index
Main.Networkmanager.associate_customer_gatewayMain.Networkmanager.associate_linkMain.Networkmanager.associate_transit_gateway_connect_peerMain.Networkmanager.create_connectionMain.Networkmanager.create_deviceMain.Networkmanager.create_global_networkMain.Networkmanager.create_linkMain.Networkmanager.create_siteMain.Networkmanager.delete_connectionMain.Networkmanager.delete_deviceMain.Networkmanager.delete_global_networkMain.Networkmanager.delete_linkMain.Networkmanager.delete_siteMain.Networkmanager.deregister_transit_gatewayMain.Networkmanager.describe_global_networksMain.Networkmanager.disassociate_customer_gatewayMain.Networkmanager.disassociate_linkMain.Networkmanager.disassociate_transit_gateway_connect_peerMain.Networkmanager.get_connectionsMain.Networkmanager.get_customer_gateway_associationsMain.Networkmanager.get_devicesMain.Networkmanager.get_link_associationsMain.Networkmanager.get_linksMain.Networkmanager.get_sitesMain.Networkmanager.get_transit_gateway_connect_peer_associationsMain.Networkmanager.get_transit_gateway_registrationsMain.Networkmanager.list_tags_for_resourceMain.Networkmanager.register_transit_gatewayMain.Networkmanager.tag_resourceMain.Networkmanager.untag_resourceMain.Networkmanager.update_connectionMain.Networkmanager.update_deviceMain.Networkmanager.update_global_networkMain.Networkmanager.update_linkMain.Networkmanager.update_site
Documentation
Main.Networkmanager.associate_customer_gateway — Methodassociate_customer_gateway(customer_gateway_arn, device_id, global_network_id)
associate_customer_gateway(customer_gateway_arn, device_id, global_network_id, params::Dict{String,<:Any})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.
Arguments
customer_gateway_arn: The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.device_id: The ID of the device.global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"LinkId": The ID of the link.
Main.Networkmanager.associate_link — Methodassociate_link(device_id, link_id, global_network_id)
associate_link(device_id, link_id, global_network_id, params::Dict{String,<:Any})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.
Arguments
device_id: The ID of the device.link_id: The ID of the link.global_network_id: The ID of the global network.
Main.Networkmanager.associate_transit_gateway_connect_peer — Methodassociate_transit_gateway_connect_peer(device_id, transit_gateway_connect_peer_arn, global_network_id)
associate_transit_gateway_connect_peer(device_id, transit_gateway_connect_peer_arn, global_network_id, params::Dict{String,<:Any})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.
Arguments
device_id: The ID of the device.transit_gateway_connect_peer_arn: The Amazon Resource Name (ARN) of the Connect peer.global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"LinkId": The ID of the link.
Main.Networkmanager.create_connection — Methodcreate_connection(connected_device_id, device_id, global_network_id)
create_connection(connected_device_id, device_id, global_network_id, params::Dict{String,<:Any})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.
Arguments
connected_device_id: The ID of the second device in the connection.device_id: The ID of the first device in the connection.global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ConnectedLinkId": The ID of the link for the second device."Description": A description of the connection. Length Constraints: Maximum length of 256 characters."LinkId": The ID of the link for the first device."Tags": The tags to apply to the resource during creation.
Main.Networkmanager.create_device — Methodcreate_device(global_network_id)
create_device(global_network_id, params::Dict{String,<:Any})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.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"AWSLocation": The AWS location of the device."Description": A description of the device. Length Constraints: Maximum length of 256 characters."Location": The location of the device."Model": The model of the device. Length Constraints: Maximum length of 128 characters."SerialNumber": The serial number of the device. Length Constraints: Maximum length of 128 characters."SiteId": The ID of the site."Tags": The tags to apply to the resource during creation."Type": The type of the device."Vendor": The vendor of the device. Length Constraints: Maximum length of 128 characters.
Main.Networkmanager.create_global_network — Methodcreate_global_network()
create_global_network(params::Dict{String,<:Any})Creates a new, empty global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Description": A description of the global network. Length Constraints: Maximum length of 256 characters."Tags": The tags to apply to the resource during creation.
Main.Networkmanager.create_link — Methodcreate_link(bandwidth, site_id, global_network_id)
create_link(bandwidth, site_id, global_network_id, params::Dict{String,<:Any})Creates a new link for a specified site.
Arguments
bandwidth: The upload speed and download speed in Mbps.site_id: The ID of the site.global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Description": A description of the link. Length Constraints: Maximum length of 256 characters."Provider": The provider of the link. Constraints: Cannot include the following characters: | ^ Length Constraints: Maximum length of 128 characters."Tags": The tags to apply to the resource during creation."Type": The type of the link. Constraints: Cannot include the following characters: | ^ Length Constraints: Maximum length of 128 characters.
Main.Networkmanager.create_site — Methodcreate_site(global_network_id)
create_site(global_network_id, params::Dict{String,<:Any})Creates a new site in a global network.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Description": A description of your site. Length Constraints: Maximum length of 256 characters."Location": 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."Tags": The tags to apply to the resource during creation.
Main.Networkmanager.delete_connection — Methoddelete_connection(connection_id, global_network_id)
delete_connection(connection_id, global_network_id, params::Dict{String,<:Any})Deletes the specified connection in your global network.
Arguments
connection_id: The ID of the connection.global_network_id: The ID of the global network.
Main.Networkmanager.delete_device — Methoddelete_device(device_id, global_network_id)
delete_device(device_id, global_network_id, params::Dict{String,<:Any})Deletes an existing device. You must first disassociate the device from any links and customer gateways.
Arguments
device_id: The ID of the device.global_network_id: The ID of the global network.
Main.Networkmanager.delete_global_network — Methoddelete_global_network(global_network_id)
delete_global_network(global_network_id, params::Dict{String,<:Any})Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
Arguments
global_network_id: The ID of the global network.
Main.Networkmanager.delete_link — Methoddelete_link(global_network_id, link_id)
delete_link(global_network_id, link_id, params::Dict{String,<:Any})Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
Arguments
global_network_id: The ID of the global network.link_id: The ID of the link.
Main.Networkmanager.delete_site — Methoddelete_site(global_network_id, site_id)
delete_site(global_network_id, site_id, params::Dict{String,<:Any})Deletes an existing site. The site cannot be associated with any device or link.
Arguments
global_network_id: The ID of the global network.site_id: The ID of the site.
Main.Networkmanager.deregister_transit_gateway — Methodderegister_transit_gateway(global_network_id, transit_gateway_arn)
deregister_transit_gateway(global_network_id, transit_gateway_arn, params::Dict{String,<:Any})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.
Arguments
global_network_id: The ID of the global network.transit_gateway_arn: The Amazon Resource Name (ARN) of the transit gateway.
Main.Networkmanager.describe_global_networks — Methoddescribe_global_networks()
describe_global_networks(params::Dict{String,<:Any})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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"globalNetworkIds": The IDs of one or more global networks. The maximum is 10."maxResults": The maximum number of results to return."nextToken": The token for the next page of results.
Main.Networkmanager.disassociate_customer_gateway — Methoddisassociate_customer_gateway(customer_gateway_arn, global_network_id)
disassociate_customer_gateway(customer_gateway_arn, global_network_id, params::Dict{String,<:Any})Disassociates a customer gateway from a device and a link.
Arguments
customer_gateway_arn: The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.global_network_id: The ID of the global network.
Main.Networkmanager.disassociate_link — Methoddisassociate_link(device_id, global_network_id, link_id)
disassociate_link(device_id, global_network_id, link_id, params::Dict{String,<:Any})Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
Arguments
device_id: The ID of the device.global_network_id: The ID of the global network.link_id: The ID of the link.
Main.Networkmanager.disassociate_transit_gateway_connect_peer — Methoddisassociate_transit_gateway_connect_peer(global_network_id, transit_gateway_connect_peer_arn)
disassociate_transit_gateway_connect_peer(global_network_id, transit_gateway_connect_peer_arn, params::Dict{String,<:Any})Disassociates a transit gateway Connect peer from a device and link.
Arguments
global_network_id: The ID of the global network.transit_gateway_connect_peer_arn: The Amazon Resource Name (ARN) of the transit gateway Connect peer.
Main.Networkmanager.get_connections — Methodget_connections(global_network_id)
get_connections(global_network_id, params::Dict{String,<:Any})Gets information about one or more of your connections in a global network.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"connectionIds": One or more connection IDs."deviceId": The ID of the device."maxResults": The maximum number of results to return."nextToken": The token for the next page of results.
Main.Networkmanager.get_customer_gateway_associations — Methodget_customer_gateway_associations(global_network_id)
get_customer_gateway_associations(global_network_id, params::Dict{String,<:Any})Gets the association information for customer gateways that are associated with devices and links in your global network.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"customerGatewayArns": One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10."maxResults": The maximum number of results to return."nextToken": The token for the next page of results.
Main.Networkmanager.get_devices — Methodget_devices(global_network_id)
get_devices(global_network_id, params::Dict{String,<:Any})Gets information about one or more of your devices in a global network.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"deviceIds": One or more device IDs. The maximum is 10."maxResults": The maximum number of results to return."nextToken": The token for the next page of results."siteId": The ID of the site.
Main.Networkmanager.get_link_associations — Methodget_link_associations(global_network_id)
get_link_associations(global_network_id, params::Dict{String,<:Any})Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"deviceId": The ID of the device."linkId": The ID of the link."maxResults": The maximum number of results to return."nextToken": The token for the next page of results.
Main.Networkmanager.get_links — Methodget_links(global_network_id)
get_links(global_network_id, params::Dict{String,<:Any})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.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"linkIds": One or more link IDs. The maximum is 10."maxResults": The maximum number of results to return."nextToken": The token for the next page of results."provider": The link provider."siteId": The ID of the site."type": The link type.
Main.Networkmanager.get_sites — Methodget_sites(global_network_id)
get_sites(global_network_id, params::Dict{String,<:Any})Gets information about one or more of your sites in a global network.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return."nextToken": The token for the next page of results."siteIds": One or more site IDs. The maximum is 10.
Main.Networkmanager.get_transit_gateway_connect_peer_associations — Methodget_transit_gateway_connect_peer_associations(global_network_id)
get_transit_gateway_connect_peer_associations(global_network_id, params::Dict{String,<:Any})Gets information about one or more of your transit gateway Connect peer associations in a global network.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return."nextToken": The token for the next page of results."transitGatewayConnectPeerArns": One or more transit gateway Connect peer Amazon Resource Names (ARNs).
Main.Networkmanager.get_transit_gateway_registrations — Methodget_transit_gateway_registrations(global_network_id)
get_transit_gateway_registrations(global_network_id, params::Dict{String,<:Any})Gets information about the transit gateway registrations in a specified global network.
Arguments
global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return."nextToken": The token for the next page of results."transitGatewayArns": The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
Main.Networkmanager.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags for a specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Networkmanager.register_transit_gateway — Methodregister_transit_gateway(transit_gateway_arn, global_network_id)
register_transit_gateway(transit_gateway_arn, global_network_id, params::Dict{String,<:Any})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.
Arguments
transit_gateway_arn: The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.global_network_id: The ID of the global network.
Main.Networkmanager.tag_resource — Methodtag_resource(tags, resource_arn)
tag_resource(tags, resource_arn, params::Dict{String,<:Any})Tags a specified resource.
Arguments
tags: The tags to apply to the specified resource.resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Networkmanager.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes tags from a specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tag_keys: The tag keys to remove from the specified resource.
Main.Networkmanager.update_connection — Methodupdate_connection(connection_id, global_network_id)
update_connection(connection_id, global_network_id, params::Dict{String,<:Any})Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.
Arguments
connection_id: The ID of the connection.global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ConnectedLinkId": The ID of the link for the second device in the connection."Description": A description of the connection. Length Constraints: Maximum length of 256 characters."LinkId": The ID of the link for the first device in the connection.
Main.Networkmanager.update_device — Methodupdate_device(device_id, global_network_id)
update_device(device_id, global_network_id, params::Dict{String,<:Any})Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
Arguments
device_id: The ID of the device.global_network_id: The ID of the global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"AWSLocation": The AWS location of the device."Description": A description of the device. Length Constraints: Maximum length of 256 characters."Location":"Model": The model of the device. Length Constraints: Maximum length of 128 characters."SerialNumber": The serial number of the device. Length Constraints: Maximum length of 128 characters."SiteId": The ID of the site."Type": The type of the device."Vendor": The vendor of the device. Length Constraints: Maximum length of 128 characters.
Main.Networkmanager.update_global_network — Methodupdate_global_network(global_network_id)
update_global_network(global_network_id, params::Dict{String,<:Any})Updates an existing global network. To remove information for any of the parameters, specify an empty string.
Arguments
global_network_id: The ID of your global network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Description": A description of the global network. Length Constraints: Maximum length of 256 characters.
Main.Networkmanager.update_link — Methodupdate_link(global_network_id, link_id)
update_link(global_network_id, link_id, params::Dict{String,<:Any})Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
Arguments
global_network_id: The ID of the global network.link_id: The ID of the link.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Bandwidth": The upload and download speed in Mbps."Description": A description of the link. Length Constraints: Maximum length of 256 characters."Provider": The provider of the link. Length Constraints: Maximum length of 128 characters."Type": The type of the link. Length Constraints: Maximum length of 128 characters.
Main.Networkmanager.update_site — Methodupdate_site(global_network_id, site_id)
update_site(global_network_id, site_id, params::Dict{String,<:Any})Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
Arguments
global_network_id: The ID of the global network.site_id: The ID of your site.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Description": A description of your site. Length Constraints: Maximum length of 256 characters."Location": The site location: Address: The physical address of the site. Latitude: The latitude of the site. Longitude: The longitude of the site.