NeptuneGraph / Client / list_import_tasks

list_import_tasks#

NeptuneGraph.Client.list_import_tasks(**kwargs)#

Lists import tasks.

Request Syntax

response = client.list_import_tasks(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) –
Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
maxResults (integer) –
The total number of records to return in the command’s output.

If the total number of records available is more than the value specified, nextToken is provided in the command’s output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

Return type:

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 or OPENCYPHER, which identies the openCypher load format.
    - 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) –
  
  Pagination token used to paginate output.
  
  When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

Exceptions

NeptuneGraph.Client.exceptions.ThrottlingException
NeptuneGraph.Client.exceptions.ValidationException
NeptuneGraph.Client.exceptions.InternalServerException
NeptuneGraph.Client.exceptions.ResourceNotFoundException