@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSNetworkManagerClient extends AmazonWebServiceClient implements AWSNetworkManager
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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.
|
static AWSNetworkManagerClientBuilder |
builder() |
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.
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AWSNetworkManagerClientBuilder builder()
public AssociateCustomerGatewayResult associateCustomerGateway(AssociateCustomerGatewayRequest request)
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.
associateCustomerGateway
in interface AWSNetworkManager
associateCustomerGatewayRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public AssociateLinkResult associateLink(AssociateLinkRequest request)
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.
associateLink
in interface AWSNetworkManager
associateLinkRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public CreateDeviceResult createDevice(CreateDeviceRequest request)
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.
createDevice
in interface AWSNetworkManager
createDeviceRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public CreateGlobalNetworkResult createGlobalNetwork(CreateGlobalNetworkRequest request)
Creates a new, empty global network.
createGlobalNetwork
in interface AWSNetworkManager
createGlobalNetworkRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public CreateLinkResult createLink(CreateLinkRequest request)
Creates a new link for a specified site.
createLink
in interface AWSNetworkManager
createLinkRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public CreateSiteResult createSite(CreateSiteRequest request)
Creates a new site in a global network.
createSite
in interface AWSNetworkManager
createSiteRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
deleteDevice
in interface AWSNetworkManager
deleteDeviceRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DeleteGlobalNetworkResult deleteGlobalNetwork(DeleteGlobalNetworkRequest request)
Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
deleteGlobalNetwork
in interface AWSNetworkManager
deleteGlobalNetworkRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DeleteLinkResult deleteLink(DeleteLinkRequest request)
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
deleteLink
in interface AWSNetworkManager
deleteLinkRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DeleteSiteResult deleteSite(DeleteSiteRequest request)
Deletes an existing site. The site cannot be associated with any device or link.
deleteSite
in interface AWSNetworkManager
deleteSiteRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DeregisterTransitGatewayResult deregisterTransitGateway(DeregisterTransitGatewayRequest request)
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.
deregisterTransitGateway
in interface AWSNetworkManager
deregisterTransitGatewayRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DescribeGlobalNetworksResult describeGlobalNetworks(DescribeGlobalNetworksRequest request)
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.
describeGlobalNetworks
in interface AWSNetworkManager
describeGlobalNetworksRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DisassociateCustomerGatewayResult disassociateCustomerGateway(DisassociateCustomerGatewayRequest request)
Disassociates a customer gateway from a device and a link.
disassociateCustomerGateway
in interface AWSNetworkManager
disassociateCustomerGatewayRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public DisassociateLinkResult disassociateLink(DisassociateLinkRequest request)
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
disassociateLink
in interface AWSNetworkManager
disassociateLinkRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public GetCustomerGatewayAssociationsResult getCustomerGatewayAssociations(GetCustomerGatewayAssociationsRequest request)
Gets the association information for customer gateways that are associated with devices and links in your global network.
getCustomerGatewayAssociations
in interface AWSNetworkManager
getCustomerGatewayAssociationsRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public GetDevicesResult getDevices(GetDevicesRequest request)
Gets information about one or more of your devices in a global network.
getDevices
in interface AWSNetworkManager
getDevicesRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public GetLinkAssociationsResult getLinkAssociations(GetLinkAssociationsRequest request)
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
getLinkAssociations
in interface AWSNetworkManager
getLinkAssociationsRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public GetLinksResult getLinks(GetLinksRequest request)
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.
getLinks
in interface AWSNetworkManager
getLinksRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public GetSitesResult getSites(GetSitesRequest request)
Gets information about one or more of your sites in a global network.
getSites
in interface AWSNetworkManager
getSitesRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public GetTransitGatewayRegistrationsResult getTransitGatewayRegistrations(GetTransitGatewayRegistrationsRequest request)
Gets information about the transit gateway registrations in a specified global network.
getTransitGatewayRegistrations
in interface AWSNetworkManager
getTransitGatewayRegistrationsRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for a specified resource.
listTagsForResource
in interface AWSNetworkManager
listTagsForResourceRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public RegisterTransitGatewayResult registerTransitGateway(RegisterTransitGatewayRequest request)
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.
registerTransitGateway
in interface AWSNetworkManager
registerTransitGatewayRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public TagResourceResult tagResource(TagResourceRequest request)
Tags a specified resource.
tagResource
in interface AWSNetworkManager
tagResourceRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a specified resource.
untagResource
in interface AWSNetworkManager
untagResourceRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
updateDevice
in interface AWSNetworkManager
updateDeviceRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public UpdateGlobalNetworkResult updateGlobalNetwork(UpdateGlobalNetworkRequest request)
Updates an existing global network. To remove information for any of the parameters, specify an empty string.
updateGlobalNetwork
in interface AWSNetworkManager
updateGlobalNetworkRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public UpdateLinkResult updateLink(UpdateLinkRequest request)
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
updateLink
in interface AWSNetworkManager
updateLinkRequest
- ValidationException
- The input fails to satisfy the constraints.ServiceQuotaExceededException
- A service limit was exceeded.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public UpdateSiteResult updateSite(UpdateSiteRequest request)
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
updateSite
in interface AWSNetworkManager
updateSiteRequest
- ValidationException
- The input fails to satisfy the constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- The specified resource could not be found.ConflictException
- There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent
state.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request has failed due to an internal error.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AWSNetworkManager
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.