AbstractAWSNetworkManager (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkmanager.AbstractAWSNetworkManager

All Implemented Interfaces:

AWSNetworkManager

Direct Known Subclasses:

AbstractAWSNetworkManagerAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSNetworkManager
extends Object
implements AWSNetworkManager
```
Abstract implementation of AWSNetworkManager. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.networkmanager.AWSNetworkManager
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateCustomerGatewayResult`	`associateCustomerGateway(AssociateCustomerGatewayRequest request)` Associates a customer gateway with a device and optionally, with a link.
`AssociateLinkResult`	`associateLink(AssociateLinkRequest request)` Associates a link to a device.
`CreateDeviceResult`	`createDevice(CreateDeviceRequest request)` Creates a new device in a global network.
`CreateGlobalNetworkResult`	`createGlobalNetwork(CreateGlobalNetworkRequest request)` Creates a new, empty global network.
`CreateLinkResult`	`createLink(CreateLinkRequest request)` Creates a new link for a specified site.
`CreateSiteResult`	`createSite(CreateSiteRequest request)` Creates a new site in a global network.
`DeleteDeviceResult`	`deleteDevice(DeleteDeviceRequest request)` Deletes an existing device.
`DeleteGlobalNetworkResult`	`deleteGlobalNetwork(DeleteGlobalNetworkRequest request)` Deletes an existing global network.
`DeleteLinkResult`	`deleteLink(DeleteLinkRequest request)` Deletes an existing link.
`DeleteSiteResult`	`deleteSite(DeleteSiteRequest request)` Deletes an existing site.
`DeregisterTransitGatewayResult`	`deregisterTransitGateway(DeregisterTransitGatewayRequest request)` Deregisters a transit gateway from your global network.
`DescribeGlobalNetworksResult`	`describeGlobalNetworks(DescribeGlobalNetworksRequest request)` Describes one or more global networks.
`DisassociateCustomerGatewayResult`	`disassociateCustomerGateway(DisassociateCustomerGatewayRequest request)` Disassociates a customer gateway from a device and a link.
`DisassociateLinkResult`	`disassociateLink(DisassociateLinkRequest request)` Disassociates an existing device from a link.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetCustomerGatewayAssociationsResult`	`getCustomerGatewayAssociations(GetCustomerGatewayAssociationsRequest request)` Gets the association information for customer gateways that are associated with devices and links in your global network.
`GetDevicesResult`	`getDevices(GetDevicesRequest request)` Gets information about one or more of your devices in a global network.
`GetLinkAssociationsResult`	`getLinkAssociations(GetLinkAssociationsRequest request)` Gets the link associations for a device or a link.
`GetLinksResult`	`getLinks(GetLinksRequest request)` Gets information about one or more links in a specified global network.
`GetSitesResult`	`getSites(GetSitesRequest request)` Gets information about one or more of your sites in a global network.
`GetTransitGatewayRegistrationsResult`	`getTransitGatewayRegistrations(GetTransitGatewayRegistrationsRequest request)` Gets information about the transit gateway registrations in a specified global network.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags for a specified resource.
`RegisterTransitGatewayResult`	`registerTransitGateway(RegisterTransitGatewayRequest request)` Registers a transit gateway in your global network.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Tags a specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from a specified resource.
`UpdateDeviceResult`	`updateDevice(UpdateDeviceRequest request)` Updates the details for an existing device.
`UpdateGlobalNetworkResult`	`updateGlobalNetwork(UpdateGlobalNetworkRequest request)` Updates an existing global network.
`UpdateLinkResult`	`updateLink(UpdateLinkRequest request)` Updates the details for an existing link.
`UpdateSiteResult`	`updateSite(UpdateSiteRequest request)` Updates the information for an existing site.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateCustomerGateway
```
public AssociateCustomerGatewayResult associateCustomerGateway(AssociateCustomerGatewayRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    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 EC2 API and filter by transit-gateway-id.
    
    You cannot associate a customer gateway with more than one device and link.
    
    Specified by:
    
    associateCustomerGateway in interface AWSNetworkManager
    
    Returns:
    
    Result of the AssociateCustomerGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateLink
```
public AssociateLinkResult associateLink(AssociateLinkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    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.
    
    Specified by:
    
    associateLink in interface AWSNetworkManager
    
    Returns:
    
    Result of the AssociateLink operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDevice
```
public CreateDeviceResult createDevice(CreateDeviceRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    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.
    
    Specified by:
    
    createDevice in interface AWSNetworkManager
    
    Returns:
    
    Result of the CreateDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGlobalNetwork
```
public CreateGlobalNetworkResult createGlobalNetwork(CreateGlobalNetworkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Creates a new, empty global network.
    
    Specified by:
    
    createGlobalNetwork in interface AWSNetworkManager
    
    Returns:
    
    Result of the CreateGlobalNetwork operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLink
```
public CreateLinkResult createLink(CreateLinkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Creates a new link for a specified site.
    
    Specified by:
    
    createLink in interface AWSNetworkManager
    
    Returns:
    
    Result of the CreateLink operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSite
```
public CreateSiteResult createSite(CreateSiteRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Creates a new site in a global network.
    
    Specified by:
    
    createSite in interface AWSNetworkManager
    
    Returns:
    
    Result of the CreateSite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDevice
```
public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Deletes an existing device. You must first disassociate the device from any links and customer gateways.
    
    Specified by:
    
    deleteDevice in interface AWSNetworkManager
    
    Returns:
    
    Result of the DeleteDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGlobalNetwork
```
public DeleteGlobalNetworkResult deleteGlobalNetwork(DeleteGlobalNetworkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
    
    Specified by:
    
    deleteGlobalNetwork in interface AWSNetworkManager
    
    Returns:
    
    Result of the DeleteGlobalNetwork operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLink
```
public DeleteLinkResult deleteLink(DeleteLinkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
    
    Specified by:
    
    deleteLink in interface AWSNetworkManager
    
    Returns:
    
    Result of the DeleteLink operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSite
```
public DeleteSiteResult deleteSite(DeleteSiteRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Deletes an existing site. The site cannot be associated with any device or link.
    
    Specified by:
    
    deleteSite in interface AWSNetworkManager
    
    Returns:
    
    Result of the DeleteSite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deregisterTransitGateway
```
public DeregisterTransitGatewayResult deregisterTransitGateway(DeregisterTransitGatewayRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    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.
    
    Specified by:
    
    deregisterTransitGateway in interface AWSNetworkManager
    
    Returns:
    
    Result of the DeregisterTransitGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGlobalNetworks
```
public DescribeGlobalNetworksResult describeGlobalNetworks(DescribeGlobalNetworksRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    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.
    
    Specified by:
    
    describeGlobalNetworks in interface AWSNetworkManager
    
    Returns:
    
    Result of the DescribeGlobalNetworks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateCustomerGateway
```
public DisassociateCustomerGatewayResult disassociateCustomerGateway(DisassociateCustomerGatewayRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Disassociates a customer gateway from a device and a link.
    
    Specified by:
    
    disassociateCustomerGateway in interface AWSNetworkManager
    
    Returns:
    
    Result of the DisassociateCustomerGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateLink
```
public DisassociateLinkResult disassociateLink(DisassociateLinkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
    
    Specified by:
    
    disassociateLink in interface AWSNetworkManager
    
    Returns:
    
    Result of the DisassociateLink operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCustomerGatewayAssociations
```
public GetCustomerGatewayAssociationsResult getCustomerGatewayAssociations(GetCustomerGatewayAssociationsRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Gets the association information for customer gateways that are associated with devices and links in your global network.
    
    Specified by:
    
    getCustomerGatewayAssociations in interface AWSNetworkManager
    
    Returns:
    
    Result of the GetCustomerGatewayAssociations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDevices
```
public GetDevicesResult getDevices(GetDevicesRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Gets information about one or more of your devices in a global network.
    
    Specified by:
    
    getDevices in interface AWSNetworkManager
    
    Returns:
    
    Result of the GetDevices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLinkAssociations
```
public GetLinkAssociationsResult getLinkAssociations(GetLinkAssociationsRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
    
    Specified by:
    
    getLinkAssociations in interface AWSNetworkManager
    
    Returns:
    
    Result of the GetLinkAssociations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLinks
```
public GetLinksResult getLinks(GetLinksRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    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.
    
    Specified by:
    
    getLinks in interface AWSNetworkManager
    
    Returns:
    
    Result of the GetLinks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSites
```
public GetSitesResult getSites(GetSitesRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Gets information about one or more of your sites in a global network.
    
    Specified by:
    
    getSites in interface AWSNetworkManager
    
    Returns:
    
    Result of the GetSites operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTransitGatewayRegistrations
```
public GetTransitGatewayRegistrationsResult getTransitGatewayRegistrations(GetTransitGatewayRegistrationsRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Gets information about the transit gateway registrations in a specified global network.
    
    Specified by:
    
    getTransitGatewayRegistrations in interface AWSNetworkManager
    
    Returns:
    
    Result of the GetTransitGatewayRegistrations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Lists the tags for a specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSNetworkManager
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerTransitGateway
```
public RegisterTransitGatewayResult registerTransitGateway(RegisterTransitGatewayRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    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.
    
    Specified by:
    
    registerTransitGateway in interface AWSNetworkManager
    
    Returns:
    
    Result of the RegisterTransitGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Tags a specified resource.
    
    Specified by:
    
    tagResource in interface AWSNetworkManager
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Removes tags from a specified resource.
    
    Specified by:
    
    untagResource in interface AWSNetworkManager
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDevice
```
public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
    
    Specified by:
    
    updateDevice in interface AWSNetworkManager
    
    Returns:
    
    Result of the UpdateDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGlobalNetwork
```
public UpdateGlobalNetworkResult updateGlobalNetwork(UpdateGlobalNetworkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Updates an existing global network. To remove information for any of the parameters, specify an empty string.
    
    Specified by:
    
    updateGlobalNetwork in interface AWSNetworkManager
    
    Returns:
    
    Result of the UpdateGlobalNetwork operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLink
```
public UpdateLinkResult updateLink(UpdateLinkRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
    
    Specified by:
    
    updateLink in interface AWSNetworkManager
    
    Returns:
    
    Result of the UpdateLink operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSite
```
public UpdateSiteResult updateSite(UpdateSiteRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
    
    Specified by:
    
    updateSite in interface AWSNetworkManager
    
    Returns:
    
    Result of the UpdateSite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSNetworkManager
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSNetworkManager
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSNetworkManager
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSNetworkManager
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSNetworkManager

Field Summary

Fields inherited from interface com.amazonaws.services.networkmanager.AWSNetworkManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateCustomerGateway

associateLink

createDevice

createGlobalNetwork

createLink

createSite

deleteDevice

deleteGlobalNetwork

deleteLink

deleteSite

deregisterTransitGateway

describeGlobalNetworks

disassociateCustomerGateway

disassociateLink

getCustomerGatewayAssociations

getDevices

getLinkAssociations

getLinks

getSites

getTransitGatewayRegistrations

listTagsForResource

registerTransitGateway

tagResource

untagResource

updateDevice

updateGlobalNetwork

updateLink

updateSite

shutdown

getCachedResponseMetadata