Amazon Neptune Graph

2025/02/04 - Amazon Neptune Graph - 1 updated api methods

Changes  Added argument to `list-export` to filter by graph ID

ListExportTasks (updated) Link ΒΆ
Changes (request)
{'graphIdentifier': 'string'}

Retrieves a list of export tasks.

See also: AWS API Documentation

Request Syntax

client.list_export_tasks(
    graphIdentifier='string',
    nextToken='string',
    maxResults=123
)
type graphIdentifier:

string

param graphIdentifier:

The unique identifier of the Neptune Analytics graph.

type nextToken:

string

param nextToken:

Pagination token used to paginate input.

type maxResults:

integer

param maxResults:

The maximum number of export tasks to return.

rtype:

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

      Pagination token used to paginate output.