networkflowmonitor/aws.sdk.kotlin.services.networkflowmonitor/NetworkFlowMonitorClient

NetworkFlowMonitorClient

interface NetworkFlowMonitorClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<NetworkFlowMonitorClient.Config, NetworkFlowMonitorClient.Config.Builder, NetworkFlowMonitorClient>

Companion

object Companion : AbstractAwsSdkClientFactory<NetworkFlowMonitorClient.Config, NetworkFlowMonitorClient.Config.Builder, NetworkFlowMonitorClient, NetworkFlowMonitorClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: NetworkFlowMonitorClient.Config

NetworkFlowMonitorClient's configuration

Functions

createMonitor

abstract suspend fun createMonitor(input: CreateMonitorRequest): CreateMonitorResponse

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.

createScope

abstract suspend fun createScope(input: CreateScopeRequest): CreateScopeResponse

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.

deleteMonitor

abstract suspend fun deleteMonitor(input: DeleteMonitorRequest): DeleteMonitorResponse

Deletes a monitor in Network Flow Monitor.

deleteScope

abstract suspend fun deleteScope(input: DeleteScopeRequest): DeleteScopeResponse

Deletes a scope that has been defined.

getMonitor

abstract suspend fun getMonitor(input: GetMonitorRequest): GetMonitorResponse

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.

getQueryResultsMonitorTopContributors

abstract suspend fun getQueryResultsMonitorTopContributors(input: GetQueryResultsMonitorTopContributorsRequest): GetQueryResultsMonitorTopContributorsResponse

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.

getQueryResultsWorkloadInsightsTopContributors

abstract suspend fun getQueryResultsWorkloadInsightsTopContributors(input: GetQueryResultsWorkloadInsightsTopContributorsRequest): GetQueryResultsWorkloadInsightsTopContributorsResponse

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.

getQueryResultsWorkloadInsightsTopContributorsData

abstract suspend fun getQueryResultsWorkloadInsightsTopContributorsData(input: GetQueryResultsWorkloadInsightsTopContributorsDataRequest): GetQueryResultsWorkloadInsightsTopContributorsDataResponse

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.

getQueryStatusMonitorTopContributors

abstract suspend fun getQueryStatusMonitorTopContributors(input: GetQueryStatusMonitorTopContributorsRequest): GetQueryStatusMonitorTopContributorsResponse

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.

getQueryStatusWorkloadInsightsTopContributors

abstract suspend fun getQueryStatusWorkloadInsightsTopContributors(input: GetQueryStatusWorkloadInsightsTopContributorsRequest): GetQueryStatusWorkloadInsightsTopContributorsResponse

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.

getQueryStatusWorkloadInsightsTopContributorsData

abstract suspend fun getQueryStatusWorkloadInsightsTopContributorsData(input: GetQueryStatusWorkloadInsightsTopContributorsDataRequest): GetQueryStatusWorkloadInsightsTopContributorsDataResponse

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.

getScope

abstract suspend fun getScope(input: GetScopeRequest): GetScopeResponse

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

listMonitors

abstract suspend fun listMonitors(input: ListMonitorsRequest = ListMonitorsRequest { }): ListMonitorsResponse

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

listScopes

abstract suspend fun listScopes(input: ListScopesRequest = ListScopesRequest { }): ListScopesResponse

List all the scopes for an account.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns all the tags for a resource.

startQueryMonitorTopContributors

abstract suspend fun startQueryMonitorTopContributors(input: StartQueryMonitorTopContributorsRequest): StartQueryMonitorTopContributorsResponse

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

startQueryWorkloadInsightsTopContributors

abstract suspend fun startQueryWorkloadInsightsTopContributors(input: StartQueryWorkloadInsightsTopContributorsRequest): StartQueryWorkloadInsightsTopContributorsResponse

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

startQueryWorkloadInsightsTopContributorsData

abstract suspend fun startQueryWorkloadInsightsTopContributorsData(input: StartQueryWorkloadInsightsTopContributorsDataRequest): StartQueryWorkloadInsightsTopContributorsDataResponse

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

stopQueryMonitorTopContributors

abstract suspend fun stopQueryMonitorTopContributors(input: StopQueryMonitorTopContributorsRequest): StopQueryMonitorTopContributorsResponse

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

stopQueryWorkloadInsightsTopContributors

abstract suspend fun stopQueryWorkloadInsightsTopContributors(input: StopQueryWorkloadInsightsTopContributorsRequest): StopQueryWorkloadInsightsTopContributorsResponse

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

stopQueryWorkloadInsightsTopContributorsData

abstract suspend fun stopQueryWorkloadInsightsTopContributorsData(input: StopQueryWorkloadInsightsTopContributorsDataRequest): StopQueryWorkloadInsightsTopContributorsDataResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds a tag to a resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag from a resource.

updateMonitor

abstract suspend fun updateMonitor(input: UpdateMonitorRequest): UpdateMonitorResponse

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

updateScope

abstract suspend fun updateScope(input: UpdateScopeRequest): UpdateScopeResponse

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.

Inherited functions

expect abstract fun close()

createMonitor

inline suspend fun NetworkFlowMonitorClient.createMonitor(crossinline block: CreateMonitorRequest.Builder.() -> Unit): CreateMonitorResponse

createScope

inline suspend fun NetworkFlowMonitorClient.createScope(crossinline block: CreateScopeRequest.Builder.() -> Unit): CreateScopeResponse

deleteMonitor

inline suspend fun NetworkFlowMonitorClient.deleteMonitor(crossinline block: DeleteMonitorRequest.Builder.() -> Unit): DeleteMonitorResponse

Deletes a monitor in Network Flow Monitor.

deleteScope

inline suspend fun NetworkFlowMonitorClient.deleteScope(crossinline block: DeleteScopeRequest.Builder.() -> Unit): DeleteScopeResponse

Deletes a scope that has been defined.

getMonitor

inline suspend fun NetworkFlowMonitorClient.getMonitor(crossinline block: GetMonitorRequest.Builder.() -> Unit): GetMonitorResponse

getQueryResultsMonitorTopContributors

inline suspend fun NetworkFlowMonitorClient.getQueryResultsMonitorTopContributors(crossinline block: GetQueryResultsMonitorTopContributorsRequest.Builder.() -> Unit): GetQueryResultsMonitorTopContributorsResponse

getQueryResultsMonitorTopContributorsPaginated

fun NetworkFlowMonitorClient.getQueryResultsMonitorTopContributorsPaginated(initialRequest: GetQueryResultsMonitorTopContributorsRequest): Flow<GetQueryResultsMonitorTopContributorsResponse>

fun NetworkFlowMonitorClient.getQueryResultsMonitorTopContributorsPaginated(block: GetQueryResultsMonitorTopContributorsRequest.Builder.() -> Unit): Flow<GetQueryResultsMonitorTopContributorsResponse>

Paginate over GetQueryResultsMonitorTopContributorsResponse results.

getQueryResultsWorkloadInsightsTopContributors

inline suspend fun NetworkFlowMonitorClient.getQueryResultsWorkloadInsightsTopContributors(crossinline block: GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder.() -> Unit): GetQueryResultsWorkloadInsightsTopContributorsResponse

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.

getQueryResultsWorkloadInsightsTopContributorsData

inline suspend fun NetworkFlowMonitorClient.getQueryResultsWorkloadInsightsTopContributorsData(crossinline block: GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder.() -> Unit): GetQueryResultsWorkloadInsightsTopContributorsDataResponse

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.

getQueryResultsWorkloadInsightsTopContributorsDataPaginated

fun NetworkFlowMonitorClient.getQueryResultsWorkloadInsightsTopContributorsDataPaginated(initialRequest: GetQueryResultsWorkloadInsightsTopContributorsDataRequest): Flow<GetQueryResultsWorkloadInsightsTopContributorsDataResponse>

fun NetworkFlowMonitorClient.getQueryResultsWorkloadInsightsTopContributorsDataPaginated(block: GetQueryResultsWorkloadInsightsTopContributorsDataRequest.Builder.() -> Unit): Flow<GetQueryResultsWorkloadInsightsTopContributorsDataResponse>

Paginate over GetQueryResultsWorkloadInsightsTopContributorsDataResponse results.

getQueryResultsWorkloadInsightsTopContributorsPaginated

fun NetworkFlowMonitorClient.getQueryResultsWorkloadInsightsTopContributorsPaginated(initialRequest: GetQueryResultsWorkloadInsightsTopContributorsRequest): Flow<GetQueryResultsWorkloadInsightsTopContributorsResponse>

fun NetworkFlowMonitorClient.getQueryResultsWorkloadInsightsTopContributorsPaginated(block: GetQueryResultsWorkloadInsightsTopContributorsRequest.Builder.() -> Unit): Flow<GetQueryResultsWorkloadInsightsTopContributorsResponse>

Paginate over GetQueryResultsWorkloadInsightsTopContributorsResponse results.

getQueryStatusMonitorTopContributors

inline suspend fun NetworkFlowMonitorClient.getQueryStatusMonitorTopContributors(crossinline block: GetQueryStatusMonitorTopContributorsRequest.Builder.() -> Unit): GetQueryStatusMonitorTopContributorsResponse

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.

getQueryStatusWorkloadInsightsTopContributors

inline suspend fun NetworkFlowMonitorClient.getQueryStatusWorkloadInsightsTopContributors(crossinline block: GetQueryStatusWorkloadInsightsTopContributorsRequest.Builder.() -> Unit): GetQueryStatusWorkloadInsightsTopContributorsResponse

getQueryStatusWorkloadInsightsTopContributorsData

inline suspend fun NetworkFlowMonitorClient.getQueryStatusWorkloadInsightsTopContributorsData(crossinline block: GetQueryStatusWorkloadInsightsTopContributorsDataRequest.Builder.() -> Unit): GetQueryStatusWorkloadInsightsTopContributorsDataResponse

getScope

inline suspend fun NetworkFlowMonitorClient.getScope(crossinline block: GetScopeRequest.Builder.() -> Unit): GetScopeResponse

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

listMonitors

inline suspend fun NetworkFlowMonitorClient.listMonitors(crossinline block: ListMonitorsRequest.Builder.() -> Unit): ListMonitorsResponse

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

listMonitorsPaginated

fun NetworkFlowMonitorClient.listMonitorsPaginated(initialRequest: ListMonitorsRequest = ListMonitorsRequest { }): Flow<ListMonitorsResponse>

fun NetworkFlowMonitorClient.listMonitorsPaginated(block: ListMonitorsRequest.Builder.() -> Unit): Flow<ListMonitorsResponse>

Paginate over ListMonitorsResponse results.

listScopes

inline suspend fun NetworkFlowMonitorClient.listScopes(crossinline block: ListScopesRequest.Builder.() -> Unit): ListScopesResponse

List all the scopes for an account.

listScopesPaginated

fun NetworkFlowMonitorClient.listScopesPaginated(initialRequest: ListScopesRequest = ListScopesRequest { }): Flow<ListScopesResponse>

fun NetworkFlowMonitorClient.listScopesPaginated(block: ListScopesRequest.Builder.() -> Unit): Flow<ListScopesResponse>

Paginate over ListScopesResponse results.

listTagsForResource

inline suspend fun NetworkFlowMonitorClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns all the tags for a resource.

startQueryMonitorTopContributors

inline suspend fun NetworkFlowMonitorClient.startQueryMonitorTopContributors(crossinline block: StartQueryMonitorTopContributorsRequest.Builder.() -> Unit): StartQueryMonitorTopContributorsResponse

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

startQueryWorkloadInsightsTopContributors

inline suspend fun NetworkFlowMonitorClient.startQueryWorkloadInsightsTopContributors(crossinline block: StartQueryWorkloadInsightsTopContributorsRequest.Builder.() -> Unit): StartQueryWorkloadInsightsTopContributorsResponse

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

startQueryWorkloadInsightsTopContributorsData

inline suspend fun NetworkFlowMonitorClient.startQueryWorkloadInsightsTopContributorsData(crossinline block: StartQueryWorkloadInsightsTopContributorsDataRequest.Builder.() -> Unit): StartQueryWorkloadInsightsTopContributorsDataResponse

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

stopQueryMonitorTopContributors

inline suspend fun NetworkFlowMonitorClient.stopQueryMonitorTopContributors(crossinline block: StopQueryMonitorTopContributorsRequest.Builder.() -> Unit): StopQueryMonitorTopContributorsResponse

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

stopQueryWorkloadInsightsTopContributors

inline suspend fun NetworkFlowMonitorClient.stopQueryWorkloadInsightsTopContributors(crossinline block: StopQueryWorkloadInsightsTopContributorsRequest.Builder.() -> Unit): StopQueryWorkloadInsightsTopContributorsResponse

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

stopQueryWorkloadInsightsTopContributorsData

inline suspend fun NetworkFlowMonitorClient.stopQueryWorkloadInsightsTopContributorsData(crossinline block: StopQueryWorkloadInsightsTopContributorsDataRequest.Builder.() -> Unit): StopQueryWorkloadInsightsTopContributorsDataResponse

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

tagResource

inline suspend fun NetworkFlowMonitorClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds a tag to a resource.

untagResource

inline suspend fun NetworkFlowMonitorClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag from a resource.

updateMonitor

inline suspend fun NetworkFlowMonitorClient.updateMonitor(crossinline block: UpdateMonitorRequest.Builder.() -> Unit): UpdateMonitorResponse

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

updateScope

inline suspend fun NetworkFlowMonitorClient.updateScope(crossinline block: UpdateScopeRequest.Builder.() -> Unit): UpdateScopeResponse

withConfig

fun NetworkFlowMonitorClient.withConfig(block: NetworkFlowMonitorClient.Config.Builder.() -> Unit): NetworkFlowMonitorClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.