Interface NetworkFlowMonitorClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface NetworkFlowMonitorClient extends AwsClient
Service client for accessing Network Flow Monitor. This can be created using the staticbuilder()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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static NetworkFlowMonitorClientBuilderbuilder()Create a builder that can be used to configure and create aNetworkFlowMonitorClient.static NetworkFlowMonitorClientcreate()Create aNetworkFlowMonitorClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateMonitorResponsecreateMonitor(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 CreateMonitorResponsecreateMonitor(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 CreateScopeResponsecreateScope(Consumer<CreateScopeRequest.Builder> createScopeRequest)Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.default CreateScopeResponsecreateScope(CreateScopeRequest createScopeRequest)Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.default DeleteMonitorResponsedeleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest)Deletes a monitor in Network Flow Monitor.default DeleteMonitorResponsedeleteMonitor(DeleteMonitorRequest deleteMonitorRequest)Deletes a monitor in Network Flow Monitor.default DeleteScopeResponsedeleteScope(Consumer<DeleteScopeRequest.Builder> deleteScopeRequest)Deletes a scope that has been defined.default DeleteScopeResponsedeleteScope(DeleteScopeRequest deleteScopeRequest)Deletes a scope that has been defined.default GetMonitorResponsegetMonitor(Consumer<GetMonitorRequest.Builder> getMonitorRequest)Gets information about a monitor in Network Flow Monitor based on a monitor name.default GetMonitorResponsegetMonitor(GetMonitorRequest getMonitorRequest)Gets information about a monitor in Network Flow Monitor based on a monitor name.default GetQueryResultsMonitorTopContributorsResponsegetQueryResultsMonitorTopContributors(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryResultsMonitorTopContributorsResponsegetQueryResultsMonitorTopContributors(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryResultsMonitorTopContributorsIterablegetQueryResultsMonitorTopContributorsPaginator(Consumer<GetQueryResultsMonitorTopContributorsRequest.Builder> getQueryResultsMonitorTopContributorsRequest)default GetQueryResultsMonitorTopContributorsIterablegetQueryResultsMonitorTopContributorsPaginator(GetQueryResultsMonitorTopContributorsRequest getQueryResultsMonitorTopContributorsRequest)default GetQueryResultsWorkloadInsightsTopContributorsResponsegetQueryResultsWorkloadInsightsTopContributors(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryResultsWorkloadInsightsTopContributorsResponsegetQueryResultsWorkloadInsightsTopContributors(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryResultsWorkloadInsightsTopContributorsDataResponsegetQueryResultsWorkloadInsightsTopContributorsData(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryResultsWorkloadInsightsTopContributorsDataResponsegetQueryResultsWorkloadInsightsTopContributorsData(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryResultsWorkloadInsightsTopContributorsDataIterablegetQueryResultsWorkloadInsightsTopContributorsDataPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsDataRequest)default GetQueryResultsWorkloadInsightsTopContributorsDataIterablegetQueryResultsWorkloadInsightsTopContributorsDataPaginator(GetQueryResultsWorkloadInsightsTopContributorsDataRequest getQueryResultsWorkloadInsightsTopContributorsDataRequest)default GetQueryResultsWorkloadInsightsTopContributorsIterablegetQueryResultsWorkloadInsightsTopContributorsPaginator(Consumer<GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder> getQueryResultsWorkloadInsightsTopContributorsRequest)default GetQueryResultsWorkloadInsightsTopContributorsIterablegetQueryResultsWorkloadInsightsTopContributorsPaginator(GetQueryResultsWorkloadInsightsTopContributorsRequest getQueryResultsWorkloadInsightsTopContributorsRequest)default GetQueryStatusMonitorTopContributorsResponsegetQueryStatusMonitorTopContributors(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 GetQueryStatusMonitorTopContributorsResponsegetQueryStatusMonitorTopContributors(GetQueryStatusMonitorTopContributorsRequest getQueryStatusMonitorTopContributorsRequest)Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.default GetQueryStatusWorkloadInsightsTopContributorsResponsegetQueryStatusWorkloadInsightsTopContributors(Consumer<GetQueryStatusWorkloadInsightsTopContributorsRequest.Builder> getQueryStatusWorkloadInsightsTopContributorsRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryStatusWorkloadInsightsTopContributorsResponsegetQueryStatusWorkloadInsightsTopContributors(GetQueryStatusWorkloadInsightsTopContributorsRequest getQueryStatusWorkloadInsightsTopContributorsRequest)Return the data for a query with the Network Flow Monitor query interface.default GetQueryStatusWorkloadInsightsTopContributorsDataResponsegetQueryStatusWorkloadInsightsTopContributorsData(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 GetQueryStatusWorkloadInsightsTopContributorsDataResponsegetQueryStatusWorkloadInsightsTopContributorsData(GetQueryStatusWorkloadInsightsTopContributorsDataRequest getQueryStatusWorkloadInsightsTopContributorsDataRequest)Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.default GetScopeResponsegetScope(Consumer<GetScopeRequest.Builder> getScopeRequest)Gets information about a scope, including the name, status, tags, and target details.default GetScopeResponsegetScope(GetScopeRequest getScopeRequest)Gets information about a scope, including the name, status, tags, and target details.default ListMonitorsResponselistMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)List all monitors in an account.default ListMonitorsResponselistMonitors(ListMonitorsRequest listMonitorsRequest)List all monitors in an account.default ListMonitorsIterablelistMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)This is a variant oflistMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest)operation.default ListMonitorsIterablelistMonitorsPaginator(ListMonitorsRequest listMonitorsRequest)This is a variant oflistMonitors(software.amazon.awssdk.services.networkflowmonitor.model.ListMonitorsRequest)operation.default ListScopesResponselistScopes(Consumer<ListScopesRequest.Builder> listScopesRequest)List all the scopes for an account.default ListScopesResponselistScopes(ListScopesRequest listScopesRequest)List all the scopes for an account.default ListScopesIterablelistScopesPaginator(Consumer<ListScopesRequest.Builder> listScopesRequest)This is a variant oflistScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest)operation.default ListScopesIterablelistScopesPaginator(ListScopesRequest listScopesRequest)This is a variant oflistScopes(software.amazon.awssdk.services.networkflowmonitor.model.ListScopesRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns all the tags for a resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns all the tags for a resource.default NetworkFlowMonitorServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartQueryMonitorTopContributorsResponsestartQueryMonitorTopContributors(Consumer<StartQueryMonitorTopContributorsRequest.Builder> startQueryMonitorTopContributorsRequest)Start a query to return the data with the Network Flow Monitor query interface.default StartQueryMonitorTopContributorsResponsestartQueryMonitorTopContributors(StartQueryMonitorTopContributorsRequest startQueryMonitorTopContributorsRequest)Start a query to return the data with the Network Flow Monitor query interface.default StartQueryWorkloadInsightsTopContributorsResponsestartQueryWorkloadInsightsTopContributors(Consumer<StartQueryWorkloadInsightsTopContributorsRequest.Builder> startQueryWorkloadInsightsTopContributorsRequest)Start a query to return the data with the Network Flow Monitor query interface.default StartQueryWorkloadInsightsTopContributorsResponsestartQueryWorkloadInsightsTopContributors(StartQueryWorkloadInsightsTopContributorsRequest startQueryWorkloadInsightsTopContributorsRequest)Start a query to return the data with the Network Flow Monitor query interface.default StartQueryWorkloadInsightsTopContributorsDataResponsestartQueryWorkloadInsightsTopContributorsData(Consumer<StartQueryWorkloadInsightsTopContributorsDataRequest.Builder> startQueryWorkloadInsightsTopContributorsDataRequest)Return the data for a query with the Network Flow Monitor query interface.default StartQueryWorkloadInsightsTopContributorsDataResponsestartQueryWorkloadInsightsTopContributorsData(StartQueryWorkloadInsightsTopContributorsDataRequest startQueryWorkloadInsightsTopContributorsDataRequest)Return the data for a query with the Network Flow Monitor query interface.default StopQueryMonitorTopContributorsResponsestopQueryMonitorTopContributors(Consumer<StopQueryMonitorTopContributorsRequest.Builder> stopQueryMonitorTopContributorsRequest)Stop a query with the Network Flow Monitor query interface.default StopQueryMonitorTopContributorsResponsestopQueryMonitorTopContributors(StopQueryMonitorTopContributorsRequest stopQueryMonitorTopContributorsRequest)Stop a query with the Network Flow Monitor query interface.default StopQueryWorkloadInsightsTopContributorsResponsestopQueryWorkloadInsightsTopContributors(Consumer<StopQueryWorkloadInsightsTopContributorsRequest.Builder> stopQueryWorkloadInsightsTopContributorsRequest)Stop a query with the Network Flow Monitor query interface.default StopQueryWorkloadInsightsTopContributorsResponsestopQueryWorkloadInsightsTopContributors(StopQueryWorkloadInsightsTopContributorsRequest stopQueryWorkloadInsightsTopContributorsRequest)Stop a query with the Network Flow Monitor query interface.default StopQueryWorkloadInsightsTopContributorsDataResponsestopQueryWorkloadInsightsTopContributorsData(Consumer<StopQueryWorkloadInsightsTopContributorsDataRequest.Builder> stopQueryWorkloadInsightsTopContributorsDataRequest)Return the data for a query with the Network Flow Monitor query interface.default StopQueryWorkloadInsightsTopContributorsDataResponsestopQueryWorkloadInsightsTopContributorsData(StopQueryWorkloadInsightsTopContributorsDataRequest stopQueryWorkloadInsightsTopContributorsDataRequest)Return the data for a query with the Network Flow Monitor query interface.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds a tag to a resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds a tag to a resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes a tag from a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes a tag from a resource.default UpdateMonitorResponseupdateMonitor(Consumer<UpdateMonitorRequest.Builder> updateMonitorRequest)Update a monitor to add or remove local or remote resources.default UpdateMonitorResponseupdateMonitor(UpdateMonitorRequest updateMonitorRequest)Update a monitor to add or remove local or remote resources.default UpdateScopeResponseupdateScope(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 UpdateScopeResponseupdateScope(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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 indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.
- Parameters:
createMonitorRequest-- Returns:
- Result of the CreateMonitor operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.
This is a convenience which creates an instance of the
CreateMonitorRequest.Builderavoiding the need to create one manually viaCreateMonitorRequest.builder()- Parameters:
createMonitorRequest- AConsumerthat will call methods onCreateMonitorRequest.Builderto create a request.- Returns:
- Result of the CreateMonitor operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createScope
default CreateScopeResponse createScope(CreateScopeRequest createScopeRequest) throws ServiceQuotaExceededException, ConflictException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope.
When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.
- Parameters:
createScopeRequest-- Returns:
- Result of the CreateScope operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createScope
default CreateScopeResponse createScope(Consumer<CreateScopeRequest.Builder> createScopeRequest) throws ServiceQuotaExceededException, ConflictException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope.
When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.
This is a convenience which creates an instance of the
CreateScopeRequest.Builderavoiding the need to create one manually viaCreateScopeRequest.builder()- Parameters:
createScopeRequest- AConsumerthat will call methods onCreateScopeRequest.Builderto create a request.- Returns:
- Result of the CreateScope operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMonitor
default DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest deleteMonitorRequest) throws ResourceNotFoundException, 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.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMonitor
default DeleteMonitorResponse deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest) throws ResourceNotFoundException, 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.Builderavoiding the need to create one manually viaDeleteMonitorRequest.builder()- Parameters:
deleteMonitorRequest- AConsumerthat will call methods onDeleteMonitorRequest.Builderto create a request.- Returns:
- Result of the DeleteMonitor operation returned by the service.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScope
default DeleteScopeResponse deleteScope(DeleteScopeRequest deleteScopeRequest) throws ServiceQuotaExceededException, 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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScope
default DeleteScopeResponse deleteScope(Consumer<DeleteScopeRequest.Builder> deleteScopeRequest) throws ServiceQuotaExceededException, 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.Builderavoiding the need to create one manually viaDeleteScopeRequest.builder()- Parameters:
deleteScopeRequest- AConsumerthat will call methods onDeleteScopeRequest.Builderto create a request.- Returns:
- Result of the DeleteScope operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetMonitorRequest.builder()- Parameters:
getMonitorRequest- AConsumerthat will call methods onGetMonitorRequest.Builderto create a request.- Returns:
- Result of the GetMonitor operation returned by the service.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 byCreateScope.Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
- Parameters:
getQueryResultsMonitorTopContributorsRequest-- Returns:
- Result of the GetQueryResultsMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 byCreateScope.Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
This is a convenience which creates an instance of the
GetQueryResultsMonitorTopContributorsRequest.Builderavoiding the need to create one manually viaGetQueryResultsMonitorTopContributorsRequest.builder()- Parameters:
getQueryResultsMonitorTopContributorsRequest- AConsumerthat will call methods onGetQueryResultsMonitorTopContributorsRequest.Builderto create a request.- Returns:
- Result of the GetQueryResultsMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client.getQueryResultsMonitorTopContributorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsMonitorTopContributorsIterable responses = client.getQueryResultsMonitorTopContributorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetQueryResultsMonitorTopContributorsRequest.builder()- Parameters:
getQueryResultsMonitorTopContributorsRequest- AConsumerthat will call methods onGetQueryResultsMonitorTopContributorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 specific monitor.
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 byCreateScope.Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
- Parameters:
getQueryResultsWorkloadInsightsTopContributorsRequest-- Returns:
- Result of the GetQueryResultsWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 specific monitor.
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 byCreateScope.Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
This is a convenience which creates an instance of the
GetQueryResultsWorkloadInsightsTopContributorsRequest.Builderavoiding the need to create one manually viaGetQueryResultsWorkloadInsightsTopContributorsRequest.builder()- Parameters:
getQueryResultsWorkloadInsightsTopContributorsRequest- AConsumerthat will call methods onGetQueryResultsWorkloadInsightsTopContributorsRequest.Builderto create a request.- Returns:
- Result of the GetQueryResultsWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetQueryResultsWorkloadInsightsTopContributorsRequest.builder()- Parameters:
getQueryResultsWorkloadInsightsTopContributorsRequest- AConsumerthat will call methods onGetQueryResultsWorkloadInsightsTopContributorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
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 byCreateScope.Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
- Parameters:
getQueryResultsWorkloadInsightsTopContributorsDataRequest-- Returns:
- Result of the GetQueryResultsWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
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 byCreateScope.Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
This is a convenience which creates an instance of the
GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builderavoiding the need to create one manually viaGetQueryResultsWorkloadInsightsTopContributorsDataRequest.builder()- Parameters:
getQueryResultsWorkloadInsightsTopContributorsDataRequest- AConsumerthat will call methods onGetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builderto create a request.- Returns:
- Result of the GetQueryResultsWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.GetQueryResultsWorkloadInsightsTopContributorsDataIterable responses = client.getQueryResultsWorkloadInsightsTopContributorsDataPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetQueryResultsWorkloadInsightsTopContributorsDataRequest.builder()- Parameters:
getQueryResultsWorkloadInsightsTopContributorsDataRequest- AConsumerthat will call methods onGetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 start a query, use this call to check the status of the query to make sure that it has has
SUCCEEDEDbefore you review the results. Use the same query ID that you used for the corresponding API call to start 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
SUCCEEDEDbefore you review the results.- Parameters:
getQueryStatusMonitorTopContributorsRequest-- Returns:
- Result of the GetQueryStatusMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 start a query, use this call to check the status of the query to make sure that it has has
SUCCEEDEDbefore you review the results. Use the same query ID that you used for the corresponding API call to start 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
SUCCEEDEDbefore you review the results.
This is a convenience which creates an instance of the
GetQueryStatusMonitorTopContributorsRequest.Builderavoiding the need to create one manually viaGetQueryStatusMonitorTopContributorsRequest.builder()- Parameters:
getQueryStatusMonitorTopContributorsRequest- AConsumerthat will call methods onGetQueryStatusMonitorTopContributorsRequest.Builderto create a request.- Returns:
- Result of the GetQueryStatusMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
SUCCEEDEDbefore 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, related to a scope (for workload insights) or a monitor.
- Parameters:
getQueryStatusWorkloadInsightsTopContributorsRequest-- Returns:
- Result of the GetQueryStatusWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
SUCCEEDEDbefore 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, related to a scope (for workload insights) or a monitor.
This is a convenience which creates an instance of the
GetQueryStatusWorkloadInsightsTopContributorsRequest.Builderavoiding the need to create one manually viaGetQueryStatusWorkloadInsightsTopContributorsRequest.builder()- Parameters:
getQueryStatusWorkloadInsightsTopContributorsRequest- AConsumerthat will call methods onGetQueryStatusWorkloadInsightsTopContributorsRequest.Builderto create a request.- Returns:
- Result of the GetQueryStatusWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
SUCCEEDEDbefore 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, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
- Parameters:
getQueryStatusWorkloadInsightsTopContributorsDataRequest-- Returns:
- Result of the GetQueryStatusWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
SUCCEEDEDbefore 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, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
This is a convenience which creates an instance of the
GetQueryStatusWorkloadInsightsTopContributorsDataRequest.Builderavoiding the need to create one manually viaGetQueryStatusWorkloadInsightsTopContributorsDataRequest.builder()- Parameters:
getQueryStatusWorkloadInsightsTopContributorsDataRequest- AConsumerthat will call methods onGetQueryStatusWorkloadInsightsTopContributorsDataRequest.Builderto create a request.- Returns:
- Result of the GetQueryStatusWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getScope
default GetScopeResponse getScope(GetScopeRequest getScopeRequest) throws ServiceQuotaExceededException, 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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getScope
default GetScopeResponse getScope(Consumer<GetScopeRequest.Builder> getScopeRequest) throws ServiceQuotaExceededException, 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.Builderavoiding the need to create one manually viaGetScopeRequest.builder()- Parameters:
getScopeRequest- AConsumerthat will call methods onGetScopeRequest.Builderto create a request.- Returns:
- Result of the GetScope operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
STATUSparameter.- Parameters:
listMonitorsRequest-- Returns:
- Result of the ListMonitors operation returned by the service.
- Throws:
ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
STATUSparameter.
This is a convenience which creates an instance of the
ListMonitorsRequest.Builderavoiding the need to create one manually viaListMonitorsRequest.builder()- Parameters:
listMonitorsRequest- AConsumerthat will call methods onListMonitorsRequest.Builderto create a request.- Returns:
- Result of the ListMonitors operation returned by the service.
- Throws:
ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListMonitorsRequest.builder()- Parameters:
listMonitorsRequest- AConsumerthat will call methods onListMonitorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListScopesRequest.builder()- Parameters:
listScopesRequest- AConsumerthat will call methods onListScopesRequest.Builderto create a request.- Returns:
- Result of the ListScopes operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client.listScopesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.networkflowmonitor.paginators.ListScopesIterable responses = client.listScopesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListScopesRequest.builder()- Parameters:
listScopesRequest- AConsumerthat will call methods onListScopesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryMonitorTopContributors
default StartQueryMonitorTopContributorsResponse startQueryMonitorTopContributors(StartQueryMonitorTopContributorsRequest startQueryMonitorTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Start a query to return the data 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 a specific monitor.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
- Parameters:
startQueryMonitorTopContributorsRequest-- Returns:
- Result of the StartQueryMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryMonitorTopContributors
default StartQueryMonitorTopContributorsResponse startQueryMonitorTopContributors(Consumer<StartQueryMonitorTopContributorsRequest.Builder> startQueryMonitorTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Start a query to return the data 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 a specific monitor.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
This is a convenience which creates an instance of the
StartQueryMonitorTopContributorsRequest.Builderavoiding the need to create one manually viaStartQueryMonitorTopContributorsRequest.builder()- Parameters:
startQueryMonitorTopContributorsRequest- AConsumerthat will call methods onStartQueryMonitorTopContributorsRequest.Builderto create a request.- Returns:
- Result of the StartQueryMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryWorkloadInsightsTopContributors
default StartQueryWorkloadInsightsTopContributorsResponse startQueryWorkloadInsightsTopContributors(StartQueryWorkloadInsightsTopContributorsRequest startQueryWorkloadInsightsTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Start a query to return the data with the Network Flow Monitor query interface. Specify the query that you want to start by providing a query ID and a monitor name. This query returns 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, related to a scope (for workload insights) or a monitor.
- Parameters:
startQueryWorkloadInsightsTopContributorsRequest-- Returns:
- Result of the StartQueryWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryWorkloadInsightsTopContributors
default StartQueryWorkloadInsightsTopContributorsResponse startQueryWorkloadInsightsTopContributors(Consumer<StartQueryWorkloadInsightsTopContributorsRequest.Builder> startQueryWorkloadInsightsTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Start a query to return the data with the Network Flow Monitor query interface. Specify the query that you want to start by providing a query ID and a monitor name. This query returns 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, related to a scope (for workload insights) or a monitor.
This is a convenience which creates an instance of the
StartQueryWorkloadInsightsTopContributorsRequest.Builderavoiding the need to create one manually viaStartQueryWorkloadInsightsTopContributorsRequest.builder()- Parameters:
startQueryWorkloadInsightsTopContributorsRequest- AConsumerthat will call methods onStartQueryWorkloadInsightsTopContributorsRequest.Builderto create a request.- Returns:
- Result of the StartQueryWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryWorkloadInsightsTopContributorsData
default StartQueryWorkloadInsightsTopContributorsDataResponse startQueryWorkloadInsightsTopContributorsData(StartQueryWorkloadInsightsTopContributorsDataRequest startQueryWorkloadInsightsTopContributorsDataRequest) 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 scope ID. This query returns data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
A query ID is returned from an API call to start a query of a specific type; for example
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
- Parameters:
startQueryWorkloadInsightsTopContributorsDataRequest-- Returns:
- Result of the StartQueryWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryWorkloadInsightsTopContributorsData
default StartQueryWorkloadInsightsTopContributorsDataResponse startQueryWorkloadInsightsTopContributorsData(Consumer<StartQueryWorkloadInsightsTopContributorsDataRequest.Builder> startQueryWorkloadInsightsTopContributorsDataRequest) 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 scope ID. This query returns data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
A query ID is returned from an API call to start a query of a specific type; for example
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
This is a convenience which creates an instance of the
StartQueryWorkloadInsightsTopContributorsDataRequest.Builderavoiding the need to create one manually viaStartQueryWorkloadInsightsTopContributorsDataRequest.builder()- Parameters:
startQueryWorkloadInsightsTopContributorsDataRequest- AConsumerthat will call methods onStartQueryWorkloadInsightsTopContributorsDataRequest.Builderto create a request.- Returns:
- Result of the StartQueryWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryMonitorTopContributors
default StopQueryMonitorTopContributorsResponse stopQueryMonitorTopContributors(StopQueryMonitorTopContributorsRequest stopQueryMonitorTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Stop a query with the Network Flow Monitor query interface. Specify the query that you want to stop by providing a query ID and a monitor name. This query returns 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, related to a scope (for workload insights) or a monitor.
- Parameters:
stopQueryMonitorTopContributorsRequest-- Returns:
- Result of the StopQueryMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryMonitorTopContributors
default StopQueryMonitorTopContributorsResponse stopQueryMonitorTopContributors(Consumer<StopQueryMonitorTopContributorsRequest.Builder> stopQueryMonitorTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Stop a query with the Network Flow Monitor query interface. Specify the query that you want to stop by providing a query ID and a monitor name. This query returns 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, related to a scope (for workload insights) or a monitor.
This is a convenience which creates an instance of the
StopQueryMonitorTopContributorsRequest.Builderavoiding the need to create one manually viaStopQueryMonitorTopContributorsRequest.builder()- Parameters:
stopQueryMonitorTopContributorsRequest- AConsumerthat will call methods onStopQueryMonitorTopContributorsRequest.Builderto create a request.- Returns:
- Result of the StopQueryMonitorTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryWorkloadInsightsTopContributors
default StopQueryWorkloadInsightsTopContributorsResponse stopQueryWorkloadInsightsTopContributors(StopQueryWorkloadInsightsTopContributorsRequest stopQueryWorkloadInsightsTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Stop a query with the Network Flow Monitor query interface. Specify the query that you want to stop by providing a query ID and a monitor name. This query returns 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, related to a scope (for workload insights) or a monitor.
- Parameters:
stopQueryWorkloadInsightsTopContributorsRequest-- Returns:
- Result of the StopQueryWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryWorkloadInsightsTopContributors
default StopQueryWorkloadInsightsTopContributorsResponse stopQueryWorkloadInsightsTopContributors(Consumer<StopQueryWorkloadInsightsTopContributorsRequest.Builder> stopQueryWorkloadInsightsTopContributorsRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NetworkFlowMonitorException
Stop a query with the Network Flow Monitor query interface. Specify the query that you want to stop by providing a query ID and a monitor name. This query returns 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, related to a scope (for workload insights) or a monitor.
This is a convenience which creates an instance of the
StopQueryWorkloadInsightsTopContributorsRequest.Builderavoiding the need to create one manually viaStopQueryWorkloadInsightsTopContributorsRequest.builder()- Parameters:
stopQueryWorkloadInsightsTopContributorsRequest- AConsumerthat will call methods onStopQueryWorkloadInsightsTopContributorsRequest.Builderto create a request.- Returns:
- Result of the StopQueryWorkloadInsightsTopContributors operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryWorkloadInsightsTopContributorsData
default StopQueryWorkloadInsightsTopContributorsDataResponse stopQueryWorkloadInsightsTopContributorsData(StopQueryWorkloadInsightsTopContributorsDataRequest stopQueryWorkloadInsightsTopContributorsDataRequest) 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 scope ID. This query returns data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
- Parameters:
stopQueryWorkloadInsightsTopContributorsDataRequest-- Returns:
- Result of the StopQueryWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryWorkloadInsightsTopContributorsData
default StopQueryWorkloadInsightsTopContributorsDataResponse stopQueryWorkloadInsightsTopContributorsData(Consumer<StopQueryWorkloadInsightsTopContributorsDataRequest.Builder> stopQueryWorkloadInsightsTopContributorsDataRequest) 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 scope ID. This query returns data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
This is a convenience which creates an instance of the
StopQueryWorkloadInsightsTopContributorsDataRequest.Builderavoiding the need to create one manually viaStopQueryWorkloadInsightsTopContributorsDataRequest.builder()- Parameters:
stopQueryWorkloadInsightsTopContributorsDataRequest- AConsumerthat will call methods onStopQueryWorkloadInsightsTopContributorsDataRequest.Builderto create a request.- Returns:
- Result of the StopQueryWorkloadInsightsTopContributorsData operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ConflictException- The requested resource is in use.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdateMonitorRequest.builder()- Parameters:
updateMonitorRequest- AConsumerthat will call methods onUpdateMonitorRequest.Builderto create a request.- Returns:
- Result of the UpdateMonitor operation returned by the service.
- Throws:
ResourceNotFoundException- The request specifies a resource that doesn't exist.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateScope
default UpdateScopeResponse updateScope(UpdateScopeRequest updateScopeRequest) throws ServiceQuotaExceededException, 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.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateScope
default UpdateScopeResponse updateScope(Consumer<UpdateScopeRequest.Builder> updateScopeRequest) throws ServiceQuotaExceededException, 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.Builderavoiding the need to create one manually viaUpdateScopeRequest.builder()- Parameters:
updateScopeRequest- AConsumerthat will call methods onUpdateScopeRequest.Builderto create a request.- Returns:
- Result of the UpdateScope operation returned by the service.
- Throws:
ServiceQuotaExceededException- The request exceeded a service quota.ValidationException- Invalid request.ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You don't have sufficient permission to perform this action.InternalServerException- An internal error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NetworkFlowMonitorException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static NetworkFlowMonitorClient create()
Create aNetworkFlowMonitorClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static NetworkFlowMonitorClientBuilder builder()
Create a builder that can be used to configure and create aNetworkFlowMonitorClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default NetworkFlowMonitorServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-