NeptuneGraph / Paginator / ListExportTasks

ListExportTasks

class NeptuneGraph.Paginator.ListExportTasks

paginator = client.get_paginator('list_export_tasks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NeptuneGraph.Client.list_export_tasks().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• graphIdentifier (string) – The unique identifier of the Neptune Analytics graph.

• 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

{
    'tasks': [
        {
            'graphId': 'string',
            'roleArn': 'string',
            'taskId': 'string',
            'status': 'INITIALIZING'|'EXPORTING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'|'DELETED',
            'format': 'PARQUET'|'CSV',
            'destination': 'string',
            'kmsKeyIdentifier': 'string',
            'parquetType': 'COLUMNAR',
            'statusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tasks (list) –

    The requested list of export tasks.

    • (dict) –

      Provides details about an export task.

      • graphId (string) –

        The source graph identifier of the export task.

      • roleArn (string) –

        The ARN of the IAM role that will allow the data to be exported to the destination.

      • taskId (string) –

        The unique identifier of the export task.

      • status (string) –

        The current status of the export task.

      • format (string) –

        The format of the export task.

      • destination (string) –

        The Amazon S3 URI of the export task where data will be exported to.

      • kmsKeyIdentifier (string) –

        The KMS key identifier of the export task.

      • parquetType (string) –

        The parquet type of the export task.

      • statusReason (string) –

        The reason that the export task has this status value.

  • NextToken (string) –

    A token to resume pagination.