aws-elixir

View Source AWS.NeptuneGraph (aws-elixir v1.0.4)

Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.

Link to this section Summary

Functions

cancel_export_task(client, task_identifier, input, options \\ [])

Cancel the specified export task.

cancel_import_task(client, task_identifier, input, options \\ [])

Deletes the specified import task.

cancel_query(client, query_id, input, options \\ [])

Cancels a specified query.

create_graph(client, input, options \\ [])

Creates a new Neptune Analytics graph.

create_graph_snapshot(client, input, options \\ [])

Creates a snapshot of the specific graph.

create_graph_using_import_task(client, input, options \\ [])

Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.

create_private_graph_endpoint(client, graph_identifier, input, options \\ [])

Create a private graph endpoint to allow private access from to the graph from within a VPC.

delete_graph(client, graph_identifier, input, options \\ [])

Deletes the specified graph.

delete_graph_snapshot(client, snapshot_identifier, input, options \\ [])

Deletes the specifed graph snapshot.

delete_private_graph_endpoint(client, graph_identifier, vpc_id, input, options \\ [])

Deletes a private graph endpoint.

execute_query(client, input, options \\ [])

Execute an openCypher query.

get_export_task(client, task_identifier, options \\ [])

Retrieves a specified export task.

get_graph(client, graph_identifier, options \\ [])

Gets information about a specified graph.

get_graph_snapshot(client, snapshot_identifier, options \\ [])

Retrieves a specified graph snapshot.

get_graph_summary(client, mode \\ nil, graph_identifier, options \\ [])

Gets a graph summary for a property graph.

get_import_task(client, task_identifier, options \\ [])

Retrieves a specified import task.

get_private_graph_endpoint(client, graph_identifier, vpc_id, options \\ [])

Retrieves information about a specified private endpoint.

get_query(client, query_id, graph_identifier, options \\ [])

Retrieves the status of a specified query.

list_export_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves a list of export tasks.

list_graph_snapshots(client, graph_identifier \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists available snapshots of a specified Neptune Analytics graph.

list_graphs(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists available Neptune Analytics graphs.

list_import_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists import tasks.

list_private_graph_endpoints(client, graph_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists private endpoints for a specified Neptune Analytics graph.

list_queries(client, max_results, state \\ nil, graph_identifier, options \\ [])

Lists active openCypher queries.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists tags associated with a specified resource.

metadata()
reset_graph(client, graph_identifier, input, options \\ [])

Empties the data from a specified Neptune Analytics graph.

restore_graph_from_snapshot(client, snapshot_identifier, input, options \\ [])

Restores a graph from a snapshot.

start_export_task(client, input, options \\ [])

Export data from an existing Neptune Analytics graph to Amazon S3.

start_import_task(client, graph_identifier, input, options \\ [])

Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).

tag_resource(client, resource_arn, input, options \\ [])

Adds tags to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes the specified tags from the specified resource.

update_graph(client, graph_identifier, input, options \\ [])

Updates the configuration of a specified Neptune Analytics graph

Link to this section Functions

Link to this function

cancel_export_task(client, task_identifier, input, options \\ [])

View Source

Cancel the specified export task.

Link to this function

cancel_import_task(client, task_identifier, input, options \\ [])

View Source

Deletes the specified import task.

Link to this function

cancel_query(client, query_id, input, options \\ [])

View Source

Cancels a specified query.

Link to this function

create_graph(client, input, options \\ [])

View Source

Creates a new Neptune Analytics graph.

Link to this function

create_graph_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of the specific graph.

Link to this function

create_graph_using_import_task(client, input, options \\ [])

View Source

Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.

The data can be loaded from files in S3 that in either the Gremlin CSV format or the openCypher load format.

Link to this function

create_private_graph_endpoint(client, graph_identifier, input, options \\ [])

View Source

Create a private graph endpoint to allow private access from to the graph from within a VPC.

You can attach security groups to the private graph endpoint.

VPC endpoint charges apply.

Link to this function

delete_graph(client, graph_identifier, input, options \\ [])

View Source

Deletes the specified graph.

Graphs cannot be deleted if delete-protection is enabled.

Link to this function

delete_graph_snapshot(client, snapshot_identifier, input, options \\ [])

View Source

Deletes the specifed graph snapshot.

Link to this function

delete_private_graph_endpoint(client, graph_identifier, vpc_id, input, options \\ [])

View Source

Deletes a private graph endpoint.

Link to this function

execute_query(client, input, options \\ [])

View Source

Execute an openCypher query.

When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:

* neptune-graph:ReadDataViaQuery

* neptune-graph:WriteDataViaQuery

* neptune-graph:DeleteDataViaQuery

Link to this function

get_export_task(client, task_identifier, options \\ [])

View Source

Retrieves a specified export task.

Link to this function

get_graph(client, graph_identifier, options \\ [])

View Source

Gets information about a specified graph.

Link to this function

get_graph_snapshot(client, snapshot_identifier, options \\ [])

View Source

Retrieves a specified graph snapshot.

Link to this function

get_graph_summary(client, mode \\ nil, graph_identifier, options \\ [])

View Source

Gets a graph summary for a property graph.

Link to this function

get_import_task(client, task_identifier, options \\ [])

View Source

Retrieves a specified import task.

Link to this function

get_private_graph_endpoint(client, graph_identifier, vpc_id, options \\ [])

View Source

Retrieves information about a specified private endpoint.

Link to this function

get_query(client, query_id, graph_identifier, options \\ [])

View Source

Retrieves the status of a specified query.

When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the neptune-graph:GetQueryStatus IAM action attached.

Link to this function

list_export_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of export tasks.

Link to this function

list_graph_snapshots(client, graph_identifier \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists available snapshots of a specified Neptune Analytics graph.

Link to this function

list_graphs(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists available Neptune Analytics graphs.

Link to this function

list_import_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists import tasks.

Link to this function

list_private_graph_endpoints(client, graph_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists private endpoints for a specified Neptune Analytics graph.

Link to this function

list_queries(client, max_results, state \\ nil, graph_identifier, options \\ [])

View Source

Lists active openCypher queries.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists tags associated with a specified resource.

Link to this function

metadata()

View Source
Link to this function

reset_graph(client, graph_identifier, input, options \\ [])

View Source

Empties the data from a specified Neptune Analytics graph.

Link to this function

restore_graph_from_snapshot(client, snapshot_identifier, input, options \\ [])

View Source

Restores a graph from a snapshot.

Link to this function

start_export_task(client, input, options \\ [])

View Source

Export data from an existing Neptune Analytics graph to Amazon S3.

The graph state should be AVAILABLE.

Link to this function

start_import_task(client, graph_identifier, input, options \\ [])

View Source

Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).

The graph needs to be empty and in the AVAILABLE state.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds tags to the specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes the specified tags from the specified resource.

Link to this function

update_graph(client, graph_identifier, input, options \\ [])

View Source

Updates the configuration of a specified Neptune Analytics graph