aws-sdk-neptunegraph 1.24.0 → 1.25.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-neptunegraph/client.rb +300 -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 +116 -11
- data/sig/types.rbs +135 -12
- data/sig/waiters.rbs +20 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 61b9d414324f373b06c1960a3eec90688a44fd8697e18a09d71fc015933dc548
|
4
|
+
data.tar.gz: 1d65c08282ea1f9d3e775c1203cf45ca9233e3d4572bdf647c8ad1f74f4810f0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7c2079958f59da155ad16cafb9221f2d0df0e398d37fa6c8182bae00233c2c7b375a5d5d5213a10ccc187dd1e7ad30e578b4a66489f6e3b04c2e2159f8d6f367
|
7
|
+
data.tar.gz: c082ed03ce95b9130ee3253ec8ee0c277540be4a953369e44d8151c2bf430762f411ef477db65153a8129463dd52e9e5429318b5745128b2c5fed057eca2cd65
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.25.0 (2024-11-22)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* 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
|
8
|
+
|
4
9
|
1.24.0 (2024-11-06)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.25.0
|
@@ -447,6 +447,50 @@ module Aws::NeptuneGraph
|
|
447
447
|
|
448
448
|
# @!group API Operations
|
449
449
|
|
450
|
+
# Cancel the specified export task.
|
451
|
+
#
|
452
|
+
# @option params [required, String] :task_identifier
|
453
|
+
# The unique identifier of the export task.
|
454
|
+
#
|
455
|
+
# @return [Types::CancelExportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
456
|
+
#
|
457
|
+
# * {Types::CancelExportTaskOutput#graph_id #graph_id} => String
|
458
|
+
# * {Types::CancelExportTaskOutput#role_arn #role_arn} => String
|
459
|
+
# * {Types::CancelExportTaskOutput#task_id #task_id} => String
|
460
|
+
# * {Types::CancelExportTaskOutput#status #status} => String
|
461
|
+
# * {Types::CancelExportTaskOutput#format #format} => String
|
462
|
+
# * {Types::CancelExportTaskOutput#destination #destination} => String
|
463
|
+
# * {Types::CancelExportTaskOutput#kms_key_identifier #kms_key_identifier} => String
|
464
|
+
# * {Types::CancelExportTaskOutput#parquet_type #parquet_type} => String
|
465
|
+
# * {Types::CancelExportTaskOutput#status_reason #status_reason} => String
|
466
|
+
#
|
467
|
+
# @example Request syntax with placeholder values
|
468
|
+
#
|
469
|
+
# resp = client.cancel_export_task({
|
470
|
+
# task_identifier: "ExportTaskId", # required
|
471
|
+
# })
|
472
|
+
#
|
473
|
+
# @example Response structure
|
474
|
+
#
|
475
|
+
# resp.graph_id #=> String
|
476
|
+
# resp.role_arn #=> String
|
477
|
+
# resp.task_id #=> String
|
478
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
479
|
+
# resp.format #=> String, one of "PARQUET", "CSV"
|
480
|
+
# resp.destination #=> String
|
481
|
+
# resp.kms_key_identifier #=> String
|
482
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
483
|
+
# resp.status_reason #=> String
|
484
|
+
#
|
485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelExportTask AWS API Documentation
|
486
|
+
#
|
487
|
+
# @overload cancel_export_task(params = {})
|
488
|
+
# @param [Hash] params ({})
|
489
|
+
def cancel_export_task(params = {}, options = {})
|
490
|
+
req = build_request(:cancel_export_task, params)
|
491
|
+
req.send_request(options)
|
492
|
+
end
|
493
|
+
|
450
494
|
# Deletes the specified import task.
|
451
495
|
#
|
452
496
|
# @option params [required, String] :task_identifier
|
@@ -458,6 +502,7 @@ module Aws::NeptuneGraph
|
|
458
502
|
# * {Types::CancelImportTaskOutput#task_id #task_id} => String
|
459
503
|
# * {Types::CancelImportTaskOutput#source #source} => String
|
460
504
|
# * {Types::CancelImportTaskOutput#format #format} => String
|
505
|
+
# * {Types::CancelImportTaskOutput#parquet_type #parquet_type} => String
|
461
506
|
# * {Types::CancelImportTaskOutput#role_arn #role_arn} => String
|
462
507
|
# * {Types::CancelImportTaskOutput#status #status} => String
|
463
508
|
#
|
@@ -472,9 +517,10 @@ module Aws::NeptuneGraph
|
|
472
517
|
# resp.graph_id #=> String
|
473
518
|
# resp.task_id #=> String
|
474
519
|
# resp.source #=> String
|
475
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
520
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
521
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
476
522
|
# resp.role_arn #=> String
|
477
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
523
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
478
524
|
#
|
479
525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelImportTask AWS API Documentation
|
480
526
|
#
|
@@ -763,6 +809,9 @@ module Aws::NeptuneGraph
|
|
763
809
|
# [2]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html
|
764
810
|
# [3]: https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html
|
765
811
|
#
|
812
|
+
# @option params [String] :parquet_type
|
813
|
+
# The parquet type of the import task.
|
814
|
+
#
|
766
815
|
# @option params [String] :blank_node_handling
|
767
816
|
# The method to handle blank nodes in the dataset. Currently, only
|
768
817
|
# `convertToIri` is supported, meaning blank nodes are converted to
|
@@ -783,6 +832,7 @@ module Aws::NeptuneGraph
|
|
783
832
|
# * {Types::CreateGraphUsingImportTaskOutput#task_id #task_id} => String
|
784
833
|
# * {Types::CreateGraphUsingImportTaskOutput#source #source} => String
|
785
834
|
# * {Types::CreateGraphUsingImportTaskOutput#format #format} => String
|
835
|
+
# * {Types::CreateGraphUsingImportTaskOutput#parquet_type #parquet_type} => String
|
786
836
|
# * {Types::CreateGraphUsingImportTaskOutput#role_arn #role_arn} => String
|
787
837
|
# * {Types::CreateGraphUsingImportTaskOutput#status #status} => String
|
788
838
|
# * {Types::CreateGraphUsingImportTaskOutput#import_options #import_options} => Types::ImportOptions
|
@@ -813,7 +863,8 @@ module Aws::NeptuneGraph
|
|
813
863
|
# min_provisioned_memory: 1,
|
814
864
|
# fail_on_error: false,
|
815
865
|
# source: "String", # required
|
816
|
-
# format: "CSV", # accepts CSV, OPEN_CYPHER, NTRIPLES
|
866
|
+
# format: "CSV", # accepts CSV, OPEN_CYPHER, PARQUET, NTRIPLES
|
867
|
+
# parquet_type: "COLUMNAR", # accepts COLUMNAR
|
817
868
|
# blank_node_handling: "convertToIri", # accepts convertToIri
|
818
869
|
# role_arn: "RoleArn", # required
|
819
870
|
# })
|
@@ -823,9 +874,10 @@ module Aws::NeptuneGraph
|
|
823
874
|
# resp.graph_id #=> String
|
824
875
|
# resp.task_id #=> String
|
825
876
|
# resp.source #=> String
|
826
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
877
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
878
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
827
879
|
# resp.role_arn #=> String
|
828
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
880
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
829
881
|
# resp.import_options.neptune.s3_export_path #=> String
|
830
882
|
# resp.import_options.neptune.s3_export_kms_key_id #=> String
|
831
883
|
# resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
|
@@ -1110,6 +1162,73 @@ module Aws::NeptuneGraph
|
|
1110
1162
|
req.send_request(options, &block)
|
1111
1163
|
end
|
1112
1164
|
|
1165
|
+
# Retrieves a specified export task.
|
1166
|
+
#
|
1167
|
+
# @option params [required, String] :task_identifier
|
1168
|
+
# The unique identifier of the export task.
|
1169
|
+
#
|
1170
|
+
# @return [Types::GetExportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1171
|
+
#
|
1172
|
+
# * {Types::GetExportTaskOutput#graph_id #graph_id} => String
|
1173
|
+
# * {Types::GetExportTaskOutput#role_arn #role_arn} => String
|
1174
|
+
# * {Types::GetExportTaskOutput#task_id #task_id} => String
|
1175
|
+
# * {Types::GetExportTaskOutput#status #status} => String
|
1176
|
+
# * {Types::GetExportTaskOutput#format #format} => String
|
1177
|
+
# * {Types::GetExportTaskOutput#destination #destination} => String
|
1178
|
+
# * {Types::GetExportTaskOutput#kms_key_identifier #kms_key_identifier} => String
|
1179
|
+
# * {Types::GetExportTaskOutput#parquet_type #parquet_type} => String
|
1180
|
+
# * {Types::GetExportTaskOutput#status_reason #status_reason} => String
|
1181
|
+
# * {Types::GetExportTaskOutput#export_task_details #export_task_details} => Types::ExportTaskDetails
|
1182
|
+
# * {Types::GetExportTaskOutput#export_filter #export_filter} => Types::ExportFilter
|
1183
|
+
#
|
1184
|
+
# @example Request syntax with placeholder values
|
1185
|
+
#
|
1186
|
+
# resp = client.get_export_task({
|
1187
|
+
# task_identifier: "ExportTaskId", # required
|
1188
|
+
# })
|
1189
|
+
#
|
1190
|
+
# @example Response structure
|
1191
|
+
#
|
1192
|
+
# resp.graph_id #=> String
|
1193
|
+
# resp.role_arn #=> String
|
1194
|
+
# resp.task_id #=> String
|
1195
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1196
|
+
# resp.format #=> String, one of "PARQUET", "CSV"
|
1197
|
+
# resp.destination #=> String
|
1198
|
+
# resp.kms_key_identifier #=> String
|
1199
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
1200
|
+
# resp.status_reason #=> String
|
1201
|
+
# resp.export_task_details.start_time #=> Time
|
1202
|
+
# resp.export_task_details.time_elapsed_seconds #=> Integer
|
1203
|
+
# resp.export_task_details.progress_percentage #=> Integer
|
1204
|
+
# resp.export_task_details.num_vertices_written #=> Integer
|
1205
|
+
# resp.export_task_details.num_edges_written #=> Integer
|
1206
|
+
# resp.export_filter.vertex_filter #=> Hash
|
1207
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties #=> Hash
|
1208
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
1209
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
1210
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
1211
|
+
# resp.export_filter.edge_filter #=> Hash
|
1212
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties #=> Hash
|
1213
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
1214
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
1215
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
1216
|
+
#
|
1217
|
+
#
|
1218
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1219
|
+
#
|
1220
|
+
# * export_task_cancelled
|
1221
|
+
# * export_task_successful
|
1222
|
+
#
|
1223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetExportTask AWS API Documentation
|
1224
|
+
#
|
1225
|
+
# @overload get_export_task(params = {})
|
1226
|
+
# @param [Hash] params ({})
|
1227
|
+
def get_export_task(params = {}, options = {})
|
1228
|
+
req = build_request(:get_export_task, params)
|
1229
|
+
req.send_request(options)
|
1230
|
+
end
|
1231
|
+
|
1113
1232
|
# Gets information about a specified graph.
|
1114
1233
|
#
|
1115
1234
|
# @option params [required, String] :graph_identifier
|
@@ -1293,6 +1412,7 @@ module Aws::NeptuneGraph
|
|
1293
1412
|
# * {Types::GetImportTaskOutput#task_id #task_id} => String
|
1294
1413
|
# * {Types::GetImportTaskOutput#source #source} => String
|
1295
1414
|
# * {Types::GetImportTaskOutput#format #format} => String
|
1415
|
+
# * {Types::GetImportTaskOutput#parquet_type #parquet_type} => String
|
1296
1416
|
# * {Types::GetImportTaskOutput#role_arn #role_arn} => String
|
1297
1417
|
# * {Types::GetImportTaskOutput#status #status} => String
|
1298
1418
|
# * {Types::GetImportTaskOutput#import_options #import_options} => Types::ImportOptions
|
@@ -1311,9 +1431,10 @@ module Aws::NeptuneGraph
|
|
1311
1431
|
# resp.graph_id #=> String
|
1312
1432
|
# resp.task_id #=> String
|
1313
1433
|
# resp.source #=> String
|
1314
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
1434
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
1435
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
1315
1436
|
# resp.role_arn #=> String
|
1316
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
1437
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1317
1438
|
# resp.import_options.neptune.s3_export_path #=> String
|
1318
1439
|
# resp.import_options.neptune.s3_export_kms_key_id #=> String
|
1319
1440
|
# resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
|
@@ -1435,6 +1556,51 @@ module Aws::NeptuneGraph
|
|
1435
1556
|
req.send_request(options)
|
1436
1557
|
end
|
1437
1558
|
|
1559
|
+
# Retrieves a list of export tasks.
|
1560
|
+
#
|
1561
|
+
# @option params [String] :next_token
|
1562
|
+
# Pagination token used to paginate input.
|
1563
|
+
#
|
1564
|
+
# @option params [Integer] :max_results
|
1565
|
+
# The maximum number of export tasks to return.
|
1566
|
+
#
|
1567
|
+
# @return [Types::ListExportTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1568
|
+
#
|
1569
|
+
# * {Types::ListExportTasksOutput#tasks #tasks} => Array<Types::ExportTaskSummary>
|
1570
|
+
# * {Types::ListExportTasksOutput#next_token #next_token} => String
|
1571
|
+
#
|
1572
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1573
|
+
#
|
1574
|
+
# @example Request syntax with placeholder values
|
1575
|
+
#
|
1576
|
+
# resp = client.list_export_tasks({
|
1577
|
+
# next_token: "PaginationToken",
|
1578
|
+
# max_results: 1,
|
1579
|
+
# })
|
1580
|
+
#
|
1581
|
+
# @example Response structure
|
1582
|
+
#
|
1583
|
+
# resp.tasks #=> Array
|
1584
|
+
# resp.tasks[0].graph_id #=> String
|
1585
|
+
# resp.tasks[0].role_arn #=> String
|
1586
|
+
# resp.tasks[0].task_id #=> String
|
1587
|
+
# resp.tasks[0].status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1588
|
+
# resp.tasks[0].format #=> String, one of "PARQUET", "CSV"
|
1589
|
+
# resp.tasks[0].destination #=> String
|
1590
|
+
# resp.tasks[0].kms_key_identifier #=> String
|
1591
|
+
# resp.tasks[0].parquet_type #=> String, one of "COLUMNAR"
|
1592
|
+
# resp.tasks[0].status_reason #=> String
|
1593
|
+
# resp.next_token #=> String
|
1594
|
+
#
|
1595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListExportTasks AWS API Documentation
|
1596
|
+
#
|
1597
|
+
# @overload list_export_tasks(params = {})
|
1598
|
+
# @param [Hash] params ({})
|
1599
|
+
def list_export_tasks(params = {}, options = {})
|
1600
|
+
req = build_request(:list_export_tasks, params)
|
1601
|
+
req.send_request(options)
|
1602
|
+
end
|
1603
|
+
|
1438
1604
|
# Lists available snapshots of a specified Neptune Analytics graph.
|
1439
1605
|
#
|
1440
1606
|
# @option params [String] :graph_identifier
|
@@ -1586,9 +1752,10 @@ module Aws::NeptuneGraph
|
|
1586
1752
|
# resp.tasks[0].graph_id #=> String
|
1587
1753
|
# resp.tasks[0].task_id #=> String
|
1588
1754
|
# resp.tasks[0].source #=> String
|
1589
|
-
# resp.tasks[0].format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
1755
|
+
# resp.tasks[0].format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
1756
|
+
# resp.tasks[0].parquet_type #=> String, one of "COLUMNAR"
|
1590
1757
|
# 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"
|
1758
|
+
# resp.tasks[0].status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1592
1759
|
# resp.next_token #=> String
|
1593
1760
|
#
|
1594
1761
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListImportTasks AWS API Documentation
|
@@ -1887,6 +2054,116 @@ module Aws::NeptuneGraph
|
|
1887
2054
|
req.send_request(options)
|
1888
2055
|
end
|
1889
2056
|
|
2057
|
+
# Export data from an existing Neptune Analytics graph to Amazon S3. The
|
2058
|
+
# graph state should be `AVAILABLE`.
|
2059
|
+
#
|
2060
|
+
# @option params [required, String] :graph_identifier
|
2061
|
+
# The source graph identifier of the export task.
|
2062
|
+
#
|
2063
|
+
# @option params [required, String] :role_arn
|
2064
|
+
# The ARN of the IAM role that will allow data to be exported to the
|
2065
|
+
# destination.
|
2066
|
+
#
|
2067
|
+
# @option params [required, String] :format
|
2068
|
+
# The format of the export task.
|
2069
|
+
#
|
2070
|
+
# @option params [required, String] :destination
|
2071
|
+
# The Amazon S3 URI where data will be exported to.
|
2072
|
+
#
|
2073
|
+
# @option params [required, String] :kms_key_identifier
|
2074
|
+
# The KMS key identifier of the export task.
|
2075
|
+
#
|
2076
|
+
# @option params [String] :parquet_type
|
2077
|
+
# The parquet type of the export task.
|
2078
|
+
#
|
2079
|
+
# @option params [Types::ExportFilter] :export_filter
|
2080
|
+
# The export filter of the export task.
|
2081
|
+
#
|
2082
|
+
# @option params [Hash<String,String>] :tags
|
2083
|
+
# Tags to be applied to the export task.
|
2084
|
+
#
|
2085
|
+
# @return [Types::StartExportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2086
|
+
#
|
2087
|
+
# * {Types::StartExportTaskOutput#graph_id #graph_id} => String
|
2088
|
+
# * {Types::StartExportTaskOutput#role_arn #role_arn} => String
|
2089
|
+
# * {Types::StartExportTaskOutput#task_id #task_id} => String
|
2090
|
+
# * {Types::StartExportTaskOutput#status #status} => String
|
2091
|
+
# * {Types::StartExportTaskOutput#format #format} => String
|
2092
|
+
# * {Types::StartExportTaskOutput#destination #destination} => String
|
2093
|
+
# * {Types::StartExportTaskOutput#kms_key_identifier #kms_key_identifier} => String
|
2094
|
+
# * {Types::StartExportTaskOutput#parquet_type #parquet_type} => String
|
2095
|
+
# * {Types::StartExportTaskOutput#status_reason #status_reason} => String
|
2096
|
+
# * {Types::StartExportTaskOutput#export_filter #export_filter} => Types::ExportFilter
|
2097
|
+
#
|
2098
|
+
# @example Request syntax with placeholder values
|
2099
|
+
#
|
2100
|
+
# resp = client.start_export_task({
|
2101
|
+
# graph_identifier: "GraphIdentifier", # required
|
2102
|
+
# role_arn: "RoleArn", # required
|
2103
|
+
# format: "PARQUET", # required, accepts PARQUET, CSV
|
2104
|
+
# destination: "StartExportTaskInputDestinationString", # required
|
2105
|
+
# kms_key_identifier: "KmsKeyArn", # required
|
2106
|
+
# parquet_type: "COLUMNAR", # accepts COLUMNAR
|
2107
|
+
# export_filter: {
|
2108
|
+
# vertex_filter: {
|
2109
|
+
# "ExportFilterLabel" => {
|
2110
|
+
# properties: {
|
2111
|
+
# "ExportFilterOutputPropertyName" => {
|
2112
|
+
# output_type: "ExportFilterOutputDataType",
|
2113
|
+
# source_property_name: "ExportFilterSourcePropertyName",
|
2114
|
+
# multi_value_handling: "TO_LIST", # accepts TO_LIST, PICK_FIRST
|
2115
|
+
# },
|
2116
|
+
# },
|
2117
|
+
# },
|
2118
|
+
# },
|
2119
|
+
# edge_filter: {
|
2120
|
+
# "ExportFilterLabel" => {
|
2121
|
+
# properties: {
|
2122
|
+
# "ExportFilterOutputPropertyName" => {
|
2123
|
+
# output_type: "ExportFilterOutputDataType",
|
2124
|
+
# source_property_name: "ExportFilterSourcePropertyName",
|
2125
|
+
# multi_value_handling: "TO_LIST", # accepts TO_LIST, PICK_FIRST
|
2126
|
+
# },
|
2127
|
+
# },
|
2128
|
+
# },
|
2129
|
+
# },
|
2130
|
+
# },
|
2131
|
+
# tags: {
|
2132
|
+
# "TagKey" => "TagValue",
|
2133
|
+
# },
|
2134
|
+
# })
|
2135
|
+
#
|
2136
|
+
# @example Response structure
|
2137
|
+
#
|
2138
|
+
# resp.graph_id #=> String
|
2139
|
+
# resp.role_arn #=> String
|
2140
|
+
# resp.task_id #=> String
|
2141
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
2142
|
+
# resp.format #=> String, one of "PARQUET", "CSV"
|
2143
|
+
# resp.destination #=> String
|
2144
|
+
# resp.kms_key_identifier #=> String
|
2145
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
2146
|
+
# resp.status_reason #=> String
|
2147
|
+
# resp.export_filter.vertex_filter #=> Hash
|
2148
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties #=> Hash
|
2149
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
2150
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
2151
|
+
# resp.export_filter.vertex_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
2152
|
+
# resp.export_filter.edge_filter #=> Hash
|
2153
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties #=> Hash
|
2154
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].output_type #=> String
|
2155
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].source_property_name #=> String
|
2156
|
+
# resp.export_filter.edge_filter["ExportFilterLabel"].properties["ExportFilterOutputPropertyName"].multi_value_handling #=> String, one of "TO_LIST", "PICK_FIRST"
|
2157
|
+
#
|
2158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/StartExportTask AWS API Documentation
|
2159
|
+
#
|
2160
|
+
# @overload start_export_task(params = {})
|
2161
|
+
# @param [Hash] params ({})
|
2162
|
+
def start_export_task(params = {}, options = {})
|
2163
|
+
req = build_request(:start_export_task, params)
|
2164
|
+
req.send_request(options)
|
2165
|
+
end
|
2166
|
+
|
1890
2167
|
# Import data into existing Neptune Analytics graph from Amazon Simple
|
1891
2168
|
# Storage Service (S3). The graph needs to be empty and in the AVAILABLE
|
1892
2169
|
# state.
|
@@ -1909,6 +2186,9 @@ module Aws::NeptuneGraph
|
|
1909
2186
|
# are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which
|
1910
2187
|
# identies the openCypher load format.
|
1911
2188
|
#
|
2189
|
+
# @option params [String] :parquet_type
|
2190
|
+
# The parquet type of the import task.
|
2191
|
+
#
|
1912
2192
|
# @option params [String] :blank_node_handling
|
1913
2193
|
# The method to handle blank nodes in the dataset. Currently, only
|
1914
2194
|
# `convertToIri` is supported, meaning blank nodes are converted to
|
@@ -1932,6 +2212,7 @@ module Aws::NeptuneGraph
|
|
1932
2212
|
# * {Types::StartImportTaskOutput#task_id #task_id} => String
|
1933
2213
|
# * {Types::StartImportTaskOutput#source #source} => String
|
1934
2214
|
# * {Types::StartImportTaskOutput#format #format} => String
|
2215
|
+
# * {Types::StartImportTaskOutput#parquet_type #parquet_type} => String
|
1935
2216
|
# * {Types::StartImportTaskOutput#role_arn #role_arn} => String
|
1936
2217
|
# * {Types::StartImportTaskOutput#status #status} => String
|
1937
2218
|
# * {Types::StartImportTaskOutput#import_options #import_options} => Types::ImportOptions
|
@@ -1949,7 +2230,8 @@ module Aws::NeptuneGraph
|
|
1949
2230
|
# },
|
1950
2231
|
# fail_on_error: false,
|
1951
2232
|
# source: "String", # required
|
1952
|
-
# format: "CSV", # accepts CSV, OPEN_CYPHER, NTRIPLES
|
2233
|
+
# format: "CSV", # accepts CSV, OPEN_CYPHER, PARQUET, NTRIPLES
|
2234
|
+
# parquet_type: "COLUMNAR", # accepts COLUMNAR
|
1953
2235
|
# blank_node_handling: "convertToIri", # accepts convertToIri
|
1954
2236
|
# graph_identifier: "GraphIdentifier", # required
|
1955
2237
|
# role_arn: "RoleArn", # required
|
@@ -1960,9 +2242,10 @@ module Aws::NeptuneGraph
|
|
1960
2242
|
# resp.graph_id #=> String
|
1961
2243
|
# resp.task_id #=> String
|
1962
2244
|
# resp.source #=> String
|
1963
|
-
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "NTRIPLES"
|
2245
|
+
# resp.format #=> String, one of "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES"
|
2246
|
+
# resp.parquet_type #=> String, one of "COLUMNAR"
|
1964
2247
|
# resp.role_arn #=> String
|
1965
|
-
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
|
2248
|
+
# resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED", "DELETED"
|
1966
2249
|
# resp.import_options.neptune.s3_export_path #=> String
|
1967
2250
|
# resp.import_options.neptune.s3_export_kms_key_id #=> String
|
1968
2251
|
# resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
|
@@ -2138,7 +2421,7 @@ module Aws::NeptuneGraph
|
|
2138
2421
|
tracer: tracer
|
2139
2422
|
)
|
2140
2423
|
context[:gem_name] = 'aws-sdk-neptunegraph'
|
2141
|
-
context[:gem_version] = '1.
|
2424
|
+
context[:gem_version] = '1.25.0'
|
2142
2425
|
Seahorse::Client::Request.new(handlers, context)
|
2143
2426
|
end
|
2144
2427
|
|
@@ -2206,6 +2489,8 @@ module Aws::NeptuneGraph
|
|
2206
2489
|
#
|
2207
2490
|
# | waiter_name | params | :delay | :max_attempts |
|
2208
2491
|
# | -------------------------------- | ----------------------------------- | -------- | ------------- |
|
2492
|
+
# | export_task_cancelled | {Client#get_export_task} | 60 | 60 |
|
2493
|
+
# | export_task_successful | {Client#get_export_task} | 60 | 480 |
|
2209
2494
|
# | graph_available | {Client#get_graph} | 60 | 480 |
|
2210
2495
|
# | graph_deleted | {Client#get_graph} | 60 | 60 |
|
2211
2496
|
# | graph_snapshot_available | {Client#get_graph_snapshot} | 60 | 120 |
|
@@ -2264,6 +2549,8 @@ module Aws::NeptuneGraph
|
|
2264
2549
|
|
2265
2550
|
def waiters
|
2266
2551
|
{
|
2552
|
+
export_task_cancelled: Waiters::ExportTaskCancelled,
|
2553
|
+
export_task_successful: Waiters::ExportTaskSuccessful,
|
2267
2554
|
graph_available: Waiters::GraphAvailable,
|
2268
2555
|
graph_deleted: Waiters::GraphDeleted,
|
2269
2556
|
graph_snapshot_available: Waiters::GraphSnapshotAvailable,
|