com.amazonaws.services.internetmonitor

Interface AmazonInternetMonitor

All Known Subinterfaces:

AmazonInternetMonitorAsync

All Known Implementing Classes:

AbstractAmazonInternetMonitor, AbstractAmazonInternetMonitorAsync, AmazonInternetMonitorAsyncClient, AmazonInternetMonitorClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonInternetMonitor

Interface for accessing Amazon CloudWatch Internet Monitor.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonInternetMonitor instead.

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end users, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for example, by switching to other Amazon Web Services services or rerouting traffic to your workload through differentAmazon Web Services Regions.

If the issue is caused by the Amazon Web Services network, you'll automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem. To support integrating health information for geographies and networks specific to your application, Internet Monitor delivers measurements to CloudWatch Logs and CloudWatch Metrics. Internet Monitor also sends health events to Amazon EventBridge, so you can set up notifications. Internet Monitor monitors internet connectivity for your application through Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and Amazon WorkSpaces directories.

To use Internet Monitor, you create a monitor and add resources to it, Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces directories that show where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations and networks that communicate with your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateMonitorResult	createMonitor(CreateMonitorRequest createMonitorRequest) Creates a monitor in Amazon CloudWatch Internet Monitor.
DeleteMonitorResult	deleteMonitor(DeleteMonitorRequest deleteMonitorRequest) Deletes a monitor in Amazon CloudWatch Internet Monitor.
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.
GetHealthEventResult	getHealthEvent(GetHealthEventRequest getHealthEventRequest) Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.
GetMonitorResult	getMonitor(GetMonitorRequest getMonitorRequest) Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.
ListHealthEventsResult	listHealthEvents(ListHealthEventsRequest listHealthEventsRequest) Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
ListMonitorsResult	listMonitors(ListMonitorsRequest listMonitorsRequest) Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for a resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds a tag to a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.
UpdateMonitorResult	updateMonitor(UpdateMonitorRequest updateMonitorRequest) Updates a monitor.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createMonitor

CreateMonitorResult createMonitor(CreateMonitorRequest createMonitorRequest)

Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories.

After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are impairing traffic. Internet Monitor can also diagnose whether the impairment is on the Amazon Web Services network or is an issue with an internet service provider (ISP).

Parameters:

createMonitorRequest -

Returns:

Result of the CreateMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

AccessDeniedException - You don't have sufficient permission to perform this action.

ThrottlingException - The request was denied due to request throttling.

ConflictException - The requested resource is in use.

LimitExceededException - The request exceeded a service quota.

ValidationException - Invalid request.

See Also:

AWS API Documentation

deleteMonitor

DeleteMonitorResult deleteMonitor(DeleteMonitorRequest deleteMonitorRequest)

Deletes a monitor in Amazon CloudWatch Internet Monitor.

Parameters:

deleteMonitorRequest -

Returns:

Result of the DeleteMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

AccessDeniedException - You don't have sufficient permission to perform this action.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

See Also:

AWS API Documentation

getHealthEvent

GetHealthEventResult getHealthEvent(GetHealthEventRequest getHealthEventRequest)

Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all of the information related to the event by location.

The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type, and so on.

Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.

Parameters:

getHealthEventRequest -

Returns:

Result of the GetHealthEvent operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

AccessDeniedException - You don't have sufficient permission to perform this action.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

See Also:

AWS API Documentation

getMonitor

GetMonitorResult getMonitor(GetMonitorRequest getMonitorRequest)

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

Parameters:

getMonitorRequest -

Returns:

Result of the GetMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

AccessDeniedException - You don't have sufficient permission to perform this action.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

See Also:

AWS API Documentation

listHealthEvents

ListHealthEventsResult listHealthEvents(ListHealthEventsRequest listHealthEventsRequest)

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status.

Health events that have start times during the time frame that is requested are not included in the list of health events.

Parameters:

listHealthEventsRequest -

Returns:

Result of the ListHealthEvents operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

AccessDeniedException - You don't have sufficient permission to perform this action.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

See Also:

AWS API Documentation

listMonitors

ListMonitorsResult listMonitors(ListMonitorsRequest listMonitorsRequest)

Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.

Parameters:

listMonitorsRequest -

Returns:

Result of the ListMonitors operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

AccessDeniedException - You don't have sufficient permission to perform this action.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

TooManyRequestsException - There were too many requests.

AccessDeniedException - You don't have sufficient permission to perform this action.

NotFoundException - The request specifies something that doesn't exist.

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.

A minimum of one tag is required for this call. It returns an error if you use the TagResource request with 0 tags.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

TooManyRequestsException - There were too many requests.

AccessDeniedException - You don't have sufficient permission to perform this action.

NotFoundException - The request specifies something that doesn't exist.

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

TooManyRequestsException - There were too many requests.

AccessDeniedException - You don't have sufficient permission to perform this action.

NotFoundException - The request specifies something that doesn't exist.

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

See Also:

AWS API Documentation

updateMonitor

UpdateMonitorResult updateMonitor(UpdateMonitorRequest updateMonitorRequest)

Updates a monitor. You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a monitor.

Parameters:

updateMonitorRequest -

Returns:

Result of the UpdateMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

ResourceNotFoundException - The request specifies a resource that doesn't exist.

AccessDeniedException - You don't have sufficient permission to perform this action.

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The request exceeded a service quota.

ValidationException - Invalid request.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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