NetworkFlowMonitor / Paginator / GetQueryResultsWorkloadInsightsTopContributors

GetQueryResultsWorkloadInsightsTopContributors

class NetworkFlowMonitor.Paginator.GetQueryResultsWorkloadInsightsTopContributors

paginator = client.get_paginator('get_query_results_workload_insights_top_contributors')

paginate(**kwargs)

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

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

{
    'topContributors': [
        {
            'accountId': 'string',
            'localSubnetId': 'string',
            'localAz': 'string',
            'localVpcId': 'string',
            'localRegion': 'string',
            'remoteIdentifier': 'string',
            'value': 123,
            'localSubnetArn': 'string',
            'localVpcArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • topContributors (list) –

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

    • (dict) –

      A row for a top contributor for a scope.

      • accountId (string) –

        The account ID for a specific row of data.

      • localSubnetId (string) –

        The subnet identifier for the local resource.

      • localAz (string) –

        The identifier for the Availability Zone where the local resource is located.

      • localVpcId (string) –

        The identifier for the VPC for the local resource.

      • localRegion (string) –

        The Amazon Web Services Region where the local resource is located.

      • remoteIdentifier (string) –

        The identifier of a remote resource.

      • value (integer) –

        The value for a metric.

      • localSubnetArn (string) –

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

      • localVpcArn (string) –

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

  • NextToken (string) –

    A token to resume pagination.