Skip to content

NetworkFlowMonitorClient#

Index > NetworkFlowMonitor > NetworkFlowMonitorClient

Auto-generated documentation for NetworkFlowMonitor type annotations stubs module mypy-boto3-networkflowmonitor.

NetworkFlowMonitorClient#

Type annotations and code completion for boto3.client("networkflowmonitor"). boto3 documentation

# NetworkFlowMonitorClient usage example

from boto3.session import Session
from mypy_boto3_networkflowmonitor.client import NetworkFlowMonitorClient

def get_networkflowmonitor_client() -> NetworkFlowMonitorClient:
    return Session().client("networkflowmonitor")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("networkflowmonitor").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("networkflowmonitor")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_networkflowmonitor.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("networkflowmonitor").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("networkflowmonitor").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

close#

Type annotations and code completion for boto3.client("networkflowmonitor").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_monitor#

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.

Type annotations and code completion for boto3.client("networkflowmonitor").create_monitor method. boto3 documentation

# create_monitor method definition

def create_monitor(
    self,
    *,
    monitorName: str,
    localResources: Sequence[MonitorLocalResourceTypeDef],  # (1)
    scopeArn: str,
    remoteResources: Sequence[MonitorRemoteResourceTypeDef] = ...,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateMonitorOutputTypeDef:  # (3)
    ...
  1. See MonitorLocalResourceTypeDef
  2. See MonitorRemoteResourceTypeDef
  3. See CreateMonitorOutputTypeDef 
# create_monitor method usage example with argument unpacking

kwargs: CreateMonitorInputRequestTypeDef = {  # (1)
    "monitorName": ...,
    "localResources": ...,
    "scopeArn": ...,
}

parent.create_monitor(**kwargs)
  1. See CreateMonitorInputRequestTypeDef

create_scope#

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.

Type annotations and code completion for boto3.client("networkflowmonitor").create_scope method. boto3 documentation

# create_scope method definition

def create_scope(
    self,
    *,
    targets: Sequence[TargetResourceTypeDef],  # (1)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateScopeOutputTypeDef:  # (2)
    ...
  1. See TargetResourceTypeDef
  2. See CreateScopeOutputTypeDef 
# create_scope method usage example with argument unpacking

kwargs: CreateScopeInputRequestTypeDef = {  # (1)
    "targets": ...,
}

parent.create_scope(**kwargs)
  1. See CreateScopeInputRequestTypeDef

delete_monitor#

Deletes a monitor in Network Flow Monitor.

Type annotations and code completion for boto3.client("networkflowmonitor").delete_monitor method. boto3 documentation

# delete_monitor method definition

def delete_monitor(
    self,
    *,
    monitorName: str,
) -> Dict[str, Any]:
    ...
# delete_monitor method usage example with argument unpacking

kwargs: DeleteMonitorInputRequestTypeDef = {  # (1)
    "monitorName": ...,
}

parent.delete_monitor(**kwargs)
  1. See DeleteMonitorInputRequestTypeDef

delete_scope#

Deletes a scope that has been defined.

Type annotations and code completion for boto3.client("networkflowmonitor").delete_scope method. boto3 documentation

# delete_scope method definition

def delete_scope(
    self,
    *,
    scopeId: str,
) -> Dict[str, Any]:
    ...
# delete_scope method usage example with argument unpacking

kwargs: DeleteScopeInputRequestTypeDef = {  # (1)
    "scopeId": ...,
}

parent.delete_scope(**kwargs)
  1. See DeleteScopeInputRequestTypeDef

get_monitor#

Gets information about a monitor in Network Flow Monitor based on a monitor name.

Type annotations and code completion for boto3.client("networkflowmonitor").get_monitor method. boto3 documentation

# get_monitor method definition

def get_monitor(
    self,
    *,
    monitorName: str,
) -> GetMonitorOutputTypeDef:  # (1)
    ...
  1. See GetMonitorOutputTypeDef 
# get_monitor method usage example with argument unpacking

kwargs: GetMonitorInputRequestTypeDef = {  # (1)
    "monitorName": ...,
}

parent.get_monitor(**kwargs)
  1. See GetMonitorInputRequestTypeDef

get_query_results_monitor_top_contributors#

Return the data for a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").get_query_results_monitor_top_contributors method. boto3 documentation

# get_query_results_monitor_top_contributors method definition

def get_query_results_monitor_top_contributors(
    self,
    *,
    monitorName: str,
    queryId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetQueryResultsMonitorTopContributorsOutputTypeDef:  # (1)
    ...
  1. See GetQueryResultsMonitorTopContributorsOutputTypeDef 
# get_query_results_monitor_top_contributors method usage example with argument unpacking

kwargs: GetQueryResultsMonitorTopContributorsInputRequestTypeDef = {  # (1)
    "monitorName": ...,
    "queryId": ...,
}

parent.get_query_results_monitor_top_contributors(**kwargs)
  1. See GetQueryResultsMonitorTopContributorsInputRequestTypeDef

get_query_results_workload_insights_top_contributors#

Return the data for a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").get_query_results_workload_insights_top_contributors method. boto3 documentation

# get_query_results_workload_insights_top_contributors method definition

def get_query_results_workload_insights_top_contributors(
    self,
    *,
    scopeId: str,
    queryId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetQueryResultsWorkloadInsightsTopContributorsOutputTypeDef:  # (1)
    ...
  1. See GetQueryResultsWorkloadInsightsTopContributorsOutputTypeDef 
# get_query_results_workload_insights_top_contributors method usage example with argument unpacking

kwargs: GetQueryResultsWorkloadInsightsTopContributorsInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "queryId": ...,
}

parent.get_query_results_workload_insights_top_contributors(**kwargs)
  1. See GetQueryResultsWorkloadInsightsTopContributorsInputRequestTypeDef

get_query_results_workload_insights_top_contributors_data#

Return the data for a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").get_query_results_workload_insights_top_contributors_data method. boto3 documentation

# get_query_results_workload_insights_top_contributors_data method definition

def get_query_results_workload_insights_top_contributors_data(
    self,
    *,
    scopeId: str,
    queryId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetQueryResultsWorkloadInsightsTopContributorsDataOutputTypeDef:  # (1)
    ...
  1. See GetQueryResultsWorkloadInsightsTopContributorsDataOutputTypeDef 
# get_query_results_workload_insights_top_contributors_data method usage example with argument unpacking

kwargs: GetQueryResultsWorkloadInsightsTopContributorsDataInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "queryId": ...,
}

parent.get_query_results_workload_insights_top_contributors_data(**kwargs)
  1. See GetQueryResultsWorkloadInsightsTopContributorsDataInputRequestTypeDef

get_query_status_monitor_top_contributors#

Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.

Type annotations and code completion for boto3.client("networkflowmonitor").get_query_status_monitor_top_contributors method. boto3 documentation

# get_query_status_monitor_top_contributors method definition

def get_query_status_monitor_top_contributors(
    self,
    *,
    monitorName: str,
    queryId: str,
) -> GetQueryStatusMonitorTopContributorsOutputTypeDef:  # (1)
    ...
  1. See GetQueryStatusMonitorTopContributorsOutputTypeDef 
# get_query_status_monitor_top_contributors method usage example with argument unpacking

kwargs: GetQueryStatusMonitorTopContributorsInputRequestTypeDef = {  # (1)
    "monitorName": ...,
    "queryId": ...,
}

parent.get_query_status_monitor_top_contributors(**kwargs)
  1. See GetQueryStatusMonitorTopContributorsInputRequestTypeDef

get_query_status_workload_insights_top_contributors#

Return the data for a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").get_query_status_workload_insights_top_contributors method. boto3 documentation

# get_query_status_workload_insights_top_contributors method definition

def get_query_status_workload_insights_top_contributors(
    self,
    *,
    scopeId: str,
    queryId: str,
) -> GetQueryStatusWorkloadInsightsTopContributorsOutputTypeDef:  # (1)
    ...
  1. See GetQueryStatusWorkloadInsightsTopContributorsOutputTypeDef 
# get_query_status_workload_insights_top_contributors method usage example with argument unpacking

kwargs: GetQueryStatusWorkloadInsightsTopContributorsInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "queryId": ...,
}

parent.get_query_status_workload_insights_top_contributors(**kwargs)
  1. See GetQueryStatusWorkloadInsightsTopContributorsInputRequestTypeDef

get_query_status_workload_insights_top_contributors_data#

Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.

Type annotations and code completion for boto3.client("networkflowmonitor").get_query_status_workload_insights_top_contributors_data method. boto3 documentation

# get_query_status_workload_insights_top_contributors_data method definition

def get_query_status_workload_insights_top_contributors_data(
    self,
    *,
    scopeId: str,
    queryId: str,
) -> GetQueryStatusWorkloadInsightsTopContributorsDataOutputTypeDef:  # (1)
    ...
  1. See GetQueryStatusWorkloadInsightsTopContributorsDataOutputTypeDef 
# get_query_status_workload_insights_top_contributors_data method usage example with argument unpacking

kwargs: GetQueryStatusWorkloadInsightsTopContributorsDataInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "queryId": ...,
}

parent.get_query_status_workload_insights_top_contributors_data(**kwargs)
  1. See GetQueryStatusWorkloadInsightsTopContributorsDataInputRequestTypeDef

get_scope#

Gets information about a scope, including the name, status, tags, and target details.

Type annotations and code completion for boto3.client("networkflowmonitor").get_scope method. boto3 documentation

# get_scope method definition

def get_scope(
    self,
    *,
    scopeId: str,
) -> GetScopeOutputTypeDef:  # (1)
    ...
  1. See GetScopeOutputTypeDef 
# get_scope method usage example with argument unpacking

kwargs: GetScopeInputRequestTypeDef = {  # (1)
    "scopeId": ...,
}

parent.get_scope(**kwargs)
  1. See GetScopeInputRequestTypeDef

list_monitors#

List all monitors in an account.

Type annotations and code completion for boto3.client("networkflowmonitor").list_monitors method. boto3 documentation

# list_monitors method definition

def list_monitors(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    monitorStatus: MonitorStatusType = ...,  # (1)
) -> ListMonitorsOutputTypeDef:  # (2)
    ...
  1. See MonitorStatusType
  2. See ListMonitorsOutputTypeDef 
# list_monitors method usage example with argument unpacking

kwargs: ListMonitorsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_monitors(**kwargs)
  1. See ListMonitorsInputRequestTypeDef

list_scopes#

List all the scopes for an account.

Type annotations and code completion for boto3.client("networkflowmonitor").list_scopes method. boto3 documentation

# list_scopes method definition

def list_scopes(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListScopesOutputTypeDef:  # (1)
    ...
  1. See ListScopesOutputTypeDef 
# list_scopes method usage example with argument unpacking

kwargs: ListScopesInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_scopes(**kwargs)
  1. See ListScopesInputRequestTypeDef

list_tags_for_resource#

Returns all the tags for a resource.

Type annotations and code completion for boto3.client("networkflowmonitor").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

start_query_monitor_top_contributors#

Start a query to return the data with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").start_query_monitor_top_contributors method. boto3 documentation

# start_query_monitor_top_contributors method definition

def start_query_monitor_top_contributors(
    self,
    *,
    monitorName: str,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    metricName: MonitorMetricType,  # (1)
    destinationCategory: DestinationCategoryType,  # (2)
    limit: int = ...,
) -> StartQueryMonitorTopContributorsOutputTypeDef:  # (3)
    ...
  1. See MonitorMetricType
  2. See DestinationCategoryType
  3. See StartQueryMonitorTopContributorsOutputTypeDef 
# start_query_monitor_top_contributors method usage example with argument unpacking

kwargs: StartQueryMonitorTopContributorsInputRequestTypeDef = {  # (1)
    "monitorName": ...,
    "startTime": ...,
    "endTime": ...,
    "metricName": ...,
    "destinationCategory": ...,
}

parent.start_query_monitor_top_contributors(**kwargs)
  1. See StartQueryMonitorTopContributorsInputRequestTypeDef

start_query_workload_insights_top_contributors#

Start a query to return the data with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").start_query_workload_insights_top_contributors method. boto3 documentation

# start_query_workload_insights_top_contributors method definition

def start_query_workload_insights_top_contributors(
    self,
    *,
    scopeId: str,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    metricName: WorkloadInsightsMetricType,  # (1)
    destinationCategory: DestinationCategoryType,  # (2)
    limit: int = ...,
) -> StartQueryWorkloadInsightsTopContributorsOutputTypeDef:  # (3)
    ...
  1. See WorkloadInsightsMetricType
  2. See DestinationCategoryType
  3. See StartQueryWorkloadInsightsTopContributorsOutputTypeDef 
# start_query_workload_insights_top_contributors method usage example with argument unpacking

kwargs: StartQueryWorkloadInsightsTopContributorsInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "startTime": ...,
    "endTime": ...,
    "metricName": ...,
    "destinationCategory": ...,
}

parent.start_query_workload_insights_top_contributors(**kwargs)
  1. See StartQueryWorkloadInsightsTopContributorsInputRequestTypeDef

start_query_workload_insights_top_contributors_data#

Return the data for a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").start_query_workload_insights_top_contributors_data method. boto3 documentation

# start_query_workload_insights_top_contributors_data method definition

def start_query_workload_insights_top_contributors_data(
    self,
    *,
    scopeId: str,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    metricName: WorkloadInsightsMetricType,  # (1)
    destinationCategory: DestinationCategoryType,  # (2)
) -> StartQueryWorkloadInsightsTopContributorsDataOutputTypeDef:  # (3)
    ...
  1. See WorkloadInsightsMetricType
  2. See DestinationCategoryType
  3. See StartQueryWorkloadInsightsTopContributorsDataOutputTypeDef 
# start_query_workload_insights_top_contributors_data method usage example with argument unpacking

kwargs: StartQueryWorkloadInsightsTopContributorsDataInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "startTime": ...,
    "endTime": ...,
    "metricName": ...,
    "destinationCategory": ...,
}

parent.start_query_workload_insights_top_contributors_data(**kwargs)
  1. See StartQueryWorkloadInsightsTopContributorsDataInputRequestTypeDef

stop_query_monitor_top_contributors#

Stop a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").stop_query_monitor_top_contributors method. boto3 documentation

# stop_query_monitor_top_contributors method definition

def stop_query_monitor_top_contributors(
    self,
    *,
    monitorName: str,
    queryId: str,
) -> Dict[str, Any]:
    ...
# stop_query_monitor_top_contributors method usage example with argument unpacking

kwargs: StopQueryMonitorTopContributorsInputRequestTypeDef = {  # (1)
    "monitorName": ...,
    "queryId": ...,
}

parent.stop_query_monitor_top_contributors(**kwargs)
  1. See StopQueryMonitorTopContributorsInputRequestTypeDef

stop_query_workload_insights_top_contributors#

Stop a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").stop_query_workload_insights_top_contributors method. boto3 documentation

# stop_query_workload_insights_top_contributors method definition

def stop_query_workload_insights_top_contributors(
    self,
    *,
    scopeId: str,
    queryId: str,
) -> Dict[str, Any]:
    ...
# stop_query_workload_insights_top_contributors method usage example with argument unpacking

kwargs: StopQueryWorkloadInsightsTopContributorsInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "queryId": ...,
}

parent.stop_query_workload_insights_top_contributors(**kwargs)
  1. See StopQueryWorkloadInsightsTopContributorsInputRequestTypeDef

stop_query_workload_insights_top_contributors_data#

Return the data for a query with the Network Flow Monitor query interface.

Type annotations and code completion for boto3.client("networkflowmonitor").stop_query_workload_insights_top_contributors_data method. boto3 documentation

# stop_query_workload_insights_top_contributors_data method definition

def stop_query_workload_insights_top_contributors_data(
    self,
    *,
    scopeId: str,
    queryId: str,
) -> Dict[str, Any]:
    ...
# stop_query_workload_insights_top_contributors_data method usage example with argument unpacking

kwargs: StopQueryWorkloadInsightsTopContributorsDataInputRequestTypeDef = {  # (1)
    "scopeId": ...,
    "queryId": ...,
}

parent.stop_query_workload_insights_top_contributors_data(**kwargs)
  1. See StopQueryWorkloadInsightsTopContributorsDataInputRequestTypeDef

tag_resource#

Adds a tag to a resource.

Type annotations and code completion for boto3.client("networkflowmonitor").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

untag_resource#

Removes a tag from a resource.

Type annotations and code completion for boto3.client("networkflowmonitor").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

update_monitor#

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

Type annotations and code completion for boto3.client("networkflowmonitor").update_monitor method. boto3 documentation

# update_monitor method definition

def update_monitor(
    self,
    *,
    monitorName: str,
    localResourcesToAdd: Sequence[MonitorLocalResourceTypeDef] = ...,  # (1)
    localResourcesToRemove: Sequence[MonitorLocalResourceTypeDef] = ...,  # (1)
    remoteResourcesToAdd: Sequence[MonitorRemoteResourceTypeDef] = ...,  # (3)
    remoteResourcesToRemove: Sequence[MonitorRemoteResourceTypeDef] = ...,  # (3)
    clientToken: str = ...,
) -> UpdateMonitorOutputTypeDef:  # (5)
    ...
  1. See MonitorLocalResourceTypeDef
  2. See MonitorLocalResourceTypeDef
  3. See MonitorRemoteResourceTypeDef
  4. See MonitorRemoteResourceTypeDef
  5. See UpdateMonitorOutputTypeDef 
# update_monitor method usage example with argument unpacking

kwargs: UpdateMonitorInputRequestTypeDef = {  # (1)
    "monitorName": ...,
}

parent.update_monitor(**kwargs)
  1. See UpdateMonitorInputRequestTypeDef

update_scope#

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.

Type annotations and code completion for boto3.client("networkflowmonitor").update_scope method. boto3 documentation

# update_scope method definition

def update_scope(
    self,
    *,
    scopeId: str,
    resourcesToAdd: Sequence[TargetResourceTypeDef] = ...,  # (1)
    resourcesToDelete: Sequence[TargetResourceTypeDef] = ...,  # (1)
) -> UpdateScopeOutputTypeDef:  # (3)
    ...
  1. See TargetResourceTypeDef
  2. See TargetResourceTypeDef
  3. See UpdateScopeOutputTypeDef 
# update_scope method usage example with argument unpacking

kwargs: UpdateScopeInputRequestTypeDef = {  # (1)
    "scopeId": ...,
}

parent.update_scope(**kwargs)
  1. See UpdateScopeInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("networkflowmonitor").get_paginator method with overloads.