aws-sdk-neptunegraph 1.2.0 → 1.4.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-neptunegraph/client.rb +271 -11
- data/lib/aws-sdk-neptunegraph/client_api.rb +225 -0
- data/lib/aws-sdk-neptunegraph/endpoints.rb +75 -0
- data/lib/aws-sdk-neptunegraph/errors.rb +37 -0
- data/lib/aws-sdk-neptunegraph/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-neptunegraph/types.rb +410 -13
- data/lib/aws-sdk-neptunegraph.rb +1 -1
- data/sig/client.rbs +64 -0
- data/sig/errors.rbs +7 -0
- data/sig/types.rbs +113 -0
- metadata +2 -2
@@ -10,6 +10,20 @@
|
|
10
10
|
module Aws::NeptuneGraph
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Raised in case of an authentication or authorization failure.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# A message describing the problem.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/AccessDeniedException AWS API Documentation
|
20
|
+
#
|
21
|
+
class AccessDeniedException < Struct.new(
|
22
|
+
:message)
|
23
|
+
SENSITIVE = []
|
24
|
+
include Aws::Structure
|
25
|
+
end
|
26
|
+
|
13
27
|
# @!attribute [rw] task_identifier
|
14
28
|
# The unique identifier of the import task.
|
15
29
|
# @return [String]
|
@@ -33,7 +47,7 @@ module Aws::NeptuneGraph
|
|
33
47
|
# @!attribute [rw] source
|
34
48
|
# A URL identifying to the location of the data to be imported. This
|
35
49
|
# can be an Amazon S3 path, or can point to a Neptune database
|
36
|
-
# endpoint or snapshot
|
50
|
+
# endpoint or snapshot.
|
37
51
|
# @return [String]
|
38
52
|
#
|
39
53
|
# @!attribute [rw] format
|
@@ -70,6 +84,23 @@ module Aws::NeptuneGraph
|
|
70
84
|
include Aws::Structure
|
71
85
|
end
|
72
86
|
|
87
|
+
# @!attribute [rw] graph_identifier
|
88
|
+
# The unique identifier of the Neptune Analytics graph.
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] query_id
|
92
|
+
# The unique identifier of the query to cancel.
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelQueryInput AWS API Documentation
|
96
|
+
#
|
97
|
+
class CancelQueryInput < Struct.new(
|
98
|
+
:graph_identifier,
|
99
|
+
:query_id)
|
100
|
+
SENSITIVE = []
|
101
|
+
include Aws::Structure
|
102
|
+
end
|
103
|
+
|
73
104
|
# Raised when a conflict is encountered.
|
74
105
|
#
|
75
106
|
# @!attribute [rw] message
|
@@ -105,8 +136,8 @@ module Aws::NeptuneGraph
|
|
105
136
|
#
|
106
137
|
# @!attribute [rw] public_connectivity
|
107
138
|
# Specifies whether or not the graph can be reachable over the
|
108
|
-
# internet. All access to graphs IAM authenticated. (`true` to
|
109
|
-
# or `false` to disable.
|
139
|
+
# internet. All access to graphs is IAM authenticated. (`true` to
|
140
|
+
# enable, or `false` to disable.
|
110
141
|
# @return [Boolean]
|
111
142
|
#
|
112
143
|
# @!attribute [rw] kms_key_identifier
|
@@ -120,7 +151,7 @@ module Aws::NeptuneGraph
|
|
120
151
|
# @return [Types::VectorSearchConfiguration]
|
121
152
|
#
|
122
153
|
# @!attribute [rw] replica_count
|
123
|
-
# The number of replicas in other AZs. Min =0, Max = 2, Default =1
|
154
|
+
# The number of replicas in other AZs. Min =0, Max = 2, Default = 1.
|
124
155
|
# @return [Integer]
|
125
156
|
#
|
126
157
|
# @!attribute [rw] deletion_protection
|
@@ -188,7 +219,7 @@ module Aws::NeptuneGraph
|
|
188
219
|
#
|
189
220
|
# @!attribute [rw] public_connectivity
|
190
221
|
# Specifies whether or not the graph can be reachable over the
|
191
|
-
# internet. All access to graphs IAM authenticated.
|
222
|
+
# internet. All access to graphs is IAM authenticated.
|
192
223
|
# @return [Boolean]
|
193
224
|
#
|
194
225
|
# @!attribute [rw] vector_search_configuration
|
@@ -327,8 +358,8 @@ module Aws::NeptuneGraph
|
|
327
358
|
#
|
328
359
|
# @!attribute [rw] public_connectivity
|
329
360
|
# Specifies whether or not the graph can be reachable over the
|
330
|
-
# internet. All access to graphs IAM authenticated. (`true` to
|
331
|
-
# or `false` to disable.
|
361
|
+
# internet. All access to graphs is IAM authenticated. (`true` to
|
362
|
+
# enable, or `false` to disable).
|
332
363
|
# @return [Boolean]
|
333
364
|
#
|
334
365
|
# @!attribute [rw] kms_key_identifier
|
@@ -743,6 +774,87 @@ module Aws::NeptuneGraph
|
|
743
774
|
include Aws::Structure
|
744
775
|
end
|
745
776
|
|
777
|
+
# Contains information about an edge in a Neptune Analytics graph.
|
778
|
+
#
|
779
|
+
# @!attribute [rw] count
|
780
|
+
# The number of instances of the edge in the graph.
|
781
|
+
# @return [Integer]
|
782
|
+
#
|
783
|
+
# @!attribute [rw] edge_properties
|
784
|
+
# A list of the properties associated with the edge.
|
785
|
+
# @return [Array<String>]
|
786
|
+
#
|
787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/EdgeStructure AWS API Documentation
|
788
|
+
#
|
789
|
+
class EdgeStructure < Struct.new(
|
790
|
+
:count,
|
791
|
+
:edge_properties)
|
792
|
+
SENSITIVE = []
|
793
|
+
include Aws::Structure
|
794
|
+
end
|
795
|
+
|
796
|
+
# @!attribute [rw] graph_identifier
|
797
|
+
# The unique identifier of the Neptune Analytics graph.
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] query_string
|
801
|
+
# The query string to be executed.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] language
|
805
|
+
# The query language the query is written in. Currently only
|
806
|
+
# openCypher is supported.
|
807
|
+
# @return [String]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] parameters
|
810
|
+
# The data parameters the query can use in JSON format. For example:
|
811
|
+
# \\\{"name": "john", "age": 20\\}. (optional)
|
812
|
+
# @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
|
813
|
+
#
|
814
|
+
# @!attribute [rw] plan_cache
|
815
|
+
# Query plan cache is a feature that saves the query plan and reuses
|
816
|
+
# it on successive executions of the same query. This reduces query
|
817
|
+
# latency, and works for both `READ` and `UPDATE` queries. The plan
|
818
|
+
# cache is an LRU cache with a 5 minute TTL and a capacity of 1000.
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @!attribute [rw] explain_mode
|
822
|
+
# The explain mode parameter returns a query explain instead of the
|
823
|
+
# actual query results. A query explain can be used to gather insights
|
824
|
+
# about the query execution such as planning decisions, time spent on
|
825
|
+
# each operator, solutions flowing etc.
|
826
|
+
# @return [String]
|
827
|
+
#
|
828
|
+
# @!attribute [rw] query_timeout_milliseconds
|
829
|
+
# Specifies the query timeout duration, in milliseconds. (optional)
|
830
|
+
# @return [Integer]
|
831
|
+
#
|
832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ExecuteQueryInput AWS API Documentation
|
833
|
+
#
|
834
|
+
class ExecuteQueryInput < Struct.new(
|
835
|
+
:graph_identifier,
|
836
|
+
:query_string,
|
837
|
+
:language,
|
838
|
+
:parameters,
|
839
|
+
:plan_cache,
|
840
|
+
:explain_mode,
|
841
|
+
:query_timeout_milliseconds)
|
842
|
+
SENSITIVE = []
|
843
|
+
include Aws::Structure
|
844
|
+
end
|
845
|
+
|
846
|
+
# @!attribute [rw] payload
|
847
|
+
# The query results.
|
848
|
+
# @return [IO]
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ExecuteQueryOutput AWS API Documentation
|
851
|
+
#
|
852
|
+
class ExecuteQueryOutput < Struct.new(
|
853
|
+
:payload)
|
854
|
+
SENSITIVE = []
|
855
|
+
include Aws::Structure
|
856
|
+
end
|
857
|
+
|
746
858
|
# @!attribute [rw] graph_identifier
|
747
859
|
# The unique identifier of the Neptune Analytics graph.
|
748
860
|
# @return [String]
|
@@ -899,6 +1011,47 @@ module Aws::NeptuneGraph
|
|
899
1011
|
include Aws::Structure
|
900
1012
|
end
|
901
1013
|
|
1014
|
+
# @!attribute [rw] graph_identifier
|
1015
|
+
# The unique identifier of the Neptune Analytics graph.
|
1016
|
+
# @return [String]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] mode
|
1019
|
+
# The summary mode can take one of two values: `basic` (the default),
|
1020
|
+
# and `detailed`.
|
1021
|
+
# @return [String]
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraphSummaryInput AWS API Documentation
|
1024
|
+
#
|
1025
|
+
class GetGraphSummaryInput < Struct.new(
|
1026
|
+
:graph_identifier,
|
1027
|
+
:mode)
|
1028
|
+
SENSITIVE = []
|
1029
|
+
include Aws::Structure
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# @!attribute [rw] version
|
1033
|
+
# Display the version of this tool.
|
1034
|
+
# @return [String]
|
1035
|
+
#
|
1036
|
+
# @!attribute [rw] last_statistics_computation_time
|
1037
|
+
# The timestamp, in ISO 8601 format, of the time at which Neptune
|
1038
|
+
# Analytics last computed statistics.
|
1039
|
+
# @return [Time]
|
1040
|
+
#
|
1041
|
+
# @!attribute [rw] graph_summary
|
1042
|
+
# The graph summary.
|
1043
|
+
# @return [Types::GraphDataSummary]
|
1044
|
+
#
|
1045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraphSummaryOutput AWS API Documentation
|
1046
|
+
#
|
1047
|
+
class GetGraphSummaryOutput < Struct.new(
|
1048
|
+
:version,
|
1049
|
+
:last_statistics_computation_time,
|
1050
|
+
:graph_summary)
|
1051
|
+
SENSITIVE = []
|
1052
|
+
include Aws::Structure
|
1053
|
+
end
|
1054
|
+
|
902
1055
|
# @!attribute [rw] task_identifier
|
903
1056
|
# The unique identifier of the import task.
|
904
1057
|
# @return [String]
|
@@ -1057,6 +1210,138 @@ module Aws::NeptuneGraph
|
|
1057
1210
|
include Aws::Structure
|
1058
1211
|
end
|
1059
1212
|
|
1213
|
+
# @!attribute [rw] graph_identifier
|
1214
|
+
# The unique identifier of the Neptune Analytics graph.
|
1215
|
+
# @return [String]
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] query_id
|
1218
|
+
# The ID of the query in question.
|
1219
|
+
# @return [String]
|
1220
|
+
#
|
1221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetQueryInput AWS API Documentation
|
1222
|
+
#
|
1223
|
+
class GetQueryInput < Struct.new(
|
1224
|
+
:graph_identifier,
|
1225
|
+
:query_id)
|
1226
|
+
SENSITIVE = []
|
1227
|
+
include Aws::Structure
|
1228
|
+
end
|
1229
|
+
|
1230
|
+
# @!attribute [rw] id
|
1231
|
+
# The ID of the query in question.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] query_string
|
1235
|
+
# The query in question.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] waited
|
1239
|
+
# Indicates how long the query waited, in milliseconds.
|
1240
|
+
# @return [Integer]
|
1241
|
+
#
|
1242
|
+
# @!attribute [rw] elapsed
|
1243
|
+
# The number of milliseconds the query has been running.
|
1244
|
+
# @return [Integer]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] state
|
1247
|
+
# State of the query.
|
1248
|
+
# @return [String]
|
1249
|
+
#
|
1250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetQueryOutput AWS API Documentation
|
1251
|
+
#
|
1252
|
+
class GetQueryOutput < Struct.new(
|
1253
|
+
:id,
|
1254
|
+
:query_string,
|
1255
|
+
:waited,
|
1256
|
+
:elapsed,
|
1257
|
+
:state)
|
1258
|
+
SENSITIVE = []
|
1259
|
+
include Aws::Structure
|
1260
|
+
end
|
1261
|
+
|
1262
|
+
# Summary information about the graph.
|
1263
|
+
#
|
1264
|
+
# @!attribute [rw] num_nodes
|
1265
|
+
# The number of nodes in the graph.
|
1266
|
+
# @return [Integer]
|
1267
|
+
#
|
1268
|
+
# @!attribute [rw] num_edges
|
1269
|
+
# The number of edges in the graph.
|
1270
|
+
# @return [Integer]
|
1271
|
+
#
|
1272
|
+
# @!attribute [rw] num_node_labels
|
1273
|
+
# The number of distinct node labels in the graph.
|
1274
|
+
# @return [Integer]
|
1275
|
+
#
|
1276
|
+
# @!attribute [rw] num_edge_labels
|
1277
|
+
# The number of unique edge labels in the graph.
|
1278
|
+
# @return [Integer]
|
1279
|
+
#
|
1280
|
+
# @!attribute [rw] node_labels
|
1281
|
+
# A list of distinct node labels in the graph.
|
1282
|
+
# @return [Array<String>]
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] edge_labels
|
1285
|
+
# A list of the edge labels in the graph.
|
1286
|
+
# @return [Array<String>]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] num_node_properties
|
1289
|
+
# The number of distinct node properties in the graph.
|
1290
|
+
# @return [Integer]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] num_edge_properties
|
1293
|
+
# The number of edge properties in the graph.
|
1294
|
+
# @return [Integer]
|
1295
|
+
#
|
1296
|
+
# @!attribute [rw] node_properties
|
1297
|
+
# A list of the distinct node properties in the graph, along with the
|
1298
|
+
# count of nodes where each property is used.
|
1299
|
+
# @return [Array<Hash<String,Integer>>]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] edge_properties
|
1302
|
+
# A list of the distinct edge properties in the graph, along with the
|
1303
|
+
# count of edges where each property is used.
|
1304
|
+
# @return [Array<Hash<String,Integer>>]
|
1305
|
+
#
|
1306
|
+
# @!attribute [rw] total_node_property_values
|
1307
|
+
# The total number of usages of all node properties.
|
1308
|
+
# @return [Integer]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] total_edge_property_values
|
1311
|
+
# The total number of usages of all edge properties.
|
1312
|
+
# @return [Integer]
|
1313
|
+
#
|
1314
|
+
# @!attribute [rw] node_structures
|
1315
|
+
# This field is only present when the requested mode is DETAILED. It
|
1316
|
+
# contains a list of node structures.
|
1317
|
+
# @return [Array<Types::NodeStructure>]
|
1318
|
+
#
|
1319
|
+
# @!attribute [rw] edge_structures
|
1320
|
+
# This field is only present when the requested mode is DETAILED. It
|
1321
|
+
# contains a list of edge structures.
|
1322
|
+
# @return [Array<Types::EdgeStructure>]
|
1323
|
+
#
|
1324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GraphDataSummary AWS API Documentation
|
1325
|
+
#
|
1326
|
+
class GraphDataSummary < Struct.new(
|
1327
|
+
:num_nodes,
|
1328
|
+
:num_edges,
|
1329
|
+
:num_node_labels,
|
1330
|
+
:num_edge_labels,
|
1331
|
+
:node_labels,
|
1332
|
+
:edge_labels,
|
1333
|
+
:num_node_properties,
|
1334
|
+
:num_edge_properties,
|
1335
|
+
:node_properties,
|
1336
|
+
:edge_properties,
|
1337
|
+
:total_node_property_values,
|
1338
|
+
:total_edge_property_values,
|
1339
|
+
:node_structures,
|
1340
|
+
:edge_structures)
|
1341
|
+
SENSITIVE = []
|
1342
|
+
include Aws::Structure
|
1343
|
+
end
|
1344
|
+
|
1060
1345
|
# Details about a graph snapshot.
|
1061
1346
|
#
|
1062
1347
|
# @!attribute [rw] id
|
@@ -1512,6 +1797,40 @@ module Aws::NeptuneGraph
|
|
1512
1797
|
include Aws::Structure
|
1513
1798
|
end
|
1514
1799
|
|
1800
|
+
# @!attribute [rw] graph_identifier
|
1801
|
+
# The unique identifier of the Neptune Analytics graph.
|
1802
|
+
# @return [String]
|
1803
|
+
#
|
1804
|
+
# @!attribute [rw] max_results
|
1805
|
+
# The maximum number of results to be fetched by the API.
|
1806
|
+
# @return [Integer]
|
1807
|
+
#
|
1808
|
+
# @!attribute [rw] state
|
1809
|
+
# Filtered list of queries based on state.
|
1810
|
+
# @return [String]
|
1811
|
+
#
|
1812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListQueriesInput AWS API Documentation
|
1813
|
+
#
|
1814
|
+
class ListQueriesInput < Struct.new(
|
1815
|
+
:graph_identifier,
|
1816
|
+
:max_results,
|
1817
|
+
:state)
|
1818
|
+
SENSITIVE = []
|
1819
|
+
include Aws::Structure
|
1820
|
+
end
|
1821
|
+
|
1822
|
+
# @!attribute [rw] queries
|
1823
|
+
# A list of current openCypher queries.
|
1824
|
+
# @return [Array<Types::QuerySummary>]
|
1825
|
+
#
|
1826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListQueriesOutput AWS API Documentation
|
1827
|
+
#
|
1828
|
+
class ListQueriesOutput < Struct.new(
|
1829
|
+
:queries)
|
1830
|
+
SENSITIVE = []
|
1831
|
+
include Aws::Structure
|
1832
|
+
end
|
1833
|
+
|
1515
1834
|
# @!attribute [rw] resource_arn
|
1516
1835
|
# The ARN of the resource.
|
1517
1836
|
# @return [String]
|
@@ -1562,7 +1881,7 @@ module Aws::NeptuneGraph
|
|
1562
1881
|
# Neptune Analytics currently does not support user defined edge ids.
|
1563
1882
|
# The edge ids are not imported by default. They are imported if
|
1564
1883
|
# *preserveEdgeIds* is set to true, and ids are stored as properties
|
1565
|
-
# on the relationships with the property name neptuneEdgeId
|
1884
|
+
# on the relationships with the property name *neptuneEdgeId*.
|
1566
1885
|
# @return [Boolean]
|
1567
1886
|
#
|
1568
1887
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/NeptuneImportOptions AWS API Documentation
|
@@ -1576,6 +1895,30 @@ module Aws::NeptuneGraph
|
|
1576
1895
|
include Aws::Structure
|
1577
1896
|
end
|
1578
1897
|
|
1898
|
+
# Information about a node.
|
1899
|
+
#
|
1900
|
+
# @!attribute [rw] count
|
1901
|
+
# The number of instances of this node.
|
1902
|
+
# @return [Integer]
|
1903
|
+
#
|
1904
|
+
# @!attribute [rw] node_properties
|
1905
|
+
# Properties associated with this node.
|
1906
|
+
# @return [Array<String>]
|
1907
|
+
#
|
1908
|
+
# @!attribute [rw] distinct_outgoing_edge_labels
|
1909
|
+
# The outgoing edge labels associated with this node.
|
1910
|
+
# @return [Array<String>]
|
1911
|
+
#
|
1912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/NodeStructure AWS API Documentation
|
1913
|
+
#
|
1914
|
+
class NodeStructure < Struct.new(
|
1915
|
+
:count,
|
1916
|
+
:node_properties,
|
1917
|
+
:distinct_outgoing_edge_labels)
|
1918
|
+
SENSITIVE = []
|
1919
|
+
include Aws::Structure
|
1920
|
+
end
|
1921
|
+
|
1579
1922
|
# Details about a private graph endpoint.
|
1580
1923
|
#
|
1581
1924
|
# @!attribute [rw] vpc_id
|
@@ -1605,6 +1948,42 @@ module Aws::NeptuneGraph
|
|
1605
1948
|
include Aws::Structure
|
1606
1949
|
end
|
1607
1950
|
|
1951
|
+
# Details of the query listed.
|
1952
|
+
#
|
1953
|
+
# @!attribute [rw] id
|
1954
|
+
# A string representation of the id of the query.
|
1955
|
+
# @return [String]
|
1956
|
+
#
|
1957
|
+
# @!attribute [rw] query_string
|
1958
|
+
# The actual query text. The `queryString` may be truncated if the
|
1959
|
+
# actual query string is too long.
|
1960
|
+
# @return [String]
|
1961
|
+
#
|
1962
|
+
# @!attribute [rw] waited
|
1963
|
+
# The amount of time, in milliseconds, the query has waited in the
|
1964
|
+
# queue before being picked up by a worker thread.
|
1965
|
+
# @return [Integer]
|
1966
|
+
#
|
1967
|
+
# @!attribute [rw] elapsed
|
1968
|
+
# The running time of the query, in milliseconds.
|
1969
|
+
# @return [Integer]
|
1970
|
+
#
|
1971
|
+
# @!attribute [rw] state
|
1972
|
+
# State of the query.
|
1973
|
+
# @return [String]
|
1974
|
+
#
|
1975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/QuerySummary AWS API Documentation
|
1976
|
+
#
|
1977
|
+
class QuerySummary < Struct.new(
|
1978
|
+
:id,
|
1979
|
+
:query_string,
|
1980
|
+
:waited,
|
1981
|
+
:elapsed,
|
1982
|
+
:state)
|
1983
|
+
SENSITIVE = []
|
1984
|
+
include Aws::Structure
|
1985
|
+
end
|
1986
|
+
|
1608
1987
|
# @!attribute [rw] graph_identifier
|
1609
1988
|
# ID of the graph to reset.
|
1610
1989
|
# @return [String]
|
@@ -1759,8 +2138,8 @@ module Aws::NeptuneGraph
|
|
1759
2138
|
#
|
1760
2139
|
# @!attribute [rw] public_connectivity
|
1761
2140
|
# Specifies whether or not the graph can be reachable over the
|
1762
|
-
# internet. All access to graphs IAM authenticated. (`true` to
|
1763
|
-
# or `false` to disable).
|
2141
|
+
# internet. All access to graphs is IAM authenticated. (`true` to
|
2142
|
+
# enable, or `false` to disable).
|
1764
2143
|
# @return [Boolean]
|
1765
2144
|
#
|
1766
2145
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/RestoreGraphFromSnapshotInput AWS API Documentation
|
@@ -1944,6 +2323,24 @@ module Aws::NeptuneGraph
|
|
1944
2323
|
include Aws::Structure
|
1945
2324
|
end
|
1946
2325
|
|
2326
|
+
# Request cannot be processed due to known reasons. Eg. partition full.
|
2327
|
+
#
|
2328
|
+
# @!attribute [rw] message
|
2329
|
+
# @return [String]
|
2330
|
+
#
|
2331
|
+
# @!attribute [rw] reason
|
2332
|
+
# The reason for the unprocessable exception.
|
2333
|
+
# @return [String]
|
2334
|
+
#
|
2335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/UnprocessableException AWS API Documentation
|
2336
|
+
#
|
2337
|
+
class UnprocessableException < Struct.new(
|
2338
|
+
:message,
|
2339
|
+
:reason)
|
2340
|
+
SENSITIVE = []
|
2341
|
+
include Aws::Structure
|
2342
|
+
end
|
2343
|
+
|
1947
2344
|
# @!attribute [rw] resource_arn
|
1948
2345
|
# ARN of the resource whose tag needs to be removed.
|
1949
2346
|
# @return [String]
|
@@ -1971,8 +2368,8 @@ module Aws::NeptuneGraph
|
|
1971
2368
|
#
|
1972
2369
|
# @!attribute [rw] public_connectivity
|
1973
2370
|
# Specifies whether or not the graph can be reachable over the
|
1974
|
-
# internet. All access to graphs IAM authenticated. (`true` to
|
1975
|
-
# or `false` to disable.
|
2371
|
+
# internet. All access to graphs is IAM authenticated. (`true` to
|
2372
|
+
# enable, or `false` to disable.
|
1976
2373
|
# @return [Boolean]
|
1977
2374
|
#
|
1978
2375
|
# @!attribute [rw] provisioned_memory
|
@@ -2081,7 +2478,7 @@ module Aws::NeptuneGraph
|
|
2081
2478
|
include Aws::Structure
|
2082
2479
|
end
|
2083
2480
|
|
2084
|
-
# A resource could not be validated
|
2481
|
+
# A resource could not be validated.
|
2085
2482
|
#
|
2086
2483
|
# @!attribute [rw] message
|
2087
2484
|
# A message describing the problem.
|
data/lib/aws-sdk-neptunegraph.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -87,6 +87,13 @@ module Aws
|
|
87
87
|
) -> _CancelImportTaskResponseSuccess
|
88
88
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelImportTaskResponseSuccess
|
89
89
|
|
90
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NeptuneGraph/Client.html#cancel_query-instance_method
|
91
|
+
def cancel_query: (
|
92
|
+
graph_identifier: ::String,
|
93
|
+
query_id: ::String
|
94
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
95
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
96
|
+
|
90
97
|
interface _CreateGraphResponseSuccess
|
91
98
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateGraphOutput]
|
92
99
|
def id: () -> ::String
|
@@ -247,6 +254,23 @@ module Aws
|
|
247
254
|
) -> _DeletePrivateGraphEndpointResponseSuccess
|
248
255
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeletePrivateGraphEndpointResponseSuccess
|
249
256
|
|
257
|
+
interface _ExecuteQueryResponseSuccess
|
258
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ExecuteQueryOutput]
|
259
|
+
def payload: () -> ::IO
|
260
|
+
end
|
261
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NeptuneGraph/Client.html#execute_query-instance_method
|
262
|
+
def execute_query: (
|
263
|
+
graph_identifier: ::String,
|
264
|
+
query_string: ::String,
|
265
|
+
language: ("OPEN_CYPHER"),
|
266
|
+
?parameters: Hash[::String, {
|
267
|
+
}],
|
268
|
+
?plan_cache: ("ENABLED" | "DISABLED" | "AUTO"),
|
269
|
+
?explain_mode: ("STATIC" | "DETAILS"),
|
270
|
+
?query_timeout_milliseconds: ::Integer
|
271
|
+
) ?{ (*untyped) -> void } -> _ExecuteQueryResponseSuccess
|
272
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _ExecuteQueryResponseSuccess
|
273
|
+
|
250
274
|
interface _GetGraphResponseSuccess
|
251
275
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetGraphOutput]
|
252
276
|
def id: () -> ::String
|
@@ -287,6 +311,19 @@ module Aws
|
|
287
311
|
) -> _GetGraphSnapshotResponseSuccess
|
288
312
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetGraphSnapshotResponseSuccess
|
289
313
|
|
314
|
+
interface _GetGraphSummaryResponseSuccess
|
315
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetGraphSummaryOutput]
|
316
|
+
def version: () -> ::String
|
317
|
+
def last_statistics_computation_time: () -> ::Time
|
318
|
+
def graph_summary: () -> Types::GraphDataSummary
|
319
|
+
end
|
320
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NeptuneGraph/Client.html#get_graph_summary-instance_method
|
321
|
+
def get_graph_summary: (
|
322
|
+
graph_identifier: ::String,
|
323
|
+
?mode: ("BASIC" | "DETAILED")
|
324
|
+
) -> _GetGraphSummaryResponseSuccess
|
325
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetGraphSummaryResponseSuccess
|
326
|
+
|
290
327
|
interface _GetImportTaskResponseSuccess
|
291
328
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetImportTaskOutput]
|
292
329
|
def graph_id: () -> ::String
|
@@ -320,6 +357,21 @@ module Aws
|
|
320
357
|
) -> _GetPrivateGraphEndpointResponseSuccess
|
321
358
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPrivateGraphEndpointResponseSuccess
|
322
359
|
|
360
|
+
interface _GetQueryResponseSuccess
|
361
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetQueryOutput]
|
362
|
+
def id: () -> ::String
|
363
|
+
def query_string: () -> ::String
|
364
|
+
def waited: () -> ::Integer
|
365
|
+
def elapsed: () -> ::Integer
|
366
|
+
def state: () -> ("RUNNING" | "WAITING" | "CANCELLING")
|
367
|
+
end
|
368
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NeptuneGraph/Client.html#get_query-instance_method
|
369
|
+
def get_query: (
|
370
|
+
graph_identifier: ::String,
|
371
|
+
query_id: ::String
|
372
|
+
) -> _GetQueryResponseSuccess
|
373
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetQueryResponseSuccess
|
374
|
+
|
323
375
|
interface _ListGraphSnapshotsResponseSuccess
|
324
376
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListGraphSnapshotsOutput]
|
325
377
|
def graph_snapshots: () -> ::Array[Types::GraphSnapshotSummary]
|
@@ -370,6 +422,18 @@ module Aws
|
|
370
422
|
) -> _ListPrivateGraphEndpointsResponseSuccess
|
371
423
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPrivateGraphEndpointsResponseSuccess
|
372
424
|
|
425
|
+
interface _ListQueriesResponseSuccess
|
426
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListQueriesOutput]
|
427
|
+
def queries: () -> ::Array[Types::QuerySummary]
|
428
|
+
end
|
429
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NeptuneGraph/Client.html#list_queries-instance_method
|
430
|
+
def list_queries: (
|
431
|
+
graph_identifier: ::String,
|
432
|
+
max_results: ::Integer,
|
433
|
+
?state: ("ALL" | "RUNNING" | "WAITING" | "CANCELLING")
|
434
|
+
) -> _ListQueriesResponseSuccess
|
435
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListQueriesResponseSuccess
|
436
|
+
|
373
437
|
interface _ListTagsForResourceResponseSuccess
|
374
438
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceOutput]
|
375
439
|
def tags: () -> ::Hash[::String, ::String]
|
data/sig/errors.rbs
CHANGED
@@ -11,6 +11,9 @@ module Aws
|
|
11
11
|
class ServiceError < ::Aws::Errors::ServiceError
|
12
12
|
end
|
13
13
|
|
14
|
+
class AccessDeniedException < ::Aws::Errors::ServiceError
|
15
|
+
def message: () -> ::String
|
16
|
+
end
|
14
17
|
class ConflictException < ::Aws::Errors::ServiceError
|
15
18
|
def message: () -> ::String
|
16
19
|
def reason: () -> ::String
|
@@ -31,6 +34,10 @@ module Aws
|
|
31
34
|
class ThrottlingException < ::Aws::Errors::ServiceError
|
32
35
|
def message: () -> ::String
|
33
36
|
end
|
37
|
+
class UnprocessableException < ::Aws::Errors::ServiceError
|
38
|
+
def message: () -> ::String
|
39
|
+
def reason: () -> ::String
|
40
|
+
end
|
34
41
|
class ValidationException < ::Aws::Errors::ServiceError
|
35
42
|
def message: () -> ::String
|
36
43
|
def reason: () -> ::String
|