:doc:`NetworkFlowMonitor <../../networkflowmonitor>` / Paginator / ListScopes

**********
ListScopes
**********



.. py:class:: NetworkFlowMonitor.Paginator.ListScopes

  ::

    
    paginator = client.get_paginator('list_scopes')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`NetworkFlowMonitor.Client.list_scopes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListScopes>`_    


    **Request Syntax**
    ::

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

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'scopes': [
                {
                    'scopeId': 'string',
                    'status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED'|'DEACTIVATING'|'DEACTIVATED',
                    '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 that you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for the accounts in a scope.

              
            

            - **status** *(string) --* 

              The status for a scope. The status can be one of the following: ``SUCCEEDED``, ``IN_PROGRESS``, ``FAILED``, ``DEACTIVATING``, or ``DEACTIVATED``.

               

              A status of ``DEACTIVATING`` means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of ``DEACTIVATED`` means that the deactivating process is complete.

              
            

            - **scopeArn** *(string) --* 

              The Amazon Resource Name (ARN) of the scope.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    