AmazonInternetMonitor (AWS SDK for Java

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. It can reduce the time it takes for you to diagnose internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global networking footprint to calculate a baseline of performance and availability for internet traffic. This is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements as a baseline, Internet Monitor raises awareness for you when there are significant problems for your end users in the different geographic locations where your application runs.

Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, to easily support using CloudWatch tools with health information for geographies and networks specific to your application. Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.

To use Internet Monitor, you create a monitor and associate your application's resources with it - VPCs, NLBs, CloudFront distributions, or WorkSpaces directories - so Internet Monitor can determine where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations and ASNs (typically, internet service providers or ISPs) 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.

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

Method Summary

All Methods Instance Methods Abstract Methods
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 that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.
`GetInternetEventResult`	`getInternetEvent(GetInternetEventRequest getInternetEventRequest)` Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event.
`GetMonitorResult`	`getMonitor(GetMonitorRequest getMonitorRequest)` Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.
`GetQueryResultsResult`	`getQueryResults(GetQueryResultsRequest getQueryResultsRequest)` Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.
`GetQueryStatusResult`	`getQueryStatus(GetQueryStatusRequest getQueryStatusRequest)` Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor.
`ListHealthEventsResult`	`listHealthEvents(ListHealthEventsRequest listHealthEventsRequest)` Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
`ListInternetEventsResult`	`listInternetEvents(ListInternetEventsRequest listInternetEventsRequest)` Lists internet events that cause performance or availability issues for client locations.
`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.
`StartQueryResult`	`startQuery(StartQueryRequest startQueryRequest)` Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface.
`StopQueryResult`	`stopQuery(StopQueryRequest stopQueryRequest)` Stop a query that is progress for a specific monitor.
`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: VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
    
    When you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the number of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network maximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor at any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
    
    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 that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location.
    
    The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs), 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
  - getInternetEvent
```
GetInternetEventResult getInternetEvent(GetInternetEventRequest getInternetEventRequest)
```
    Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
    
    The information returned here includes the impacted location, when the event started and (if the event is over) ended, the type of event (PERFORMANCE or AVAILABILITY), and the status ( ACTIVE or RESOLVED).
    
    Parameters:
    
    getInternetEventRequest -
    
    Returns:
    
    Result of the GetInternetEvent 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
  - getQueryResults
```
GetQueryResultsResult getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
```
    Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a QueryId and a monitor name.
    
    For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
    
    Parameters:
    
    getQueryResultsRequest -
    
    Returns:
    
    Result of the GetQueryResults 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.
    
    LimitExceededException - The request exceeded a service quota.
    
    ValidationException - Invalid request.
    
    See Also:
    
    AWS API Documentation
  - getQueryStatus
```
GetQueryStatusResult getQueryStatus(GetQueryStatusRequest getQueryStatusRequest)
```
    Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED before you review the results.
    - QUEUED: The query is scheduled to run.
    - RUNNING: The query is in progress but not complete.
    - SUCCEEDED: The query completed sucessfully.
    - FAILED: The query failed due to an error.
    - CANCELED: The query was canceled.
    Parameters:
    
    getQueryStatusRequest -
    
    Returns:
    
    Result of the GetQueryStatus 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.
    
    LimitExceededException - The request exceeded a service quota.
    
    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 information for health events including the event start and end times, and the 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
  - listInternetEvents
```
ListInternetEventsResult listInternetEvents(ListInternetEventsRequest listInternetEventsRequest)
```
    Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
    
    You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time.
    
    You can also limit the events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).
    
    Parameters:
    
    listInternetEventsRequest -
    
    Returns:
    
    Result of the ListInternetEvents 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
  - startQuery
```
StartQueryResult startQuery(StartQueryRequest startQueryRequest)
```
    Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you want returned by using StartTime and EndTime. You filter the query results to return by providing parameters that you specify with FilterParameters.
    
    For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
    
    Parameters:
    
    startQueryRequest -
    
    Returns:
    
    Result of the StartQuery 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.
    
    LimitExceededException - The request exceeded a service quota.
    
    ValidationException - Invalid request.
    
    See Also:
    
    AWS API Documentation
  - stopQuery
```
StopQueryResult stopQuery(StopQueryRequest stopQueryRequest)
```
    Stop a query that is progress for a specific monitor.
    
    Parameters:
    
    stopQueryRequest -
    
    Returns:
    
    Result of the StopQuery 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.
    
    LimitExceededException - The request exceeded a service quota.
    
    ValidationException - Invalid request.
    
    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 change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.
    
    The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.779

Interface AmazonInternetMonitor

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createMonitor

deleteMonitor

getHealthEvent

getInternetEvent

getMonitor

getQueryResults

getQueryStatus

listHealthEvents

listInternetEvents

listMonitors

listTagsForResource

startQuery

stopQuery

tagResource

untagResource

updateMonitor

shutdown

getCachedResponseMetadata