Class: Aws::NeptuneGraph::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::NeptuneGraph::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb
Overview
An API client for NeptuneGraph. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::NeptuneGraph::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_import_task(params = {}) ⇒ Types::CancelImportTaskOutput
Deletes the specified import task.
-
#cancel_query(params = {}) ⇒ Struct
Cancels a specified query.
-
#create_graph(params = {}) ⇒ Types::CreateGraphOutput
Creates a new Neptune Analytics graph.
-
#create_graph_snapshot(params = {}) ⇒ Types::CreateGraphSnapshotOutput
Creates a snapshot of the specific graph.
-
#create_graph_using_import_task(params = {}) ⇒ Types::CreateGraphUsingImportTaskOutput
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(params = {}) ⇒ Types::CreatePrivateGraphEndpointOutput
Create a private graph endpoint to allow private access from to the graph from within a VPC.
-
#delete_graph(params = {}) ⇒ Types::DeleteGraphOutput
Deletes the specified graph.
-
#delete_graph_snapshot(params = {}) ⇒ Types::DeleteGraphSnapshotOutput
Deletes the specifed graph snapshot.
-
#delete_private_graph_endpoint(params = {}) ⇒ Types::DeletePrivateGraphEndpointOutput
Deletes a private graph endpoint.
-
#execute_query(params = {}) ⇒ Types::ExecuteQueryOutput
Execute an openCypher query.
-
#get_graph(params = {}) ⇒ Types::GetGraphOutput
Gets information about a specified graph.
-
#get_graph_snapshot(params = {}) ⇒ Types::GetGraphSnapshotOutput
Retrieves a specified graph snapshot.
-
#get_graph_summary(params = {}) ⇒ Types::GetGraphSummaryOutput
Gets a graph summary for a property graph.
-
#get_import_task(params = {}) ⇒ Types::GetImportTaskOutput
Retrieves a specified import task.
-
#get_private_graph_endpoint(params = {}) ⇒ Types::GetPrivateGraphEndpointOutput
Retrieves information about a specified private endpoint.
-
#get_query(params = {}) ⇒ Types::GetQueryOutput
Retrieves the status of a specified query.
-
#list_graph_snapshots(params = {}) ⇒ Types::ListGraphSnapshotsOutput
Lists available snapshots of a specified Neptune Analytics graph.
-
#list_graphs(params = {}) ⇒ Types::ListGraphsOutput
Lists available Neptune Analytics graphs.
-
#list_import_tasks(params = {}) ⇒ Types::ListImportTasksOutput
Lists import tasks.
-
#list_private_graph_endpoints(params = {}) ⇒ Types::ListPrivateGraphEndpointsOutput
Lists private endpoints for a specified Neptune Analytics graph.
-
#list_queries(params = {}) ⇒ Types::ListQueriesOutput
Lists active openCypher queries.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists tags associated with a specified resource.
-
#reset_graph(params = {}) ⇒ Types::ResetGraphOutput
Empties the data from a specified Neptune Analytics graph.
-
#restore_graph_from_snapshot(params = {}) ⇒ Types::RestoreGraphFromSnapshotOutput
Restores a graph from a snapshot.
-
#start_import_task(params = {}) ⇒ Types::StartImportTaskOutput
Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_graph(params = {}) ⇒ Types::UpdateGraphOutput
Updates the configuration of a specified Neptune Analytics graph.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#cancel_import_task(params = {}) ⇒ Types::CancelImportTaskOutput
Deletes the specified import task.
449 450 451 452 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 449 def cancel_import_task(params = {}, = {}) req = build_request(:cancel_import_task, params) req.send_request() end |
#cancel_query(params = {}) ⇒ Struct
Cancels a specified query.
475 476 477 478 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 475 def cancel_query(params = {}, = {}) req = build_request(:cancel_query, params) req.send_request() end |
#create_graph(params = {}) ⇒ Types::CreateGraphOutput
Creates a new Neptune Analytics graph.
579 580 581 582 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 579 def create_graph(params = {}, = {}) req = build_request(:create_graph, params) req.send_request() end |
#create_graph_snapshot(params = {}) ⇒ Types::CreateGraphSnapshotOutput
Creates a snapshot of the specific graph.
635 636 637 638 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 635 def create_graph_snapshot(params = {}, = {}) req = build_request(:create_graph_snapshot, params) req.send_request() end |
#create_graph_using_import_task(params = {}) ⇒ Types::CreateGraphUsingImportTaskOutput
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.
791 792 793 794 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 791 def create_graph_using_import_task(params = {}, = {}) req = build_request(:create_graph_using_import_task, params) req.send_request() end |
#create_private_graph_endpoint(params = {}) ⇒ Types::CreatePrivateGraphEndpointOutput
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.
844 845 846 847 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 844 def create_private_graph_endpoint(params = {}, = {}) req = build_request(:create_private_graph_endpoint, params) req.send_request() end |
#delete_graph(params = {}) ⇒ Types::DeleteGraphOutput
Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.
908 909 910 911 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 908 def delete_graph(params = {}, = {}) req = build_request(:delete_graph, params) req.send_request() end |
#delete_graph_snapshot(params = {}) ⇒ Types::DeleteGraphSnapshotOutput
Deletes the specifed graph snapshot.
948 949 950 951 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 948 def delete_graph_snapshot(params = {}, = {}) req = build_request(:delete_graph_snapshot, params) req.send_request() end |
#delete_private_graph_endpoint(params = {}) ⇒ Types::DeletePrivateGraphEndpointOutput
Deletes a private graph endpoint.
987 988 989 990 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 987 def delete_private_graph_endpoint(params = {}, = {}) req = build_request(:delete_private_graph_endpoint, params) req.send_request() end |
#execute_query(params = {}) ⇒ Types::ExecuteQueryOutput
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
1061 1062 1063 1064 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1061 def execute_query(params = {}, = {}, &block) req = build_request(:execute_query, params) req.send_request(, &block) end |
#get_graph(params = {}) ⇒ Types::GetGraphOutput
Gets information about a specified graph.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- graph_available
- graph_deleted
1123 1124 1125 1126 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1123 def get_graph(params = {}, = {}) req = build_request(:get_graph, params) req.send_request() end |
#get_graph_snapshot(params = {}) ⇒ Types::GetGraphSnapshotOutput
Retrieves a specified graph snapshot.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- graph_snapshot_available
- graph_snapshot_deleted
1169 1170 1171 1172 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1169 def get_graph_snapshot(params = {}, = {}) req = build_request(:get_graph_snapshot, params) req.send_request() end |
#get_graph_summary(params = {}) ⇒ Types::GetGraphSummaryOutput
Gets a graph summary for a property graph.
1233 1234 1235 1236 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1233 def get_graph_summary(params = {}, = {}) req = build_request(:get_graph_summary, params) req.send_request() end |
#get_import_task(params = {}) ⇒ Types::GetImportTaskOutput
Retrieves a specified import task.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- import_task_cancelled
- import_task_successful
1295 1296 1297 1298 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1295 def get_import_task(params = {}, = {}) req = build_request(:get_import_task, params) req.send_request() end |
#get_private_graph_endpoint(params = {}) ⇒ Types::GetPrivateGraphEndpointOutput
Retrieves information about a specified private endpoint.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- private_graph_endpoint_available
- private_graph_endpoint_deleted
1340 1341 1342 1343 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1340 def get_private_graph_endpoint(params = {}, = {}) req = build_request(:get_private_graph_endpoint, params) req.send_request() end |
#get_query(params = {}) ⇒ Types::GetQueryOutput
Retrieves the status of a specified query.
neptune-graph:GetQueryStatus
IAM action attached.
1386 1387 1388 1389 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1386 def get_query(params = {}, = {}) req = build_request(:get_query, params) req.send_request() end |
#list_graph_snapshots(params = {}) ⇒ Types::ListGraphSnapshotsOutput
Lists available snapshots of a specified Neptune Analytics graph.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1443 1444 1445 1446 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1443 def list_graph_snapshots(params = {}, = {}) req = build_request(:list_graph_snapshots, params) req.send_request() end |
#list_graphs(params = {}) ⇒ Types::ListGraphsOutput
Lists available Neptune Analytics graphs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1499 1500 1501 1502 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1499 def list_graphs(params = {}, = {}) req = build_request(:list_graphs, params) req.send_request() end |
#list_import_tasks(params = {}) ⇒ Types::ListImportTasksOutput
Lists import tasks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1551 1552 1553 1554 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1551 def list_import_tasks(params = {}, = {}) req = build_request(:list_import_tasks, params) req.send_request() end |
#list_private_graph_endpoints(params = {}) ⇒ Types::ListPrivateGraphEndpointsOutput
Lists private endpoints for a specified Neptune Analytics graph.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1606 def list_private_graph_endpoints(params = {}, = {}) req = build_request(:list_private_graph_endpoints, params) req.send_request() end |
#list_queries(params = {}) ⇒ Types::ListQueriesOutput
Lists active openCypher queries.
1647 1648 1649 1650 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1647 def list_queries(params = {}, = {}) req = build_request(:list_queries, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists tags associated with a specified resource.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1676 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#reset_graph(params = {}) ⇒ Types::ResetGraphOutput
Empties the data from a specified Neptune Analytics graph.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1739 def reset_graph(params = {}, = {}) req = build_request(:reset_graph, params) req.send_request() end |
#restore_graph_from_snapshot(params = {}) ⇒ Types::RestoreGraphFromSnapshotOutput
Restores a graph from a snapshot.
1838 1839 1840 1841 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1838 def restore_graph_from_snapshot(params = {}, = {}) req = build_request(:restore_graph_from_snapshot, params) req.send_request() end |
#start_import_task(params = {}) ⇒ Types::StartImportTaskOutput
Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1917 def start_import_task(params = {}, = {}) req = build_request(:start_import_task, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
1959 1960 1961 1962 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1959 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
1985 1986 1987 1988 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 1985 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_graph(params = {}) ⇒ Types::UpdateGraphOutput
Updates the configuration of a specified Neptune Analytics graph
2060 2061 2062 2063 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 2060 def update_graph(params = {}, = {}) req = build_request(:update_graph, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
graph_available | #get_graph | 60 | 480 |
graph_deleted | #get_graph | 60 | 60 |
graph_snapshot_available | #get_graph_snapshot | 60 | 120 |
graph_snapshot_deleted | #get_graph_snapshot | 60 | 60 |
import_task_cancelled | #get_import_task | 60 | 60 |
import_task_successful | #get_import_task | 60 | 480 |
private_graph_endpoint_available | #get_private_graph_endpoint | 10 | 180 |
private_graph_endpoint_deleted | #get_private_graph_endpoint | 10 | 180 |
2177 2178 2179 2180 2181 |
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/client.rb', line 2177 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |