aws-sdk-neptunegraph 1.24.0 → 1.26.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 +323 -13
- data/lib/aws-sdk-neptunegraph/client_api.rb +191 -0
- data/lib/aws-sdk-neptunegraph/endpoints.rb +44 -0
- data/lib/aws-sdk-neptunegraph/types.rb +487 -1
- data/lib/aws-sdk-neptunegraph/waiters.rb +104 -0
- data/lib/aws-sdk-neptunegraph.rb +2 -2
- data/sig/client.rbs +118 -11
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +135 -12
- data/sig/waiters.rbs +20 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6e49bc4f27e62a7f037e6111172e6b067f8fa797cf9ec5776cd2330f5c83c346
|
4
|
+
data.tar.gz: 58d9e551c615c7d72412a4ded3a77887ea0898475c8b7b342a893214a63365a3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2cbb914d428b7169f62d9204b4521802c66dfb249843f45ddce3ac7b3e6c48aa6177de786de3d1ad78cc8ef0abb4cedb4620b3452f18359248eb286454348c63
|
7
|
+
data.tar.gz: dd49784daa3a3e5ec1e1d0c6535eef61da017a1b5ce398db723d1cba15ff1947797c396817d708fc45c4511aca4cde4dceb3dabb4979b7699bdc861394d772f5
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.26.0 (2025-01-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.25.0 (2024-11-22)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Add 4 new APIs to support new Export features, allowing Parquet and CSV formats. Add new arguments in Import APIs to support Parquet import. Add a new query "neptune.read" to run algorithms without loading data into database
|
13
|
+
|
4
14
|
1.24.0 (2024-11-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.26.0
|
@@ -257,11 +257,34 @@ module Aws::NeptuneGraph
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -447,6 +470,50 @@ module Aws::NeptuneGraph
|
|
447
470
|
|
448
471
|
# @!group API Operations
|
449
472
|
|
473
|
+
# Cancel the specified export task.
|
474
|
+
#
|
475
|
+
# @option params [required, String] :task_identifier
|
476
|
+
# The unique identifier of the export task.
|
477
|
+
#
|
478
|
+
# @return [Types::CancelExportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
479
|
+
#
|
480
|
+
# * {Types::CancelExportTaskOutput#graph_id #graph_id} => String
|
481
|
+
# * {Types::CancelExportTaskOutput#role_arn #role_arn} => String
|
482
|
+
# * {Types::CancelExportTaskOutput#task_id #task_id} => String
|
483
|
+
# * {Types::CancelExportTaskOutput#status #status} => String
|
484
|
+
# * {Types::CancelExportTaskOutput#format #format} => String
|
485
|
+
# * {Types::CancelExportTaskOutput#destination #destination} => String
|
486
|
+
# * {Types::CancelExportTaskOutput#kms_key_identifier #kms_key_identifier} => String
|
487
|
+
# * {Types::CancelExportTaskOutput#parquet_type #parquet_type} => String
|
488
|
+
# * {Types::CancelExportTaskOutput#status_reason #status_reason} => String
|
489
|
+
#
|
490
|
+
# @example Request syntax with placeholder values
|
491
|
+
#
|
492
|
+
# resp = client.cancel_export_task({
|
493
|
+
# task_identifier: "ExportTaskId", # required
|
494
|
+
# })
|
495
|
+
#
|
496
|
+
# @example Response structure
|
497
|
+
#
|
498
|
+
# resp.graph_id #=> String
|
499
|
+
# resp.role_arn #=> String
|
500
|
+
# resp.task_id #=> String
|
501
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
502
|
+
# resp.format #=> String, one of "PARQUET", "CSV"
|
503
|
+
# resp.destination #=> String
|
504
|
+
# resp.kms_key_identifier #=> String
|
505
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
506
|
+
# resp.status_reason #=> String
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelExportTask AWS API Documentation
|
509
|
+
#
|
510
|
+
# @overload cancel_export_task(params = {})
|
511
|
+
# @param [Hash] params ({})
|
512
|
+
def cancel_export_task(params = {}, options = {})
|
513
|
+
req = build_request(:cancel_export_task, params)
|
514
|
+
req.send_request(options)
|
515
|
+
end
|
516
|
+
|
450
517
|
# Deletes the specified import task.
|
451
518
|
#
|
452
519
|
# @option params [required, String] :task_identifier
|
@@ -458,6 +525,7 @@ module Aws::NeptuneGraph
|
|
458
525
|
# * {Types::CancelImportTaskOutput#task_id #task_id} => String
|
459
526
|
# * {Types::CancelImportTaskOutput#source #source} => String
|
460
527
|
# * {Types::CancelImportTaskOutput#format #format} => String
|
528
|
+
# * {Types::CancelImportTaskOutput#parquet_type #parquet_type} => String
|
461
529
|
# * {Types::CancelImportTaskOutput#role_arn #role_arn} => String
|
462
530
|
# * {Types::CancelImportTaskOutput#status #status} => String
|
463
531
|
#
|
@@ -472,9 +540,10 @@ module Aws::NeptuneGraph
|
|
472
540
|
# resp.graph_id #=> String
|
473
541
|
# resp.task_id #=> String
|
474
542
|
# resp.source #=> String
|
475
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
543
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
544
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
476
545
|
# resp.role_arn #=> String
|
477
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
546
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
478
547
|
#
|
479
548
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelImportTask AWS API Documentation
|
480
549
|
#
|
@@ -763,6 +832,9 @@ module Aws::NeptuneGraph
|
|
763
832
|
# [2]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html
|
764
833
|
# [3]: https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html
|
765
834
|
#
|
835
|
+
# @option params [String] :parquet_type
|
836
|
+
# The parquet type of the import task.
|
837
|
+
#
|
766
838
|
# @option params [String] :blank_node_handling
|
767
839
|
# The method to handle blank nodes in the dataset. Currently, only
|
768
840
|
# `convertToIri` is supported, meaning blank nodes are converted to
|
@@ -783,6 +855,7 @@ module Aws::NeptuneGraph
|
|
783
855
|
# * {Types::CreateGraphUsingImportTaskOutput#task_id #task_id} => String
|
784
856
|
# * {Types::CreateGraphUsingImportTaskOutput#source #source} => String
|
785
857
|
# * {Types::CreateGraphUsingImportTaskOutput#format #format} => String
|
858
|
+
# * {Types::CreateGraphUsingImportTaskOutput#parquet_type #parquet_type} => String
|
786
859
|
# * {Types::CreateGraphUsingImportTaskOutput#role_arn #role_arn} => String
|
787
860
|
# * {Types::CreateGraphUsingImportTaskOutput#status #status} => String
|
788
861
|
# * {Types::CreateGraphUsingImportTaskOutput#import_options #import_options} => Types::ImportOptions
|
@@ -813,7 +886,8 @@ module Aws::NeptuneGraph
|
|
813
886
|
# min_provisioned_memory: 1,
|
814
887
|
# fail_on_error: false,
|
815
888
|
# source: "String", # required
|
816
|
-
# format: "CSV", # accepts CSV, OPEN_CYPHER, NTRIPLES
|
889
|
+
# format: "CSV", # accepts CSV, OPEN_CYPHER, PARQUET, NTRIPLES
|
890
|
+
# parquet_type: "COLUMNAR", # accepts COLUMNAR
|
817
891
|
# blank_node_handling: "convertToIri", # accepts convertToIri
|
818
892
|
# role_arn: "RoleArn", # required
|
819
893
|
# })
|
@@ -823,9 +897,10 @@ module Aws::NeptuneGraph
|
|
823
897
|
# resp.graph_id #=> String
|
824
898
|
# resp.task_id #=> String
|
825
899
|
# resp.source #=> String
|
826
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
900
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
901
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
827
902
|
# resp.role_arn #=> String
|
828
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
903
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
829
904
|
# resp.import_options.neptune.s3_export_path #=> String
|
830
905
|
# resp.import_options.neptune.s3_export_kms_key_id #=> String
|
831
906
|
# resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
|
@@ -1110,6 +1185,73 @@ module Aws::NeptuneGraph
|
|
1110
1185
|
req.send_request(options, &block)
|
1111
1186
|
end
|
1112
1187
|
|
1188
|
+
# Retrieves a specified export task.
|
1189
|
+
#
|
1190
|
+
# @option params [required, String] :task_identifier
|
1191
|
+
# The unique identifier of the export task.
|
1192
|
+
#
|
1193
|
+
# @return [Types::GetExportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1194
|
+
#
|
1195
|
+
# * {Types::GetExportTaskOutput#graph_id #graph_id} => String
|
1196
|
+
# * {Types::GetExportTaskOutput#role_arn #role_arn} => String
|
1197
|
+
# * {Types::GetExportTaskOutput#task_id #task_id} => String
|
1198
|
+
# * {Types::GetExportTaskOutput#status #status} => String
|
1199
|
+
# * {Types::GetExportTaskOutput#format #format} => String
|
1200
|
+
# * {Types::GetExportTaskOutput#destination #destination} => String
|
1201
|
+
# * {Types::GetExportTaskOutput#kms_key_identifier #kms_key_identifier} => String
|
1202
|
+
# * {Types::GetExportTaskOutput#parquet_type #parquet_type} => String
|
1203
|
+
# * {Types::GetExportTaskOutput#status_reason #status_reason} => String
|
1204
|
+
# * {Types::GetExportTaskOutput#export_task_details #export_task_details} => Types::ExportTaskDetails
|
1205
|
+
# * {Types::GetExportTaskOutput#export_filter #export_filter} => Types::ExportFilter
|
1206
|
+
#
|
1207
|
+
# @example Request syntax with placeholder values
|
1208
|
+
#
|
1209
|
+
# resp = client.get_export_task({
|
1210
|
+
# task_identifier: "ExportTaskId", # required
|
1211
|
+
# })
|
1212
|
+
#
|
1213
|
+
# @example Response structure
|
1214
|
+
#
|
1215
|
+
# resp.graph_id #=> String
|
1216
|
+
# resp.role_arn #=> String
|
1217
|
+
# resp.task_id #=> String
|
1218
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1219
|
+
# resp.format #=> String, one of "PARQUET", "CSV"
|
1220
|
+
# resp.destination #=> String
|
1221
|
+
# resp.kms_key_identifier #=> String
|
1222
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
1223
|
+
# resp.status_reason #=> String
|
1224
|
+
# resp.export_task_details.start_time #=> Time
|
1225
|
+
# resp.export_task_details.time_elapsed_seconds #=> Integer
|
1226
|
+
# resp.export_task_details.progress_percentage #=> Integer
|
1227
|
+
# resp.export_task_details.num_vertices_written #=> Integer
|
1228
|
+
# resp.export_task_details.num_edges_written #=> Integer
|
1229
|
+
# resp.export_filter.vertex_filter #=> Hash
|
1230
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties #=> Hash
|
1231
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
1232
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
1233
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
1234
|
+
# resp.export_filter.edge_filter #=> Hash
|
1235
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties #=> Hash
|
1236
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
1237
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
1238
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
1239
|
+
#
|
1240
|
+
#
|
1241
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1242
|
+
#
|
1243
|
+
# * export_task_cancelled
|
1244
|
+
# * export_task_successful
|
1245
|
+
#
|
1246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetExportTask AWS API Documentation
|
1247
|
+
#
|
1248
|
+
# @overload get_export_task(params = {})
|
1249
|
+
# @param [Hash] params ({})
|
1250
|
+
def get_export_task(params = {}, options = {})
|
1251
|
+
req = build_request(:get_export_task, params)
|
1252
|
+
req.send_request(options)
|
1253
|
+
end
|
1254
|
+
|
1113
1255
|
# Gets information about a specified graph.
|
1114
1256
|
#
|
1115
1257
|
# @option params [required, String] :graph_identifier
|
@@ -1293,6 +1435,7 @@ module Aws::NeptuneGraph
|
|
1293
1435
|
# * {Types::GetImportTaskOutput#task_id #task_id} => String
|
1294
1436
|
# * {Types::GetImportTaskOutput#source #source} => String
|
1295
1437
|
# * {Types::GetImportTaskOutput#format #format} => String
|
1438
|
+
# * {Types::GetImportTaskOutput#parquet_type #parquet_type} => String
|
1296
1439
|
# * {Types::GetImportTaskOutput#role_arn #role_arn} => String
|
1297
1440
|
# * {Types::GetImportTaskOutput#status #status} => String
|
1298
1441
|
# * {Types::GetImportTaskOutput#import_options #import_options} => Types::ImportOptions
|
@@ -1311,9 +1454,10 @@ module Aws::NeptuneGraph
|
|
1311
1454
|
# resp.graph_id #=> String
|
1312
1455
|
# resp.task_id #=> String
|
1313
1456
|
# resp.source #=> String
|
1314
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
1457
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
1458
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
1315
1459
|
# resp.role_arn #=> String
|
1316
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
1460
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1317
1461
|
# resp.import_options.neptune.s3_export_path #=> String
|
1318
1462
|
# resp.import_options.neptune.s3_export_kms_key_id #=> String
|
1319
1463
|
# resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
|
@@ -1435,6 +1579,51 @@ module Aws::NeptuneGraph
|
|
1435
1579
|
req.send_request(options)
|
1436
1580
|
end
|
1437
1581
|
|
1582
|
+
# Retrieves a list of export tasks.
|
1583
|
+
#
|
1584
|
+
# @option params [String] :next_token
|
1585
|
+
# Pagination token used to paginate input.
|
1586
|
+
#
|
1587
|
+
# @option params [Integer] :max_results
|
1588
|
+
# The maximum number of export tasks to return.
|
1589
|
+
#
|
1590
|
+
# @return [Types::ListExportTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1591
|
+
#
|
1592
|
+
# * {Types::ListExportTasksOutput#tasks #tasks} => Array<Types::ExportTaskSummary>
|
1593
|
+
# * {Types::ListExportTasksOutput#next_token #next_token} => String
|
1594
|
+
#
|
1595
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1596
|
+
#
|
1597
|
+
# @example Request syntax with placeholder values
|
1598
|
+
#
|
1599
|
+
# resp = client.list_export_tasks({
|
1600
|
+
# next_token: "PaginationToken",
|
1601
|
+
# max_results: 1,
|
1602
|
+
# })
|
1603
|
+
#
|
1604
|
+
# @example Response structure
|
1605
|
+
#
|
1606
|
+
# resp.tasks #=> Array
|
1607
|
+
# resp.tasks[0].graph_id #=> String
|
1608
|
+
# resp.tasks[0].role_arn #=> String
|
1609
|
+
# resp.tasks[0].task_id #=> String
|
1610
|
+
# resp.tasks[0].status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1611
|
+
# resp.tasks[0].format #=> String, one of "PARQUET", "CSV"
|
1612
|
+
# resp.tasks[0].destination #=> String
|
1613
|
+
# resp.tasks[0].kms_key_identifier #=> String
|
1614
|
+
# resp.tasks[0].parquet_type #=> String, one of "COLUMNAR"
|
1615
|
+
# resp.tasks[0].status_reason #=> String
|
1616
|
+
# resp.next_token #=> String
|
1617
|
+
#
|
1618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListExportTasks AWS API Documentation
|
1619
|
+
#
|
1620
|
+
# @overload list_export_tasks(params = {})
|
1621
|
+
# @param [Hash] params ({})
|
1622
|
+
def list_export_tasks(params = {}, options = {})
|
1623
|
+
req = build_request(:list_export_tasks, params)
|
1624
|
+
req.send_request(options)
|
1625
|
+
end
|
1626
|
+
|
1438
1627
|
# Lists available snapshots of a specified Neptune Analytics graph.
|
1439
1628
|
#
|
1440
1629
|
# @option params [String] :graph_identifier
|
@@ -1586,9 +1775,10 @@ module Aws::NeptuneGraph
|
|
1586
1775
|
# resp.tasks[0].graph_id #=> String
|
1587
1776
|
# resp.tasks[0].task_id #=> String
|
1588
1777
|
# resp.tasks[0].source #=> String
|
1589
|
-
# resp.tasks[0].format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
1778
|
+
# resp.tasks[0].format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
1779
|
+
# resp.tasks[0].parquet_type #=> String, one of "COLUMNAR"
|
1590
1780
|
# resp.tasks[0].role_arn #=> String
|
1591
|
-
# resp.tasks[0].status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
1781
|
+
# resp.tasks[0].status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1592
1782
|
# resp.next_token #=> String
|
1593
1783
|
#
|
1594
1784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListImportTasks AWS API Documentation
|
@@ -1887,6 +2077,116 @@ module Aws::NeptuneGraph
|
|
1887
2077
|
req.send_request(options)
|
1888
2078
|
end
|
1889
2079
|
|
2080
|
+
# Export data from an existing Neptune Analytics graph to Amazon S3. The
|
2081
|
+
# graph state should be `AVAILABLE`.
|
2082
|
+
#
|
2083
|
+
# @option params [required, String] :graph_identifier
|
2084
|
+
# The source graph identifier of the export task.
|
2085
|
+
#
|
2086
|
+
# @option params [required, String] :role_arn
|
2087
|
+
# The ARN of the IAM role that will allow data to be exported to the
|
2088
|
+
# destination.
|
2089
|
+
#
|
2090
|
+
# @option params [required, String] :format
|
2091
|
+
# The format of the export task.
|
2092
|
+
#
|
2093
|
+
# @option params [required, String] :destination
|
2094
|
+
# The Amazon S3 URI where data will be exported to.
|
2095
|
+
#
|
2096
|
+
# @option params [required, String] :kms_key_identifier
|
2097
|
+
# The KMS key identifier of the export task.
|
2098
|
+
#
|
2099
|
+
# @option params [String] :parquet_type
|
2100
|
+
# The parquet type of the export task.
|
2101
|
+
#
|
2102
|
+
# @option params [Types::ExportFilter] :export_filter
|
2103
|
+
# The export filter of the export task.
|
2104
|
+
#
|
2105
|
+
# @option params [Hash<String,String>] :tags
|
2106
|
+
# Tags to be applied to the export task.
|
2107
|
+
#
|
2108
|
+
# @return [Types::StartExportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2109
|
+
#
|
2110
|
+
# * {Types::StartExportTaskOutput#graph_id #graph_id} => String
|
2111
|
+
# * {Types::StartExportTaskOutput#role_arn #role_arn} => String
|
2112
|
+
# * {Types::StartExportTaskOutput#task_id #task_id} => String
|
2113
|
+
# * {Types::StartExportTaskOutput#status #status} => String
|
2114
|
+
# * {Types::StartExportTaskOutput#format #format} => String
|
2115
|
+
# * {Types::StartExportTaskOutput#destination #destination} => String
|
2116
|
+
# * {Types::StartExportTaskOutput#kms_key_identifier #kms_key_identifier} => String
|
2117
|
+
# * {Types::StartExportTaskOutput#parquet_type #parquet_type} => String
|
2118
|
+
# * {Types::StartExportTaskOutput#status_reason #status_reason} => String
|
2119
|
+
# * {Types::StartExportTaskOutput#export_filter #export_filter} => Types::ExportFilter
|
2120
|
+
#
|
2121
|
+
# @example Request syntax with placeholder values
|
2122
|
+
#
|
2123
|
+
# resp = client.start_export_task({
|
2124
|
+
# graph_identifier: "GraphIdentifier", # required
|
2125
|
+
# role_arn: "RoleArn", # required
|
2126
|
+
# format: "PARQUET", # required, accepts PARQUET, CSV
|
2127
|
+
# destination: "StartExportTaskInputDestinationString", # required
|
2128
|
+
# kms_key_identifier: "KmsKeyArn", # required
|
2129
|
+
# parquet_type: "COLUMNAR", # accepts COLUMNAR
|
2130
|
+
# export_filter: {
|
2131
|
+
# vertex_filter: {
|
2132
|
+
# "ExportFilterLabel" => {
|
2133
|
+
# properties: {
|
2134
|
+
# "ExportFilterOutputPropertyName" => {
|
2135
|
+
# output_type: "ExportFilterOutputDataType",
|
2136
|
+
# source_property_name: "ExportFilterSourcePropertyName",
|
2137
|
+
# multi_value_handling: "TO_LIST", # accepts TO_LIST, PICK_FIRST
|
2138
|
+
# },
|
2139
|
+
# },
|
2140
|
+
# },
|
2141
|
+
# },
|
2142
|
+
# edge_filter: {
|
2143
|
+
# "ExportFilterLabel" => {
|
2144
|
+
# properties: {
|
2145
|
+
# "ExportFilterOutputPropertyName" => {
|
2146
|
+
# output_type: "ExportFilterOutputDataType",
|
2147
|
+
# source_property_name: "ExportFilterSourcePropertyName",
|
2148
|
+
# multi_value_handling: "TO_LIST", # accepts TO_LIST, PICK_FIRST
|
2149
|
+
# },
|
2150
|
+
# },
|
2151
|
+
# },
|
2152
|
+
# },
|
2153
|
+
# },
|
2154
|
+
# tags: {
|
2155
|
+
# "TagKey" => "TagValue",
|
2156
|
+
# },
|
2157
|
+
# })
|
2158
|
+
#
|
2159
|
+
# @example Response structure
|
2160
|
+
#
|
2161
|
+
# resp.graph_id #=> String
|
2162
|
+
# resp.role_arn #=> String
|
2163
|
+
# resp.task_id #=> String
|
2164
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
2165
|
+
# resp.format #=> String, one of "PARQUET", "CSV"
|
2166
|
+
# resp.destination #=> String
|
2167
|
+
# resp.kms_key_identifier #=> String
|
2168
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
2169
|
+
# resp.status_reason #=> String
|
2170
|
+
# resp.export_filter.vertex_filter #=> Hash
|
2171
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties #=> Hash
|
2172
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
2173
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
2174
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
2175
|
+
# resp.export_filter.edge_filter #=> Hash
|
2176
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties #=> Hash
|
2177
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
2178
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
2179
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
2180
|
+
#
|
2181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/StartExportTask AWS API Documentation
|
2182
|
+
#
|
2183
|
+
# @overload start_export_task(params = {})
|
2184
|
+
# @param [Hash] params ({})
|
2185
|
+
def start_export_task(params = {}, options = {})
|
2186
|
+
req = build_request(:start_export_task, params)
|
2187
|
+
req.send_request(options)
|
2188
|
+
end
|
2189
|
+
|
1890
2190
|
# Import data into existing Neptune Analytics graph from Amazon Simple
|
1891
2191
|
# Storage Service (S3). The graph needs to be empty and in the AVAILABLE
|
1892
2192
|
# state.
|
@@ -1909,6 +2209,9 @@ module Aws::NeptuneGraph
|
|
1909
2209
|
# are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which
|
1910
2210
|
# identies the openCypher load format.
|
1911
2211
|
#
|
2212
|
+
# @option params [String] :parquet_type
|
2213
|
+
# The parquet type of the import task.
|
2214
|
+
#
|
1912
2215
|
# @option params [String] :blank_node_handling
|
1913
2216
|
# The method to handle blank nodes in the dataset. Currently, only
|
1914
2217
|
# `convertToIri` is supported, meaning blank nodes are converted to
|
@@ -1932,6 +2235,7 @@ module Aws::NeptuneGraph
|
|
1932
2235
|
# * {Types::StartImportTaskOutput#task_id #task_id} => String
|
1933
2236
|
# * {Types::StartImportTaskOutput#source #source} => String
|
1934
2237
|
# * {Types::StartImportTaskOutput#format #format} => String
|
2238
|
+
# * {Types::StartImportTaskOutput#parquet_type #parquet_type} => String
|
1935
2239
|
# * {Types::StartImportTaskOutput#role_arn #role_arn} => String
|
1936
2240
|
# * {Types::StartImportTaskOutput#status #status} => String
|
1937
2241
|
# * {Types::StartImportTaskOutput#import_options #import_options} => Types::ImportOptions
|
@@ -1949,7 +2253,8 @@ module Aws::NeptuneGraph
|
|
1949
2253
|
# },
|
1950
2254
|
# fail_on_error: false,
|
1951
2255
|
# source: "String", # required
|
1952
|
-
# format: "CSV", # accepts CSV, OPEN_CYPHER, NTRIPLES
|
2256
|
+
# format: "CSV", # accepts CSV, OPEN_CYPHER, PARQUET, NTRIPLES
|
2257
|
+
# parquet_type: "COLUMNAR", # accepts COLUMNAR
|
1953
2258
|
# blank_node_handling: "convertToIri", # accepts convertToIri
|
1954
2259
|
# graph_identifier: "GraphIdentifier", # required
|
1955
2260
|
# role_arn: "RoleArn", # required
|
@@ -1960,9 +2265,10 @@ module Aws::NeptuneGraph
|
|
1960
2265
|
# resp.graph_id #=> String
|
1961
2266
|
# resp.task_id #=> String
|
1962
2267
|
# resp.source #=> String
|
1963
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
2268
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
2269
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
1964
2270
|
# resp.role_arn #=> String
|
1965
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
2271
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1966
2272
|
# resp.import_options.neptune.s3_export_path #=> String
|
1967
2273
|
# resp.import_options.neptune.s3_export_kms_key_id #=> String
|
1968
2274
|
# resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
|
@@ -2138,7 +2444,7 @@ module Aws::NeptuneGraph
|
|
2138
2444
|
tracer: tracer
|
2139
2445
|
)
|
2140
2446
|
context[:gem_name] = 'aws-sdk-neptunegraph'
|
2141
|
-
context[:gem_version] = '1.
|
2447
|
+
context[:gem_version] = '1.26.0'
|
2142
2448
|
Seahorse::Client::Request.new(handlers, context)
|
2143
2449
|
end
|
2144
2450
|
|
@@ -2206,6 +2512,8 @@ module Aws::NeptuneGraph
|
|
2206
2512
|
#
|
2207
2513
|
# | waiter_name | params | :delay | :max_attempts |
|
2208
2514
|
# | -------------------------------- | ----------------------------------- | -------- | ------------- |
|
2515
|
+
# | export_task_cancelled | {Client#get_export_task} | 60 | 60 |
|
2516
|
+
# | export_task_successful | {Client#get_export_task} | 60 | 480 |
|
2209
2517
|
# | graph_available | {Client#get_graph} | 60 | 480 |
|
2210
2518
|
# | graph_deleted | {Client#get_graph} | 60 | 60 |
|
2211
2519
|
# | graph_snapshot_available | {Client#get_graph_snapshot} | 60 | 120 |
|
@@ -2264,6 +2572,8 @@ module Aws::NeptuneGraph
|
|
2264
2572
|
|
2265
2573
|
def waiters
|
2266
2574
|
{
|
2575
|
+
export_task_cancelled: Waiters::ExportTaskCancelled,
|
2576
|
+
export_task_successful: Waiters::ExportTaskSuccessful,
|
2267
2577
|
graph_available: Waiters::GraphAvailable,
|
2268
2578
|
graph_deleted: Waiters::GraphDeleted,
|
2269
2579
|
graph_snapshot_available: Waiters::GraphSnapshotAvailable,
|