lib/aws-sdk-neptunegraph/client.rb in aws-sdk-neptunegraph-1.5.0 vs lib/aws-sdk-neptunegraph/client.rb in aws-sdk-neptunegraph-1.6.0
- old
+ new
@@ -1804,10 +1804,89 @@
def restore_graph_from_snapshot(params = {}, options = {})
req = build_request(:restore_graph_from_snapshot, params)
req.send_request(options)
end
+ # Import data into existing Neptune Analytics graph from Amazon Simple
+ # Storage Service (S3). The graph needs to be empty and in the AVAILABLE
+ # state.
+ #
+ # @option params [Types::ImportOptions] :import_options
+ # Options for how to perform an import.
+ #
+ # @option params [Boolean] :fail_on_error
+ # If set to true, the task halts when an import error is encountered. If
+ # set to false, the task skips the data that caused the error and
+ # continues if possible.
+ #
+ # @option params [required, String] :source
+ # A URL identifying the location of the data to be imported. This can be
+ # an Amazon S3 path, or can point to a Neptune database endpoint or
+ # snapshot.
+ #
+ # @option params [String] :format
+ # Specifies the format of Amazon S3 data to be imported. Valid values
+ # are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which
+ # identies the openCypher load format.
+ #
+ # @option params [required, String] :graph_identifier
+ # The unique identifier of the Neptune Analytics graph.
+ #
+ # @option params [required, String] :role_arn
+ # The ARN of the IAM role that will allow access to the data that is to
+ # be imported.
+ #
+ # @return [Types::StartImportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::StartImportTaskOutput#graph_id #graph_id} => String
+ # * {Types::StartImportTaskOutput#task_id #task_id} => String
+ # * {Types::StartImportTaskOutput#source #source} => String
+ # * {Types::StartImportTaskOutput#format #format} => String
+ # * {Types::StartImportTaskOutput#role_arn #role_arn} => String
+ # * {Types::StartImportTaskOutput#status #status} => String
+ # * {Types::StartImportTaskOutput#import_options #import_options} => Types::ImportOptions
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.start_import_task({
+ # import_options: {
+ # neptune: {
+ # s3_export_path: "NeptuneImportOptionsS3ExportPathString", # required
+ # s3_export_kms_key_id: "NeptuneImportOptionsS3ExportKmsKeyIdString", # required
+ # preserve_default_vertex_labels: false,
+ # preserve_edge_ids: false,
+ # },
+ # },
+ # fail_on_error: false,
+ # source: "String", # required
+ # format: "CSV", # accepts CSV, OPEN_CYPHER
+ # graph_identifier: "GraphIdentifier", # required
+ # role_arn: "RoleArn", # required
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.graph_id #=> String
+ # resp.task_id #=> String
+ # resp.source #=> String
+ # resp.format #=> String, one of "CSV", "OPEN_CYPHER"
+ # resp.role_arn #=> String
+ # resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
+ # resp.import_options.neptune.s3_export_path #=> String
+ # resp.import_options.neptune.s3_export_kms_key_id #=> String
+ # resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
+ # resp.import_options.neptune.preserve_edge_ids #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/StartImportTask AWS API Documentation
+ #
+ # @overload start_import_task(params = {})
+ # @param [Hash] params ({})
+ def start_import_task(params = {}, options = {})
+ req = build_request(:start_import_task, params)
+ req.send_request(options)
+ end
+
# Adds tags to the specified resource.
#
# @option params [required, String] :resource_arn
# ARN of the resource for which tags need to be added.
#
@@ -1960,10 +2039,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-neptunegraph'
- context[:gem_version] = '1.5.0'
+ context[:gem_version] = '1.6.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#