/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::NetworkManager

NAME

Paws::NetworkManager - Perl Interface to AWS AWS Network Manager

SYNOPSIS

use Paws;

my $obj = Paws->service('NetworkManager');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your AWS and on-premises networks that are built around transit gateways.

The Network Manager APIs are supported in the US West (Oregon) Region only. You must specify the us-west-2 Region in all requests made to Network Manager.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05

METHODS

AssociateCustomerGateway

CustomerGatewayArn => Str
DeviceId => Str
GlobalNetworkId => Str
[LinkId => Str]

Each argument is described in detail in: Paws::NetworkManager::AssociateCustomerGateway

Returns: a Paws::NetworkManager::AssociateCustomerGatewayResponse instance

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. The transit gateway must be registered in your global network. When you register a transit gateway, 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html) EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

DeviceId => Str
GlobalNetworkId => Str
LinkId => Str

Each argument is described in detail in: Paws::NetworkManager::AssociateLink

Returns: a Paws::NetworkManager::AssociateLinkResponse instance

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.

AssociateTransitGatewayConnectPeer

DeviceId => Str
GlobalNetworkId => Str
TransitGatewayConnectPeerArn => Str
[LinkId => Str]

Each argument is described in detail in: Paws::NetworkManager::AssociateTransitGatewayConnectPeer

Returns: a Paws::NetworkManager::AssociateTransitGatewayConnectPeerResponse instance

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.

CreateConnection

ConnectedDeviceId => Str
DeviceId => Str
GlobalNetworkId => Str
[ConnectedLinkId => Str]
[Description => Str]
[LinkId => Str]
[Tags => ArrayRef[Paws::NetworkManager::Tag]]

Each argument is described in detail in: Paws::NetworkManager::CreateConnection

Returns: a Paws::NetworkManager::CreateConnectionResponse instance

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.

CreateDevice

GlobalNetworkId => Str
[AWSLocation => Paws::NetworkManager::AWSLocation]
[Description => Str]
[Location => Paws::NetworkManager::Location]
[Model => Str]
[SerialNumber => Str]
[SiteId => Str]
[Tags => ArrayRef[Paws::NetworkManager::Tag]]
[Type => Str]
[Vendor => Str]

Each argument is described in detail in: Paws::NetworkManager::CreateDevice

Returns: a Paws::NetworkManager::CreateDeviceResponse instance

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.

CreateGlobalNetwork

[Description => Str]
[Tags => ArrayRef[Paws::NetworkManager::Tag]]

Each argument is described in detail in: Paws::NetworkManager::CreateGlobalNetwork

Returns: a Paws::NetworkManager::CreateGlobalNetworkResponse instance

Creates a new, empty global network.

Bandwidth => Paws::NetworkManager::Bandwidth
GlobalNetworkId => Str
SiteId => Str
[Description => Str]
[Provider => Str]
[Tags => ArrayRef[Paws::NetworkManager::Tag]]
[Type => Str]

Each argument is described in detail in: Paws::NetworkManager::CreateLink

Returns: a Paws::NetworkManager::CreateLinkResponse instance

Creates a new link for a specified site.

CreateSite

GlobalNetworkId => Str
[Description => Str]
[Location => Paws::NetworkManager::Location]
[Tags => ArrayRef[Paws::NetworkManager::Tag]]

Each argument is described in detail in: Paws::NetworkManager::CreateSite

Returns: a Paws::NetworkManager::CreateSiteResponse instance

Creates a new site in a global network.

DeleteConnection

ConnectionId => Str
GlobalNetworkId => Str

Each argument is described in detail in: Paws::NetworkManager::DeleteConnection

Returns: a Paws::NetworkManager::DeleteConnectionResponse instance

Deletes the specified connection in your global network.

DeleteDevice

DeviceId => Str
GlobalNetworkId => Str

Each argument is described in detail in: Paws::NetworkManager::DeleteDevice

Returns: a Paws::NetworkManager::DeleteDeviceResponse instance

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

DeleteGlobalNetwork

GlobalNetworkId => Str

Each argument is described in detail in: Paws::NetworkManager::DeleteGlobalNetwork

Returns: a Paws::NetworkManager::DeleteGlobalNetworkResponse instance

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.

GlobalNetworkId => Str
LinkId => Str

Each argument is described in detail in: Paws::NetworkManager::DeleteLink

Returns: a Paws::NetworkManager::DeleteLinkResponse instance

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

DeleteSite

GlobalNetworkId => Str
SiteId => Str

Each argument is described in detail in: Paws::NetworkManager::DeleteSite

Returns: a Paws::NetworkManager::DeleteSiteResponse instance

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

DeregisterTransitGateway

GlobalNetworkId => Str
TransitGatewayArn => Str

Each argument is described in detail in: Paws::NetworkManager::DeregisterTransitGateway

Returns: a Paws::NetworkManager::DeregisterTransitGatewayResponse instance

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.

DescribeGlobalNetworks

[GlobalNetworkIds => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::NetworkManager::DescribeGlobalNetworks

Returns: a Paws::NetworkManager::DescribeGlobalNetworksResponse instance

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.

DisassociateCustomerGateway

CustomerGatewayArn => Str
GlobalNetworkId => Str

Each argument is described in detail in: Paws::NetworkManager::DisassociateCustomerGateway

Returns: a Paws::NetworkManager::DisassociateCustomerGatewayResponse instance

Disassociates a customer gateway from a device and a link.

DeviceId => Str
GlobalNetworkId => Str
LinkId => Str

Each argument is described in detail in: Paws::NetworkManager::DisassociateLink

Returns: a Paws::NetworkManager::DisassociateLinkResponse instance

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

DisassociateTransitGatewayConnectPeer

GlobalNetworkId => Str
TransitGatewayConnectPeerArn => Str

Each argument is described in detail in: Paws::NetworkManager::DisassociateTransitGatewayConnectPeer

Returns: a Paws::NetworkManager::DisassociateTransitGatewayConnectPeerResponse instance

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

GetConnections

GlobalNetworkId => Str
[ConnectionIds => ArrayRef[Str|Undef]]
[DeviceId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::NetworkManager::GetConnections

Returns: a Paws::NetworkManager::GetConnectionsResponse instance

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

GetCustomerGatewayAssociations

GlobalNetworkId => Str
[CustomerGatewayArns => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::NetworkManager::GetCustomerGatewayAssociations

Returns: a Paws::NetworkManager::GetCustomerGatewayAssociationsResponse instance

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

GetDevices

GlobalNetworkId => Str
[DeviceIds => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]
[SiteId => Str]

Each argument is described in detail in: Paws::NetworkManager::GetDevices

Returns: a Paws::NetworkManager::GetDevicesResponse instance

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

GetLinkAssociations

GlobalNetworkId => Str
[DeviceId => Str]
[LinkId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::NetworkManager::GetLinkAssociations

Returns: a Paws::NetworkManager::GetLinkAssociationsResponse instance

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

GlobalNetworkId => Str
[LinkIds => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]
[Provider => Str]
[SiteId => Str]
[Type => Str]

Each argument is described in detail in: Paws::NetworkManager::GetLinks

Returns: a Paws::NetworkManager::GetLinksResponse instance

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.

GetSites

GlobalNetworkId => Str
[MaxResults => Int]
[NextToken => Str]
[SiteIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::NetworkManager::GetSites

Returns: a Paws::NetworkManager::GetSitesResponse instance

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

GetTransitGatewayConnectPeerAssociations

GlobalNetworkId => Str
[MaxResults => Int]
[NextToken => Str]
[TransitGatewayConnectPeerArns => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::NetworkManager::GetTransitGatewayConnectPeerAssociations

Returns: a Paws::NetworkManager::GetTransitGatewayConnectPeerAssociationsResponse instance

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

GetTransitGatewayRegistrations

GlobalNetworkId => Str
[MaxResults => Int]
[NextToken => Str]
[TransitGatewayArns => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::NetworkManager::GetTransitGatewayRegistrations

Returns: a Paws::NetworkManager::GetTransitGatewayRegistrationsResponse instance

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

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::NetworkManager::ListTagsForResource

Returns: a Paws::NetworkManager::ListTagsForResourceResponse instance

Lists the tags for a specified resource.

RegisterTransitGateway

GlobalNetworkId => Str
TransitGatewayArn => Str

Each argument is described in detail in: Paws::NetworkManager::RegisterTransitGateway

Returns: a Paws::NetworkManager::RegisterTransitGatewayResponse instance

Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::NetworkManager::Tag]

Each argument is described in detail in: Paws::NetworkManager::TagResource

Returns: a Paws::NetworkManager::TagResourceResponse instance

Tags a specified resource.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::NetworkManager::UntagResource

Returns: a Paws::NetworkManager::UntagResourceResponse instance

Removes tags from a specified resource.

UpdateConnection

ConnectionId => Str
GlobalNetworkId => Str
[ConnectedLinkId => Str]
[Description => Str]
[LinkId => Str]

Each argument is described in detail in: Paws::NetworkManager::UpdateConnection

Returns: a Paws::NetworkManager::UpdateConnectionResponse instance

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

UpdateDevice

DeviceId => Str
GlobalNetworkId => Str
[AWSLocation => Paws::NetworkManager::AWSLocation]
[Description => Str]
[Location => Paws::NetworkManager::Location]
[Model => Str]
[SerialNumber => Str]
[SiteId => Str]
[Type => Str]
[Vendor => Str]

Each argument is described in detail in: Paws::NetworkManager::UpdateDevice

Returns: a Paws::NetworkManager::UpdateDeviceResponse instance

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

UpdateGlobalNetwork

GlobalNetworkId => Str
[Description => Str]

Each argument is described in detail in: Paws::NetworkManager::UpdateGlobalNetwork

Returns: a Paws::NetworkManager::UpdateGlobalNetworkResponse instance

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

GlobalNetworkId => Str
LinkId => Str
[Bandwidth => Paws::NetworkManager::Bandwidth]
[Description => Str]
[Provider => Str]
[Type => Str]

Each argument is described in detail in: Paws::NetworkManager::UpdateLink

Returns: a Paws::NetworkManager::UpdateLinkResponse instance

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

UpdateSite

GlobalNetworkId => Str
SiteId => Str
[Description => Str]
[Location => Paws::NetworkManager::Location]

Each argument is described in detail in: Paws::NetworkManager::UpdateSite

Returns: a Paws::NetworkManager::UpdateSiteResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllGlobalNetworks(sub { },[GlobalNetworkIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

DescribeAllGlobalNetworks([GlobalNetworkIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- GlobalNetworks, passing the object as the first parameter, and the string 'GlobalNetworks' as the second parameter

If not, it will return a a Paws::NetworkManager::DescribeGlobalNetworksResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllConnections(sub { },GlobalNetworkId => Str, [ConnectionIds => ArrayRef[Str|Undef], DeviceId => Str, MaxResults => Int, NextToken => Str])

GetAllConnections(GlobalNetworkId => Str, [ConnectionIds => ArrayRef[Str|Undef], DeviceId => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Connections, passing the object as the first parameter, and the string 'Connections' as the second parameter

If not, it will return a a Paws::NetworkManager::GetConnectionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllCustomerGatewayAssociations(sub { },GlobalNetworkId => Str, [CustomerGatewayArns => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

GetAllCustomerGatewayAssociations(GlobalNetworkId => Str, [CustomerGatewayArns => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- CustomerGatewayAssociations, passing the object as the first parameter, and the string 'CustomerGatewayAssociations' as the second parameter

If not, it will return a a Paws::NetworkManager::GetCustomerGatewayAssociationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllDevices(sub { },GlobalNetworkId => Str, [DeviceIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, SiteId => Str])

GetAllDevices(GlobalNetworkId => Str, [DeviceIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, SiteId => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Devices, passing the object as the first parameter, and the string 'Devices' as the second parameter

If not, it will return a a Paws::NetworkManager::GetDevicesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllLinkAssociations(sub { },GlobalNetworkId => Str, [DeviceId => Str, LinkId => Str, MaxResults => Int, NextToken => Str])

GetAllLinkAssociations(GlobalNetworkId => Str, [DeviceId => Str, LinkId => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- LinkAssociations, passing the object as the first parameter, and the string 'LinkAssociations' as the second parameter

If not, it will return a a Paws::NetworkManager::GetLinkAssociationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllLinks(sub { },GlobalNetworkId => Str, [LinkIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, Provider => Str, SiteId => Str, Type => Str])

GetAllLinks(GlobalNetworkId => Str, [LinkIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, Provider => Str, SiteId => Str, Type => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Links, passing the object as the first parameter, and the string 'Links' as the second parameter

If not, it will return a a Paws::NetworkManager::GetLinksResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllSites(sub { },GlobalNetworkId => Str, [MaxResults => Int, NextToken => Str, SiteIds => ArrayRef[Str|Undef]])

GetAllSites(GlobalNetworkId => Str, [MaxResults => Int, NextToken => Str, SiteIds => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

- Sites, passing the object as the first parameter, and the string 'Sites' as the second parameter

If not, it will return a a Paws::NetworkManager::GetSitesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllTransitGatewayConnectPeerAssociations(sub { },GlobalNetworkId => Str, [MaxResults => Int, NextToken => Str, TransitGatewayConnectPeerArns => ArrayRef[Str|Undef]])

GetAllTransitGatewayConnectPeerAssociations(GlobalNetworkId => Str, [MaxResults => Int, NextToken => Str, TransitGatewayConnectPeerArns => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

- TransitGatewayConnectPeerAssociations, passing the object as the first parameter, and the string 'TransitGatewayConnectPeerAssociations' as the second parameter

If not, it will return a a Paws::NetworkManager::GetTransitGatewayConnectPeerAssociationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllTransitGatewayRegistrations(sub { },GlobalNetworkId => Str, [MaxResults => Int, NextToken => Str, TransitGatewayArns => ArrayRef[Str|Undef]])

GetAllTransitGatewayRegistrations(GlobalNetworkId => Str, [MaxResults => Int, NextToken => Str, TransitGatewayArns => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

- TransitGatewayRegistrations, passing the object as the first parameter, and the string 'TransitGatewayRegistrations' as the second parameter

If not, it will return a a Paws::NetworkManager::GetTransitGatewayRegistrationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues