software.amazon.awssdk.services.internetmonitor

Interface InternetMonitorClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface InternetMonitorClient
extends SdkClient

Service client for accessing Amazon CloudWatch Internet Monitor. This can be created using the static 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, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for example, by switching to other Amazon Web Services services or rerouting traffic to your workload through differentAmazon Web Services Regions.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

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

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

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: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories.

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

Parameters:

createMonitorRequest -

Returns:

Result of the CreateMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ConflictException - The requested resource is in use.

LimitExceededException - The request exceeded a service quota.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories.

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

This is a convenience which creates an instance of the CreateMonitorRequest.Builder avoiding the need to create one manually via CreateMonitorRequest.builder()

Parameters:

createMonitorRequest - A Consumer that will call methods on CreateMonitorInput.Builder to create a request.

Returns:

Result of the CreateMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ConflictException - The requested resource is in use.

LimitExceededException - The request exceeded a service quota.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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 via DeleteMonitorRequest.builder()

Parameters:

deleteMonitorRequest - A Consumer that will call methods on DeleteMonitorInput.Builder to create a request.

Returns:

Result of the DeleteMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

getHealthEvent

default 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 of the information related to the event by location.

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

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

Parameters:

getHealthEventRequest -

Returns:

Result of the GetHealthEvent operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

getHealthEvent

default 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 of the information related to the event by location.

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

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

This is a convenience which creates an instance of the GetHealthEventRequest.Builder avoiding the need to create one manually via GetHealthEventRequest.builder()

Parameters:

getHealthEventRequest - A Consumer that will call methods on GetHealthEventInput.Builder to create a request.

Returns:

Result of the GetHealthEvent operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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 via GetMonitorRequest.builder()

Parameters:

getMonitorRequest - A Consumer that will call methods on GetMonitorInput.Builder to create a request.

Returns:

Result of the GetMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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 all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status.

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

Parameters:

listHealthEventsRequest -

Returns:

Result of the ListHealthEvents operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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 all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status.

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

This is a convenience which creates an instance of the ListHealthEventsRequest.Builder avoiding the need to create one manually via ListHealthEventsRequest.builder()

Parameters:

listHealthEventsRequest - A Consumer that will call methods on ListHealthEventsInput.Builder to create a request.

Returns:

Result of the ListHealthEvents operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

listHealthEventsPaginator

default 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 all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status.

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

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.

Parameters:

listHealthEventsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

listHealthEventsPaginator

default 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 all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status.

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

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()

Parameters:

listHealthEventsRequest - A Consumer that will call methods on ListHealthEventsInput.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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 via ListMonitorsRequest.builder()

Parameters:

listMonitorsRequest - A Consumer that will call methods on ListMonitorsInput.Builder to create a request.

Returns:

Result of the ListMonitors operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

listMonitorsPaginator

default 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.

Parameters:

listMonitorsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

listMonitorsPaginator

default 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()

Parameters:

listMonitorsRequest - A Consumer that will call methods on ListMonitorsInput.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InternalServerException - An internal error occurred.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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.

Throws:

TooManyRequestsException - There were too many requests.

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

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

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

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.

AwsServiceException

See Also:

AWS API Documentation

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

TooManyRequestsException - There were too many requests.

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

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

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

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.

AwsServiceException

See Also:

AWS API Documentation

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.

Throws:

TooManyRequestsException - There were too many requests.

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

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

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

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.

AwsServiceException

See Also:

AWS API Documentation

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

TooManyRequestsException - There were too many requests.

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

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

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

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.

AwsServiceException

See Also:

AWS API Documentation

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.

Throws:

TooManyRequestsException - There were too many requests.

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

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

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

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.

AwsServiceException

See Also:

AWS API Documentation

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

TooManyRequestsException - There were too many requests.

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

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

BadRequestException - A bad request was received.

InternalServerErrorException - There was an internal server error.

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.

AwsServiceException

See Also:

AWS API Documentation

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 add or remove resources, or to change the status of the monitor. You can't change the name of a monitor.

Parameters:

updateMonitorRequest -

Returns:

Result of the UpdateMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

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

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The request exceeded a service quota.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

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 add or remove resources, or to change the status of the monitor. You can't change the name of a monitor.

This is a convenience which creates an instance of the UpdateMonitorRequest.Builder avoiding the need to create one manually via UpdateMonitorRequest.builder()

Parameters:

updateMonitorRequest - A Consumer that will call methods on UpdateMonitorInput.Builder to create a request.

Returns:

Result of the UpdateMonitor operation returned by the service.

Throws:

InternalServerException - An internal error occurred.

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

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

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The request exceeded a service quota.

ValidationException - Invalid request.

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.

AwsServiceException

See Also:

AWS API Documentation

create

static InternetMonitorClient create()

Create a InternetMonitorClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static InternetMonitorClientBuilder builder()

Create a builder that can be used to configure and create a InternetMonitorClient.

serviceMetadata

static ServiceMetadata serviceMetadata()