Interface InternetMonitorClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic InternetMonitorClientBuilder
builder()
Create a builder that can be used to configure and create aInternetMonitorClient
.static InternetMonitorClient
create()
Create aInternetMonitorClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateMonitorResponse
createMonitor
(Consumer<CreateMonitorRequest.Builder> createMonitorRequest) Creates a monitor in Amazon CloudWatch Internet Monitor.default CreateMonitorResponse
createMonitor
(CreateMonitorRequest createMonitorRequest) Creates a monitor in Amazon CloudWatch Internet Monitor.default DeleteMonitorResponse
deleteMonitor
(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest) Deletes a monitor in Amazon CloudWatch Internet Monitor.default DeleteMonitorResponse
deleteMonitor
(DeleteMonitorRequest deleteMonitorRequest) Deletes a monitor in Amazon CloudWatch Internet Monitor.default GetHealthEventResponse
getHealthEvent
(Consumer<GetHealthEventRequest.Builder> getHealthEventRequest) Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.default GetHealthEventResponse
getHealthEvent
(GetHealthEventRequest getHealthEventRequest) Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.default GetInternetEventResponse
getInternetEvent
(Consumer<GetInternetEventRequest.Builder> getInternetEventRequest) Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event.default GetInternetEventResponse
getInternetEvent
(GetInternetEventRequest getInternetEventRequest) Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event.default GetMonitorResponse
getMonitor
(Consumer<GetMonitorRequest.Builder> getMonitorRequest) Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.default GetMonitorResponse
getMonitor
(GetMonitorRequest getMonitorRequest) Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.default GetQueryResultsResponse
getQueryResults
(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.default GetQueryResultsResponse
getQueryResults
(GetQueryResultsRequest getQueryResultsRequest) Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.default GetQueryResultsIterable
getQueryResultsPaginator
(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) This is a variant ofgetQueryResults(software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsRequest)
operation.default GetQueryResultsIterable
getQueryResultsPaginator
(GetQueryResultsRequest getQueryResultsRequest) This is a variant ofgetQueryResults(software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsRequest)
operation.default GetQueryStatusResponse
getQueryStatus
(Consumer<GetQueryStatusRequest.Builder> getQueryStatusRequest) Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor.default GetQueryStatusResponse
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.default ListHealthEventsResponse
listHealthEvents
(Consumer<ListHealthEventsRequest.Builder> listHealthEventsRequest) Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.default ListHealthEventsResponse
listHealthEvents
(ListHealthEventsRequest listHealthEventsRequest) Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.default ListHealthEventsIterable
listHealthEventsPaginator
(Consumer<ListHealthEventsRequest.Builder> listHealthEventsRequest) This is a variant oflistHealthEvents(software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsRequest)
operation.default ListHealthEventsIterable
listHealthEventsPaginator
(ListHealthEventsRequest listHealthEventsRequest) This is a variant oflistHealthEvents(software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsRequest)
operation.default ListInternetEventsResponse
listInternetEvents
(Consumer<ListInternetEventsRequest.Builder> listInternetEventsRequest) Lists internet events that cause performance or availability issues for client locations.default ListInternetEventsResponse
listInternetEvents
(ListInternetEventsRequest listInternetEventsRequest) Lists internet events that cause performance or availability issues for client locations.default ListInternetEventsIterable
listInternetEventsPaginator
(Consumer<ListInternetEventsRequest.Builder> listInternetEventsRequest) This is a variant oflistInternetEvents(software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsRequest)
operation.default ListInternetEventsIterable
listInternetEventsPaginator
(ListInternetEventsRequest listInternetEventsRequest) This is a variant oflistInternetEvents(software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsRequest)
operation.default ListMonitorsResponse
listMonitors
(Consumer<ListMonitorsRequest.Builder> 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.default ListMonitorsResponse
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.default ListMonitorsIterable
listMonitorsPaginator
(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest) This is a variant oflistMonitors(software.amazon.awssdk.services.internetmonitor.model.ListMonitorsRequest)
operation.default ListMonitorsIterable
listMonitorsPaginator
(ListMonitorsRequest listMonitorsRequest) This is a variant oflistMonitors(software.amazon.awssdk.services.internetmonitor.model.ListMonitorsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for a resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartQueryResponse
startQuery
(Consumer<StartQueryRequest.Builder> startQueryRequest) Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface.default StartQueryResponse
startQuery
(StartQueryRequest startQueryRequest) Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface.default StopQueryResponse
stopQuery
(Consumer<StopQueryRequest.Builder> stopQueryRequest) Stop a query that is progress for a specific monitor.default StopQueryResponse
stopQuery
(StopQueryRequest stopQueryRequest) Stop a query that is progress for a specific monitor.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a tag to a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds a tag to a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.default UpdateMonitorResponse
updateMonitor
(Consumer<UpdateMonitorRequest.Builder> updateMonitorRequest) Updates a monitor.default UpdateMonitorResponse
updateMonitor
(UpdateMonitorRequest updateMonitorRequest) Updates a monitor.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createMonitor
default CreateMonitorResponse createMonitor(CreateMonitorRequest createMonitorRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ConflictException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
createMonitor
default CreateMonitorResponse createMonitor(Consumer<CreateMonitorRequest.Builder> createMonitorRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ConflictException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
CreateMonitorRequest.Builder
avoiding the need to create one manually viaCreateMonitorRequest.builder()
- Parameters:
createMonitorRequest
- AConsumer
that will call methods onCreateMonitorRequest.Builder
to create a request.- Returns:
- Result of the CreateMonitor operation returned by the service.
- See Also:
-
deleteMonitor
default DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest deleteMonitorRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException Deletes a monitor in Amazon CloudWatch Internet Monitor.
- Parameters:
deleteMonitorRequest
-- Returns:
- Result of the DeleteMonitor operation returned by the service.
- See Also:
-
deleteMonitor
default DeleteMonitorResponse deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException Deletes a monitor in Amazon CloudWatch Internet Monitor.
This is a convenience which creates an instance of the
DeleteMonitorRequest.Builder
avoiding the need to create one manually viaDeleteMonitorRequest.builder()
- Parameters:
deleteMonitorRequest
- AConsumer
that will call methods onDeleteMonitorRequest.Builder
to create a request.- Returns:
- Result of the DeleteMonitor operation returned by the service.
- See Also:
-
getHealthEvent
default GetHealthEventResponse getHealthEvent(GetHealthEventRequest getHealthEventRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
getHealthEvent
default GetHealthEventResponse getHealthEvent(Consumer<GetHealthEventRequest.Builder> getHealthEventRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
GetHealthEventRequest.Builder
avoiding the need to create one manually viaGetHealthEventRequest.builder()
- Parameters:
getHealthEventRequest
- AConsumer
that will call methods onGetHealthEventRequest.Builder
to create a request.- Returns:
- Result of the GetHealthEvent operation returned by the service.
- See Also:
-
getInternetEvent
default GetInternetEventResponse getInternetEvent(GetInternetEventRequest getInternetEventRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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
orAVAILABILITY
), and the status (ACTIVE
orRESOLVED
).- Parameters:
getInternetEventRequest
-- Returns:
- Result of the GetInternetEvent operation returned by the service.
- See Also:
-
getInternetEvent
default GetInternetEventResponse getInternetEvent(Consumer<GetInternetEventRequest.Builder> getInternetEventRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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
orAVAILABILITY
), and the status (ACTIVE
orRESOLVED
).
This is a convenience which creates an instance of the
GetInternetEventRequest.Builder
avoiding the need to create one manually viaGetInternetEventRequest.builder()
- Parameters:
getInternetEventRequest
- AConsumer
that will call methods onGetInternetEventRequest.Builder
to create a request.- Returns:
- Result of the GetInternetEvent operation returned by the service.
- See Also:
-
getMonitor
default GetMonitorResponse getMonitor(GetMonitorRequest getMonitorRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
getMonitor
default GetMonitorResponse getMonitor(Consumer<GetMonitorRequest.Builder> getMonitorRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
GetMonitorRequest.Builder
avoiding the need to create one manually viaGetMonitorRequest.builder()
- Parameters:
getMonitorRequest
- AConsumer
that will call methods onGetMonitorRequest.Builder
to create a request.- Returns:
- Result of the GetMonitor operation returned by the service.
- See Also:
-
getQueryResults
default GetQueryResultsResponse getQueryResults(GetQueryResultsRequest getQueryResultsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
getQueryResults
default GetQueryResultsResponse getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
GetQueryResultsRequest.Builder
avoiding the need to create one manually viaGetQueryResultsRequest.builder()
- Parameters:
getQueryResultsRequest
- AConsumer
that will call methods onGetQueryResultsRequest.Builder
to create a request.- Returns:
- Result of the GetQueryResults operation returned by the service.
- See Also:
-
getQueryResultsPaginator
default GetQueryResultsIterable getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
getQueryResults(software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.GetQueryResultsIterable responses = client .getQueryResultsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsRequest)
operation.- Parameters:
getQueryResultsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getQueryResultsPaginator
default GetQueryResultsIterable getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
getQueryResults(software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.GetQueryResultsIterable responses = client .getQueryResultsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.internetmonitor.model.GetQueryResultsRequest)
operation.
This is a convenience which creates an instance of the
GetQueryResultsRequest.Builder
avoiding the need to create one manually viaGetQueryResultsRequest.builder()
- Parameters:
getQueryResultsRequest
- AConsumer
that will call methods onGetQueryResultsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getQueryStatus
default GetQueryStatusResponse getQueryStatus(GetQueryStatusRequest getQueryStatusRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
-
getQueryStatus
default GetQueryStatusResponse getQueryStatus(Consumer<GetQueryStatusRequest.Builder> getQueryStatusRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
GetQueryStatusRequest.Builder
avoiding the need to create one manually viaGetQueryStatusRequest.builder()
- Parameters:
getQueryStatusRequest
- AConsumer
that will call methods onGetQueryStatusRequest.Builder
to create a request.- Returns:
- Result of the GetQueryStatus operation returned by the service.
- See Also:
-
-
listHealthEvents
default ListHealthEventsResponse listHealthEvents(ListHealthEventsRequest listHealthEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
listHealthEvents
default ListHealthEventsResponse listHealthEvents(Consumer<ListHealthEventsRequest.Builder> listHealthEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
ListHealthEventsRequest.Builder
avoiding the need to create one manually viaListHealthEventsRequest.builder()
- Parameters:
listHealthEventsRequest
- AConsumer
that will call methods onListHealthEventsRequest.Builder
to create a request.- Returns:
- Result of the ListHealthEvents operation returned by the service.
- See Also:
-
listHealthEventsPaginator
default ListHealthEventsIterable listHealthEventsPaginator(ListHealthEventsRequest listHealthEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
listHealthEvents(software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client.listHealthEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client .listHealthEventsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client.listHealthEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHealthEvents(software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsRequest)
operation.- Parameters:
listHealthEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHealthEventsPaginator
default ListHealthEventsIterable listHealthEventsPaginator(Consumer<ListHealthEventsRequest.Builder> listHealthEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
listHealthEvents(software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client.listHealthEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client .listHealthEventsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client.listHealthEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHealthEvents(software.amazon.awssdk.services.internetmonitor.model.ListHealthEventsRequest)
operation.
This is a convenience which creates an instance of the
ListHealthEventsRequest.Builder
avoiding the need to create one manually viaListHealthEventsRequest.builder()
- Parameters:
listHealthEventsRequest
- AConsumer
that will call methods onListHealthEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInternetEvents
default ListInternetEventsResponse listInternetEvents(ListInternetEventsRequest listInternetEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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
orRESOLVED
) or type (PERFORMANCE
orAVAILABILITY
).- Parameters:
listInternetEventsRequest
-- Returns:
- Result of the ListInternetEvents operation returned by the service.
- See Also:
-
listInternetEvents
default ListInternetEventsResponse listInternetEvents(Consumer<ListInternetEventsRequest.Builder> listInternetEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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
orRESOLVED
) or type (PERFORMANCE
orAVAILABILITY
).
This is a convenience which creates an instance of the
ListInternetEventsRequest.Builder
avoiding the need to create one manually viaListInternetEventsRequest.builder()
- Parameters:
listInternetEventsRequest
- AConsumer
that will call methods onListInternetEventsRequest.Builder
to create a request.- Returns:
- Result of the ListInternetEvents operation returned by the service.
- See Also:
-
listInternetEventsPaginator
default ListInternetEventsIterable listInternetEventsPaginator(ListInternetEventsRequest listInternetEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
listInternetEvents(software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.ListInternetEventsIterable responses = client.listInternetEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.ListInternetEventsIterable responses = client .listInternetEventsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.ListInternetEventsIterable responses = client.listInternetEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInternetEvents(software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsRequest)
operation.- Parameters:
listInternetEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInternetEventsPaginator
default ListInternetEventsIterable listInternetEventsPaginator(Consumer<ListInternetEventsRequest.Builder> listInternetEventsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
listInternetEvents(software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.ListInternetEventsIterable responses = client.listInternetEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.ListInternetEventsIterable responses = client .listInternetEventsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.ListInternetEventsIterable responses = client.listInternetEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInternetEvents(software.amazon.awssdk.services.internetmonitor.model.ListInternetEventsRequest)
operation.
This is a convenience which creates an instance of the
ListInternetEventsRequest.Builder
avoiding the need to create one manually viaListInternetEventsRequest.builder()
- Parameters:
listInternetEventsRequest
- AConsumer
that will call methods onListInternetEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMonitors
default ListMonitorsResponse listMonitors(ListMonitorsRequest listMonitorsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
listMonitors
default ListMonitorsResponse listMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
ListMonitorsRequest.Builder
avoiding the need to create one manually viaListMonitorsRequest.builder()
- Parameters:
listMonitorsRequest
- AConsumer
that will call methods onListMonitorsRequest.Builder
to create a request.- Returns:
- Result of the ListMonitors operation returned by the service.
- See Also:
-
listMonitorsPaginator
default ListMonitorsIterable listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
listMonitors(software.amazon.awssdk.services.internetmonitor.model.ListMonitorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client .listMonitorsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.ListMonitorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMonitors(software.amazon.awssdk.services.internetmonitor.model.ListMonitorsRequest)
operation.- Parameters:
listMonitorsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMonitorsPaginator
default ListMonitorsIterable listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException This is a variant of
listMonitors(software.amazon.awssdk.services.internetmonitor.model.ListMonitorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client .listMonitorsPaginator(request); for (software.amazon.awssdk.services.internetmonitor.model.ListMonitorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMonitors(software.amazon.awssdk.services.internetmonitor.model.ListMonitorsRequest)
operation.
This is a convenience which creates an instance of the
ListMonitorsRequest.Builder
avoiding the need to create one manually viaListMonitorsRequest.builder()
- Parameters:
listMonitorsRequest
- AConsumer
that will call methods onListMonitorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws TooManyRequestsException, AccessDeniedException, NotFoundException, BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws TooManyRequestsException, AccessDeniedException, NotFoundException, BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, InternetMonitorException Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startQuery
default StartQueryResponse startQuery(StartQueryRequest startQueryRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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
andEndTime
. You filter the query results to return by providing parameters that you specify withFilterParameters
.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.
- See Also:
-
startQuery
default StartQueryResponse startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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
andEndTime
. You filter the query results to return by providing parameters that you specify withFilterParameters
.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.
This is a convenience which creates an instance of the
StartQueryRequest.Builder
avoiding the need to create one manually viaStartQueryRequest.builder()
- Parameters:
startQueryRequest
- AConsumer
that will call methods onStartQueryRequest.Builder
to create a request.- Returns:
- Result of the StartQuery operation returned by the service.
- See Also:
-
stopQuery
default StopQueryResponse stopQuery(StopQueryRequest stopQueryRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException Stop a query that is progress for a specific monitor.
- Parameters:
stopQueryRequest
-- Returns:
- Result of the StopQuery operation returned by the service.
- See Also:
-
stopQuery
default StopQueryResponse stopQuery(Consumer<StopQueryRequest.Builder> stopQueryRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException Stop a query that is progress for a specific monitor.
This is a convenience which creates an instance of the
StopQueryRequest.Builder
avoiding the need to create one manually viaStopQueryRequest.builder()
- Parameters:
stopQueryRequest
- AConsumer
that will call methods onStopQueryRequest.Builder
to create a request.- Returns:
- Result of the StopQuery operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws TooManyRequestsException, AccessDeniedException, NotFoundException, BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws TooManyRequestsException, AccessDeniedException, NotFoundException, BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws TooManyRequestsException, AccessDeniedException, NotFoundException, BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, InternetMonitorException Removes a tag from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws TooManyRequestsException, AccessDeniedException, NotFoundException, BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, InternetMonitorException Removes a tag from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateMonitor
default UpdateMonitorResponse updateMonitor(UpdateMonitorRequest updateMonitorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
- See Also:
-
updateMonitor
default UpdateMonitorResponse updateMonitor(Consumer<UpdateMonitorRequest.Builder> updateMonitorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException 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.
This is a convenience which creates an instance of the
UpdateMonitorRequest.Builder
avoiding the need to create one manually viaUpdateMonitorRequest.builder()
- Parameters:
updateMonitorRequest
- AConsumer
that will call methods onUpdateMonitorRequest.Builder
to create a request.- Returns:
- Result of the UpdateMonitor operation returned by the service.
- See Also:
-
create
Create aInternetMonitorClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aInternetMonitorClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-