Interface NetworkFlowMonitorClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface NetworkFlowMonitorClient
extends AwsClient

Service client for accessing Network Flow Monitor. This can be created using the static builder() method.

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 Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static NetworkFlowMonitorClientBuilder	builder()	Create a builder that can be used to configure and create a NetworkFlowMonitorClient.
static NetworkFlowMonitorClient	create()	Create a NetworkFlowMonitorClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default 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.
default 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.
default CreateScopeResponse	createScope(Consumer<CreateScopeRequest.Builder> createScopeRequest)	In Network Flow Monitor, you specify a scope for the service to generate metrics for.
default CreateScopeResponse	createScope(CreateScopeRequest createScopeRequest)	In Network Flow Monitor, you specify a scope for the service to generate metrics for.
default DeleteMonitorResponse	deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest)	Deletes a monitor in Network Flow Monitor.
default DeleteMonitorResponse	deleteMonitor(DeleteMonitorRequest deleteMonitorRequest)	Deletes a monitor in Network Flow Monitor.
default DeleteScopeResponse	deleteScope(Consumer<DeleteScopeRequest.Builder> deleteScopeRequest)	Deletes a scope that has been defined.
default DeleteScopeResponse	deleteScope(DeleteScopeRequest deleteScopeRequest)	Deletes a scope that has been defined.
default GetMonitorResponse	getMonitor(Consumer<GetMonitorRequest.Builder> getMonitorRequest)	Gets information about a monitor in Network Flow Monitor based on a monitor name.
default GetMonitorResponse	getMonitor(GetMonitorRequest getMonitorRequest)	Gets information about a monitor in Network Flow Monitor based on a monitor name.
default GetQueryResultsMonitorTopContributorsResponse	getQueryResultsMonitorTopContributors(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)	Return the data for a query with the Network Flow Monitor query interface.
default GetQueryResultsMonitorTopContributorsResponse	getQueryResultsMonitorTopContributors(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)	Return the data for a query with the Network Flow Monitor query interface.
default GetQueryResultsMonitorTopContributorsIterable	getQueryResultsMonitorTopContributorsPaginator(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)	This is a variant of getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation.
default GetQueryResultsMonitorTopContributorsIterable	getQueryResultsMonitorTopContributorsPaginator(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)	This is a variant of getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation.
default GetQueryResultsWorkloadInsightsTopContributorsResponse	getQueryResultsWorkloadInsightsTopContributors(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)	Return the data for a query with the Network Flow Monitor query interface.
default GetQueryResultsWorkloadInsightsTopContributorsResponse	getQueryResultsWorkloadInsightsTopContributors(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)	Return the data for a query with the Network Flow Monitor query interface.
default GetQueryResultsWorkloadInsightsTopContributorsDataResponse	getQueryResultsWorkloadInsightsTopContributorsData(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)	Return the data for a query with the Network Flow Monitor query interface.
default GetQueryResultsWorkloadInsightsTopContributorsDataResponse	getQueryResultsWorkloadInsightsTopContributorsData(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)	Return the data for a query with the Network Flow Monitor query interface.
default GetQueryResultsWorkloadInsightsTopContributorsDataIterable	getQueryResultsWorkloadInsightsTopContributorsDataPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)	This is a variant of getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation.
default GetQueryResultsWorkloadInsightsTopContributorsDataIterable	getQueryResultsWorkloadInsightsTopContributorsDataPaginator(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)	This is a variant of getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation.
default GetQueryResultsWorkloadInsightsTopContributorsIterable	getQueryResultsWorkloadInsightsTopContributorsPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)	This is a variant of getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation.
default GetQueryResultsWorkloadInsightsTopContributorsIterable	getQueryResultsWorkloadInsightsTopContributorsPaginator(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)	This is a variant of getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation.
default 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.
default 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.
default GetQueryStatusWorkloadInsightsTopContributorsResponse	getQueryStatusWorkloadInsightsTopContributors(Consumer<GetQueryStatusWorkloadInsightsTopContributorsRequest.Builder> getQueryStatusWorkloadInsightsTopContributorsRequest)	Return the data for a query with the Network Flow Monitor query interface.
default GetQueryStatusWorkloadInsightsTopContributorsResponse	getQueryStatusWorkloadInsightsTopContributors(GetQueryStatusWorkloadInsightsTopContributorsRequest getQueryStatusWorkloadInsightsTopContributorsRequest)	Return the data for a query with the Network Flow Monitor query interface.
default 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.
default 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.
default GetScopeResponse	getScope(Consumer<GetScopeRequest.Builder> getScopeRequest)	Gets information about a scope, including the name, status, tags, and target details.
default GetScopeResponse	getScope(GetScopeRequest getScopeRequest)	Gets information about a scope, including the name, status, tags, and target details.
default ListMonitorsResponse	listMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)	List all monitors in an account.
default ListMonitorsResponse	listMonitors(ListMonitorsRequest listMonitorsRequest)	List all monitors in an account.
default ListMonitorsIterable	listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)	This is a variant of listMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest) operation.
default ListMonitorsIterable	listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest)	This is a variant of listMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest) operation.
default ListScopesResponse	listScopes(Consumer<ListScopesRequest.Builder> listScopesRequest)	List all the scopes for an account.
default ListScopesResponse	listScopes(ListScopesRequest listScopesRequest)	List all the scopes for an account.
default ListScopesIterable	listScopesPaginator(Consumer<ListScopesRequest.Builder> listScopesRequest)	This is a variant of listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation.
default ListScopesIterable	listScopesPaginator(ListScopesRequest listScopesRequest)	This is a variant of listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns all the tags for a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns all the tags for a resource.
default NetworkFlowMonitorServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default 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.
default 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.
default 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.
default StartQueryWorkloadInsightsTopContributorsResponse	startQueryWorkloadInsightsTopContributors(StartQueryWorkloadInsightsTopContributorsRequest startQueryWorkloadInsightsTopContributorsRequest)	Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors.
default 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.
default 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.
default StopQueryMonitorTopContributorsResponse	stopQueryMonitorTopContributors(Consumer<StopQueryMonitorTopContributorsRequest.Builder> stopQueryMonitorTopContributorsRequest)	Stop a top contributors query for a monitor.
default StopQueryMonitorTopContributorsResponse	stopQueryMonitorTopContributors(StopQueryMonitorTopContributorsRequest stopQueryMonitorTopContributorsRequest)	Stop a top contributors query for a monitor.
default StopQueryWorkloadInsightsTopContributorsResponse	stopQueryWorkloadInsightsTopContributors(Consumer<StopQueryWorkloadInsightsTopContributorsRequest.Builder> stopQueryWorkloadInsightsTopContributorsRequest)	Stop a top contributors query for workload insights.
default StopQueryWorkloadInsightsTopContributorsResponse	stopQueryWorkloadInsightsTopContributors(StopQueryWorkloadInsightsTopContributorsRequest stopQueryWorkloadInsightsTopContributorsRequest)	Stop a top contributors query for workload insights.
default StopQueryWorkloadInsightsTopContributorsDataResponse	stopQueryWorkloadInsightsTopContributorsData(Consumer<StopQueryWorkloadInsightsTopContributorsDataRequest.Builder> stopQueryWorkloadInsightsTopContributorsDataRequest)	Stop a top contributors data query for workload insights.
default StopQueryWorkloadInsightsTopContributorsDataResponse	stopQueryWorkloadInsightsTopContributorsData(StopQueryWorkloadInsightsTopContributorsDataRequest stopQueryWorkloadInsightsTopContributorsDataRequest)	Stop a top contributors data query for workload insights.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds a tag to a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds a tag to a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag from a resource.
default UpdateMonitorResponse	updateMonitor(Consumer<UpdateMonitorRequest.Builder> updateMonitorRequest)	Update a monitor to add or remove local or remote resources.
default UpdateMonitorResponse	updateMonitor(UpdateMonitorRequest updateMonitorRequest)	Update a monitor to add or remove local or remote resources.
default 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.
default 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.

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

close

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

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

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

See Also:

• Constant Field Values

Method Details

createMonitor

default CreateMonitorResponse createMonitor(CreateMonitorRequest createMonitorRequest)
                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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

Parameters:

createMonitorRequest -

Returns:

Result of the CreateMonitor operation returned by the service.

See Also:

• AWS API Documentation

createMonitor

default CreateMonitorResponse createMonitor(Consumer<CreateMonitorRequest.Builder> createMonitorRequest)
                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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

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:

Result of the CreateMonitor operation returned by the service.

See Also:

• AWS API Documentation

createScope

default CreateScopeResponse createScope(CreateScopeRequest createScopeRequest)
                                 throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.

A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.

To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:

• Targets, which are arrays of targetResources.

• Target resources, which are Region-targetIdentifier pairs.

• Target identifiers, made up of a targetID (currently always an account ID) and a targetType (currently always an account).

Parameters:

createScopeRequest -

Returns:

Result of the CreateScope operation returned by the service.

See Also:

• AWS API Documentation

createScope

default CreateScopeResponse createScope(Consumer<CreateScopeRequest.Builder> createScopeRequest)
                                 throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.

A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.

To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:

• Targets, which are arrays of targetResources.

• Target resources, which are Region-targetIdentifier pairs.

• Target identifiers, made up of a targetID (currently always an account ID) and a targetType (currently always an account).

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:

Result of the CreateScope operation returned by the service.

See Also:

• AWS API Documentation

deleteMonitor

default DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest deleteMonitorRequest)
                                     throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

Deletes a monitor in Network Flow Monitor.

Parameters:

deleteMonitorRequest -

Returns:

Result of the DeleteMonitor operation returned by the service.

See Also:

• AWS API Documentation

deleteMonitor

default DeleteMonitorResponse deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest)
                                     throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the DeleteMonitor operation returned by the service.

See Also:

• AWS API Documentation

deleteScope

default DeleteScopeResponse deleteScope(DeleteScopeRequest deleteScopeRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

Deletes a scope that has been defined.

Parameters:

deleteScopeRequest -

Returns:

Result of the DeleteScope operation returned by the service.

See Also:

• AWS API Documentation

deleteScope

default DeleteScopeResponse deleteScope(Consumer<DeleteScopeRequest.Builder> deleteScopeRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the DeleteScope operation returned by the service.

See Also:

• AWS API Documentation

getMonitor

default GetMonitorResponse getMonitor(GetMonitorRequest getMonitorRequest)
                               throws ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetMonitor operation returned by the service.

See Also:

• AWS API Documentation

getMonitor

default GetMonitorResponse getMonitor(Consumer<GetMonitorRequest.Builder> getMonitorRequest)
                               throws ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetMonitor operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsMonitorTopContributors

default GetQueryResultsMonitorTopContributorsResponse getQueryResultsMonitorTopContributors(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)
                                                                                     throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryResultsMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsMonitorTopContributors

default GetQueryResultsMonitorTopContributorsResponse getQueryResultsMonitorTopContributors(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)
                                                                                     throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryResultsMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsMonitorTopContributorsPaginator

default GetQueryResultsMonitorTopContributorsIterable getQueryResultsMonitorTopContributorsPaginator(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)
                                                                                              throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client.getQueryResultsMonitorTopContributorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client
             .getQueryResultsMonitorTopContributorsPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client.getQueryResultsMonitorTopContributorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation.

Parameters:

getQueryResultsMonitorTopContributorsRequest -

Returns:

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

See Also:

• AWS API Documentation

getQueryResultsMonitorTopContributorsPaginator

default GetQueryResultsMonitorTopContributorsIterable getQueryResultsMonitorTopContributorsPaginator(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)
                                                                                              throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of getQueryResultsMonitorTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client.getQueryResultsMonitorTopContributorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client
             .getQueryResultsMonitorTopContributorsPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsMonitorTopContributorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client.getQueryResultsMonitorTopContributorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributors

default GetQueryResultsWorkloadInsightsTopContributorsResponse getQueryResultsWorkloadInsightsTopContributors(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)
                                                                                                       throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryResultsWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributors

default GetQueryResultsWorkloadInsightsTopContributorsResponse getQueryResultsWorkloadInsightsTopContributors(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)
                                                                                                       throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryResultsWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributorsPaginator

default GetQueryResultsWorkloadInsightsTopContributorsIterable getQueryResultsWorkloadInsightsTopContributorsPaginator(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)
                                                                                                                throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client
             .getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation.

Parameters:

getQueryResultsWorkloadInsightsTopContributorsRequest -

Returns:

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

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributorsPaginator

default GetQueryResultsWorkloadInsightsTopContributorsIterable getQueryResultsWorkloadInsightsTopContributorsPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)
                                                                                                                throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of getQueryResultsWorkloadInsightsTopContributors(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client
             .getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributorsData

default GetQueryResultsWorkloadInsightsTopContributorsDataResponse getQueryResultsWorkloadInsightsTopContributorsData(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)
                                                                                                               throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryResultsWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributorsData

default GetQueryResultsWorkloadInsightsTopContributorsDataResponse getQueryResultsWorkloadInsightsTopContributorsData(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)
                                                                                                               throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryResultsWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributorsDataPaginator

default GetQueryResultsWorkloadInsightsTopContributorsDataIterable getQueryResultsWorkloadInsightsTopContributorsDataPaginator(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)
                                                                                                                        throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client
             .getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation.

Parameters:

getQueryResultsWorkloadInsightsTopContributorsDataRequest -

Returns:

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

See Also:

• AWS API Documentation

getQueryResultsWorkloadInsightsTopContributorsDataPaginator

default GetQueryResultsWorkloadInsightsTopContributorsDataIterable getQueryResultsWorkloadInsightsTopContributorsDataPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)
                                                                                                                        throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of getQueryResultsWorkloadInsightsTopContributorsData(software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client
             .getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getQueryStatusMonitorTopContributors

default GetQueryStatusMonitorTopContributorsResponse getQueryStatusMonitorTopContributors(GetQueryStatusMonitorTopContributorsRequest getQueryStatusMonitorTopContributorsRequest)
                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryStatusMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryStatusMonitorTopContributors

default GetQueryStatusMonitorTopContributorsResponse getQueryStatusMonitorTopContributors(Consumer<GetQueryStatusMonitorTopContributorsRequest.Builder> getQueryStatusMonitorTopContributorsRequest)
                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryStatusMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryStatusWorkloadInsightsTopContributors

default GetQueryStatusWorkloadInsightsTopContributorsResponse getQueryStatusWorkloadInsightsTopContributors(GetQueryStatusWorkloadInsightsTopContributorsRequest getQueryStatusWorkloadInsightsTopContributorsRequest)
                                                                                                     throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryStatusWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryStatusWorkloadInsightsTopContributors

default GetQueryStatusWorkloadInsightsTopContributorsResponse getQueryStatusWorkloadInsightsTopContributors(Consumer<GetQueryStatusWorkloadInsightsTopContributorsRequest.Builder> getQueryStatusWorkloadInsightsTopContributorsRequest)
                                                                                                     throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryStatusWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

getQueryStatusWorkloadInsightsTopContributorsData

default GetQueryStatusWorkloadInsightsTopContributorsDataResponse getQueryStatusWorkloadInsightsTopContributorsData(GetQueryStatusWorkloadInsightsTopContributorsDataRequest getQueryStatusWorkloadInsightsTopContributorsDataRequest)
                                                                                                             throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryStatusWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

getQueryStatusWorkloadInsightsTopContributorsData

default GetQueryStatusWorkloadInsightsTopContributorsDataResponse getQueryStatusWorkloadInsightsTopContributorsData(Consumer<GetQueryStatusWorkloadInsightsTopContributorsDataRequest.Builder> getQueryStatusWorkloadInsightsTopContributorsDataRequest)
                                                                                                             throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetQueryStatusWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

getScope

default GetScopeResponse getScope(GetScopeRequest getScopeRequest)
                           throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetScope operation returned by the service.

See Also:

• AWS API Documentation

getScope

default GetScopeResponse getScope(Consumer<GetScopeRequest.Builder> getScopeRequest)
                           throws ServiceQuotaExceededException,
ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the GetScope operation returned by the service.

See Also:

• AWS API Documentation

listMonitors

default ListMonitorsResponse listMonitors(ListMonitorsRequest listMonitorsRequest)
                                   throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the ListMonitors operation returned by the service.

See Also:

• AWS API Documentation

listMonitors

default ListMonitorsResponse listMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)
                                   throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the ListMonitors operation returned by the service.

See Also:

• AWS API Documentation

listMonitorsPaginator

default ListMonitorsIterable listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest)
                                            throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of listMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client
             .listMonitorsPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest) operation.

Parameters:

listMonitorsRequest -

Returns:

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

See Also:

• AWS API Documentation

listMonitorsPaginator

default ListMonitorsIterable listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)
                                            throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of listMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client
             .listMonitorsPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMonitors(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listScopes

default ListScopesResponse listScopes(ListScopesRequest listScopesRequest)
                               throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

List all the scopes for an account.

Parameters:

listScopesRequest -

Returns:

Result of the ListScopes operation returned by the service.

See Also:

• AWS API Documentation

listScopes

default ListScopesResponse listScopes(Consumer<ListScopesRequest.Builder> listScopesRequest)
                               throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the ListScopes operation returned by the service.

See Also:

• AWS API Documentation

listScopesPaginator

default ListScopesIterable listScopesPaginator(ListScopesRequest listScopesRequest)
                                        throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client.listScopesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client
             .listScopesPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.ListScopesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client.listScopesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation.

Parameters:

listScopesRequest -

Returns:

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

See Also:

• AWS API Documentation

listScopesPaginator

default ListScopesIterable listScopesPaginator(Consumer<ListScopesRequest.Builder> listScopesRequest)
                                        throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

This is a variant of listScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client.listScopesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client
             .listScopesPaginator(request);
     for (software.amazon.awssdk.services.networkflowmonitor.model.ListScopesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client.listScopesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

Returns all the tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startQueryMonitorTopContributors

default StartQueryMonitorTopContributorsResponse startQueryMonitorTopContributors(StartQueryMonitorTopContributorsRequest startQueryMonitorTopContributorsRequest)
                                                                           throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StartQueryMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

startQueryMonitorTopContributors

default StartQueryMonitorTopContributorsResponse startQueryMonitorTopContributors(Consumer<StartQueryMonitorTopContributorsRequest.Builder> startQueryMonitorTopContributorsRequest)
                                                                           throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StartQueryMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

startQueryWorkloadInsightsTopContributors

default StartQueryWorkloadInsightsTopContributorsResponse startQueryWorkloadInsightsTopContributors(StartQueryWorkloadInsightsTopContributorsRequest startQueryWorkloadInsightsTopContributorsRequest)
                                                                                             throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StartQueryWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

startQueryWorkloadInsightsTopContributors

default StartQueryWorkloadInsightsTopContributorsResponse startQueryWorkloadInsightsTopContributors(Consumer<StartQueryWorkloadInsightsTopContributorsRequest.Builder> startQueryWorkloadInsightsTopContributorsRequest)
                                                                                             throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StartQueryWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

startQueryWorkloadInsightsTopContributorsData

default StartQueryWorkloadInsightsTopContributorsDataResponse startQueryWorkloadInsightsTopContributorsData(StartQueryWorkloadInsightsTopContributorsDataRequest startQueryWorkloadInsightsTopContributorsDataRequest)
                                                                                                     throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StartQueryWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

startQueryWorkloadInsightsTopContributorsData

default StartQueryWorkloadInsightsTopContributorsDataResponse startQueryWorkloadInsightsTopContributorsData(Consumer<StartQueryWorkloadInsightsTopContributorsDataRequest.Builder> startQueryWorkloadInsightsTopContributorsDataRequest)
                                                                                                     throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StartQueryWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

stopQueryMonitorTopContributors

default StopQueryMonitorTopContributorsResponse stopQueryMonitorTopContributors(StopQueryMonitorTopContributorsRequest stopQueryMonitorTopContributorsRequest)
                                                                         throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StopQueryMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

stopQueryMonitorTopContributors

default StopQueryMonitorTopContributorsResponse stopQueryMonitorTopContributors(Consumer<StopQueryMonitorTopContributorsRequest.Builder> stopQueryMonitorTopContributorsRequest)
                                                                         throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StopQueryMonitorTopContributors operation returned by the service.

See Also:

• AWS API Documentation

stopQueryWorkloadInsightsTopContributors

default StopQueryWorkloadInsightsTopContributorsResponse stopQueryWorkloadInsightsTopContributors(StopQueryWorkloadInsightsTopContributorsRequest stopQueryWorkloadInsightsTopContributorsRequest)
                                                                                           throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StopQueryWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

stopQueryWorkloadInsightsTopContributors

default StopQueryWorkloadInsightsTopContributorsResponse stopQueryWorkloadInsightsTopContributors(Consumer<StopQueryWorkloadInsightsTopContributorsRequest.Builder> stopQueryWorkloadInsightsTopContributorsRequest)
                                                                                           throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StopQueryWorkloadInsightsTopContributors operation returned by the service.

See Also:

• AWS API Documentation

stopQueryWorkloadInsightsTopContributorsData

default StopQueryWorkloadInsightsTopContributorsDataResponse stopQueryWorkloadInsightsTopContributorsData(StopQueryWorkloadInsightsTopContributorsDataRequest stopQueryWorkloadInsightsTopContributorsDataRequest)
                                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StopQueryWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

stopQueryWorkloadInsightsTopContributorsData

default StopQueryWorkloadInsightsTopContributorsDataResponse stopQueryWorkloadInsightsTopContributorsData(Consumer<StopQueryWorkloadInsightsTopContributorsDataRequest.Builder> stopQueryWorkloadInsightsTopContributorsDataRequest)
                                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the StopQueryWorkloadInsightsTopContributorsData operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

Adds a tag to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

Removes a tag from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateMonitor

default UpdateMonitorResponse updateMonitor(UpdateMonitorRequest updateMonitorRequest)
                                     throws ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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

Parameters:

updateMonitorRequest -

Returns:

Result of the UpdateMonitor operation returned by the service.

See Also:

• AWS API Documentation

updateMonitor

default UpdateMonitorResponse updateMonitor(Consumer<UpdateMonitorRequest.Builder> updateMonitorRequest)
                                     throws ResourceNotFoundException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the UpdateMonitor operation returned by the service.

See Also:

• AWS API Documentation

updateScope

default UpdateScopeResponse updateScope(UpdateScopeRequest updateScopeRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the UpdateScope operation returned by the service.

See Also:

• AWS API Documentation

updateScope

default UpdateScopeResponse updateScope(Consumer<UpdateScopeRequest.Builder> updateScopeRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
NetworkFlowMonitorException

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:

Result of the UpdateScope operation returned by the service.

See Also:

• AWS API Documentation

create

static NetworkFlowMonitorClient create()

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

builder

static NetworkFlowMonitorClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

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