:doc:`NeptuneGraph <../../neptune-graph>` / Paginator / ListGraphs

**********
ListGraphs
**********



.. py:class:: NeptuneGraph.Paginator.ListGraphs

  ::

    
    paginator = client.get_paginator('list_graphs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`NeptuneGraph.Client.list_graphs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListGraphs>`_    


    **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**

      
      ::

        {
            'graphs': [
                {
                    'id': 'string',
                    'name': 'string',
                    'arn': 'string',
                    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED'|'IMPORTING'|'STARTING'|'STOPPING'|'STOPPED',
                    'provisionedMemory': 123,
                    'publicConnectivity': True|False,
                    'endpoint': 'string',
                    'replicaCount': 123,
                    'kmsKeyIdentifier': 'string',
                    'deletionProtection': True|False
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **graphs** *(list) --* 

          A list of the graphs.

          
          

          - *(dict) --* 

            Summary details about a graph.

            
            

            - **id** *(string) --* 

              The unique identifier of the graph.

              
            

            - **name** *(string) --* 

              The name of the graph.

              
            

            - **arn** *(string) --* 

              The ARN associated with the graph.

              
            

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

              The status of the graph.

              
            

            - **provisionedMemory** *(integer) --* 

              The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

              
            

            - **publicConnectivity** *(boolean) --* 

              If ``true``, the graph has a public endpoint, otherwise not.

              
            

            - **endpoint** *(string) --* 

              The graph endpoint.

              
            

            - **replicaCount** *(integer) --* 

              The number of replicas for the graph.

              
            

            - **kmsKeyIdentifier** *(string) --* 

              The ID of the KMS key used to encrypt and decrypt graph data.

              
            

            - **deletionProtection** *(boolean) --* 

              If ``true``, deletion protection is enabled for the graph.

              
        
      
        

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

          A token to resume pagination.

          
    