@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSNetworkManager
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSNetworkManager
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateCustomerGatewayResult |
associateCustomerGateway(AssociateCustomerGatewayRequest associateCustomerGatewayRequest)
Associates a customer gateway with a device and optionally, with a link.
|
AssociateLinkResult |
associateLink(AssociateLinkRequest associateLinkRequest)
Associates a link to a device.
|
CreateDeviceResult |
createDevice(CreateDeviceRequest createDeviceRequest)
Creates a new device in a global network.
|
CreateGlobalNetworkResult |
createGlobalNetwork(CreateGlobalNetworkRequest createGlobalNetworkRequest)
Creates a new, empty global network.
|
CreateLinkResult |
createLink(CreateLinkRequest createLinkRequest)
Creates a new link for a specified site.
|
CreateSiteResult |
createSite(CreateSiteRequest createSiteRequest)
Creates a new site in a global network.
|
DeleteDeviceResult |
deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Deletes an existing device.
|
DeleteGlobalNetworkResult |
deleteGlobalNetwork(DeleteGlobalNetworkRequest deleteGlobalNetworkRequest)
Deletes an existing global network.
|
DeleteLinkResult |
deleteLink(DeleteLinkRequest deleteLinkRequest)
Deletes an existing link.
|
DeleteSiteResult |
deleteSite(DeleteSiteRequest deleteSiteRequest)
Deletes an existing site.
|
DeregisterTransitGatewayResult |
deregisterTransitGateway(DeregisterTransitGatewayRequest deregisterTransitGatewayRequest)
Deregisters a transit gateway from your global network.
|
DescribeGlobalNetworksResult |
describeGlobalNetworks(DescribeGlobalNetworksRequest describeGlobalNetworksRequest)
Describes one or more global networks.
|
DisassociateCustomerGatewayResult |
disassociateCustomerGateway(DisassociateCustomerGatewayRequest disassociateCustomerGatewayRequest)
Disassociates a customer gateway from a device and a link.
|
DisassociateLinkResult |
disassociateLink(DisassociateLinkRequest disassociateLinkRequest)
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 getCustomerGatewayAssociationsRequest)
Gets the association information for customer gateways that are associated with devices and links in your global
network.
|
GetDevicesResult |
getDevices(GetDevicesRequest getDevicesRequest)
Gets information about one or more of your devices in a global network.
|
GetLinkAssociationsResult |
getLinkAssociations(GetLinkAssociationsRequest getLinkAssociationsRequest)
Gets the link associations for a device or a link.
|
GetLinksResult |
getLinks(GetLinksRequest getLinksRequest)
Gets information about one or more links in a specified global network.
|
GetSitesResult |
getSites(GetSitesRequest getSitesRequest)
Gets information about one or more of your sites in a global network.
|
GetTransitGatewayRegistrationsResult |
getTransitGatewayRegistrations(GetTransitGatewayRegistrationsRequest getTransitGatewayRegistrationsRequest)
Gets information about the transit gateway registrations in a specified global network.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for a specified resource.
|
RegisterTransitGatewayResult |
registerTransitGateway(RegisterTransitGatewayRequest registerTransitGatewayRequest)
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 tagResourceRequest)
Tags a specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a specified resource.
|
UpdateDeviceResult |
updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates the details for an existing device.
|
UpdateGlobalNetworkResult |
updateGlobalNetwork(UpdateGlobalNetworkRequest updateGlobalNetworkRequest)
Updates an existing global network.
|
UpdateLinkResult |
updateLink(UpdateLinkRequest updateLinkRequest)
Updates the details for an existing link.
|
UpdateSiteResult |
updateSite(UpdateSiteRequest updateSiteRequest)
Updates the information for an existing site.
|
static final String ENDPOINT_PREFIX
AssociateCustomerGatewayResult associateCustomerGateway(AssociateCustomerGatewayRequest associateCustomerGatewayRequest)
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.
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.AssociateLinkResult associateLink(AssociateLinkRequest associateLinkRequest)
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.
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.CreateDeviceResult createDevice(CreateDeviceRequest createDeviceRequest)
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.
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.CreateGlobalNetworkResult createGlobalNetwork(CreateGlobalNetworkRequest createGlobalNetworkRequest)
Creates a new, empty global network.
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.CreateLinkResult createLink(CreateLinkRequest createLinkRequest)
Creates a new link for a specified site.
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.CreateSiteResult createSite(CreateSiteRequest createSiteRequest)
Creates a new site in a global network.
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.DeleteDeviceResult deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
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.DeleteGlobalNetworkResult deleteGlobalNetwork(DeleteGlobalNetworkRequest deleteGlobalNetworkRequest)
Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
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.DeleteLinkResult deleteLink(DeleteLinkRequest deleteLinkRequest)
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
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.DeleteSiteResult deleteSite(DeleteSiteRequest deleteSiteRequest)
Deletes an existing site. The site cannot be associated with any device or link.
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.DeregisterTransitGatewayResult deregisterTransitGateway(DeregisterTransitGatewayRequest deregisterTransitGatewayRequest)
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.
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.DescribeGlobalNetworksResult describeGlobalNetworks(DescribeGlobalNetworksRequest describeGlobalNetworksRequest)
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.
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.DisassociateCustomerGatewayResult disassociateCustomerGateway(DisassociateCustomerGatewayRequest disassociateCustomerGatewayRequest)
Disassociates a customer gateway from a device and a link.
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.DisassociateLinkResult disassociateLink(DisassociateLinkRequest disassociateLinkRequest)
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
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.GetCustomerGatewayAssociationsResult getCustomerGatewayAssociations(GetCustomerGatewayAssociationsRequest getCustomerGatewayAssociationsRequest)
Gets the association information for customer gateways that are associated with devices and links in your global network.
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.GetDevicesResult getDevices(GetDevicesRequest getDevicesRequest)
Gets information about one or more of your devices in a global network.
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.GetLinkAssociationsResult getLinkAssociations(GetLinkAssociationsRequest getLinkAssociationsRequest)
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
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.GetLinksResult getLinks(GetLinksRequest getLinksRequest)
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.
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.GetSitesResult getSites(GetSitesRequest getSitesRequest)
Gets information about one or more of your sites in a global network.
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.GetTransitGatewayRegistrationsResult getTransitGatewayRegistrations(GetTransitGatewayRegistrationsRequest getTransitGatewayRegistrationsRequest)
Gets information about the transit gateway registrations in a specified global network.
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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for a specified resource.
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.RegisterTransitGatewayResult registerTransitGateway(RegisterTransitGatewayRequest registerTransitGatewayRequest)
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.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Tags a specified resource.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a specified resource.
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.UpdateDeviceResult updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
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.UpdateGlobalNetworkResult updateGlobalNetwork(UpdateGlobalNetworkRequest updateGlobalNetworkRequest)
Updates an existing global network. To remove information for any of the parameters, specify an empty string.
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.UpdateLinkResult updateLink(UpdateLinkRequest updateLinkRequest)
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
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.UpdateSiteResult updateSite(UpdateSiteRequest updateSiteRequest)
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
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.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.