com.amazonaws.services.networkmonitor

Class AmazonNetworkMonitorClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.networkmonitor.AmazonNetworkMonitorClient

All Implemented Interfaces:

AmazonNetworkMonitor

Direct Known Subclasses:

AmazonNetworkMonitorAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonNetworkMonitorClient
extends AmazonWebServiceClient
implements AmazonNetworkMonitor

Client for accessing Amazon CloudWatch Network Monitor. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web Services network or your own company network. Within Network Monitor you'll choose the source VPCs and subnets from the Amazon Web Services network in which you operate and then you'll choose the destination IP addresses from your on-premises network. From these sources and destinations, Network Monitor creates a monitor containing all the possible source and destination combinations, each of which is called a probe, within a single monitor. These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.

Before you begin, ensure the Amazon Web Services CLI is configured in the Amazon Web Services Account where you will create the Network Monitor resource. Network Monitor doesn’t support creation on cross-account resources, but you can create a Network Monitor in any subnet belonging to a VPC owned by your Account.

For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.networkmonitor.AmazonNetworkMonitor

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonNetworkMonitorClientBuilder	builder()
CreateMonitorResult	createMonitor(CreateMonitorRequest request) Creates a monitor between a source subnet and destination IP address.
CreateProbeResult	createProbe(CreateProbeRequest request) Create a probe within a monitor.
DeleteMonitorResult	deleteMonitor(DeleteMonitorRequest request) Deletes a specified monitor.
DeleteProbeResult	deleteProbe(DeleteProbeRequest request) Deletes the specified probe.
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.
GetMonitorResult	getMonitor(GetMonitorRequest request) Returns details about a specific monitor.
GetProbeResult	getProbe(GetProbeRequest request) Returns the details about a probe.
ListMonitorsResult	listMonitors(ListMonitorsRequest request) Returns a list of all of your monitors.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags assigned to this resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds key-value pairs to a monitor or probe.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a key-value pair from a monitor or probe.
UpdateMonitorResult	updateMonitor(UpdateMonitorRequest request) Updates the aggregationPeriod for a monitor.
UpdateProbeResult	updateProbe(UpdateProbeRequest request) Updates a monitor probe.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonNetworkMonitorClientBuilder builder()

createMonitor

public CreateMonitorResult createMonitor(CreateMonitorRequest request)

Creates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.

You can also create a monitor with probes using this command. For each probe, you define the following:

• source—The subnet IDs where the probes will be created.

• destination— The target destination IP address for the probe.

• destinationPort—Required only if the protocol is TCP.

• protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

• packetSize—The size of the packets. This must be a number between 56 and 8500.

• (Optional) tags —Key-value pairs created and assigned to the probe.

Specified by:

createMonitor in interface AmazonNetworkMonitor

Parameters:

createMonitorRequest -

Returns:

Result of the CreateMonitor operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - This operation attempted to create a resource that already exists.

ServiceQuotaExceededException - This request exceeds a service quota.

See Also:

AWS API Documentation

createProbe

public CreateProbeResult createProbe(CreateProbeRequest request)

Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names. Note the name of the monitorName you want to create the probe for.

Specified by:

createProbe in interface AmazonNetworkMonitor

Parameters:

createProbeRequest -

Returns:

Result of the CreateProbe operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException - This request exceeds a service quota.

See Also:

AWS API Documentation

deleteMonitor

public DeleteMonitorResult deleteMonitor(DeleteMonitorRequest request)

Deletes a specified monitor.

This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

Specified by:

deleteMonitor in interface AmazonNetworkMonitor

Parameters:

deleteMonitorRequest -

Returns:

Result of the DeleteMonitor operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

deleteProbe

public DeleteProbeResult deleteProbe(DeleteProbeRequest request)

Deletes the specified probe. Once a probe is deleted you'll no longer incur any billing fees for that probe.

This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs. You can only delete a single probe at a time using this action.

Specified by:

deleteProbe in interface AmazonNetworkMonitor

Parameters:

deleteProbeRequest -

Returns:

Result of the DeleteProbe operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException - This request exceeds a service quota.

See Also:

AWS API Documentation

getMonitor

public GetMonitorResult getMonitor(GetMonitorRequest request)

Returns details about a specific monitor.

This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

Specified by:

getMonitor in interface AmazonNetworkMonitor

Parameters:

getMonitorRequest -

Returns:

Result of the GetMonitor operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

getProbe

public GetProbeResult getProbe(GetProbeRequest request)

Returns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

Specified by:

getProbe in interface AmazonNetworkMonitor

Parameters:

getProbeRequest -

Returns:

Result of the GetProbe operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listMonitors

public ListMonitorsResult listMonitors(ListMonitorsRequest request)

Returns a list of all of your monitors.

Specified by:

listMonitors in interface AmazonNetworkMonitor

Parameters:

listMonitorsRequest -

Returns:

Result of the ListMonitors operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags assigned to this resource.

Specified by:

listTagsForResource in interface AmazonNetworkMonitor

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - This operation attempted to create a resource that already exists.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds key-value pairs to a monitor or probe.

Specified by:

tagResource in interface AmazonNetworkMonitor

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - This operation attempted to create a resource that already exists.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a key-value pair from a monitor or probe.

Specified by:

untagResource in interface AmazonNetworkMonitor

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - This operation attempted to create a resource that already exists.

See Also:

AWS API Documentation

updateMonitor

public UpdateMonitorResult updateMonitor(UpdateMonitorRequest request)

Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds. This action requires the monitorName and probeId parameter. Run ListMonitors to get a list of monitor names.

Specified by:

updateMonitor in interface AmazonNetworkMonitor

Parameters:

updateMonitorRequest -

Returns:

Result of the UpdateMonitor operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException - This request exceeds a service quota.

See Also:

AWS API Documentation

updateProbe

public UpdateProbeResult updateProbe(UpdateProbeRequest request)

Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

You can update the following para create a monitor with probes using this command. For each probe, you define the following:

• state—The state of the probe.

• destination— The target destination IP address for the probe.

• destinationPort—Required only if the protocol is TCP.

• protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

• packetSize—The size of the packets. This must be a number between 56 and 8500.

• (Optional) tags —Key-value pairs created and assigned to the probe.

Specified by:

updateProbe in interface AmazonNetworkMonitor

Parameters:

updateProbeRequest -

Returns:

Result of the UpdateProbe operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The request was denied due to request throttling

ValidationException - One of the parameters for the request is not valid.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException - This request exceeds a service quota.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonNetworkMonitor

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonNetworkMonitor

Overrides:

shutdown in class AmazonWebServiceClient