View Source AWS.NetworkManager (aws-elixir v1.0.4)
Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.
Link to this section Summary
Functions
Accepts a core network attachment request.
Associates a core network Connect peer with a device and optionally, with a link.
Associates a customer gateway with a device and optionally, with a link.
Associates a link to a device.
Associates a transit gateway Connect peer with a device, and optionally, with a link.
Creates a core network Connect attachment from a specified core network attachment.
Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance.
Creates a connection between two devices.
Creates a core network as part of your global network, and optionally, with a core network policy.
Creates a new device in a global network.
Creates an Amazon Web Services Direct Connect gateway attachment
Creates a new, empty global network.
Creates a new link for a specified site.
Creates a new site in a global network.
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
Creates a transit gateway peering connection.
Creates a transit gateway route table attachment.
Creates a VPC attachment on an edge location of a core network.
Deletes an attachment.
Deletes a Connect peer.
Deletes the specified connection in your global network.
Deletes a core network along with all core network policies.
Deletes a policy version from a core network.
Deletes an existing device.
Deletes an existing global network.
Deletes an existing link.
Deletes an existing peering connection.
Deletes a resource policy for the specified resource.
Deletes an existing site.
Deregisters a transit gateway from your global network.
Describes one or more global networks.
Disassociates a core network Connect peer from a device and a link.
Disassociates a customer gateway from a device and a link.
Disassociates an existing device from a link.
Disassociates a transit gateway Connect peer from a device and link.
Executes a change set on your core network.
Returns information about a core network Connect attachment.
Returns information about a core network Connect peer.
Returns information about a core network Connect peer associations.
Gets information about one or more of your connections in a global network.
Returns information about the LIVE policy for a core network.
Returns information about a core network change event.
Returns a change set between the LIVE core network policy and a submitted policy.
Returns details about a core network policy.
Gets the association information for customer gateways that are associated with devices and links in your global network.
Gets information about one or more of your devices in a global network.
Returns information about a specific Amazon Web Services Direct Connect gateway attachment.
Gets the link associations for a device or a link.
Gets information about one or more links in a specified global network.
Gets the count of network resources, by resource type, for the specified global network.
Gets the network resource relationships for the specified global network.
Describes the network resources for the specified global network.
Gets the network routes of the specified global network.
Gets the network telemetry of the specified global network.
Returns information about a resource policy.
Gets information about the specified route analysis.
Returns information about a site-to-site VPN attachment.
Gets information about one or more of your sites in a global network.
Gets information about one or more of your transit gateway Connect peer associations in a global network.
Returns information about a transit gateway peer.
Gets information about the transit gateway registrations in a specified global network.
Returns information about a transit gateway route table attachment.
Returns information about a VPC attachment.
Returns a list of core network attachments.
Returns a list of core network Connect peers.
Returns a list of core network policy versions.
Returns a list of owned and shared core networks.
Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.
Lists the peerings for a core network.
Lists the tags for a specified resource.
Creates a new, immutable version of a core network policy.
Creates or updates a resource policy.
Registers a transit gateway in your global network.
Rejects a core network attachment request.
Restores a previous policy version as a new, immutable version of a core network policy.
Enables the Network Manager service for an Amazon Web Services Organization.
Starts analyzing the routing path between the specified source and destination.
Tags a specified resource.
Removes tags from a specified resource.
Updates the information for an existing connection.
Updates the description of a core network.
Updates the details for an existing device.
Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.
Updates an existing global network.
Updates the details for an existing link.
Updates the resource metadata for the specified global network.
Updates the information for an existing site.
Updates a VPC attachment.
Link to this section Functions
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.
associate_connect_peer(client, global_network_id, input, options \\ [])
View SourceAssociates 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.
associate_customer_gateway(client, global_network_id, input, options \\ [])
View SourceAssociates 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.
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.
associate_transit_gateway_connect_peer(client, global_network_id, input, options \\ [])
View SourceAssociates 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.
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.
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).
create_connection(client, global_network_id, input, options \\ [])
View SourceCreates 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.
Creates a core network as part of your global network, and optionally, with a core network policy.
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.
create_direct_connect_gateway_attachment(client, input, options \\ [])
View SourceCreates an Amazon Web Services Direct Connect gateway attachment
Creates a new, empty global network.
Creates a new link for a specified site.
Creates a new site in a global network.
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
Creates a transit gateway peering connection.
create_transit_gateway_route_table_attachment(client, input, options \\ [])
View SourceCreates a transit gateway route table attachment.
Creates a VPC attachment on an edge location of a core network.
Deletes an attachment.
Supports all attachment types.
delete_connect_peer(client, connect_peer_id, input, options \\ [])
View SourceDeletes a Connect peer.
delete_connection(client, connection_id, global_network_id, input, options \\ [])
View SourceDeletes the specified connection in your global network.
delete_core_network(client, core_network_id, input, options \\ [])
View SourceDeletes a core network along with all core network policies.
This can only be done if there are no attachments on a core network.
delete_core_network_policy_version(client, core_network_id, policy_version_id, input, options \\ [])
View SourceDeletes a policy version from a core network.
You can't delete the current LIVE policy.
delete_device(client, device_id, global_network_id, input, options \\ [])
View SourceDeletes an existing device.
You must first disassociate the device from any links and customer gateways.
delete_global_network(client, global_network_id, input, options \\ [])
View SourceDeletes 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.
delete_link(client, global_network_id, link_id, input, options \\ [])
View SourceDeletes an existing link.
You must first disassociate the link from any devices and customer gateways.
Deletes an existing peering connection.
delete_resource_policy(client, resource_arn, input, options \\ [])
View SourceDeletes a resource policy for the specified resource.
This revokes the access of the principals specified in the resource policy.
delete_site(client, global_network_id, site_id, input, options \\ [])
View SourceDeletes an existing site.
The site cannot be associated with any device or link.
deregister_transit_gateway(client, global_network_id, transit_gateway_arn, input, options \\ [])
View SourceDeregisters 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.
describe_global_networks(client, global_network_ids \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceDescribes 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
.
disassociate_connect_peer(client, connect_peer_id, global_network_id, input, options \\ [])
View SourceDisassociates a core network Connect peer from a device and a link.
disassociate_customer_gateway(client, customer_gateway_arn, global_network_id, input, options \\ [])
View SourceDisassociates a customer gateway from a device and a link.
disassociate_link(client, global_network_id, input, options \\ [])
View SourceDisassociates an existing device from a link.
You must first disassociate any customer gateways that are associated with the link.
disassociate_transit_gateway_connect_peer(client, global_network_id, transit_gateway_connect_peer_arn, input, options \\ [])
View SourceDisassociates a transit gateway Connect peer from a device and link.
execute_core_network_change_set(client, core_network_id, policy_version_id, input, options \\ [])
View SourceExecutes a change set on your core network.
Deploys changes globally based on the policy submitted..
Returns information about a core network Connect attachment.
Returns information about a core network Connect peer.
get_connect_peer_associations(client, global_network_id, connect_peer_ids \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns information about a core network Connect peer associations.
get_connections(client, global_network_id, connection_ids \\ nil, device_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets information about one or more of your connections in a global network.
Returns information about the LIVE policy for a core network.
get_core_network_change_events(client, core_network_id, policy_version_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns information about a core network change event.
get_core_network_change_set(client, core_network_id, policy_version_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a change set between the LIVE core network policy and a submitted policy.
get_core_network_policy(client, core_network_id, alias \\ nil, policy_version_id \\ nil, options \\ [])
View SourceReturns details about a core network policy.
You can get details about your current live policy or any previous policy version.
get_customer_gateway_associations(client, global_network_id, customer_gateway_arns \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets the association information for customer gateways that are associated with devices and links in your global network.
get_devices(client, global_network_id, device_ids \\ nil, max_results \\ nil, next_token \\ nil, site_id \\ nil, options \\ [])
View SourceGets information about one or more of your devices in a global network.
get_direct_connect_gateway_attachment(client, attachment_id, options \\ [])
View SourceReturns information about a specific Amazon Web Services Direct Connect gateway attachment.
get_link_associations(client, global_network_id, device_id \\ nil, link_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets the link associations for a device or a link.
Either the device ID or the link ID must be specified.
get_links(client, global_network_id, link_ids \\ nil, max_results \\ nil, next_token \\ nil, provider \\ nil, site_id \\ nil, type \\ nil, options \\ [])
View SourceGets 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.
get_network_resource_counts(client, global_network_id, max_results \\ nil, next_token \\ nil, resource_type \\ nil, options \\ [])
View SourceGets the count of network resources, by resource type, for the specified global network.
get_network_resource_relationships(client, global_network_id, account_id \\ nil, aws_region \\ nil, core_network_id \\ nil, max_results \\ nil, next_token \\ nil, registered_gateway_arn \\ nil, resource_arn \\ nil, resource_type \\ nil, options \\ [])
View SourceGets the network resource relationships for the specified global network.
get_network_resources(client, global_network_id, account_id \\ nil, aws_region \\ nil, core_network_id \\ nil, max_results \\ nil, next_token \\ nil, registered_gateway_arn \\ nil, resource_arn \\ nil, resource_type \\ nil, options \\ [])
View SourceDescribes 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.
get_network_routes(client, global_network_id, input, options \\ [])
View SourceGets the network routes of the specified global network.
get_network_telemetry(client, global_network_id, account_id \\ nil, aws_region \\ nil, core_network_id \\ nil, max_results \\ nil, next_token \\ nil, registered_gateway_arn \\ nil, resource_arn \\ nil, resource_type \\ nil, options \\ [])
View SourceGets the network telemetry of the specified global network.
Returns information about a resource policy.
get_route_analysis(client, global_network_id, route_analysis_id, options \\ [])
View SourceGets information about the specified route analysis.
get_site_to_site_vpn_attachment(client, attachment_id, options \\ [])
View SourceReturns information about a site-to-site VPN attachment.
get_sites(client, global_network_id, max_results \\ nil, next_token \\ nil, site_ids \\ nil, options \\ [])
View SourceGets information about one or more of your sites in a global network.
get_transit_gateway_connect_peer_associations(client, global_network_id, max_results \\ nil, next_token \\ nil, transit_gateway_connect_peer_arns \\ nil, options \\ [])
View SourceGets information about one or more of your transit gateway Connect peer associations in a global network.
Returns information about a transit gateway peer.
get_transit_gateway_registrations(client, global_network_id, max_results \\ nil, next_token \\ nil, transit_gateway_arns \\ nil, options \\ [])
View SourceGets information about the transit gateway registrations in a specified global network.
get_transit_gateway_route_table_attachment(client, attachment_id, options \\ [])
View SourceReturns information about a transit gateway route table attachment.
Returns information about a VPC attachment.
list_attachments(client, attachment_type \\ nil, core_network_id \\ nil, edge_location \\ nil, max_results \\ nil, next_token \\ nil, state \\ nil, options \\ [])
View SourceReturns a list of core network attachments.
list_connect_peers(client, connect_attachment_id \\ nil, core_network_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of core network Connect peers.
list_core_network_policy_versions(client, core_network_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of core network policy versions.
list_core_networks(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of owned and shared core networks.
list_organization_service_access_status(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.
list_peerings(client, core_network_id \\ nil, edge_location \\ nil, max_results \\ nil, next_token \\ nil, peering_type \\ nil, state \\ nil, options \\ [])
View SourceLists the peerings for a core network.
Lists the tags for a specified resource.
put_core_network_policy(client, core_network_id, input, options \\ [])
View SourceCreates 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.
Creates or updates a resource policy.
register_transit_gateway(client, global_network_id, input, options \\ [])
View SourceRegisters 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.
Rejects a core network attachment request.
restore_core_network_policy_version(client, core_network_id, policy_version_id, input, options \\ [])
View SourceRestores 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.
start_organization_service_access_update(client, input, options \\ [])
View SourceEnables the Network Manager service for an Amazon Web Services Organization.
This can only be called by a management account within the organization.
start_route_analysis(client, global_network_id, input, options \\ [])
View SourceStarts analyzing the routing path between the specified source and destination.
For more information, see Route Analyzer.
Tags a specified resource.
Removes tags from a specified resource.
update_connection(client, connection_id, global_network_id, input, options \\ [])
View SourceUpdates the information for an existing connection.
To remove information for any of the parameters, specify an empty string.
update_core_network(client, core_network_id, input, options \\ [])
View SourceUpdates the description of a core network.
update_device(client, device_id, global_network_id, input, options \\ [])
View SourceUpdates the details for an existing device.
To remove information for any of the parameters, specify an empty string.
update_direct_connect_gateway_attachment(client, attachment_id, input, options \\ [])
View SourceUpdates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.
update_global_network(client, global_network_id, input, options \\ [])
View SourceUpdates an existing global network.
To remove information for any of the parameters, specify an empty string.
update_link(client, global_network_id, link_id, input, options \\ [])
View SourceUpdates the details for an existing link.
To remove information for any of the parameters, specify an empty string.
update_network_resource_metadata(client, global_network_id, resource_arn, input, options \\ [])
View SourceUpdates the resource metadata for the specified global network.
update_site(client, global_network_id, site_id, input, options \\ [])
View SourceUpdates the information for an existing site.
To remove information for any of the parameters, specify an empty string.
update_vpc_attachment(client, attachment_id, input, options \\ [])
View SourceUpdates a VPC attachment.