aws-sdk-neptunegraph 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d92d892f5b9dfc5079992b0aad0658dabbe87b1b4df8ac9ef85d9a0b77dc6aa
-  data.tar.gz: d2877c397f9d8356b1fcea8fb9cbb3832b6253c0686c1fbc05957fdd4909b5cf
+  metadata.gz: ed56e747212fec56caae70446d1728e5441decb309a72a4ce2a1159f137e4c92
+  data.tar.gz: 6b949a8cd251ba69d9e92e2f70ccdb0c1a64d8203feca00141c13860196e9751
 SHA512:
-  metadata.gz: 505643a54e061aeda54f236192b1315c31d70746d468faf9cc9fdc9e392b0f21f6514f1ea740e8fd8e4892c3ec0902a0fb3fc162c50f4244f68445372914756d
-  data.tar.gz: 4addc61e4ac2976316e66063cba76db1570b335e8c52782728fe543b621c7cb2d98d1f98afa4e036da59919f85bb26466b186d016c7ed9be7d907a675d91dc42
+  metadata.gz: 617790114e2ab5059e5c29097607ffbb4df8ec7013d6dcb05fd968c115eb2fa973e9096bc1eb8e9c7bc1c9889db0ac4ae9a0435f292c5d8b096c6732e4c691ec
+  data.tar.gz: 5a8df0569ae6d8845c1ac9f6d58fd259d954bda9b16be7d147b9da1b0550f6ebb71bc7e007f14b59f54f12280835f744ffab51b0b2bd8f6db839c25a7c3b983f

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.4.0 (2024-02-12)
+------------------
+
+* Feature - Adding a new option "parameters" for data plane api ExecuteQuery to support running parameterized query via SDK.
+
+1.3.0 (2024-02-01)
+------------------
+
+* Feature - Adding new APIs in SDK for Amazon Neptune Analytics. These APIs include operations to execute, cancel, list queries and get the graph summary.
+
 1.2.0 (2024-01-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.4.0

data/lib/aws-sdk-neptunegraph/client.rb

@@ -388,7 +388,7 @@ module Aws::NeptuneGraph
 
     # @!group API Operations
 
-    # Deletes the specified import task
+    # Deletes the specified import task.
     #
     # @option params [required, String] :task_identifier
     #   The unique identifier of the import task.
@@ -426,6 +426,32 @@ module Aws::NeptuneGraph
       req.send_request(options)
     end
 
+    # Cancels a specified query.
+    #
+    # @option params [required, String] :graph_identifier
+    #   The unique identifier of the Neptune Analytics graph.
+    #
+    # @option params [required, String] :query_id
+    #   The unique identifier of the query to cancel.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.cancel_query({
+    #     graph_identifier: "GraphIdentifier", # required
+    #     query_id: "String", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelQuery AWS API Documentation
+    #
+    # @overload cancel_query(params = {})
+    # @param [Hash] params ({})
+    def cancel_query(params = {}, options = {})
+      req = build_request(:cancel_query, params)
+      req.send_request(options)
+    end
+
     # Creates a new Neptune Analytics graph.
     #
     # @option params [required, String] :graph_name
@@ -442,8 +468,8 @@ module Aws::NeptuneGraph
     #
     # @option params [Boolean] :public_connectivity
     #   Specifies whether or not the graph can be reachable over the internet.
-    #   All access to graphs IAM authenticated. (`true` to enable, or `false`
-    #   to disable.
+    #   All access to graphs is IAM authenticated. (`true` to enable, or
+    #   `false` to disable.
     #
     # @option params [String] :kms_key_identifier
     #   Specifies a KMS key to use to encrypt data in the new graph.
@@ -454,7 +480,7 @@ module Aws::NeptuneGraph
     #   Max = 65,535
     #
     # @option params [Integer] :replica_count
-    #   The number of replicas in other AZs. Min =0, Max = 2, Default =1
+    #   The number of replicas in other AZs. Min =0, Max = 2, Default = 1.
     #
     # @option params [Boolean] :deletion_protection
     #   Indicates whether or not to enable deletion protection on the graph.
@@ -609,8 +635,8 @@ module Aws::NeptuneGraph
     #
     # @option params [Boolean] :public_connectivity
     #   Specifies whether or not the graph can be reachable over the internet.
-    #   All access to graphs IAM authenticated. (`true` to enable, or `false`
-    #   to disable.
+    #   All access to graphs is IAM authenticated. (`true` to enable, or
+    #   `false` to disable).
     #
     # @option params [String] :kms_key_identifier
     #   Specifies a KMS key to use to encrypt data imported into the new
@@ -928,6 +954,89 @@ module Aws::NeptuneGraph
       req.send_request(options)
     end
 
+    # Execute an openCypher query. Currently, the SDK does not support
+    # parameterized queries. If you want to make a parameterized query call,
+    # you can use an HTTP request.
+    #
+    # 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
+    #
+    # <note markdown="1"> Non-parametrized queries are not considered for plan caching. You can
+    # force plan caching with `planCache=enabled`. The plan cache will be
+    # reused only for the same exact query. Slight variations in the query
+    # will not be able to reuse the query plan cache.
+    #
+    #  </note>
+    #
+    # @option params [required, String] :graph_identifier
+    #   The unique identifier of the Neptune Analytics graph.
+    #
+    # @option params [required, String] :query_string
+    #   The query string to be executed.
+    #
+    # @option params [required, String] :language
+    #   The query language the query is written in. Currently only openCypher
+    #   is supported.
+    #
+    # @option params [Hash<String,Hash,Array,String,Numeric,Boolean>] :parameters
+    #   The data parameters the query can use in JSON format. For example:
+    #   \\\{"name": "john", "age": 20\\}. (optional)
+    #
+    # @option params [String] :plan_cache
+    #   Query plan cache is a feature that saves the query plan and reuses it
+    #   on successive executions of the same query. This reduces query
+    #   latency, and works for both `READ` and `UPDATE` queries. The plan
+    #   cache is an LRU cache with a 5 minute TTL and a capacity of 1000.
+    #
+    # @option params [String] :explain_mode
+    #   The explain mode parameter returns a query explain instead of the
+    #   actual query results. A query explain can be used to gather insights
+    #   about the query execution such as planning decisions, time spent on
+    #   each operator, solutions flowing etc.
+    #
+    # @option params [Integer] :query_timeout_milliseconds
+    #   Specifies the query timeout duration, in milliseconds. (optional)
+    #
+    # @return [Types::ExecuteQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ExecuteQueryOutput#payload #payload} => IO
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.execute_query({
+    #     graph_identifier: "GraphIdentifier", # required
+    #     query_string: "String", # required
+    #     language: "OPEN_CYPHER", # required, accepts OPEN_CYPHER
+    #     parameters: {
+    #       "String" => {
+    #       },
+    #     },
+    #     plan_cache: "ENABLED", # accepts ENABLED, DISABLED, AUTO
+    #     explain_mode: "STATIC", # accepts STATIC, DETAILS
+    #     query_timeout_milliseconds: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.payload #=> IO
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ExecuteQuery AWS API Documentation
+    #
+    # @overload execute_query(params = {})
+    # @param [Hash] params ({})
+    def execute_query(params = {}, options = {}, &block)
+      req = build_request(:execute_query, params)
+      req.send_request(options, &block)
+    end
+
     # Gets information about a specified graph.
     #
     # @option params [required, String] :graph_identifier
@@ -1036,6 +1145,70 @@ module Aws::NeptuneGraph
       req.send_request(options)
     end
 
+    # Gets a graph summary for a property graph.
+    #
+    # @option params [required, String] :graph_identifier
+    #   The unique identifier of the Neptune Analytics graph.
+    #
+    # @option params [String] :mode
+    #   The summary mode can take one of two values: `basic` (the default),
+    #   and `detailed`.
+    #
+    # @return [Types::GetGraphSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetGraphSummaryOutput#version #version} => String
+    #   * {Types::GetGraphSummaryOutput#last_statistics_computation_time #last_statistics_computation_time} => Time
+    #   * {Types::GetGraphSummaryOutput#graph_summary #graph_summary} => Types::GraphDataSummary
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_graph_summary({
+    #     graph_identifier: "GraphIdentifier", # required
+    #     mode: "BASIC", # accepts BASIC, DETAILED
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.version #=> String
+    #   resp.last_statistics_computation_time #=> Time
+    #   resp.graph_summary.num_nodes #=> Integer
+    #   resp.graph_summary.num_edges #=> Integer
+    #   resp.graph_summary.num_node_labels #=> Integer
+    #   resp.graph_summary.num_edge_labels #=> Integer
+    #   resp.graph_summary.node_labels #=> Array
+    #   resp.graph_summary.node_labels[0] #=> String
+    #   resp.graph_summary.edge_labels #=> Array
+    #   resp.graph_summary.edge_labels[0] #=> String
+    #   resp.graph_summary.num_node_properties #=> Integer
+    #   resp.graph_summary.num_edge_properties #=> Integer
+    #   resp.graph_summary.node_properties #=> Array
+    #   resp.graph_summary.node_properties[0] #=> Hash
+    #   resp.graph_summary.node_properties[0]["String"] #=> Integer
+    #   resp.graph_summary.edge_properties #=> Array
+    #   resp.graph_summary.edge_properties[0] #=> Hash
+    #   resp.graph_summary.edge_properties[0]["String"] #=> Integer
+    #   resp.graph_summary.total_node_property_values #=> Integer
+    #   resp.graph_summary.total_edge_property_values #=> Integer
+    #   resp.graph_summary.node_structures #=> Array
+    #   resp.graph_summary.node_structures[0].count #=> Integer
+    #   resp.graph_summary.node_structures[0].node_properties #=> Array
+    #   resp.graph_summary.node_structures[0].node_properties[0] #=> String
+    #   resp.graph_summary.node_structures[0].distinct_outgoing_edge_labels #=> Array
+    #   resp.graph_summary.node_structures[0].distinct_outgoing_edge_labels[0] #=> String
+    #   resp.graph_summary.edge_structures #=> Array
+    #   resp.graph_summary.edge_structures[0].count #=> Integer
+    #   resp.graph_summary.edge_structures[0].edge_properties #=> Array
+    #   resp.graph_summary.edge_structures[0].edge_properties[0] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraphSummary AWS API Documentation
+    #
+    # @overload get_graph_summary(params = {})
+    # @param [Hash] params ({})
+    def get_graph_summary(params = {}, options = {})
+      req = build_request(:get_graph_summary, params)
+      req.send_request(options)
+    end
+
     # Retrieves a specified import task.
     #
     # @option params [required, String] :task_identifier
@@ -1143,6 +1316,52 @@ module Aws::NeptuneGraph
       req.send_request(options)
     end
 
+    # Retrieves the status of a specified query.
+    #
+    # <note markdown="1"> 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.
+    #
+    #  </note>
+    #
+    # @option params [required, String] :graph_identifier
+    #   The unique identifier of the Neptune Analytics graph.
+    #
+    # @option params [required, String] :query_id
+    #   The ID of the query in question.
+    #
+    # @return [Types::GetQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetQueryOutput#id #id} => String
+    #   * {Types::GetQueryOutput#query_string #query_string} => String
+    #   * {Types::GetQueryOutput#waited #waited} => Integer
+    #   * {Types::GetQueryOutput#elapsed #elapsed} => Integer
+    #   * {Types::GetQueryOutput#state #state} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_query({
+    #     graph_identifier: "GraphIdentifier", # required
+    #     query_id: "String", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.id #=> String
+    #   resp.query_string #=> String
+    #   resp.waited #=> Integer
+    #   resp.elapsed #=> Integer
+    #   resp.state #=> String, one of "RUNNING", "WAITING", "CANCELLING"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetQuery AWS API Documentation
+    #
+    # @overload get_query(params = {})
+    # @param [Hash] params ({})
+    def get_query(params = {}, options = {})
+      req = build_request(:get_query, params)
+      req.send_request(options)
+    end
+
     # Lists available snapshots of a specified Neptune Analytics graph.
     #
     # @option params [String] :graph_identifier
@@ -1363,6 +1582,47 @@ module Aws::NeptuneGraph
       req.send_request(options)
     end
 
+    # Lists active openCypher queries.
+    #
+    # @option params [required, String] :graph_identifier
+    #   The unique identifier of the Neptune Analytics graph.
+    #
+    # @option params [required, Integer] :max_results
+    #   The maximum number of results to be fetched by the API.
+    #
+    # @option params [String] :state
+    #   Filtered list of queries based on state.
+    #
+    # @return [Types::ListQueriesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListQueriesOutput#queries #queries} => Array&lt;Types::QuerySummary&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_queries({
+    #     graph_identifier: "GraphIdentifier", # required
+    #     max_results: 1, # required
+    #     state: "ALL", # accepts ALL, RUNNING, WAITING, CANCELLING
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.queries #=> Array
+    #   resp.queries[0].id #=> String
+    #   resp.queries[0].query_string #=> String
+    #   resp.queries[0].waited #=> Integer
+    #   resp.queries[0].elapsed #=> Integer
+    #   resp.queries[0].state #=> String, one of "RUNNING", "WAITING", "CANCELLING"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListQueries AWS API Documentation
+    #
+    # @overload list_queries(params = {})
+    # @param [Hash] params ({})
+    def list_queries(params = {}, options = {})
+      req = build_request(:list_queries, params)
+      req.send_request(options)
+    end
+
     # Lists tags associated with a specified resource.
     #
     # @option params [required, String] :resource_arn
@@ -1487,8 +1747,8 @@ module Aws::NeptuneGraph
     #
     # @option params [Boolean] :public_connectivity
     #   Specifies whether or not the graph can be reachable over the internet.
-    #   All access to graphs IAM authenticated. (`true` to enable, or `false`
-    #   to disable).
+    #   All access to graphs is IAM authenticated. (`true` to enable, or
+    #   `false` to disable).
     #
     # @return [Types::RestoreGraphFromSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1624,8 +1884,8 @@ module Aws::NeptuneGraph
     #
     # @option params [Boolean] :public_connectivity
     #   Specifies whether or not the graph can be reachable over the internet.
-    #   All access to graphs IAM authenticated. (`true` to enable, or `false`
-    #   to disable.
+    #   All access to graphs is IAM authenticated. (`true` to enable, or
+    #   `false` to disable.
     #
     # @option params [Integer] :provisioned_memory
     #   The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to
@@ -1703,7 +1963,7 @@ module Aws::NeptuneGraph
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-neptunegraph'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.4.0'
       Seahorse::Client::Request.new(handlers, context)
     end