export_tasks

Creates, updates, deletes, gets or lists an export_tasks resource.

Overview

Name	export_tasks
Type	Resource
Id	aws.neptune_graph.export_tasks

Fields

The following fields are returned by SELECT queries:

get_export_task

Name	Datatype	Description
destination	string	The Amazon S3 URI of the export task where data will be exported.
export_filter	object	The export filter of the export task.
export_task_details	object	The details of the export task.
format_	string	The format of the export task. (PARQUET, CSV)
graph_id	string	The source graph identifier of the export task. (pattern: <code>g-[a-z0-9]{10}</code>)
kms_key_identifier	string	The KMS key identifier of the export task. (pattern: <code>arn:aws[^:]:kms:[a-zA-Z0-9-]:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
parquet_type	string	The parquet type of the export task. (COLUMNAR)
role_arn	string	The ARN of the IAM role that will allow data to be exported to the destination. (pattern: <code>arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+</code>)
status	string	The current status of the export task. (INITIALIZING, EXPORTING, SUCCEEDED, FAILED, CANCELLING, CANCELLED, DELETED)
status_reason	string	The reason that the export task has this status value.
task_id	string	The unique identifier of the export task. (pattern: <code>t-[a-z0-9]{10}</code>)

list_export_tasks

Name	Datatype	Description
destination	string	The Amazon S3 URI of the export task where data will be exported to.
format_	string	The format of the export task. (PARQUET, CSV)
graph_id	string	The source graph identifier of the export task. (pattern: <code>g-[a-z0-9]{10}</code>)
kms_key_identifier	string	The KMS key identifier of the export task. (pattern: <code>arn:aws[^:]:kms:[a-zA-Z0-9-]:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
parquet_type	string	The parquet type of the export task. (COLUMNAR)
role_arn	string	The ARN of the IAM role that will allow the data to be exported to the destination. (pattern: <code>arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+</code>)
status	string	The current status of the export task. (INITIALIZING, EXPORTING, SUCCEEDED, FAILED, CANCELLING, CANCELLED, DELETED)
status_reason	string	The reason that the export task has this status value.
task_id	string	The unique identifier of the export task. (pattern: <code>t-[a-z0-9]{10}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_export_task	select	task_identifier, region		Retrieves a specified export task.
list_export_tasks	select	region	graphIdentifier, nextToken, maxResults	Retrieves a list of export tasks.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
task_identifier	string	The unique identifier of the export task.
graphIdentifier	string	The unique identifier of the Neptune Analytics graph.
maxResults	integer	The maximum number of export tasks to return.
nextToken	string	Pagination token used to paginate input.

SELECT examples

get_export_task

Retrieves a specified export task.

SELECT
destination,
export_filter,
export_task_details,
format_,
graph_id,
kms_key_identifier,
parquet_type,
role_arn,
status,
status_reason,
task_id
FROM aws.neptune_graph.export_tasks
WHERE task_identifier = '{{ task_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_export_tasks

Retrieves a list of export tasks.

SELECT
destination,
format_,
graph_id,
kms_key_identifier,
parquet_type,
role_arn,
status,
status_reason,
task_id
FROM aws.neptune_graph.export_tasks
WHERE region = '{{ region }}' -- required
AND graphIdentifier = '{{ graphIdentifier }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;