aws-sdk-neptunegraph 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c173103569b1b83024481a73ef00a13ed912424ce979389e16cc124f45c49ef7
-  data.tar.gz: 66ad2ae39150d15cf31a9e13ac51e32195f62d3cab993f46ee229d7d3c1b06e4
+  metadata.gz: 50424775a60269822c9e3656ac908b9107cc34e834bacf5cdb1b860aa6b49250
+  data.tar.gz: bed42fadf1f6c8313691ac0da54fe4218f3731511c2baaffb2d4bbcc2874a3a8
 SHA512:
-  metadata.gz: cd943c9a098a39d6dbcaea2ef799a67295bae528da8a93dd174826585112ec69d698b1fa478de35694d6f1272dd7e8f188d8a41f482492f548051dd567778a07
-  data.tar.gz: 70579bf61632a03448b8c9a1ac085fa27dc62638896fdcc7f1fc9c8fd555fd02f7db17a1577ba565f5ba6b15c5b4e0c84fb1b4d832a88b26865447de737af7e7
+  metadata.gz: 8801663d4b0dc8b75839b6ea71f75795626809f07acdbea8496ee50f08d5bd1ef3eadce5c6720698986a49ccdb1a01e021491afbd95b953201cd654c0536d3d1
+  data.tar.gz: 226878539f5b96bfdaff0703e96eb1ad1fe66b431648382ce54da5dd22dd392ddc0607cc6a81141ef69da837fb8c36c82f1d6fdc5049dd48b54b535e5fb12e0e

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.6.0 (2024-03-29)
+------------------
+
+* Feature - Add the new API Start-Import-Task for Amazon Neptune Analytics.
+
 1.5.0 (2024-03-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/lib/aws-sdk-neptunegraph/client.rb

@@ -1806,6 +1806,85 @@ module Aws::NeptuneGraph
       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
@@ -1962,7 +2041,7 @@ module Aws::NeptuneGraph
         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
 

data/lib/aws-sdk-neptunegraph/client_api.rb

@@ -125,6 +125,8 @@ module Aws::NeptuneGraph
     SnapshotIdentifier = Shapes::StringShape.new(name: 'SnapshotIdentifier')
     SnapshotName = Shapes::StringShape.new(name: 'SnapshotName')
     SnapshotStatus = Shapes::StringShape.new(name: 'SnapshotStatus')
+    StartImportTaskInput = Shapes::StructureShape.new(name: 'StartImportTaskInput')
+    StartImportTaskOutput = Shapes::StructureShape.new(name: 'StartImportTaskOutput')
     String = Shapes::StringShape.new(name: 'String')
     SubnetId = Shapes::StringShape.new(name: 'SubnetId')
     SubnetIds = Shapes::ListShape.new(name: 'SubnetIds')
@@ -616,6 +618,23 @@ module Aws::NeptuneGraph
     ServiceQuotaExceededException.add_member(:quota_code, Shapes::ShapeRef.new(shape: String, location_name: "quotaCode"))
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
+    StartImportTaskInput.add_member(:import_options, Shapes::ShapeRef.new(shape: ImportOptions, location_name: "importOptions"))
+    StartImportTaskInput.add_member(:fail_on_error, Shapes::ShapeRef.new(shape: Boolean, location_name: "failOnError"))
+    StartImportTaskInput.add_member(:source, Shapes::ShapeRef.new(shape: String, required: true, location_name: "source"))
+    StartImportTaskInput.add_member(:format, Shapes::ShapeRef.new(shape: Format, location_name: "format"))
+    StartImportTaskInput.add_member(:graph_identifier, Shapes::ShapeRef.new(shape: GraphIdentifier, required: true, location: "uri", location_name: "graphIdentifier"))
+    StartImportTaskInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
+    StartImportTaskInput.struct_class = Types::StartImportTaskInput
+
+    StartImportTaskOutput.add_member(:graph_id, Shapes::ShapeRef.new(shape: GraphId, location_name: "graphId"))
+    StartImportTaskOutput.add_member(:task_id, Shapes::ShapeRef.new(shape: TaskId, required: true, location_name: "taskId"))
+    StartImportTaskOutput.add_member(:source, Shapes::ShapeRef.new(shape: String, required: true, location_name: "source"))
+    StartImportTaskOutput.add_member(:format, Shapes::ShapeRef.new(shape: Format, location_name: "format"))
+    StartImportTaskOutput.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
+    StartImportTaskOutput.add_member(:status, Shapes::ShapeRef.new(shape: ImportTaskStatus, required: true, location_name: "status"))
+    StartImportTaskOutput.add_member(:import_options, Shapes::ShapeRef.new(shape: ImportOptions, location_name: "importOptions"))
+    StartImportTaskOutput.struct_class = Types::StartImportTaskOutput
+
     SubnetIds.member = Shapes::ShapeRef.new(shape: SubnetId)
 
     TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey)
@@ -1036,6 +1055,19 @@ module Aws::NeptuneGraph
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:start_import_task, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartImportTask"
+        o.http_method = "POST"
+        o.http_request_uri = "/graphs/{graphIdentifier}/importtasks"
+        o.input = Shapes::ShapeRef.new(shape: StartImportTaskInput)
+        o.output = Shapes::ShapeRef.new(shape: StartImportTaskOutput)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
         o.name = "TagResource"
         o.http_method = "POST"

data/lib/aws-sdk-neptunegraph/endpoints.rb

@@ -372,6 +372,21 @@ module Aws::NeptuneGraph
       end
     end
 
+    class StartImportTask
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::NeptuneGraph::EndpointParameters.new(
+          region: context.config.region,
+          use_fips: context.config.use_fips_endpoint,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          endpoint: endpoint,
+          api_type: "ControlPlane",
+        )
+      end
+    end
+
     class TagResource
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-neptunegraph/plugins/endpoints.rb

@@ -106,6 +106,8 @@ module Aws::NeptuneGraph
             Aws::NeptuneGraph::Endpoints::ResetGraph.build(context)
           when :restore_graph_from_snapshot
             Aws::NeptuneGraph::Endpoints::RestoreGraphFromSnapshot.build(context)
+          when :start_import_task
+            Aws::NeptuneGraph::Endpoints::StartImportTask.build(context)
           when :tag_resource
             Aws::NeptuneGraph::Endpoints::TagResource.build(context)
           when :untag_resource

data/lib/aws-sdk-neptunegraph/types.rb

@@ -2284,6 +2284,97 @@ module Aws::NeptuneGraph
       include Aws::Structure
     end
 
+    # @!attribute [rw] import_options
+    #   Options for how to perform an import.
+    #   @return [Types::ImportOptions]
+    #
+    # @!attribute [rw] 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.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] graph_identifier
+    #   The unique identifier of the Neptune Analytics graph.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   The ARN of the IAM role that will allow access to the data that is
+    #   to be imported.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/StartImportTaskInput AWS API Documentation
+    #
+    class StartImportTaskInput < Struct.new(
+      :import_options,
+      :fail_on_error,
+      :source,
+      :format,
+      :graph_identifier,
+      :role_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] graph_id
+    #   The unique identifier of the Neptune Analytics graph.
+    #   @return [String]
+    #
+    # @!attribute [rw] task_id
+    #   The unique identifier of the import task.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   The ARN of the IAM role that will allow access to the data that is
+    #   to be imported.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the import task.
+    #   @return [String]
+    #
+    # @!attribute [rw] import_options
+    #   Options for how to perform an import.
+    #   @return [Types::ImportOptions]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/StartImportTaskOutput AWS API Documentation
+    #
+    class StartImportTaskOutput < Struct.new(
+      :graph_id,
+      :task_id,
+      :source,
+      :format,
+      :role_arn,
+      :status,
+      :import_options)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] resource_arn
     #   ARN of the resource for which tags need to be added.
     #   @return [String]

data/lib/aws-sdk-neptunegraph.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-neptunegraph/customizations'
 # @!group service
 module Aws::NeptuneGraph
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.6.0'
 
 end

data/sig/client.rbs

@@ -499,6 +499,34 @@ module Aws
                                        ) -> _RestoreGraphFromSnapshotResponseSuccess
                                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RestoreGraphFromSnapshotResponseSuccess
 
+      interface _StartImportTaskResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::StartImportTaskOutput]
+        def graph_id: () -> ::String
+        def task_id: () -> ::String
+        def source: () -> ::String
+        def format: () -> ("CSV" | "OPEN_CYPHER")
+        def role_arn: () -> ::String
+        def status: () -> ("INITIALIZING" | "EXPORTING" | "ANALYZING_DATA" | "IMPORTING" | "REPROVISIONING" | "ROLLING_BACK" | "SUCCEEDED" | "FAILED" | "CANCELLING" | "CANCELLED")
+        def import_options: () -> Types::ImportOptions
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NeptuneGraph/Client.html#start_import_task-instance_method
+      def start_import_task: (
+                               ?import_options: {
+                                 neptune: {
+                                   s3_export_path: ::String,
+                                   s3_export_kms_key_id: ::String,
+                                   preserve_default_vertex_labels: bool?,
+                                   preserve_edge_ids: bool?
+                                 }?
+                               },
+                               ?fail_on_error: bool,
+                               source: ::String,
+                               ?format: ("CSV" | "OPEN_CYPHER"),
+                               graph_identifier: ::String,
+                               role_arn: ::String
+                             ) -> _StartImportTaskResponseSuccess
+                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartImportTaskResponseSuccess
+
       interface _TagResourceResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceOutput]
       end

data/sig/types.rbs

@@ -566,6 +566,27 @@ module Aws::NeptuneGraph
       SENSITIVE: []
     end
 
+    class StartImportTaskInput
+      attr_accessor import_options: Types::ImportOptions
+      attr_accessor fail_on_error: bool
+      attr_accessor source: ::String
+      attr_accessor format: ("CSV" | "OPEN_CYPHER")
+      attr_accessor graph_identifier: ::String
+      attr_accessor role_arn: ::String
+      SENSITIVE: []
+    end
+
+    class StartImportTaskOutput
+      attr_accessor graph_id: ::String
+      attr_accessor task_id: ::String
+      attr_accessor source: ::String
+      attr_accessor format: ("CSV" | "OPEN_CYPHER")
+      attr_accessor role_arn: ::String
+      attr_accessor status: ("INITIALIZING" | "EXPORTING" | "ANALYZING_DATA" | "IMPORTING" | "REPROVISIONING" | "ROLLING_BACK" | "SUCCEEDED" | "FAILED" | "CANCELLING" | "CANCELLED")
+      attr_accessor import_options: Types::ImportOptions
+      SENSITIVE: []
+    end
+
     class TagResourceInput
       attr_accessor resource_arn: ::String
       attr_accessor tags: ::Hash[::String, ::String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-neptunegraph
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core