@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface InternetMonitorClient extends AwsClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static InternetMonitorClientBuilder |
builder()
Create a builder that can be used to configure and create a
InternetMonitorClient. |
static InternetMonitorClient |
create()
Create a
InternetMonitorClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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 the Amazon CloudWatch Internet Monitor has created and stored about a health event for a
specified monitor.
|
default GetHealthEventResponse |
getHealthEvent(GetHealthEventRequest getHealthEventRequest)
Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a
specified monitor.
|
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 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)
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
|
default ListHealthEventsIterable |
listHealthEventsPaginator(ListHealthEventsRequest listHealthEventsRequest)
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
|
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)
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(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 ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags for a resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for a resource.
|
default InternetMonitorServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
createMonitorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateMonitorRequest.builder()
createMonitorRequest - A Consumer that will call methods on CreateMonitorInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest deleteMonitorRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException
Deletes a monitor in Amazon CloudWatch Internet Monitor.
deleteMonitorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteMonitorRequest.builder()
deleteMonitorRequest - A Consumer that will call methods on DeleteMonitorInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetHealthEventResponse getHealthEvent(GetHealthEventRequest getHealthEventRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException
Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all 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.
getHealthEventRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetHealthEventResponse getHealthEvent(Consumer<GetHealthEventRequest.Builder> getHealthEventRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, InternetMonitorException
Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all 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 via GetHealthEventRequest.builder()
getHealthEventRequest - A Consumer that will call methods on GetHealthEventInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getMonitorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetMonitorRequest.builder()
getMonitorRequest - A Consumer that will call methods on GetMonitorInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 time 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.
listHealthEventsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 time 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 via ListHealthEventsRequest.builder()
listHealthEventsRequest - A Consumer that will call methods on ListHealthEventsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListHealthEventsIterable listHealthEventsPaginator(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 time 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 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 Stream
software.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client.listHealthEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listHealthEventsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListHealthEventsIterable listHealthEventsPaginator(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 time 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 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 Stream
software.amazon.awssdk.services.internetmonitor.paginators.ListHealthEventsIterable responses = client.listHealthEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListHealthEventsRequest.builder()
listHealthEventsRequest - A Consumer that will call methods on ListHealthEventsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listMonitorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMonitorsRequest.builder()
listMonitorsRequest - A Consumer that will call methods on ListMonitorsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorsIterable listMonitorsPaginator(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.
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 Stream
software.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listMonitorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorsIterable listMonitorsPaginator(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 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 Stream
software.amazon.awssdk.services.internetmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListMonitorsRequest.builder()
listMonitorsRequest - A Consumer that will call methods on ListMonitorsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
tagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws TooManyRequestsException, AccessDeniedException, NotFoundException, BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, InternetMonitorException
Removes a tag from a resource.
untagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateMonitorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateMonitorRequest.builder()
updateMonitorRequest - A Consumer that will call methods on UpdateMonitorInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.InternetMonitorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic InternetMonitorClient create()
InternetMonitorClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static InternetMonitorClientBuilder builder()
InternetMonitorClient.static ServiceMetadata serviceMetadata()
default InternetMonitorServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.