Networkmanager
This page documents function available when using the Networkmanager
module, created with @service Networkmanager
.
Index
Main.Networkmanager.accept_attachment
Main.Networkmanager.associate_connect_peer
Main.Networkmanager.associate_customer_gateway
Main.Networkmanager.associate_link
Main.Networkmanager.associate_transit_gateway_connect_peer
Main.Networkmanager.create_connect_attachment
Main.Networkmanager.create_connect_peer
Main.Networkmanager.create_connection
Main.Networkmanager.create_core_network
Main.Networkmanager.create_device
Main.Networkmanager.create_global_network
Main.Networkmanager.create_link
Main.Networkmanager.create_site
Main.Networkmanager.create_site_to_site_vpn_attachment
Main.Networkmanager.create_transit_gateway_peering
Main.Networkmanager.create_transit_gateway_route_table_attachment
Main.Networkmanager.create_vpc_attachment
Main.Networkmanager.delete_attachment
Main.Networkmanager.delete_connect_peer
Main.Networkmanager.delete_connection
Main.Networkmanager.delete_core_network
Main.Networkmanager.delete_core_network_policy_version
Main.Networkmanager.delete_device
Main.Networkmanager.delete_global_network
Main.Networkmanager.delete_link
Main.Networkmanager.delete_peering
Main.Networkmanager.delete_resource_policy
Main.Networkmanager.delete_site
Main.Networkmanager.deregister_transit_gateway
Main.Networkmanager.describe_global_networks
Main.Networkmanager.disassociate_connect_peer
Main.Networkmanager.disassociate_customer_gateway
Main.Networkmanager.disassociate_link
Main.Networkmanager.disassociate_transit_gateway_connect_peer
Main.Networkmanager.execute_core_network_change_set
Main.Networkmanager.get_connect_attachment
Main.Networkmanager.get_connect_peer
Main.Networkmanager.get_connect_peer_associations
Main.Networkmanager.get_connections
Main.Networkmanager.get_core_network
Main.Networkmanager.get_core_network_change_events
Main.Networkmanager.get_core_network_change_set
Main.Networkmanager.get_core_network_policy
Main.Networkmanager.get_customer_gateway_associations
Main.Networkmanager.get_devices
Main.Networkmanager.get_link_associations
Main.Networkmanager.get_links
Main.Networkmanager.get_network_resource_counts
Main.Networkmanager.get_network_resource_relationships
Main.Networkmanager.get_network_resources
Main.Networkmanager.get_network_routes
Main.Networkmanager.get_network_telemetry
Main.Networkmanager.get_resource_policy
Main.Networkmanager.get_route_analysis
Main.Networkmanager.get_site_to_site_vpn_attachment
Main.Networkmanager.get_sites
Main.Networkmanager.get_transit_gateway_connect_peer_associations
Main.Networkmanager.get_transit_gateway_peering
Main.Networkmanager.get_transit_gateway_registrations
Main.Networkmanager.get_transit_gateway_route_table_attachment
Main.Networkmanager.get_vpc_attachment
Main.Networkmanager.list_attachments
Main.Networkmanager.list_connect_peers
Main.Networkmanager.list_core_network_policy_versions
Main.Networkmanager.list_core_networks
Main.Networkmanager.list_organization_service_access_status
Main.Networkmanager.list_peerings
Main.Networkmanager.list_tags_for_resource
Main.Networkmanager.put_core_network_policy
Main.Networkmanager.put_resource_policy
Main.Networkmanager.register_transit_gateway
Main.Networkmanager.reject_attachment
Main.Networkmanager.restore_core_network_policy_version
Main.Networkmanager.start_organization_service_access_update
Main.Networkmanager.start_route_analysis
Main.Networkmanager.tag_resource
Main.Networkmanager.untag_resource
Main.Networkmanager.update_connection
Main.Networkmanager.update_core_network
Main.Networkmanager.update_device
Main.Networkmanager.update_global_network
Main.Networkmanager.update_link
Main.Networkmanager.update_network_resource_metadata
Main.Networkmanager.update_site
Main.Networkmanager.update_vpc_attachment
Documentation
Main.Networkmanager.accept_attachment
— Methodaccept_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.
Main.Networkmanager.associate_connect_peer
— Methodassociate_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.
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 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.
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_connect_attachment
— Methodcreate_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.
Main.Networkmanager.create_connect_peer
— Methodcreate_connect_peer(connect_attachment_id, peer_address)
create_connect_peer(connect_attachment_id, 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.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. This only applies only when the protocol is GRE."ClientToken"
: The client token associated with the request."CoreNetworkAddress"
: A Connect peer core network address. This only applies only when the protocol is GRE."InsideCidrBlocks"
: The inside IP addresses used for BGP peering."SubnetArn"
: The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP."Tags"
: The tags associated with the peer request.
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_core_network
— Methodcreate_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.
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 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.
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. 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. 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: | ^
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. 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.create_site_to_site_vpn_attachment
— Methodcreate_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.
Main.Networkmanager.create_transit_gateway_peering
— Methodcreate_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.
Main.Networkmanager.create_transit_gateway_route_table_attachment
— Methodcreate_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 thetransit_gateway_route_table_arn
: The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".
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.
Main.Networkmanager.create_vpc_attachment
— Methodcreate_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.
Main.Networkmanager.delete_attachment
— Methoddelete_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.
Main.Networkmanager.delete_connect_peer
— Methoddelete_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.
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_core_network
— Methoddelete_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.
Main.Networkmanager.delete_core_network_policy_version
— Methoddelete_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.
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), deregister all transit gateways, and delete any core networks.
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_peering
— Methoddelete_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.
Main.Networkmanager.delete_resource_policy
— Methoddelete_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.
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_connect_peer
— Methoddisassociate_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.
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.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.execute_core_network_change_set
— Methodexecute_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.
Main.Networkmanager.get_connect_attachment
— Methodget_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.
Main.Networkmanager.get_connect_peer
— Methodget_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.
Main.Networkmanager.get_connect_peer_associations
— Methodget_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.
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_core_network
— Methodget_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.
Main.Networkmanager.get_core_network_change_events
— Methodget_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.
Main.Networkmanager.get_core_network_change_set
— Methodget_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.
Main.Networkmanager.get_core_network_policy
— Methodget_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.
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). 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_network_resource_counts
— Methodget_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: attachment connect-peer connection core-network device link peering 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
Main.Networkmanager.get_network_resource_relationships
— Methodget_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: attachment connect-peer connection core-network device link peering 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
Main.Networkmanager.get_network_resources
— Methodget_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 dx-gateway dx-vif The following are the supported resource types for Network Manager: attachment connect-peer connection core-network device link peering 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
Main.Networkmanager.get_network_routes
— Methodget_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.
Main.Networkmanager.get_network_telemetry
— Methodget_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: connect-peer transit-gateway-connect-peer vpn-connection
Main.Networkmanager.get_resource_policy
— Methodget_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.
Main.Networkmanager.get_route_analysis
— Methodget_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.
Main.Networkmanager.get_site_to_site_vpn_attachment
— Methodget_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.
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_peering
— Methodget_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.
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.get_transit_gateway_route_table_attachment
— Methodget_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.
Main.Networkmanager.get_vpc_attachment
— Methodget_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.
Main.Networkmanager.list_attachments
— Methodlist_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.
Main.Networkmanager.list_connect_peers
— Methodlist_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.
Main.Networkmanager.list_core_network_policy_versions
— Methodlist_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.
Main.Networkmanager.list_core_networks
— Methodlist_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.
Main.Networkmanager.list_organization_service_access_status
— Methodlist_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.
Main.Networkmanager.list_peerings
— Methodlist_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.
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.put_core_network_policy
— Methodput_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.
Main.Networkmanager.put_resource_policy
— Methodput_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.
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. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, 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.
Main.Networkmanager.reject_attachment
— Methodreject_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.
Main.Networkmanager.restore_core_network_policy_version
— Methodrestore_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.
Main.Networkmanager.start_organization_service_access_update
— Methodstart_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.
Main.Networkmanager.start_route_analysis
— Methodstart_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.
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_core_network
— Methodupdate_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.
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 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.
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. 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. 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.
Main.Networkmanager.update_network_resource_metadata
— Methodupdate_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.
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. 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.
Main.Networkmanager.update_vpc_attachment
— Methodupdate_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.