NetworkFlowMonitor / Paginator / ListScopes

ListScopes

class NetworkFlowMonitor.Paginator.ListScopes

paginator = client.get_paginator('list_scopes')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'scopes': [
        {
            'scopeId': 'string',
            'status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED',
            'scopeArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • scopes (list) –

    The scopes returned by the call.

    • (dict) –

      A summary of information about a scope, including the ARN, target ID, and Amazon Web Services Region.

      • scopeId (string) –

        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.

      • status (string) –

        The status of a scope. The status can be one of the following, depending on the state of scope creation: SUCCEEDED, IN_PROGRESS, or FAILED.

      • scopeArn (string) –

        The Amazon Resource Name (ARN) of the scope.

  • NextToken (string) –

    A token to resume pagination.