Networkmanager

This page documents function available when using the Networkmanager module, created with @service Networkmanager.

Index

Documentation

Main.Networkmanager.accept_attachmentMethod
accept_attachment(attachment_id)
accept_attachment(attachment_id, params::Dict{String,<:Any})

Accepts a core network attachment request. Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.

Arguments

  • attachment_id: The ID of the attachment.
source
Main.Networkmanager.associate_connect_peerMethod
associate_connect_peer(connect_peer_id, device_id, global_network_id)
associate_connect_peer(connect_peer_id, device_id, global_network_id, params::Dict{String,<:Any})

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

Arguments

  • connect_peer_id: The ID of the Connect peer.
  • device_id: The ID of the device.
  • 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:

  • "LinkId": The ID of the link.
source
Main.Networkmanager.associate_customer_gatewayMethod
associate_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 or core network registered in your global network. When you register a transit gateway or core network, 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.
  • 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.
source
Main.Networkmanager.associate_linkMethod
associate_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.
source
Main.Networkmanager.associate_transit_gateway_connect_peerMethod
associate_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.
source
Main.Networkmanager.create_connect_attachmentMethod
create_connect_attachment(core_network_id, edge_location, options, transport_attachment_id)
create_connect_attachment(core_network_id, edge_location, options, transport_attachment_id, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network where you want to create the attachment.
  • edge_location: The Region where the edge is located.
  • options: Options for creating an attachment.
  • transport_attachment_id: The ID of the attachment between the two connections.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The client token associated with the request.
  • "Tags": The list of key-value tags associated with the request.
source
Main.Networkmanager.create_connect_peerMethod
create_connect_peer(connect_attachment_id, inside_cidr_blocks, peer_address)
create_connect_peer(connect_attachment_id, inside_cidr_blocks, peer_address, params::Dict{String,<:Any})

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

Arguments

  • connect_attachment_id: The ID of the connection attachment.
  • inside_cidr_blocks: The inside IP addresses used for BGP peering.
  • peer_address: The Connect peer address.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BgpOptions": The Connect peer BGP options.
  • "ClientToken": The client token associated with the request.
  • "CoreNetworkAddress": A Connect peer core network address.
  • "Tags": The tags associated with the peer request.
source
Main.Networkmanager.create_connectionMethod
create_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.
source
Main.Networkmanager.create_core_networkMethod
create_core_network(global_network_id)
create_core_network(global_network_id, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The client token associated with a core network request.
  • "Description": The description of a core network.
  • "PolicyDocument": The policy document for creating a core network.
  • "Tags": Key-value tags associated with a core network request.
source
Main.Networkmanager.create_deviceMethod
create_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 Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
  • "Description": A description of the device. Constraints: Maximum length of 256 characters.
  • "Location": The location of the device.
  • "Model": The model of the device. Constraints: Maximum length of 128 characters.
  • "SerialNumber": The serial number of the device. 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. Constraints: Maximum length of 128 characters.
source
Main.Networkmanager.create_global_networkMethod
create_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. Constraints: Maximum length of 256 characters.
  • "Tags": The tags to apply to the resource during creation.
source
Main.Networkmanager.create_linkMethod
create_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. Constraints: Maximum length of 256 characters.
  • "Provider": The provider of the link. Constraints: Maximum length of 128 characters. Cannot include the following characters: | ^
  • "Tags": The tags to apply to the resource during creation.
  • "Type": The type of the link. Constraints: Maximum length of 128 characters. Cannot include the following characters: | ^
source
Main.Networkmanager.create_siteMethod
create_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. 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.
source
Main.Networkmanager.create_site_to_site_vpn_attachmentMethod
create_site_to_site_vpn_attachment(core_network_id, vpn_connection_arn)
create_site_to_site_vpn_attachment(core_network_id, vpn_connection_arn, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network where you're creating a site-to-site VPN attachment.
  • vpn_connection_arn: The ARN identifying the VPN attachment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The client token associated with the request.
  • "Tags": The tags associated with the request.
source
Main.Networkmanager.create_transit_gateway_peeringMethod
create_transit_gateway_peering(core_network_id, transit_gateway_arn)
create_transit_gateway_peering(core_network_id, transit_gateway_arn, params::Dict{String,<:Any})

Creates a transit gateway peering connection.

Arguments

  • core_network_id: The ID of a core network.
  • transit_gateway_arn: The ARN of the transit gateway for the peering request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The client token associated with the request.
  • "Tags": The list of key-value tags associated with the request.
source
Main.Networkmanager.create_transit_gateway_route_table_attachmentMethod
create_transit_gateway_route_table_attachment(peering_id, transit_gateway_route_table_arn)
create_transit_gateway_route_table_attachment(peering_id, transit_gateway_route_table_arn, params::Dict{String,<:Any})

Creates a transit gateway route table attachment.

Arguments

  • peering_id: The ID of the peer for the
  • transit_gateway_route_table_arn: The ARN of the transit gateway route table for the attachment request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The client token associated with the request.
  • "Tags": The list of key-value tags associated with the request.
source
Main.Networkmanager.create_vpc_attachmentMethod
create_vpc_attachment(core_network_id, subnet_arns, vpc_arn)
create_vpc_attachment(core_network_id, subnet_arns, vpc_arn, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network for the VPC attachment.
  • subnet_arns: The subnet ARN of the VPC attachment.
  • vpc_arn: The ARN of the VPC.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The client token associated with the request.
  • "Options": Options for the VPC attachment.
  • "Tags": The key-value tags associated with the request.
source
Main.Networkmanager.delete_attachmentMethod
delete_attachment(attachment_id)
delete_attachment(attachment_id, params::Dict{String,<:Any})

Deletes an attachment. Supports all attachment types.

Arguments

  • attachment_id: The ID of the attachment to delete.
source
Main.Networkmanager.delete_connect_peerMethod
delete_connect_peer(connect_peer_id)
delete_connect_peer(connect_peer_id, params::Dict{String,<:Any})

Deletes a Connect peer.

Arguments

  • connect_peer_id: The ID of the deleted Connect peer.
source
Main.Networkmanager.delete_connectionMethod
delete_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.
source
Main.Networkmanager.delete_core_networkMethod
delete_core_network(core_network_id)
delete_core_network(core_network_id, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The network ID of the deleted core network.
source
Main.Networkmanager.delete_core_network_policy_versionMethod
delete_core_network_policy_version(core_network_id, policy_version_id)
delete_core_network_policy_version(core_network_id, policy_version_id, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network for the deleted policy.
  • policy_version_id: The version ID of the deleted policy.
source
Main.Networkmanager.delete_deviceMethod
delete_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.
source
Main.Networkmanager.delete_global_networkMethod
delete_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), deregister all transit gateways, and delete any core networks.

Arguments

  • global_network_id: The ID of the global network.
source
Main.Networkmanager.delete_linkMethod
delete_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.
source
Main.Networkmanager.delete_peeringMethod
delete_peering(peering_id)
delete_peering(peering_id, params::Dict{String,<:Any})

Deletes an existing peering connection.

Arguments

  • peering_id: The ID of the peering connection to delete.
source
Main.Networkmanager.delete_resource_policyMethod
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the policy to delete.
source
Main.Networkmanager.delete_siteMethod
delete_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.
source
Main.Networkmanager.deregister_transit_gatewayMethod
deregister_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.
source
Main.Networkmanager.describe_global_networksMethod
describe_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.
source
Main.Networkmanager.disassociate_connect_peerMethod
disassociate_connect_peer(connect_peer_id, global_network_id)
disassociate_connect_peer(connect_peer_id, global_network_id, params::Dict{String,<:Any})

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

Arguments

  • connect_peer_id: The ID of the Connect peer to disassociate from a device.
  • global_network_id: The ID of the global network.
source
Main.Networkmanager.disassociate_customer_gatewayMethod
disassociate_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.
  • global_network_id: The ID of the global network.
source
Main.Networkmanager.disassociate_linkMethod
disassociate_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.
source
Main.Networkmanager.disassociate_transit_gateway_connect_peerMethod
disassociate_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.
source
Main.Networkmanager.execute_core_network_change_setMethod
execute_core_network_change_set(core_network_id, policy_version_id)
execute_core_network_change_set(core_network_id, policy_version_id, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network.
  • policy_version_id: The ID of the policy version.
source
Main.Networkmanager.get_connect_attachmentMethod
get_connect_attachment(attachment_id)
get_connect_attachment(attachment_id, params::Dict{String,<:Any})

Returns information about a core network Connect attachment.

Arguments

  • attachment_id: The ID of the attachment.
source
Main.Networkmanager.get_connect_peerMethod
get_connect_peer(connect_peer_id)
get_connect_peer(connect_peer_id, params::Dict{String,<:Any})

Returns information about a core network Connect peer.

Arguments

  • connect_peer_id: The ID of the Connect peer.
source
Main.Networkmanager.get_connect_peer_associationsMethod
get_connect_peer_associations(global_network_id)
get_connect_peer_associations(global_network_id, params::Dict{String,<:Any})

Returns information about a core network Connect peer associations.

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:

  • "connectPeerIds": The IDs of the Connect peers.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
source
Main.Networkmanager.get_connectionsMethod
get_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.
source
Main.Networkmanager.get_core_networkMethod
get_core_network(core_network_id)
get_core_network(core_network_id, params::Dict{String,<:Any})

Returns information about the LIVE policy for a core network.

Arguments

  • core_network_id: The ID of a core network.
source
Main.Networkmanager.get_core_network_change_eventsMethod
get_core_network_change_events(core_network_id, policy_version_id)
get_core_network_change_events(core_network_id, policy_version_id, params::Dict{String,<:Any})

Returns information about a core network change event.

Arguments

  • core_network_id: The ID of a core network.
  • policy_version_id: The ID of the policy version.

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.
source
Main.Networkmanager.get_core_network_change_setMethod
get_core_network_change_set(core_network_id, policy_version_id)
get_core_network_change_set(core_network_id, policy_version_id, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network.
  • policy_version_id: The ID of the policy version.

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.
source
Main.Networkmanager.get_core_network_policyMethod
get_core_network_policy(core_network_id)
get_core_network_policy(core_network_id, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": The alias of a core network policy
  • "policyVersionId": The ID of a core network policy version.
source
Main.Networkmanager.get_customer_gateway_associationsMethod
get_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). The maximum is 10.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
source
Main.Networkmanager.get_devicesMethod
get_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.
source
Main.Networkmanager.get_link_associationsMethod
get_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.
source
Main.Networkmanager.get_linksMethod
get_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.
source
Main.Networkmanager.get_network_resource_countsMethod
get_network_resource_counts(global_network_id)
get_network_resource_counts(global_network_id, params::Dict{String,<:Any})

Gets the count of network resources, by resource type, for the 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.
  • "resourceType": The resource type. The following are the supported resource types for Direct Connect: dxcon dx-gateway dx-vif The following are the supported resource types for Network Manager: connection device link site The following are the supported resource types for Amazon VPC: customer-gateway transit-gateway transit-gateway-attachment transit-gateway-connect-peer transit-gateway-route-table vpn-connection
source
Main.Networkmanager.get_network_resource_relationshipsMethod
get_network_resource_relationships(global_network_id)
get_network_resource_relationships(global_network_id, params::Dict{String,<:Any})

Gets the network resource relationships for the 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:

  • "accountId": The Amazon Web Services account ID.
  • "awsRegion": The Amazon Web Services Region.
  • "coreNetworkId": The ID of a core network.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
  • "registeredGatewayArn": The ARN of the registered gateway.
  • "resourceArn": The ARN of the gateway.
  • "resourceType": The resource type. The following are the supported resource types for Direct Connect: dxcon dx-gateway dx-vif The following are the supported resource types for Network Manager: connection device link site The following are the supported resource types for Amazon VPC: customer-gateway transit-gateway transit-gateway-attachment transit-gateway-connect-peer transit-gateway-route-table vpn-connection
source
Main.Networkmanager.get_network_resourcesMethod
get_network_resources(global_network_id)
get_network_resources(global_network_id, params::Dict{String,<:Any})

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

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:

  • "accountId": The Amazon Web Services account ID.
  • "awsRegion": The Amazon Web Services Region.
  • "coreNetworkId": The ID of a core network.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
  • "registeredGatewayArn": The ARN of the gateway.
  • "resourceArn": The ARN of the resource.
  • "resourceType": The resource type. The following are the supported resource types for Direct Connect: dxcon - The definition model is Connection. dx-gateway - The definition model is DirectConnectGateway. dx-vif - The definition model is VirtualInterface. The following are the supported resource types for Network Manager: connection - The definition model is Connection. device - The definition model is Device. link - The definition model is Link. site - The definition model is Site. The following are the supported resource types for Amazon VPC: customer-gateway - The definition model is CustomerGateway. transit-gateway - The definition model is TransitGateway. transit-gateway-attachment - The definition model is TransitGatewayAttachment. transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer. transit-gateway-route-table - The definition model is TransitGatewayRouteTable. vpn-connection - The definition model is VpnConnection.
source
Main.Networkmanager.get_network_routesMethod
get_network_routes(route_table_identifier, global_network_id)
get_network_routes(route_table_identifier, global_network_id, params::Dict{String,<:Any})

Gets the network routes of the specified global network.

Arguments

  • route_table_identifier: The ID of the route table.
  • 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:

  • "DestinationFilters": Filter by route table destination. Possible Values: TRANSITGATEWAYATTACHMENTID, RESOURCEID, or RESOURCE_TYPE.
  • "ExactCidrMatches": An exact CIDR block.
  • "LongestPrefixMatches": The most specific route that matches the traffic (longest prefix match).
  • "PrefixListIds": The IDs of the prefix lists.
  • "States": The route states.
  • "SubnetOfMatches": The routes with a subnet that match the specified CIDR filter.
  • "SupernetOfMatches": The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.
  • "Types": The route types.
source
Main.Networkmanager.get_network_telemetryMethod
get_network_telemetry(global_network_id)
get_network_telemetry(global_network_id, params::Dict{String,<:Any})

Gets the network telemetry of the 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:

  • "accountId": The Amazon Web Services account ID.
  • "awsRegion": The Amazon Web Services Region.
  • "coreNetworkId": The ID of a core network.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
  • "registeredGatewayArn": The ARN of the gateway.
  • "resourceArn": The ARN of the resource.
  • "resourceType": The resource type. The following are the supported resource types for Direct Connect: dxcon dx-gateway dx-vif The following are the supported resource types for Network Manager: connection device link site The following are the supported resource types for Amazon VPC: customer-gateway transit-gateway transit-gateway-attachment transit-gateway-connect-peer transit-gateway-route-table vpn-connection
source
Main.Networkmanager.get_resource_policyMethod
get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})

Returns information about a resource policy.

Arguments

  • resource_arn: The ARN of the resource.
source
Main.Networkmanager.get_route_analysisMethod
get_route_analysis(global_network_id, route_analysis_id)
get_route_analysis(global_network_id, route_analysis_id, params::Dict{String,<:Any})

Gets information about the specified route analysis.

Arguments

  • global_network_id: The ID of the global network.
  • route_analysis_id: The ID of the route analysis.
source
Main.Networkmanager.get_site_to_site_vpn_attachmentMethod
get_site_to_site_vpn_attachment(attachment_id)
get_site_to_site_vpn_attachment(attachment_id, params::Dict{String,<:Any})

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

Arguments

  • attachment_id: The ID of the attachment.
source
Main.Networkmanager.get_sitesMethod
get_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.
source
Main.Networkmanager.get_transit_gateway_connect_peer_associationsMethod
get_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).
source
Main.Networkmanager.get_transit_gateway_peeringMethod
get_transit_gateway_peering(peering_id)
get_transit_gateway_peering(peering_id, params::Dict{String,<:Any})

Returns information about a transit gateway peer.

Arguments

  • peering_id: The ID of the peering request.
source
Main.Networkmanager.get_transit_gateway_registrationsMethod
get_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.
source
Main.Networkmanager.get_transit_gateway_route_table_attachmentMethod
get_transit_gateway_route_table_attachment(attachment_id)
get_transit_gateway_route_table_attachment(attachment_id, params::Dict{String,<:Any})

Returns information about a transit gateway route table attachment.

Arguments

  • attachment_id: The ID of the transit gateway route table attachment.
source
Main.Networkmanager.get_vpc_attachmentMethod
get_vpc_attachment(attachment_id)
get_vpc_attachment(attachment_id, params::Dict{String,<:Any})

Returns information about a VPC attachment.

Arguments

  • attachment_id: The ID of the attachment.
source
Main.Networkmanager.list_attachmentsMethod
list_attachments()
list_attachments(params::Dict{String,<:Any})

Returns a list of core network attachments.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "attachmentType": The type of attachment.
  • "coreNetworkId": The ID of a core network.
  • "edgeLocation": The Region where the edge is located.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
  • "state": The state of the attachment.
source
Main.Networkmanager.list_connect_peersMethod
list_connect_peers()
list_connect_peers(params::Dict{String,<:Any})

Returns a list of core network Connect peers.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "connectAttachmentId": The ID of the attachment.
  • "coreNetworkId": The ID of a core network.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
source
Main.Networkmanager.list_core_network_policy_versionsMethod
list_core_network_policy_versions(core_network_id)
list_core_network_policy_versions(core_network_id, params::Dict{String,<:Any})

Returns a list of core network policy versions.

Arguments

  • core_network_id: The ID of a core 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.
source
Main.Networkmanager.list_core_networksMethod
list_core_networks()
list_core_networks(params::Dict{String,<:Any})

Returns a list of owned and shared core networks.

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.
source
Main.Networkmanager.list_organization_service_access_statusMethod
list_organization_service_access_status()
list_organization_service_access_status(params::Dict{String,<:Any})

Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

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.
source
Main.Networkmanager.list_peeringsMethod
list_peerings()
list_peerings(params::Dict{String,<:Any})

Lists the peerings for a core network.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "coreNetworkId": The ID of a core network.
  • "edgeLocation": Returns a list edge locations for the
  • "maxResults": The maximum number of results to return.
  • "nextToken": The token for the next page of results.
  • "peeringType": Returns a list of a peering requests.
  • "state": Returns a list of the peering request states.
source
Main.Networkmanager.list_tags_for_resourceMethod
list_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.
source
Main.Networkmanager.put_core_network_policyMethod
put_core_network_policy(policy_document, core_network_id)
put_core_network_policy(policy_document, core_network_id, params::Dict{String,<:Any})

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

Arguments

  • policy_document: The policy document.
  • core_network_id: The ID of a core network.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The client token associated with the request.
  • "Description": a core network policy description.
  • "LatestVersionId": The ID of a core network policy.
source
Main.Networkmanager.put_resource_policyMethod
put_resource_policy(policy_document, resource_arn)
put_resource_policy(policy_document, resource_arn, params::Dict{String,<:Any})

Creates or updates a resource policy.

Arguments

  • policy_document: The JSON resource policy document.
  • resource_arn: The ARN of the resource policy.
source
Main.Networkmanager.register_transit_gatewayMethod
register_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 Amazon Web Services Region, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.

Arguments

  • transit_gateway_arn: The Amazon Resource Name (ARN) of the transit gateway.
  • global_network_id: The ID of the global network.
source
Main.Networkmanager.reject_attachmentMethod
reject_attachment(attachment_id)
reject_attachment(attachment_id, params::Dict{String,<:Any})

Rejects a core network attachment request.

Arguments

  • attachment_id: The ID of the attachment.
source
Main.Networkmanager.restore_core_network_policy_versionMethod
restore_core_network_policy_version(core_network_id, policy_version_id)
restore_core_network_policy_version(core_network_id, policy_version_id, params::Dict{String,<:Any})

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

Arguments

  • core_network_id: The ID of a core network.
  • policy_version_id: The ID of the policy version to restore.
source
Main.Networkmanager.start_organization_service_access_updateMethod
start_organization_service_access_update(action)
start_organization_service_access_update(action, params::Dict{String,<:Any})

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

Arguments

  • action: The action to take for the update request. This can be either ENABLE or DISABLE.
source
Main.Networkmanager.start_route_analysisMethod
start_route_analysis(destination, source, global_network_id)
start_route_analysis(destination, source, global_network_id, params::Dict{String,<:Any})

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

Arguments

  • destination: The destination.
  • source: The source from which traffic originates.
  • 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:

  • "IncludeReturnPath": Indicates whether to analyze the return path. The default is false.
  • "UseMiddleboxes": Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.
source
Main.Networkmanager.tag_resourceMethod
tag_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.
source
Main.Networkmanager.untag_resourceMethod
untag_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.
source
Main.Networkmanager.update_connectionMethod
update_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.
source
Main.Networkmanager.update_core_networkMethod
update_core_network(core_network_id)
update_core_network(core_network_id, params::Dict{String,<:Any})

Updates the description of a core network.

Arguments

  • core_network_id: The ID of a core network.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the update.
source
Main.Networkmanager.update_deviceMethod
update_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 Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
  • "Description": A description of the device. Constraints: Maximum length of 256 characters.
  • "Location":
  • "Model": The model of the device. Constraints: Maximum length of 128 characters.
  • "SerialNumber": The serial number of the device. Constraints: Maximum length of 128 characters.
  • "SiteId": The ID of the site.
  • "Type": The type of the device.
  • "Vendor": The vendor of the device. Constraints: Maximum length of 128 characters.
source
Main.Networkmanager.update_global_networkMethod
update_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. Constraints: Maximum length of 256 characters.
source
Main.Networkmanager.update_linkMethod
update_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. Constraints: Maximum length of 256 characters.
  • "Provider": The provider of the link. Constraints: Maximum length of 128 characters.
  • "Type": The type of the link. Constraints: Maximum length of 128 characters.
source
Main.Networkmanager.update_network_resource_metadataMethod
update_network_resource_metadata(metadata, global_network_id, resource_arn)
update_network_resource_metadata(metadata, global_network_id, resource_arn, params::Dict{String,<:Any})

Updates the resource metadata for the specified global network.

Arguments

  • metadata: The resource metadata.
  • global_network_id: The ID of the global network.
  • resource_arn: The ARN of the resource.
source
Main.Networkmanager.update_siteMethod
update_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. 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.
source
Main.Networkmanager.update_vpc_attachmentMethod
update_vpc_attachment(attachment_id)
update_vpc_attachment(attachment_id, params::Dict{String,<:Any})

Updates a VPC attachment.

Arguments

  • attachment_id: The ID of the attachment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AddSubnetArns": Adds a subnet ARN to the VPC attachment.
  • "Options": Additional options for updating the VPC attachment.
  • "RemoveSubnetArns": Removes a subnet ARN from the attachment.
source