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

***************
ListImportTasks
***************



.. py:class:: NeptuneGraph.Paginator.ListImportTasks

  ::

    
    paginator = client.get_paginator('list_import_tasks')

  
  

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

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

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


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

      
      ::

        {
            'tasks': [
                {
                    'graphId': 'string',
                    'taskId': 'string',
                    'source': 'string',
                    'format': 'CSV'|'OPEN_CYPHER'|'PARQUET'|'NTRIPLES',
                    'parquetType': 'COLUMNAR',
                    'roleArn': 'string',
                    'status': 'INITIALIZING'|'EXPORTING'|'ANALYZING_DATA'|'IMPORTING'|'REPROVISIONING'|'ROLLING_BACK'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'|'DELETED'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **tasks** *(list) --* 

          The requested list of import tasks.

          
          

          - *(dict) --* 

            Details about an import task.

            
            

            - **graphId** *(string) --* 

              The unique identifier of the Neptune Analytics graph.

              
            

            - **taskId** *(string) --* 

              The unique identifier of the import task.

              
            

            - **source** *(string) --* 

              A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot

              
            

            - **format** *(string) --* 

              Specifies the format of S3 data to be imported. Valid values are ``CSV``, which identifies the `Gremlin CSV format <https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html>`__ or ``OPENCYPHER``, which identies the `openCypher load format <https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html>`__.

              
            

            - **parquetType** *(string) --* 

              The parquet type of the import task.

              
            

            - **roleArn** *(string) --* 

              The ARN of the IAM role that will allow access to the data that is to be imported.

              
            

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

              Status of the import task.

              
        
      
        

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

          A token to resume pagination.

          
    