Interface NetworkFlowMonitorAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface NetworkFlowMonitorAsyncClient extends AwsClient
Service client for accessing Network Flow Monitor asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.

In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.

To learn more about Network Flow Monitor, see the Network Flow Monitor User Guide in the Amazon CloudWatch User Guide.

  • Field Details

  • Method Details

    • createMonitor

      default CompletableFuture<CreateMonitorResponse> createMonitor(CreateMonitorRequest createMonitorRequest)

      Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.

      Parameters:
      createMonitorRequest -
      Returns:
      A Java Future containing the result of the CreateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createMonitor

      default CompletableFuture<CreateMonitorResponse> createMonitor(Consumer<CreateMonitorRequest.Builder> createMonitorRequest)

      Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.


      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 CreateMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createScope

      default CompletableFuture<CreateScopeResponse> createScope(CreateScopeRequest createScopeRequest)

      Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope.

      When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.

      Parameters:
      createScopeRequest -
      Returns:
      A Java Future containing the result of the CreateScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createScope

      default CompletableFuture<CreateScopeResponse> createScope(Consumer<CreateScopeRequest.Builder> createScopeRequest)

      Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope.

      When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.


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

      Parameters:
      createScopeRequest - A Consumer that will call methods on CreateScopeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteMonitor

      default CompletableFuture<DeleteMonitorResponse> deleteMonitor(DeleteMonitorRequest deleteMonitorRequest)

      Deletes a monitor in Network Flow Monitor.

      Parameters:
      deleteMonitorRequest -
      Returns:
      A Java Future containing the result of the DeleteMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteMonitor

      default CompletableFuture<DeleteMonitorResponse> deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest)

      Deletes a monitor in Network Flow 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 DeleteMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteScope

      default CompletableFuture<DeleteScopeResponse> deleteScope(DeleteScopeRequest deleteScopeRequest)

      Deletes a scope that has been defined.

      Parameters:
      deleteScopeRequest -
      Returns:
      A Java Future containing the result of the DeleteScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteScope

      default CompletableFuture<DeleteScopeResponse> deleteScope(Consumer<DeleteScopeRequest.Builder> deleteScopeRequest)

      Deletes a scope that has been defined.


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

      Parameters:
      deleteScopeRequest - A Consumer that will call methods on DeleteScopeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getMonitor

      default CompletableFuture<GetMonitorResponse> getMonitor(GetMonitorRequest getMonitorRequest)

      Gets information about a monitor in Network Flow 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:
      A Java Future containing the result of the GetMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getMonitor

      default CompletableFuture<GetMonitorResponse> getMonitor(Consumer<GetMonitorRequest.Builder> getMonitorRequest)

      Gets information about a monitor in Network Flow 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 GetMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsMonitorTopContributors

      default CompletableFuture<GetQueryResultsMonitorTopContributorsResponse> getQueryResultsMonitorTopContributors(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)

      Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.

      Create a query ID for this call by calling the corresponding API call to start the query, StartQueryMonitorTopContributors. Use the scope ID that was returned for your account by CreateScope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      Parameters:
      getQueryResultsMonitorTopContributorsRequest -
      Returns:
      A Java Future containing the result of the GetQueryResultsMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsMonitorTopContributors

      default CompletableFuture<GetQueryResultsMonitorTopContributorsResponse> getQueryResultsMonitorTopContributors(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)

      Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.

      Create a query ID for this call by calling the corresponding API call to start the query, StartQueryMonitorTopContributors. Use the scope ID that was returned for your account by CreateScope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.


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

      Parameters:
      getQueryResultsMonitorTopContributorsRequest - A Consumer that will call methods on GetQueryResultsMonitorTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryResultsMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsMonitorTopContributorsPaginator

      default GetQueryResultsMonitorTopContributorsPublisher getQueryResultsMonitorTopContributorsPaginator(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)

      This is a variant of getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsPublisher publisher = client.getQueryResultsMonitorTopContributorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsPublisher publisher = client.getQueryResultsMonitorTopContributorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation.

      Parameters:
      getQueryResultsMonitorTopContributorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsMonitorTopContributorsPaginator

      default GetQueryResultsMonitorTopContributorsPublisher getQueryResultsMonitorTopContributorsPaginator(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)

      This is a variant of getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsPublisher publisher = client.getQueryResultsMonitorTopContributorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsPublisher publisher = client.getQueryResultsMonitorTopContributorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation.


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

      Parameters:
      getQueryResultsMonitorTopContributorsRequest - A Consumer that will call methods on GetQueryResultsMonitorTopContributorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributors

      default CompletableFuture<GetQueryResultsWorkloadInsightsTopContributorsResponse> getQueryResultsWorkloadInsightsTopContributors(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)

      Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name.

      This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see GetQueryResultsWorkloadInsightsTopContributorsData.

      Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors. Use the scope ID that was returned for your account by CreateScope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsRequest -
      Returns:
      A Java Future containing the result of the GetQueryResultsWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributors

      default CompletableFuture<GetQueryResultsWorkloadInsightsTopContributorsResponse> getQueryResultsWorkloadInsightsTopContributors(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)

      Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name.

      This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see GetQueryResultsWorkloadInsightsTopContributorsData.

      Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors. Use the scope ID that was returned for your account by CreateScope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.


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

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsRequest - A Consumer that will call methods on GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryResultsWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributorsData

      default CompletableFuture<GetQueryResultsWorkloadInsightsTopContributorsDataResponse> getQueryResultsWorkloadInsightsTopContributorsData(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)

      Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID.

      This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see GetQueryResultsWorkloadInsightsTopContributors.

      Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData. Use the scope ID that was returned for your account by CreateScope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsDataRequest -
      Returns:
      A Java Future containing the result of the GetQueryResultsWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributorsData

      default CompletableFuture<GetQueryResultsWorkloadInsightsTopContributorsDataResponse> getQueryResultsWorkloadInsightsTopContributorsData(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)

      Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID.

      This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see GetQueryResultsWorkloadInsightsTopContributors.

      Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData. Use the scope ID that was returned for your account by CreateScope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.


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

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsDataRequest - A Consumer that will call methods on GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryResultsWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributorsDataPaginator

      default GetQueryResultsWorkloadInsightsTopContributorsDataPublisher getQueryResultsWorkloadInsightsTopContributorsDataPaginator(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)

      This is a variant of getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation.

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsDataRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributorsDataPaginator

      default GetQueryResultsWorkloadInsightsTopContributorsDataPublisher getQueryResultsWorkloadInsightsTopContributorsDataPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)

      This is a variant of getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation.


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

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsDataRequest - A Consumer that will call methods on GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributorsPaginator

      default GetQueryResultsWorkloadInsightsTopContributorsPublisher getQueryResultsWorkloadInsightsTopContributorsPaginator(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)

      This is a variant of getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation.

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryResultsWorkloadInsightsTopContributorsPaginator

      default GetQueryResultsWorkloadInsightsTopContributorsPublisher getQueryResultsWorkloadInsightsTopContributorsPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)

      This is a variant of getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsPublisher publisher = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation.


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

      Parameters:
      getQueryResultsWorkloadInsightsTopContributorsRequest - A Consumer that will call methods on GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryStatusMonitorTopContributors

      default CompletableFuture<GetQueryStatusMonitorTopContributorsResponse> getQueryStatusMonitorTopContributors(GetQueryStatusMonitorTopContributorsRequest getQueryStatusMonitorTopContributorsRequest)

      Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor.

      When you create a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, StartQueryMonitorTopContributors.

      When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.

      Parameters:
      getQueryStatusMonitorTopContributorsRequest -
      Returns:
      A Java Future containing the result of the GetQueryStatusMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryStatusMonitorTopContributors

      default CompletableFuture<GetQueryStatusMonitorTopContributorsResponse> getQueryStatusMonitorTopContributors(Consumer<GetQueryStatusMonitorTopContributorsRequest.Builder> getQueryStatusMonitorTopContributorsRequest)

      Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor.

      When you create a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, StartQueryMonitorTopContributors.

      When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.


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

      Parameters:
      getQueryStatusMonitorTopContributorsRequest - A Consumer that will call methods on GetQueryStatusMonitorTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryStatusMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryStatusWorkloadInsightsTopContributors

      default CompletableFuture<GetQueryStatusWorkloadInsightsTopContributorsResponse> getQueryStatusWorkloadInsightsTopContributors(GetQueryStatusWorkloadInsightsTopContributorsRequest getQueryStatusWorkloadInsightsTopContributorsRequest)

      Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights.

      When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      Parameters:
      getQueryStatusWorkloadInsightsTopContributorsRequest -
      Returns:
      A Java Future containing the result of the GetQueryStatusWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryStatusWorkloadInsightsTopContributors

      default CompletableFuture<GetQueryStatusWorkloadInsightsTopContributorsResponse> getQueryStatusWorkloadInsightsTopContributors(Consumer<GetQueryStatusWorkloadInsightsTopContributorsRequest.Builder> getQueryStatusWorkloadInsightsTopContributorsRequest)

      Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights.

      When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.


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

      Parameters:
      getQueryStatusWorkloadInsightsTopContributorsRequest - A Consumer that will call methods on GetQueryStatusWorkloadInsightsTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryStatusWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryStatusWorkloadInsightsTopContributorsData

      default CompletableFuture<GetQueryStatusWorkloadInsightsTopContributorsDataResponse> getQueryStatusWorkloadInsightsTopContributorsData(GetQueryStatusWorkloadInsightsTopContributorsDataRequest getQueryStatusWorkloadInsightsTopContributorsDataRequest)

      Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights.

      When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

      Parameters:
      getQueryStatusWorkloadInsightsTopContributorsDataRequest -
      Returns:
      A Java Future containing the result of the GetQueryStatusWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueryStatusWorkloadInsightsTopContributorsData

      default CompletableFuture<GetQueryStatusWorkloadInsightsTopContributorsDataResponse> getQueryStatusWorkloadInsightsTopContributorsData(Consumer<GetQueryStatusWorkloadInsightsTopContributorsDataRequest.Builder> getQueryStatusWorkloadInsightsTopContributorsDataRequest)

      Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights.

      When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.


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

      Parameters:
      getQueryStatusWorkloadInsightsTopContributorsDataRequest - A Consumer that will call methods on GetQueryStatusWorkloadInsightsTopContributorsDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryStatusWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getScope

      default CompletableFuture<GetScopeResponse> getScope(GetScopeRequest getScopeRequest)

      Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.

      Parameters:
      getScopeRequest -
      Returns:
      A Java Future containing the result of the GetScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getScope

      Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.


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

      Parameters:
      getScopeRequest - A Consumer that will call methods on GetScopeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitors

      default CompletableFuture<ListMonitorsResponse> listMonitors(ListMonitorsRequest listMonitorsRequest)

      List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the STATUS parameter.

      Parameters:
      listMonitorsRequest -
      Returns:
      A Java Future containing the result of the ListMonitors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitors

      default CompletableFuture<ListMonitorsResponse> listMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)

      List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the STATUS parameter.


      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 ListMonitorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMonitors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitorsPaginator

      default ListMonitorsPublisher listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest)

      This is a variant of listMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.networkflowmonitor.model.ListMonitorsRequest) operation.

      Parameters:
      listMonitorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitorsPaginator

      default ListMonitorsPublisher listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)

      This is a variant of listMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.networkflowmonitor.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 ListMonitorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScopes

      default CompletableFuture<ListScopesResponse> listScopes(ListScopesRequest listScopesRequest)

      List all the scopes for an account.

      Parameters:
      listScopesRequest -
      Returns:
      A Java Future containing the result of the ListScopes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScopes

      default CompletableFuture<ListScopesResponse> listScopes(Consumer<ListScopesRequest.Builder> listScopesRequest)

      List all the scopes for an account.


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

      Parameters:
      listScopesRequest - A Consumer that will call methods on ListScopesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListScopes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScopesPaginator

      default ListScopesPublisher listScopesPaginator(ListScopesRequest listScopesRequest)

      This is a variant of listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesPublisher publisher = client.listScopesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesPublisher publisher = client.listScopesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.ListScopesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation.

      Parameters:
      listScopesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScopesPaginator

      default ListScopesPublisher listScopesPaginator(Consumer<ListScopesRequest.Builder> listScopesRequest)

      This is a variant of listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesPublisher publisher = client.listScopesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesPublisher publisher = client.listScopesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.networkflowmonitor.model.ListScopesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation.


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

      Parameters:
      listScopesRequest - A Consumer that will call methods on ListScopesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns all the tags for a resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns all the tags for a resource.


      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 ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startQueryMonitorTopContributors

      default CompletableFuture<StartQueryMonitorTopContributorsResponse> startQueryMonitorTopContributors(StartQueryMonitorTopContributorsRequest startQueryMonitorTopContributorsRequest)

      Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for.

      The call returns a query ID that you can use with GetQueryResultsMonitorTopContributors to run the query and return the top contributors for a specific monitor.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.

      Parameters:
      startQueryMonitorTopContributorsRequest -
      Returns:
      A Java Future containing the result of the StartQueryMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startQueryMonitorTopContributors

      default CompletableFuture<StartQueryMonitorTopContributorsResponse> startQueryMonitorTopContributors(Consumer<StartQueryMonitorTopContributorsRequest.Builder> startQueryMonitorTopContributorsRequest)

      Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for.

      The call returns a query ID that you can use with GetQueryResultsMonitorTopContributors to run the query and return the top contributors for a specific monitor.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.


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

      Parameters:
      startQueryMonitorTopContributorsRequest - A Consumer that will call methods on StartQueryMonitorTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartQueryMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startQueryWorkloadInsightsTopContributors

      default CompletableFuture<StartQueryWorkloadInsightsTopContributorsResponse> startQueryWorkloadInsightsTopContributors(StartQueryWorkloadInsightsTopContributorsRequest startQueryWorkloadInsightsTopContributorsRequest)

      Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for.

      The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributors to run the query and return the top contributors for the workload insights for a scope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.

      Parameters:
      startQueryWorkloadInsightsTopContributorsRequest -
      Returns:
      A Java Future containing the result of the StartQueryWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startQueryWorkloadInsightsTopContributors

      default CompletableFuture<StartQueryWorkloadInsightsTopContributorsResponse> startQueryWorkloadInsightsTopContributors(Consumer<StartQueryWorkloadInsightsTopContributorsRequest.Builder> startQueryWorkloadInsightsTopContributorsRequest)

      Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for.

      The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributors to run the query and return the top contributors for the workload insights for a scope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.


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

      Parameters:
      startQueryWorkloadInsightsTopContributorsRequest - A Consumer that will call methods on StartQueryWorkloadInsightsTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartQueryWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startQueryWorkloadInsightsTopContributorsData

      default CompletableFuture<StartQueryWorkloadInsightsTopContributorsDataResponse> startQueryWorkloadInsightsTopContributorsData(StartQueryWorkloadInsightsTopContributorsDataRequest startQueryWorkloadInsightsTopContributorsDataRequest)

      Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for.

      The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributorsData to run the query and return the data for the top contributors for the workload insights for a scope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      Parameters:
      startQueryWorkloadInsightsTopContributorsDataRequest -
      Returns:
      A Java Future containing the result of the StartQueryWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startQueryWorkloadInsightsTopContributorsData

      default CompletableFuture<StartQueryWorkloadInsightsTopContributorsDataResponse> startQueryWorkloadInsightsTopContributorsData(Consumer<StartQueryWorkloadInsightsTopContributorsDataRequest.Builder> startQueryWorkloadInsightsTopContributorsDataRequest)

      Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for.

      The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributorsData to run the query and return the data for the top contributors for the workload insights for a scope.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.


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

      Parameters:
      startQueryWorkloadInsightsTopContributorsDataRequest - A Consumer that will call methods on StartQueryWorkloadInsightsTopContributorsDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartQueryWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • stopQueryMonitorTopContributors

      default CompletableFuture<StopQueryMonitorTopContributorsResponse> stopQueryMonitorTopContributors(StopQueryMonitorTopContributorsRequest stopQueryMonitorTopContributorsRequest)

      Stop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      Parameters:
      stopQueryMonitorTopContributorsRequest -
      Returns:
      A Java Future containing the result of the StopQueryMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • stopQueryMonitorTopContributors

      default CompletableFuture<StopQueryMonitorTopContributorsResponse> stopQueryMonitorTopContributors(Consumer<StopQueryMonitorTopContributorsRequest.Builder> stopQueryMonitorTopContributorsRequest)

      Stop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.


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

      Parameters:
      stopQueryMonitorTopContributorsRequest - A Consumer that will call methods on StopQueryMonitorTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopQueryMonitorTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • stopQueryWorkloadInsightsTopContributors

      default CompletableFuture<StopQueryWorkloadInsightsTopContributorsResponse> stopQueryWorkloadInsightsTopContributors(StopQueryWorkloadInsightsTopContributorsRequest stopQueryWorkloadInsightsTopContributorsRequest)

      Stop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      Parameters:
      stopQueryWorkloadInsightsTopContributorsRequest -
      Returns:
      A Java Future containing the result of the StopQueryWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • stopQueryWorkloadInsightsTopContributors

      default CompletableFuture<StopQueryWorkloadInsightsTopContributorsResponse> stopQueryWorkloadInsightsTopContributors(Consumer<StopQueryWorkloadInsightsTopContributorsRequest.Builder> stopQueryWorkloadInsightsTopContributorsRequest)

      Stop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.


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

      Parameters:
      stopQueryWorkloadInsightsTopContributorsRequest - A Consumer that will call methods on StopQueryWorkloadInsightsTopContributorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopQueryWorkloadInsightsTopContributors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • stopQueryWorkloadInsightsTopContributorsData

      default CompletableFuture<StopQueryWorkloadInsightsTopContributorsDataResponse> stopQueryWorkloadInsightsTopContributorsData(StopQueryWorkloadInsightsTopContributorsDataRequest stopQueryWorkloadInsightsTopContributorsDataRequest)

      Stop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

      Parameters:
      stopQueryWorkloadInsightsTopContributorsDataRequest -
      Returns:
      A Java Future containing the result of the StopQueryWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • stopQueryWorkloadInsightsTopContributorsData

      default CompletableFuture<StopQueryWorkloadInsightsTopContributorsDataResponse> stopQueryWorkloadInsightsTopContributorsData(Consumer<StopQueryWorkloadInsightsTopContributorsDataRequest.Builder> stopQueryWorkloadInsightsTopContributorsDataRequest)

      Stop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

      Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.


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

      Parameters:
      stopQueryWorkloadInsightsTopContributorsDataRequest - A Consumer that will call methods on StopQueryWorkloadInsightsTopContributorsDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopQueryWorkloadInsightsTopContributorsData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds a tag to a resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds a tag to a resource.


      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 TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag from a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      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 UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateMonitor

      default CompletableFuture<UpdateMonitorResponse> updateMonitor(UpdateMonitorRequest updateMonitorRequest)

      Update a monitor to add or remove local or remote resources.

      Parameters:
      updateMonitorRequest -
      Returns:
      A Java Future containing the result of the UpdateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateMonitor

      default CompletableFuture<UpdateMonitorResponse> updateMonitor(Consumer<UpdateMonitorRequest.Builder> updateMonitorRequest)

      Update a monitor to add or remove local or remote resources.


      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 UpdateMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateScope

      default CompletableFuture<UpdateScopeResponse> updateScope(UpdateScopeRequest updateScopeRequest)

      Update a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.

      Parameters:
      updateScopeRequest -
      Returns:
      A Java Future containing the result of the UpdateScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateScope

      default CompletableFuture<UpdateScopeResponse> updateScope(Consumer<UpdateScopeRequest.Builder> updateScopeRequest)

      Update a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.


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

      Parameters:
      updateScopeRequest - A Consumer that will call methods on UpdateScopeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateScope operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeded a service quota.
      • ResourceNotFoundException The request specifies a resource that doesn't exist.
      • ConflictException The requested resource is in use.
      • ValidationException Invalid request.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You don't have sufficient permission to perform this action.
      • InternalServerException An internal error occurred.
      • 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.
      • NetworkFlowMonitorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • serviceClientConfiguration

      default NetworkFlowMonitorServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration
    • create

      Create a NetworkFlowMonitorAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

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