NetworkManagerClient

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.

Installation

NPM
npm install @aws-sdk/client-networkmanager
Yarn
yarn add @aws-sdk/client-networkmanager
pnpm
pnpm add @aws-sdk/client-networkmanager

NetworkManagerClient Operations

Command
Summary
AcceptAttachmentCommand

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.

AssociateConnectPeerCommand

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.

AssociateCustomerGatewayCommand

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.

AssociateLinkCommand

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.

AssociateTransitGatewayConnectPeerCommand

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.

CreateConnectAttachmentCommand

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.

CreateConnectPeerCommand

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

CreateConnectionCommand

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.

CreateCoreNetworkCommand

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

CreateDeviceCommand

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.

CreateDirectConnectGatewayAttachmentCommand

Creates an Amazon Web Services Direct Connect gateway attachment

CreateGlobalNetworkCommand

Creates a new, empty global network.

CreateLinkCommand

Creates a new link for a specified site.

CreateSiteCommand

Creates a new site in a global network.

CreateSiteToSiteVpnAttachmentCommand

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

CreateTransitGatewayPeeringCommand

Creates a transit gateway peering connection.

CreateTransitGatewayRouteTableAttachmentCommand

Creates a transit gateway route table attachment.

CreateVpcAttachmentCommand

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

DeleteAttachmentCommand

Deletes an attachment. Supports all attachment types.

DeleteConnectPeerCommand

Deletes a Connect peer.

DeleteConnectionCommand

Deletes the specified connection in your global network.

DeleteCoreNetworkCommand

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

DeleteCoreNetworkPolicyVersionCommand

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

DeleteDeviceCommand

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

DeleteGlobalNetworkCommand

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.

DeleteLinkCommand

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

DeletePeeringCommand

Deletes an existing peering connection.

DeleteResourcePolicyCommand

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

DeleteSiteCommand

Deletes an existing site. The site cannot be associated with any device or link.

DeregisterTransitGatewayCommand

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.

DescribeGlobalNetworksCommand

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.

DisassociateConnectPeerCommand

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

DisassociateCustomerGatewayCommand

Disassociates a customer gateway from a device and a link.

DisassociateLinkCommand

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

DisassociateTransitGatewayConnectPeerCommand

Disassociates a transit gateway Connect peer from a device and link.

ExecuteCoreNetworkChangeSetCommand

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

GetConnectAttachmentCommand

Returns information about a core network Connect attachment.

GetConnectPeerAssociationsCommand

Returns information about a core network Connect peer associations.

GetConnectPeerCommand

Returns information about a core network Connect peer.

GetConnectionsCommand

Gets information about one or more of your connections in a global network.

GetCoreNetworkChangeEventsCommand

Returns information about a core network change event.

GetCoreNetworkChangeSetCommand

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

GetCoreNetworkCommand

Returns information about the LIVE policy for a core network.

GetCoreNetworkPolicyCommand

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

GetCustomerGatewayAssociationsCommand

Gets the association information for customer gateways that are associated with devices and links in your global network.

GetDevicesCommand

Gets information about one or more of your devices in a global network.

GetDirectConnectGatewayAttachmentCommand

Returns information about a specific Amazon Web Services Direct Connect gateway attachment.

GetLinkAssociationsCommand

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

GetLinksCommand

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.

GetNetworkResourceCountsCommand

Gets the count of network resources, by resource type, for the specified global network.

GetNetworkResourceRelationshipsCommand

Gets the network resource relationships for the specified global network.

GetNetworkResourcesCommand

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.

GetNetworkRoutesCommand

Gets the network routes of the specified global network.

GetNetworkTelemetryCommand

Gets the network telemetry of the specified global network.

GetResourcePolicyCommand

Returns information about a resource policy.

GetRouteAnalysisCommand

Gets information about the specified route analysis.

GetSiteToSiteVpnAttachmentCommand

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

GetSitesCommand

Gets information about one or more of your sites in a global network.

GetTransitGatewayConnectPeerAssociationsCommand

Gets information about one or more of your transit gateway Connect peer associations in a global network.

GetTransitGatewayPeeringCommand

Returns information about a transit gateway peer.

GetTransitGatewayRegistrationsCommand

Gets information about the transit gateway registrations in a specified global network.

GetTransitGatewayRouteTableAttachmentCommand

Returns information about a transit gateway route table attachment.

GetVpcAttachmentCommand

Returns information about a VPC attachment.

ListAttachmentsCommand

Returns a list of core network attachments.

ListConnectPeersCommand

Returns a list of core network Connect peers.

ListCoreNetworkPolicyVersionsCommand

Returns a list of core network policy versions.

ListCoreNetworksCommand

Returns a list of owned and shared core networks.

ListOrganizationServiceAccessStatusCommand

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

ListPeeringsCommand

Lists the peerings for a core network.

ListTagsForResourceCommand

Lists the tags for a specified resource.

PutCoreNetworkPolicyCommand

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.

PutResourcePolicyCommand

Creates or updates a resource policy.

RegisterTransitGatewayCommand

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.

RejectAttachmentCommand

Rejects a core network attachment request.

RestoreCoreNetworkPolicyVersionCommand

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.

StartOrganizationServiceAccessUpdateCommand

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

StartRouteAnalysisCommand

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

TagResourceCommand

Tags a specified resource.

UntagResourceCommand

Removes tags from a specified resource.

UpdateConnectionCommand

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

UpdateCoreNetworkCommand

Updates the description of a core network.

UpdateDeviceCommand

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

UpdateDirectConnectGatewayAttachmentCommand

Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.

UpdateGlobalNetworkCommand

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

UpdateLinkCommand

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

UpdateNetworkResourceMetadataCommand

Updates the resource metadata for the specified global network.

UpdateSiteCommand

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

UpdateVpcAttachmentCommand

Updates a VPC attachment.

NetworkManagerClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: NetworkManagerClientConfig