NetworkFlowMonitor / Paginator / GetQueryResultsWorkloadInsightsTopContributorsData

GetQueryResultsWorkloadInsightsTopContributorsData

class NetworkFlowMonitor.Paginator.GetQueryResultsWorkloadInsightsTopContributorsData

paginator = client.get_paginator('get_query_results_workload_insights_top_contributors_data')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkFlowMonitor.Client.get_query_results_workload_insights_top_contributors_data().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    scopeId='string',
    queryId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• scopeId (string) –

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

• queryId (string) –

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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',
    'datapoints': [
        {
            'timestamps': [
                datetime(2015, 1, 1),
            ],
            'values': [
                123.0,
            ],
            'label': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • unit (string) –

    The units for a metric returned by the query.

  • datapoints (list) –

    The datapoints returned by the query.

    • (dict) –

      A data point for a top contributor network flow in a scope. Network Flow Monitor returns information about the network flows with the top values for each metric type, which are called top contributors.

      • timestamps (list) –

        An array of the timestamps for the data point.

        • (datetime) –

      • values (list) –

        The values for the data point.

        • (float) –

      • label (string) –

        The label identifying the data point.

  • NextToken (string) –

    A token to resume pagination.