aws-sdk-neptunegraph 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6d92d892f5b9dfc5079992b0aad0658dabbe87b1b4df8ac9ef85d9a0b77dc6aa
4
- data.tar.gz: d2877c397f9d8356b1fcea8fb9cbb3832b6253c0686c1fbc05957fdd4909b5cf
3
+ metadata.gz: 68c40b0b208ef29b39a1490b12aea910ce2c1eeae91bd176642e160467e9eac0
4
+ data.tar.gz: 17c892aaca6ac33d8babe21aaee2a778c3b4a08fdbed5a302f9e16ae1965cd10
5
5
  SHA512:
6
- metadata.gz: 505643a54e061aeda54f236192b1315c31d70746d468faf9cc9fdc9e392b0f21f6514f1ea740e8fd8e4892c3ec0902a0fb3fc162c50f4244f68445372914756d
7
- data.tar.gz: 4addc61e4ac2976316e66063cba76db1570b335e8c52782728fe543b621c7cb2d98d1f98afa4e036da59919f85bb26466b186d016c7ed9be7d907a675d91dc42
6
+ metadata.gz: 758c9f0522ecc11d875b17e89f457a054d021d35eabe387ef2cec8d9df2024246170fa8062a18284ba6b39128b056a958c6f3065781198ef4acfb3ffb104c305
7
+ data.tar.gz: 6656d1a65eb40841e70ee94cd46ebf570ae44579d6f69006a18481f0b319bd9b65db6c4d6e2e5954f9103336715465b309699cb13e9dedb85b335652440f0c50
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.3.0 (2024-02-01)
5
+ ------------------
6
+
7
+ * Feature - Adding new APIs in SDK for Amazon Neptune Analytics. These APIs include operations to execute, cancel, list queries and get the graph summary.
8
+
4
9
  1.2.0 (2024-01-26)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.0
1
+ 1.3.0
@@ -388,7 +388,7 @@ module Aws::NeptuneGraph
388
388
 
389
389
  # @!group API Operations
390
390
 
391
- # Deletes the specified import task
391
+ # Deletes the specified import task.
392
392
  #
393
393
  # @option params [required, String] :task_identifier
394
394
  # The unique identifier of the import task.
@@ -426,6 +426,32 @@ module Aws::NeptuneGraph
426
426
  req.send_request(options)
427
427
  end
428
428
 
429
+ # Cancels a specified query.
430
+ #
431
+ # @option params [required, String] :graph_identifier
432
+ # The unique identifier of the Neptune Analytics graph.
433
+ #
434
+ # @option params [required, String] :query_id
435
+ # The unique identifier of the query to cancel.
436
+ #
437
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
438
+ #
439
+ # @example Request syntax with placeholder values
440
+ #
441
+ # resp = client.cancel_query({
442
+ # graph_identifier: "GraphIdentifier", # required
443
+ # query_id: "String", # required
444
+ # })
445
+ #
446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelQuery AWS API Documentation
447
+ #
448
+ # @overload cancel_query(params = {})
449
+ # @param [Hash] params ({})
450
+ def cancel_query(params = {}, options = {})
451
+ req = build_request(:cancel_query, params)
452
+ req.send_request(options)
453
+ end
454
+
429
455
  # Creates a new Neptune Analytics graph.
430
456
  #
431
457
  # @option params [required, String] :graph_name
@@ -454,7 +480,7 @@ module Aws::NeptuneGraph
454
480
  # Max = 65,535
455
481
  #
456
482
  # @option params [Integer] :replica_count
457
- # The number of replicas in other AZs. Min =0, Max = 2, Default =1
483
+ # The number of replicas in other AZs. Min =0, Max = 2, Default = 1.
458
484
  #
459
485
  # @option params [Boolean] :deletion_protection
460
486
  # Indicates whether or not to enable deletion protection on the graph.
@@ -610,7 +636,7 @@ module Aws::NeptuneGraph
610
636
  # @option params [Boolean] :public_connectivity
611
637
  # Specifies whether or not the graph can be reachable over the internet.
612
638
  # All access to graphs IAM authenticated. (`true` to enable, or `false`
613
- # to disable.
639
+ # to disable).
614
640
  #
615
641
  # @option params [String] :kms_key_identifier
616
642
  # Specifies a KMS key to use to encrypt data imported into the new
@@ -928,6 +954,70 @@ module Aws::NeptuneGraph
928
954
  req.send_request(options)
929
955
  end
930
956
 
957
+ # Execute an openCypher query. Currently, the SDK does not support
958
+ # parameterized queries. If you want to make a parameterized query call,
959
+ # you can use an HTTP request.
960
+ #
961
+ # <note markdown="1"> Non-parametrized queries are not considered for plan caching. You can
962
+ # force plan caching with `planCache=enabled`. The plan cache will be
963
+ # reused only for the same exact query. Slight variations in the query
964
+ # will not be able to reuse the query plan cache.
965
+ #
966
+ # </note>
967
+ #
968
+ # @option params [required, String] :graph_identifier
969
+ # The unique identifier of the Neptune Analytics graph.
970
+ #
971
+ # @option params [required, String] :query_string
972
+ # The query string to be executed.
973
+ #
974
+ # @option params [required, String] :language
975
+ # The query language the query is written in. Currently only openCypher
976
+ # is supported.
977
+ #
978
+ # @option params [String] :plan_cache
979
+ # Query plan cache is a feature that saves the query plan and reuses it
980
+ # on successive executions of the same query. This reduces query
981
+ # latency, and works for both `READ` and `UPDATE` queries. The plan
982
+ # cache is an LRU cache with a 5 minute TTL and a capacity of 1000.
983
+ #
984
+ # @option params [String] :explain_mode
985
+ # The explain mode parameter returns a query explain instead of the
986
+ # actual query results. A query explain can be used to gather insights
987
+ # about the query execution such as planning decisions, time spent on
988
+ # each operator, solutions flowing etc.
989
+ #
990
+ # @option params [Integer] :query_timeout_milliseconds
991
+ # Specifies the query timeout duration, in milliseconds. (optional)
992
+ #
993
+ # @return [Types::ExecuteQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
994
+ #
995
+ # * {Types::ExecuteQueryOutput#payload #payload} => IO
996
+ #
997
+ # @example Request syntax with placeholder values
998
+ #
999
+ # resp = client.execute_query({
1000
+ # graph_identifier: "GraphIdentifier", # required
1001
+ # query_string: "String", # required
1002
+ # language: "OPEN_CYPHER", # required, accepts OPEN_CYPHER
1003
+ # plan_cache: "ENABLED", # accepts ENABLED, DISABLED, AUTO
1004
+ # explain_mode: "STATIC", # accepts STATIC, DETAILS
1005
+ # query_timeout_milliseconds: 1,
1006
+ # })
1007
+ #
1008
+ # @example Response structure
1009
+ #
1010
+ # resp.payload #=> IO
1011
+ #
1012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ExecuteQuery AWS API Documentation
1013
+ #
1014
+ # @overload execute_query(params = {})
1015
+ # @param [Hash] params ({})
1016
+ def execute_query(params = {}, options = {}, &block)
1017
+ req = build_request(:execute_query, params)
1018
+ req.send_request(options, &block)
1019
+ end
1020
+
931
1021
  # Gets information about a specified graph.
932
1022
  #
933
1023
  # @option params [required, String] :graph_identifier
@@ -1036,6 +1126,70 @@ module Aws::NeptuneGraph
1036
1126
  req.send_request(options)
1037
1127
  end
1038
1128
 
1129
+ # Gets a graph summary for a property graph.
1130
+ #
1131
+ # @option params [required, String] :graph_identifier
1132
+ # The unique identifier of the Neptune Analytics graph.
1133
+ #
1134
+ # @option params [String] :mode
1135
+ # The summary mode can take one of two values: `basic` (the default),
1136
+ # and `detailed`.
1137
+ #
1138
+ # @return [Types::GetGraphSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1139
+ #
1140
+ # * {Types::GetGraphSummaryOutput#version #version} => String
1141
+ # * {Types::GetGraphSummaryOutput#last_statistics_computation_time #last_statistics_computation_time} => Time
1142
+ # * {Types::GetGraphSummaryOutput#graph_summary #graph_summary} => Types::GraphDataSummary
1143
+ #
1144
+ # @example Request syntax with placeholder values
1145
+ #
1146
+ # resp = client.get_graph_summary({
1147
+ # graph_identifier: "GraphIdentifier", # required
1148
+ # mode: "BASIC", # accepts BASIC, DETAILED
1149
+ # })
1150
+ #
1151
+ # @example Response structure
1152
+ #
1153
+ # resp.version #=> String
1154
+ # resp.last_statistics_computation_time #=> Time
1155
+ # resp.graph_summary.num_nodes #=> Integer
1156
+ # resp.graph_summary.num_edges #=> Integer
1157
+ # resp.graph_summary.num_node_labels #=> Integer
1158
+ # resp.graph_summary.num_edge_labels #=> Integer
1159
+ # resp.graph_summary.node_labels #=> Array
1160
+ # resp.graph_summary.node_labels[0] #=> String
1161
+ # resp.graph_summary.edge_labels #=> Array
1162
+ # resp.graph_summary.edge_labels[0] #=> String
1163
+ # resp.graph_summary.num_node_properties #=> Integer
1164
+ # resp.graph_summary.num_edge_properties #=> Integer
1165
+ # resp.graph_summary.node_properties #=> Array
1166
+ # resp.graph_summary.node_properties[0] #=> Hash
1167
+ # resp.graph_summary.node_properties[0]["String"] #=> Integer
1168
+ # resp.graph_summary.edge_properties #=> Array
1169
+ # resp.graph_summary.edge_properties[0] #=> Hash
1170
+ # resp.graph_summary.edge_properties[0]["String"] #=> Integer
1171
+ # resp.graph_summary.total_node_property_values #=> Integer
1172
+ # resp.graph_summary.total_edge_property_values #=> Integer
1173
+ # resp.graph_summary.node_structures #=> Array
1174
+ # resp.graph_summary.node_structures[0].count #=> Integer
1175
+ # resp.graph_summary.node_structures[0].node_properties #=> Array
1176
+ # resp.graph_summary.node_structures[0].node_properties[0] #=> String
1177
+ # resp.graph_summary.node_structures[0].distinct_outgoing_edge_labels #=> Array
1178
+ # resp.graph_summary.node_structures[0].distinct_outgoing_edge_labels[0] #=> String
1179
+ # resp.graph_summary.edge_structures #=> Array
1180
+ # resp.graph_summary.edge_structures[0].count #=> Integer
1181
+ # resp.graph_summary.edge_structures[0].edge_properties #=> Array
1182
+ # resp.graph_summary.edge_structures[0].edge_properties[0] #=> String
1183
+ #
1184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraphSummary AWS API Documentation
1185
+ #
1186
+ # @overload get_graph_summary(params = {})
1187
+ # @param [Hash] params ({})
1188
+ def get_graph_summary(params = {}, options = {})
1189
+ req = build_request(:get_graph_summary, params)
1190
+ req.send_request(options)
1191
+ end
1192
+
1039
1193
  # Retrieves a specified import task.
1040
1194
  #
1041
1195
  # @option params [required, String] :task_identifier
@@ -1143,6 +1297,46 @@ module Aws::NeptuneGraph
1143
1297
  req.send_request(options)
1144
1298
  end
1145
1299
 
1300
+ # Retrieves the status of a specified query.
1301
+ #
1302
+ # @option params [required, String] :graph_identifier
1303
+ # The unique identifier of the Neptune Analytics graph.
1304
+ #
1305
+ # @option params [required, String] :query_id
1306
+ # The ID of the query in question.
1307
+ #
1308
+ # @return [Types::GetQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1309
+ #
1310
+ # * {Types::GetQueryOutput#id #id} => String
1311
+ # * {Types::GetQueryOutput#query_string #query_string} => String
1312
+ # * {Types::GetQueryOutput#waited #waited} => Integer
1313
+ # * {Types::GetQueryOutput#elapsed #elapsed} => Integer
1314
+ # * {Types::GetQueryOutput#state #state} => String
1315
+ #
1316
+ # @example Request syntax with placeholder values
1317
+ #
1318
+ # resp = client.get_query({
1319
+ # graph_identifier: "GraphIdentifier", # required
1320
+ # query_id: "String", # required
1321
+ # })
1322
+ #
1323
+ # @example Response structure
1324
+ #
1325
+ # resp.id #=> String
1326
+ # resp.query_string #=> String
1327
+ # resp.waited #=> Integer
1328
+ # resp.elapsed #=> Integer
1329
+ # resp.state #=> String, one of "RUNNING", "WAITING", "CANCELLING"
1330
+ #
1331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetQuery AWS API Documentation
1332
+ #
1333
+ # @overload get_query(params = {})
1334
+ # @param [Hash] params ({})
1335
+ def get_query(params = {}, options = {})
1336
+ req = build_request(:get_query, params)
1337
+ req.send_request(options)
1338
+ end
1339
+
1146
1340
  # Lists available snapshots of a specified Neptune Analytics graph.
1147
1341
  #
1148
1342
  # @option params [String] :graph_identifier
@@ -1363,6 +1557,47 @@ module Aws::NeptuneGraph
1363
1557
  req.send_request(options)
1364
1558
  end
1365
1559
 
1560
+ # Lists active openCypher queries.
1561
+ #
1562
+ # @option params [required, String] :graph_identifier
1563
+ # The unique identifier of the Neptune Analytics graph.
1564
+ #
1565
+ # @option params [required, Integer] :max_results
1566
+ # The maximum number of results to be fetched by the API.
1567
+ #
1568
+ # @option params [String] :state
1569
+ # Filtered list of queries based on state.
1570
+ #
1571
+ # @return [Types::ListQueriesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1572
+ #
1573
+ # * {Types::ListQueriesOutput#queries #queries} => Array&lt;Types::QuerySummary&gt;
1574
+ #
1575
+ # @example Request syntax with placeholder values
1576
+ #
1577
+ # resp = client.list_queries({
1578
+ # graph_identifier: "GraphIdentifier", # required
1579
+ # max_results: 1, # required
1580
+ # state: "ALL", # accepts ALL, RUNNING, WAITING, CANCELLING
1581
+ # })
1582
+ #
1583
+ # @example Response structure
1584
+ #
1585
+ # resp.queries #=> Array
1586
+ # resp.queries[0].id #=> String
1587
+ # resp.queries[0].query_string #=> String
1588
+ # resp.queries[0].waited #=> Integer
1589
+ # resp.queries[0].elapsed #=> Integer
1590
+ # resp.queries[0].state #=> String, one of "RUNNING", "WAITING", "CANCELLING"
1591
+ #
1592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListQueries AWS API Documentation
1593
+ #
1594
+ # @overload list_queries(params = {})
1595
+ # @param [Hash] params ({})
1596
+ def list_queries(params = {}, options = {})
1597
+ req = build_request(:list_queries, params)
1598
+ req.send_request(options)
1599
+ end
1600
+
1366
1601
  # Lists tags associated with a specified resource.
1367
1602
  #
1368
1603
  # @option params [required, String] :resource_arn
@@ -1703,7 +1938,7 @@ module Aws::NeptuneGraph
1703
1938
  params: params,
1704
1939
  config: config)
1705
1940
  context[:gem_name] = 'aws-sdk-neptunegraph'
1706
- context[:gem_version] = '1.2.0'
1941
+ context[:gem_version] = '1.3.0'
1707
1942
  Seahorse::Client::Request.new(handlers, context)
1708
1943
  end
1709
1944