Network Flow Monitor

2026/11/16 - Network Flow Monitor - 10 new4 updated api methods

Changes  This release adds Performance Monitors to Amazon CloudWatch Network Monitoring. Without installing an agent, they track traffic in the VPCs you select and report an impact score (None, Low, Medium, or High) showing whether the AWS network is degrading your workloads.

GetQueryResultsPerformanceMonitor (new) Link ¶

Returns the results of a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. This call returns the top paths for a performance monitor.

Create a query with StartQueryPerformanceMonitor, and then use the query ID with this call to return the results.

See also: AWS API Documentation

Request Syntax

client.get_query_results_performance_monitor(
    monitorName='string',
    queryId='string',
    nextToken='string',
    maxResults=123
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

type queryId:

string

param queryId:

[REQUIRED]

The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

type nextToken:

string

param nextToken:

The token for the next set of results. You receive this token from a previous call.

type maxResults:

integer

param maxResults:

The number of query results that you want to return with this call.

rtype:

dict

returns:

Response Syntax

{
    'fields': [
        {
            'name': 'string',
            'type': 'string'
        },
    ],
    'data': [
        [
            'string',
        ],
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • fields (list) --

      The columns that the query returns, in the order that the values for each row appear in data.

      • (dict) --

        A column that a query returns, with its name and data type.

        • name (string) --

          The name of the column.

        • type (string) --

          The data type of the values in the column.

    • data (list) --

      The results of the query. Each row contains the values for the columns that fields describes, in the same order.

      • (list) --

        A single result row: one value per column in 'fields', by position. A cell may be null when no value is available for that column.

        • (string) --

    • nextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

GetQueryStatusPerformanceMonitor (new) Link ¶

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

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

See also: AWS API Documentation

Request Syntax

client.get_query_status_performance_monitor(
    monitorName='string',
    queryId='string'
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

type queryId:

string

param queryId:

[REQUIRED]

The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

rtype:

dict

returns:

Response Syntax

{
    'status': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELED'
}

Response Structure

  • (dict) --

    • status (string) --

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

      • QUEUED: The query is scheduled to run.

      • RUNNING: The query is in progress but not complete.

      • SUCCEEDED: The query completed successfully.

      • FAILED: The query failed due to an error.

      • CANCELED: The query was canceled.

StopQueryPerformanceMonitor (new) Link ¶

Stop a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. Use the same query ID that you used for the corresponding API call to start the query, StartQueryPerformanceMonitor.

See also: AWS API Documentation

Request Syntax

client.stop_query_performance_monitor(
    monitorName='string',
    queryId='string'
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

type queryId:

string

param queryId:

[REQUIRED]

The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetMonitorScopeSuggestions (new) Link ¶

Returns the accounts that are sending traffic to, or receiving traffic from, resources in a monitor, but that aren't included in the monitoring scope for the monitor. By adding the suggested accounts to your scope, you enable Network Flow Monitor to resolve the network paths for that traffic.

See also: AWS API Documentation

Request Syntax

client.get_monitor_scope_suggestions(
    monitorArn='string',
    maxResults=123,
    nextToken='string'
)
type monitorArn:

string

param monitorArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the monitor that you want to return scope suggestions for.

type maxResults:

integer

param maxResults:

The number of query results that you want to return with this call.

type nextToken:

string

param nextToken:

The token for the next set of results. You receive this token from a previous call.

rtype:

dict

returns:

Response Syntax

{
    'status': 'COMPLETE'|'INCOMPLETE'|'PENDING'|'STALE',
    'accountsToAdd': [
        {
            'accountId': 'string',
            'region': 'string',
            'membership': 'IN_ORG'|'NOT_IN_ORG'|'UNKNOWN'
        },
    ],
    'nextToken': 'string',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • status (string) --

      The coverage status of the monitoring scope for the monitor. The status can be one of the following

      • COMPLETE: The scope includes every account that sends traffic to, or receives traffic from, resources in the monitor.

      • INCOMPLETE: There are accounts that you can add to the scope.

      • PENDING: Network Flow Monitor is determining the coverage of the scope.

      • STALE: The coverage of the scope was last determined too long ago to be current.

    • accountsToAdd (list) --

      The accounts that you can add to the monitoring scope, so that Network Flow Monitor can resolve the network paths for traffic to and from resources in those accounts.

      • (dict) --

        An account that you can add to the monitoring scope for a monitor, so that Network Flow Monitor can resolve the network paths for traffic to and from resources in the account.

        • accountId (string) --

          The ID of the account that you can add to the monitoring scope.

        • region (string) --

          The Amazon Web Services Region of the traffic that Network Flow Monitor identified for the account.

        • membership (string) --

          Whether the account is a member of the same organization as the account that owns the monitor. The membership status can be one of the following

          • IN_ORG: The account is a member of the same organization.

          • NOT_IN_ORG: The account isn't a member of the same organization.

          • UNKNOWN: Network Flow Monitor can't determine the organization membership of the account.

    • nextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

    • updatedAt (datetime) --

      The date and time when Network Flow Monitor last determined the coverage of the monitoring scope.

DeletePerformanceMonitor (new) Link ¶

Delete a performance monitor. Network Flow Monitor stops tracking network performance for the resources that the monitor included.

See also: AWS API Documentation

Request Syntax

client.delete_performance_monitor(
    monitorName='string'
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListPerformanceMonitors (new) Link ¶

Returns a list of the performance monitors in an account. You can optionally return only the monitors that have a specific status or type.

Results are paginated. Use the nextToken parameter to return additional results.

See also: AWS API Documentation

Request Syntax

client.list_performance_monitors(
    nextToken='string',
    maxResults=123,
    monitorStatus='PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
    monitorType='VPC'
)
type nextToken:

string

param nextToken:

The token for the next set of results. You receive this token from a previous call.

type maxResults:

integer

param maxResults:

The number of performance monitors that you want to return with this call. If you don't specify a value, the default is 25.

type monitorStatus:

string

param monitorStatus:

The status of the performance monitors that you want to return. If you don't specify a status, Network Flow Monitor returns performance monitors with any status.

type monitorType:

string

param monitorType:

The type of the performance monitors that you want to return. If you don't specify a type, Network Flow Monitor returns performance monitors of any type.

rtype:

dict

returns:

Response Syntax

{
    'monitors': [
        {
            'monitorArn': 'string',
            'monitorName': 'string',
            'monitorStatus': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
            'monitorType': 'VPC',
            'targets': [
                {
                    'type': 'AWS::EC2::VPC',
                    'identifier': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • monitors (list) --

      The performance monitors in the account.

      • (dict) --

        A summary of information about a performance monitor, including the ARN, the name, the status, and the resources that it tracks network performance for.

        • monitorArn (string) --

          The Amazon Resource Name (ARN) of the performance monitor.

        • monitorName (string) --

          The name of the performance monitor.

        • monitorStatus (string) --

          The status of a performance monitor. The status can be one of the following

          • PENDING: The performance monitor is in the process of being created.

          • ACTIVE: The performance monitor is active.

          • INACTIVE: The performance monitor is inactive.

          • ERROR: The performance monitor can't be created or updated.

          • DELETING: The performance monitor is in the process of being deleted.

        • monitorType (string) --

          The type of resource that you monitor determines the type of the performance monitor.

        • targets (list) --

          The resources that the performance monitor tracks network performance for.

          • (dict) --

            A resource that a performance monitor tracks network performance for.

            • type (string) --

              The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.

            • identifier (string) --

              The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

    • nextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

GetPerformanceMonitor (new) Link ¶

Returns information about a performance monitor, including the resources that it monitors, its status, and the tags for the monitor.

See also: AWS API Documentation

Request Syntax

client.get_performance_monitor(
    monitorName='string'
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

rtype:

dict

returns:

Response Syntax

{
    'monitorArn': 'string',
    'monitorName': 'string',
    'monitorStatus': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
    'monitorType': 'VPC',
    'targets': [
        {
            'type': 'AWS::EC2::VPC',
            'identifier': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • monitorArn (string) --

      The Amazon Resource Name (ARN) of the performance monitor.

    • monitorName (string) --

      The name of the performance monitor.

    • monitorStatus (string) --

      The status of a performance monitor. The status can be one of the following

      • PENDING: The performance monitor is in the process of being created.

      • ACTIVE: The performance monitor is active.

      • INACTIVE: The performance monitor is inactive.

      • ERROR: The performance monitor can't be created or updated.

      • DELETING: The performance monitor is in the process of being deleted.

    • monitorType (string) --

      The type of resource that you monitor determines the type of the performance monitor.

    • targets (list) --

      The resources that the performance monitor tracks network performance for.

      • (dict) --

        A resource that a performance monitor tracks network performance for.

        • type (string) --

          The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.

        • identifier (string) --

          The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

    • createdAt (datetime) --

      The date and time when the performance monitor was created.

    • modifiedAt (datetime) --

      The date and time when the performance monitor was last modified.

    • tags (dict) --

      The tags for a performance monitor.

      • (string) --

        • (string) --

UpdatePerformanceMonitor (new) Link ¶

Update a performance monitor, to add or remove the resources that the monitor tracks network performance for.

See also: AWS API Documentation

Request Syntax

client.update_performance_monitor(
    monitorName='string',
    targetsToAdd=[
        {
            'type': 'AWS::EC2::VPC',
            'identifier': 'string'
        },
    ],
    targetsToRemove=[
        {
            'type': 'AWS::EC2::VPC',
            'identifier': 'string'
        },
    ],
    clientToken='string'
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

type targetsToAdd:

list

param targetsToAdd:

The resources to add to the performance monitor.

  • (dict) --

    A resource that a performance monitor tracks network performance for.

    • type (string) -- [REQUIRED]

      The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.

    • identifier (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

type targetsToRemove:

list

param targetsToRemove:

The resources to remove from the performance monitor.

  • (dict) --

    A resource that a performance monitor tracks network performance for.

    • type (string) -- [REQUIRED]

      The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.

    • identifier (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

type clientToken:

string

param clientToken:

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. If the token matches a previous request, the service ignores the request without returning an error. Don't reuse the same client token for other API requests.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'monitorArn': 'string',
    'monitorName': 'string',
    'monitorStatus': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
    'monitorType': 'VPC',
    'targets': [
        {
            'type': 'AWS::EC2::VPC',
            'identifier': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • monitorArn (string) --

      The Amazon Resource Name (ARN) of the performance monitor.

    • monitorName (string) --

      The name of the performance monitor.

    • monitorStatus (string) --

      The status of a performance monitor. The status can be one of the following

      • PENDING: The performance monitor is in the process of being created.

      • ACTIVE: The performance monitor is active.

      • INACTIVE: The performance monitor is inactive.

      • ERROR: The performance monitor can't be created or updated.

      • DELETING: The performance monitor is in the process of being deleted.

    • monitorType (string) --

      The type of resource that you monitor determines the type of the performance monitor.

    • targets (list) --

      The resources that the performance monitor tracks network performance for.

      • (dict) --

        A resource that a performance monitor tracks network performance for.

        • type (string) --

          The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.

        • identifier (string) --

          The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

    • createdAt (datetime) --

      The date and time when the performance monitor was created.

    • modifiedAt (datetime) --

      The date and time when the performance monitor was last modified.

    • tags (dict) --

      The tags for a performance monitor.

      • (string) --

        • (string) --

CreatePerformanceMonitor (new) Link ¶

Create a performance monitor to monitor the traffic of the Amazon Virtual Private Clouds (VPCs) that you specify as targets, to determine whether the Amazon Web Services network is causing issues for your workloads. With a performance monitor, you can identify network degradation across paths between Availability Zones and across Amazon Web Services Regions.

See also: AWS API Documentation

Request Syntax

client.create_performance_monitor(
    monitorName='string',
    scopeArn='string',
    targets=[
        {
            'type': 'AWS::EC2::VPC',
            'identifier': 'string'
        },
    ],
    clientToken='string',
    tags={
        'string': 'string'
    }
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

type scopeArn:

string

param scopeArn:

The Amazon Resource Name (ARN) of the scope for the performance monitor.

type targets:

list

param targets:

[REQUIRED]

The resources to monitor. Each target identifies a resource, currently a VPC, for which you can track network performance. For a VPC, specify the VPC ARN.

  • (dict) --

    A resource that a performance monitor tracks network performance for.

    • type (string) -- [REQUIRED]

      The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.

    • identifier (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

type clientToken:

string

param clientToken:

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. If the token matches a previous request, the service ignores the request without returning an error. Don't reuse the same client token for other API requests.

This field is autopopulated if not provided.

type tags:

dict

param tags:

The tags for a performance monitor. You can add a maximum of 200 tags.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'monitorArn': 'string',
    'monitorName': 'string',
    'monitorStatus': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
    'monitorType': 'VPC',
    'targets': [
        {
            'type': 'AWS::EC2::VPC',
            'identifier': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • monitorArn (string) --

      The Amazon Resource Name (ARN) of the performance monitor.

    • monitorName (string) --

      The name of the performance monitor.

    • monitorStatus (string) --

      The status of a performance monitor. The status can be one of the following

      • PENDING: The performance monitor is in the process of being created.

      • ACTIVE: The performance monitor is active.

      • INACTIVE: The performance monitor is inactive.

      • ERROR: The performance monitor can't be created or updated.

      • DELETING: The performance monitor is in the process of being deleted.

    • monitorType (string) --

      The type of resource that you monitor determines the type of the performance monitor.

    • targets (list) --

      The resources that the performance monitor tracks network performance for.

      • (dict) --

        A resource that a performance monitor tracks network performance for.

        • type (string) --

          The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC.

        • identifier (string) --

          The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

    • createdAt (datetime) --

      The date and time when the performance monitor was created.

    • modifiedAt (datetime) --

      The date and time when the performance monitor was last modified.

    • tags (dict) --

      The tags for a performance monitor.

      • (string) --

        • (string) --

StartQueryPerformanceMonitor (new) Link ¶

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

The call returns a query ID that you can use with GetQueryResultsPerformanceMonitor to return the results of the query.

Top paths in Network Flow Monitor are the network paths used by the traffic for the resources that a performance monitor tracks, ranked by impact score and then by traffic volume. Each path includes the traffic and round-trip time for the path, together with a breakdown of the subnet pairs that the path includes.

See also: AWS API Documentation

Request Syntax

client.start_query_performance_monitor(
    monitorName='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    queryType='TOP_PATHS',
    filterParameters=[
        {
            'field': 'string',
            'operator': 'EQUALS'|'NOT_EQUALS'|'IN'|'CONTAINS',
            'values': [
                'string',
            ]
        },
    ],
    limit=123
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the performance monitor.

type startTime:

datetime

param startTime:

[REQUIRED]

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

type endTime:

datetime

param endTime:

[REQUIRED]

The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

type queryType:

string

param queryType:

[REQUIRED]

The type of query that you want to create. Specify TOP_PATHS to return the top paths for the performance monitor.

type filterParameters:

list

param filterParameters:

The filters for the query, to return a subset of the top paths. For a TOP_PATHS query, you can filter on the following fields:

  • local_az_id: The Availability Zone ID of the local end of a path

  • remote_az_id: The Availability Zone ID of the remote end of a path

  • impact_level: The impact level of a path

When you filter on impact_level, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an impact_level filter, including a NOT_EQUALS filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.

  • (dict) --

    A filter for a query, to return a subset of the results.

    • field (string) -- [REQUIRED]

      The name of the field that you want to filter on. The fields that you can specify depend on the type of query.

    • operator (string) -- [REQUIRED]

      The operator to use to compare the field with the values that you specify. The operator can be one of the following

      • EQUALS: The field matches a single value.

      • NOT_EQUALS: The field doesn't match a single value.

      • IN: The field matches any one of several values.

      • CONTAINS: The field contains a value.

    • values (list) -- [REQUIRED]

      The values to compare the field with.

      • (string) --

type limit:

integer

param limit:

The maximum number of top paths that you want the query to return.

rtype:

dict

returns:

Response Syntax

{
    'queryId': 'string'
}

Response Structure

  • (dict) --

    • queryId (string) --

      The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

GetQueryResultsMonitorTopContributors (updated) Link ¶
Changes (response)
{'topContributors': {'additionalFlowInfo': {'clientLocation': {'city': 'string',
                                                               'country': 'string',
                                                               'subdivision': 'string'},
                                            'network': {'asName': 'string',
                                                        'asNumber': 'long'}},
                     'destinationCategory': {'AWS_SERVICE',
                                             'INTERNET',
                                             'LOCAL_ZONE',
                                             'TRANSIT_GATEWAY'}}}

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

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

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

See also: AWS API Documentation

Request Syntax

client.get_query_results_monitor_top_contributors(
    monitorName='string',
    queryId='string',
    nextToken='string',
    maxResults=123
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the monitor.

type queryId:

string

param queryId:

[REQUIRED]

The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

type nextToken:

string

param nextToken:

The token for the next set of results. You receive this token from a previous call.

type maxResults:

integer

param maxResults:

The number of query results that you want to return with this call.

rtype:

dict

returns:

Response Syntax

{
    'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
    'topContributors': [
        {
            'localIp': 'string',
            'snatIp': 'string',
            'localInstanceId': 'string',
            'localVpcId': 'string',
            'localRegion': 'string',
            'localAz': 'string',
            'localSubnetId': 'string',
            'targetPort': 123,
            'destinationCategory': 'INTRA_AZ'|'INTER_AZ'|'INTER_VPC'|'UNCLASSIFIED'|'AMAZON_S3'|'AMAZON_DYNAMODB'|'INTER_REGION'|'INTERNET'|'AWS_SERVICE'|'LOCAL_ZONE'|'TRANSIT_GATEWAY',
            'remoteVpcId': 'string',
            'remoteRegion': 'string',
            'remoteAz': 'string',
            'remoteSubnetId': 'string',
            'remoteInstanceId': 'string',
            'remoteIp': 'string',
            'dnatIp': 'string',
            'value': 123,
            'traversedConstructs': [
                {
                    'componentId': 'string',
                    'componentType': 'string',
                    'componentArn': 'string',
                    'serviceName': 'string'
                },
            ],
            'kubernetesMetadata': {
                'localServiceName': 'string',
                'localPodName': 'string',
                'localPodNamespace': 'string',
                'remoteServiceName': 'string',
                'remotePodName': 'string',
                'remotePodNamespace': 'string'
            },
            'localInstanceArn': 'string',
            'localSubnetArn': 'string',
            'localVpcArn': 'string',
            'remoteInstanceArn': 'string',
            'remoteSubnetArn': 'string',
            'remoteVpcArn': 'string',
            'additionalFlowInfo': {
                'network': {
                    'asName': 'string',
                    'asNumber': 123
                },
                'clientLocation': {
                    'city': 'string',
                    'subdivision': 'string',
                    'country': 'string'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • unit (string) --

      The units for a metric returned by the query.

    • topContributors (list) --

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

      • (dict) --

        A set of information for a top contributor network flow in a monitor. In a monitor, Network Flow Monitor returns information about the network flows for top contributors for each metric. Top contributors are network flows with the top values for each metric type.

        • localIp (string) --

          The IP address of the local resource for a top contributor network flow.

        • snatIp (string) --

          The secure network address translation (SNAT) IP address for a top contributor network flow.

        • localInstanceId (string) --

          The instance identifier for the local resource for a top contributor network flow.

        • localVpcId (string) --

          The VPC ID for a top contributor network flow for the local resource.

        • localRegion (string) --

          The Amazon Web Services Region for the local resource for a top contributor network flow.

        • localAz (string) --

          The Availability Zone for the local resource for a top contributor network flow.

        • localSubnetId (string) --

          The subnet ID for the local resource for a top contributor network flow.

        • targetPort (integer) --

          The target port.

        • destinationCategory (string) --

          The destination category for a top contributors row. Destination categories can be one of the following:

          • INTRA_AZ: Top contributor network flows within a single Availability Zone

          • INTER_AZ: Top contributor network flows between Availability Zones

          • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

          • INTER_VPC: Top contributor network flows between VPCs

          • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

          • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

        • remoteVpcId (string) --

          The VPC ID for a top contributor network flow for the remote resource.

        • remoteRegion (string) --

          The Amazon Web Services Region for the remote resource for a top contributor network flow.

        • remoteAz (string) --

          The Availability Zone for the remote resource for a top contributor network flow.

        • remoteSubnetId (string) --

          The subnet ID for the remote resource for a top contributor network flow.

        • remoteInstanceId (string) --

          The instance identifier for the remote resource for a top contributor network flow.

        • remoteIp (string) --

          The IP address of the remote resource for a top contributor network flow.

        • dnatIp (string) --

          The destination network address translation (DNAT) IP address for a top contributor network flow.

        • value (integer) --

          The value of the metric for a top contributor network flow.

        • traversedConstructs (list) --

          The constructs traversed by a network flow.

          • (dict) --

            A section of the network that a network flow has traveled through.

            • componentId (string) --

              The identifier for the traversed component.

            • componentType (string) --

              The type of component that was traversed.

            • componentArn (string) --

              The Amazon Resource Name (ARN) of a traversed component.

            • serviceName (string) --

              The service name for the traversed component.

        • kubernetesMetadata (dict) --

          Meta data about Kubernetes resources.

          • localServiceName (string) --

            The service name for a local resource.

          • localPodName (string) --

            The name of the pod for a local resource.

          • localPodNamespace (string) --

            The namespace of the pod for a local resource.

          • remoteServiceName (string) --

            The service name for a remote resource.

          • remotePodName (string) --

            The name of the pod for a remote resource.

          • remotePodNamespace (string) --

            The namespace of the pod for a remote resource.

        • localInstanceArn (string) --

          The Amazon Resource Name (ARN) of a local resource.

        • localSubnetArn (string) --

          The Amazon Resource Name (ARN) of a local subnet.

        • localVpcArn (string) --

          The Amazon Resource Name (ARN) of a local VPC.

        • remoteInstanceArn (string) --

          The Amazon Resource Name (ARN) of a remote resource.

        • remoteSubnetArn (string) --

          The Amazon Resource Name (ARN) of a remote subnet.

        • remoteVpcArn (string) --

          The Amazon Resource Name (ARN) of a remote VPC.

        • additionalFlowInfo (dict) --

          Additional information about the network flow, such as the network that the remote address belongs to and the location of the client.

          • network (dict) --

            The network that the remote address of the network flow belongs to.

            • asName (string) --

              The name of the autonomous system that the network belongs to.

            • asNumber (integer) --

              The autonomous system number (ASN) of the autonomous system that the network belongs to.

          • clientLocation (dict) --

            The location of the client for the network flow.

            • city (string) --

              The city where the client is located.

            • subdivision (string) --

              The subdivision, such as a state or province, where the client is located.

            • country (string) --

              The country where the client is located.

    • nextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

StartQueryMonitorTopContributors (updated) Link ¶
Changes (request)
{'destinationCategory': {'AWS_SERVICE',
                         'INTERNET',
                         'LOCAL_ZONE',
                         'TRANSIT_GATEWAY'}}

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

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

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

See also: AWS API Documentation

Request Syntax

client.start_query_monitor_top_contributors(
    monitorName='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    metricName='ROUND_TRIP_TIME'|'TIMEOUTS'|'RETRANSMISSIONS'|'DATA_TRANSFERRED',
    destinationCategory='INTRA_AZ'|'INTER_AZ'|'INTER_VPC'|'UNCLASSIFIED'|'AMAZON_S3'|'AMAZON_DYNAMODB'|'INTER_REGION'|'INTERNET'|'AWS_SERVICE'|'LOCAL_ZONE'|'TRANSIT_GATEWAY',
    limit=123
)
type monitorName:

string

param monitorName:

[REQUIRED]

The name of the monitor.

type startTime:

datetime

param startTime:

[REQUIRED]

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

type endTime:

datetime

param endTime:

[REQUIRED]

The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

type metricName:

string

param metricName:

[REQUIRED]

The metric that you want to query top contributors for. That is, you can specify a metric with this call and return the top contributor network flows, for that type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

type destinationCategory:

string

param destinationCategory:

[REQUIRED]

The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

  • INTER_VPC: Top contributor network flows between VPCs

  • AMAZON_S3: Top contributor network flows to or from Amazon S3

  • AMAZON_DYNAMODB: Top contributor network flows to or from Amazon Dynamo DB

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

type limit:

integer

param limit:

The maximum number of top contributors to return.

rtype:

dict

returns:

Response Syntax

{
    'queryId': 'string'
}

Response Structure

  • (dict) --

    • queryId (string) --

      The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

StartQueryWorkloadInsightsTopContributors (updated) Link ¶
Changes (request)
{'destinationCategory': {'AWS_SERVICE',
                         'INTERNET',
                         'LOCAL_ZONE',
                         'TRANSIT_GATEWAY'}}

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

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

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

See also: AWS API Documentation

Request Syntax

client.start_query_workload_insights_top_contributors(
    scopeId='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    metricName='TIMEOUTS'|'RETRANSMISSIONS'|'DATA_TRANSFERRED',
    destinationCategory='INTRA_AZ'|'INTER_AZ'|'INTER_VPC'|'UNCLASSIFIED'|'AMAZON_S3'|'AMAZON_DYNAMODB'|'INTER_REGION'|'INTERNET'|'AWS_SERVICE'|'LOCAL_ZONE'|'TRANSIT_GATEWAY',
    limit=123
)
type scopeId:

string

param scopeId:

[REQUIRED]

The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.

type startTime:

datetime

param startTime:

[REQUIRED]

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

type endTime:

datetime

param endTime:

[REQUIRED]

The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

type metricName:

string

param metricName:

[REQUIRED]

The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

type destinationCategory:

string

param destinationCategory:

[REQUIRED]

The destination category for a top contributors row. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

type limit:

integer

param limit:

The maximum number of top contributors to return.

rtype:

dict

returns:

Response Syntax

{
    'queryId': 'string'
}

Response Structure

  • (dict) --

    • queryId (string) --

      The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

StartQueryWorkloadInsightsTopContributorsData (updated) Link ¶
Changes (request)
{'destinationCategory': {'AWS_SERVICE',
                         'INTERNET',
                         'LOCAL_ZONE',
                         'TRANSIT_GATEWAY'}}

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

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

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

See also: AWS API Documentation

Request Syntax

client.start_query_workload_insights_top_contributors_data(
    scopeId='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    metricName='TIMEOUTS'|'RETRANSMISSIONS'|'DATA_TRANSFERRED',
    destinationCategory='INTRA_AZ'|'INTER_AZ'|'INTER_VPC'|'UNCLASSIFIED'|'AMAZON_S3'|'AMAZON_DYNAMODB'|'INTER_REGION'|'INTERNET'|'AWS_SERVICE'|'LOCAL_ZONE'|'TRANSIT_GATEWAY'
)
type scopeId:

string

param scopeId:

[REQUIRED]

The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

type startTime:

datetime

param startTime:

[REQUIRED]

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

type endTime:

datetime

param endTime:

[REQUIRED]

The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

type metricName:

string

param metricName:

[REQUIRED]

The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

type destinationCategory:

string

param destinationCategory:

[REQUIRED]

The destination category for a top contributors. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

rtype:

dict

returns:

Response Syntax

{
    'queryId': 'string'
}

Response Structure

  • (dict) --

    • queryId (string) --

      The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.