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.

Properties

Link copied to clipboard
abstract override val config: NetworkManagerClient.Config

NetworkManagerClient's configuration

Functions

Link copied to clipboard

Accepts a core network attachment request.

Link copied to clipboard

Associates a core network Connect peer with a device and optionally, with a link.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Creates a core network Connect attachment from a specified core network attachment.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun createGlobalNetwork(input: CreateGlobalNetworkRequest = CreateGlobalNetworkRequest { }): CreateGlobalNetworkResponse

Creates a new, empty global network.

Link copied to clipboard
abstract suspend fun createLink(input: CreateLinkRequest): CreateLinkResponse

Creates a new link for a specified site.

Link copied to clipboard
abstract suspend fun createSite(input: CreateSiteRequest): CreateSiteResponse

Creates a new site in a global network.

Link copied to clipboard

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

Link copied to clipboard

Creates a transit gateway peering connection.

Link copied to clipboard

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

Link copied to clipboard

Deletes an attachment. Supports all attachment types.

Link copied to clipboard

Deletes the specified connection in your global network.

Link copied to clipboard

Deletes a Connect peer.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun deleteLink(input: DeleteLinkRequest): DeleteLinkResponse

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

Link copied to clipboard

Deletes an existing peering connection.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun deleteSite(input: DeleteSiteRequest): DeleteSiteResponse

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

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun describeGlobalNetworks(input: DescribeGlobalNetworksRequest = DescribeGlobalNetworksRequest { }): DescribeGlobalNetworksResponse

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.

Link copied to clipboard

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

Link copied to clipboard

Disassociates a customer gateway from a device and a link.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about a core network Connect attachment.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a core network Connect peer.

Link copied to clipboard

Returns information about a core network Connect peer associations.

Link copied to clipboard

Returns information about the LIVE policy for a core network.

Link copied to clipboard

Returns information about a core network change event.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun getDevices(input: GetDevicesRequest): GetDevicesResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun getLinks(input: GetLinksRequest): GetLinksResponse

Gets information about one or more links in a specified global network.

Link copied to clipboard

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

Link copied to clipboard

Gets the network resource relationships for the specified global network.

Link copied to clipboard

Describes the network resources for the specified global network.

Link copied to clipboard

Gets the network routes of the specified global network.

Link copied to clipboard

Gets the network telemetry of the specified global network.

Link copied to clipboard

Returns information about a resource policy.

Link copied to clipboard

Gets information about the specified route analysis.

Link copied to clipboard
abstract suspend fun getSites(input: GetSitesRequest): GetSitesResponse

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about a transit gateway peer.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a transit gateway route table attachment.

Link copied to clipboard

Returns information about a VPC attachment.

Link copied to clipboard
abstract suspend fun listAttachments(input: ListAttachmentsRequest = ListAttachmentsRequest { }): ListAttachmentsResponse

Returns a list of core network attachments.

Link copied to clipboard
abstract suspend fun listConnectPeers(input: ListConnectPeersRequest = ListConnectPeersRequest { }): ListConnectPeersResponse

Returns a list of core network Connect peers.

Link copied to clipboard

Returns a list of core network policy versions.

Link copied to clipboard
abstract suspend fun listCoreNetworks(input: ListCoreNetworksRequest = ListCoreNetworksRequest { }): ListCoreNetworksResponse

Returns a list of owned and shared core networks.

Link copied to clipboard
abstract suspend fun listOrganizationServiceAccessStatus(input: ListOrganizationServiceAccessStatusRequest = ListOrganizationServiceAccessStatusRequest { }): ListOrganizationServiceAccessStatusResponse

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

Link copied to clipboard
abstract suspend fun listPeerings(input: ListPeeringsRequest = ListPeeringsRequest { }): ListPeeringsResponse

Lists the peerings for a core network.

Link copied to clipboard

Lists the tags for a specified resource.

Link copied to clipboard

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.

Link copied to clipboard

Creates or updates a resource policy.

Link copied to clipboard

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.

Link copied to clipboard

Rejects a core network attachment request.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags a specified resource.

Link copied to clipboard

Removes tags from a specified resource.

Link copied to clipboard

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

Link copied to clipboard

Updates the description of a core network.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun updateLink(input: UpdateLinkRequest): UpdateLinkResponse

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

Link copied to clipboard

Updates the resource metadata for the specified global network.

Link copied to clipboard
abstract suspend fun updateSite(input: UpdateSiteRequest): UpdateSiteResponse

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

Link copied to clipboard

Updates a VPC attachment.

Inherited functions

Link copied to clipboard

Accepts a core network attachment request.

Link copied to clipboard

Associates a core network Connect peer with a device and optionally, with a link.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates a core network Connect attachment from a specified core network attachment.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates a new, empty global network.

Link copied to clipboard

Creates a new link for a specified site.

Link copied to clipboard

Creates a new site in a global network.

Link copied to clipboard

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

Link copied to clipboard

Creates a transit gateway peering connection.

Link copied to clipboard

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

Link copied to clipboard

Deletes an attachment. Supports all attachment types.

Link copied to clipboard

Deletes the specified connection in your global network.

Link copied to clipboard

Deletes a Connect peer.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Deletes an existing peering connection.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Disassociates a customer gateway from a device and a link.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about a core network Connect attachment.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a core network Connect peer.

Link copied to clipboard

Returns information about a core network Connect peer associations.

Link copied to clipboard

Returns information about the LIVE policy for a core network.

Link copied to clipboard

Returns information about a core network change event.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun NetworkManagerClient.getLinks(crossinline block: GetLinksRequest.Builder.() -> Unit): GetLinksResponse

Gets information about one or more links in a specified global network.

Link copied to clipboard

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

Link copied to clipboard

Gets the network resource relationships for the specified global network.

Link copied to clipboard

Describes the network resources for the specified global network.

Link copied to clipboard

Gets the network routes of the specified global network.

Link copied to clipboard

Gets the network telemetry of the specified global network.

Link copied to clipboard

Returns information about a resource policy.

Link copied to clipboard

Gets information about the specified route analysis.

Link copied to clipboard
inline suspend fun NetworkManagerClient.getSites(crossinline block: GetSitesRequest.Builder.() -> Unit): GetSitesResponse

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about a transit gateway peer.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a transit gateway route table attachment.

Link copied to clipboard

Returns information about a VPC attachment.

Link copied to clipboard

Returns a list of core network attachments.

Link copied to clipboard

Returns a list of core network Connect peers.

Link copied to clipboard

Returns a list of core network policy versions.

Link copied to clipboard

Returns a list of owned and shared core networks.

Link copied to clipboard

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

Link copied to clipboard

Lists the peerings for a core network.

Link copied to clipboard

Lists the tags for a specified resource.

Link copied to clipboard

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.

Link copied to clipboard

Creates or updates a resource policy.

Link copied to clipboard

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.

Link copied to clipboard

Rejects a core network attachment request.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Tags a specified resource.

Link copied to clipboard

Removes tags from a specified resource.

Link copied to clipboard

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

Link copied to clipboard

Updates the description of a core network.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Updates the resource metadata for the specified global network.

Link copied to clipboard

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

Link copied to clipboard

Updates a VPC attachment.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.