@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonInternetMonitor extends Object implements AmazonInternetMonitor
AmazonInternetMonitor
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateMonitorResult |
createMonitor(CreateMonitorRequest request)
Creates a monitor in Amazon CloudWatch Internet Monitor.
|
DeleteMonitorResult |
deleteMonitor(DeleteMonitorRequest request)
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 request)
Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a
specified monitor.
|
GetInternetEventResult |
getInternetEvent(GetInternetEventRequest request)
Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event.
|
GetMonitorResult |
getMonitor(GetMonitorRequest request)
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.
|
GetQueryResultsResult |
getQueryResults(GetQueryResultsRequest request)
Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.
|
GetQueryStatusResult |
getQueryStatus(GetQueryStatusRequest request)
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 request)
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
|
ListInternetEventsResult |
listInternetEvents(ListInternetEventsRequest request)
Lists internet events that cause performance or availability issues for client locations.
|
ListMonitorsResult |
listMonitors(ListMonitorsRequest request)
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 request)
Lists the tags for a resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartQueryResult |
startQuery(StartQueryRequest request)
Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query
interface.
|
StopQueryResult |
stopQuery(StopQueryRequest request)
Stop a query that is progress for a specific monitor.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds a tag to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from a resource.
|
UpdateMonitorResult |
updateMonitor(UpdateMonitorRequest request)
Updates a monitor.
|
public CreateMonitorResult createMonitor(CreateMonitorRequest request)
AmazonInternetMonitor
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.
createMonitor
in interface AmazonInternetMonitor
public DeleteMonitorResult deleteMonitor(DeleteMonitorRequest request)
AmazonInternetMonitor
Deletes a monitor in Amazon CloudWatch Internet Monitor.
deleteMonitor
in interface AmazonInternetMonitor
public GetHealthEventResult getHealthEvent(GetHealthEventRequest request)
AmazonInternetMonitor
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.
getHealthEvent
in interface AmazonInternetMonitor
public GetInternetEventResult getInternetEvent(GetInternetEventRequest request)
AmazonInternetMonitor
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
).
getInternetEvent
in interface AmazonInternetMonitor
public GetMonitorResult getMonitor(GetMonitorRequest request)
AmazonInternetMonitor
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.
getMonitor
in interface AmazonInternetMonitor
public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
AmazonInternetMonitor
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.
getQueryResults
in interface AmazonInternetMonitor
public GetQueryStatusResult getQueryStatus(GetQueryStatusRequest request)
AmazonInternetMonitor
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.
getQueryStatus
in interface AmazonInternetMonitor
public ListHealthEventsResult listHealthEvents(ListHealthEventsRequest request)
AmazonInternetMonitor
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.
listHealthEvents
in interface AmazonInternetMonitor
public ListInternetEventsResult listInternetEvents(ListInternetEventsRequest request)
AmazonInternetMonitor
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
).
listInternetEvents
in interface AmazonInternetMonitor
public ListMonitorsResult listMonitors(ListMonitorsRequest request)
AmazonInternetMonitor
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.
listMonitors
in interface AmazonInternetMonitor
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonInternetMonitor
Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
listTagsForResource
in interface AmazonInternetMonitor
public StartQueryResult startQuery(StartQueryRequest request)
AmazonInternetMonitor
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.
startQuery
in interface AmazonInternetMonitor
public StopQueryResult stopQuery(StopQueryRequest request)
AmazonInternetMonitor
Stop a query that is progress for a specific monitor.
stopQuery
in interface AmazonInternetMonitor
public TagResourceResult tagResource(TagResourceRequest request)
AmazonInternetMonitor
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.
tagResource
in interface AmazonInternetMonitor
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonInternetMonitor
Removes a tag from a resource.
untagResource
in interface AmazonInternetMonitor
public UpdateMonitorResult updateMonitor(UpdateMonitorRequest request)
AmazonInternetMonitor
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.
updateMonitor
in interface AmazonInternetMonitor
public void shutdown()
AmazonInternetMonitor
shutdown
in interface AmazonInternetMonitor
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonInternetMonitor
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.
getCachedResponseMetadata
in interface AmazonInternetMonitor
request
- The originally executed request.