aws-sdk-sagemakerfeaturestoreruntime 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b20c383a510388f800e89e8457ceed0327b80df5bc99264ab8ae9cef0632dd17
-  data.tar.gz: 7527a5dd0cb6767ad09503d18735ed5b5284b3cf4f3eafbb8f0142b19c4f9ed0
+  metadata.gz: df34ad84e90e61964bb10ed527dfe9390b660d35a3b907317a622bf01c7d9157
+  data.tar.gz: db1ca94413777256e800fbed8d9a7c20a3c18e6de8ce49351d613ec98189c119
 SHA512:
-  metadata.gz: 2111307156f2a39a2f6df26d9ab4161c3c852533303eb68b0ed907785b360f08213e69b80c46d84b027245ef426f17a6facb67fc5a7655f7dfef2f49fd0477d2
-  data.tar.gz: 2e8efedc29b6d1e0f7f1d6f0e13d1e53d4c09bfb7d6cab2c4b2f7fde4c3a47d0d6df1ab1c9d2321e4693149eddfc05dcaf1f1a5ac4bc308c69519b91da21bb74
+  metadata.gz: 6656d203cc62c7b02c18e3a2de124577752355edaefe5d01f83acf1a9387eee9215ce677d6e52234b4a1233d98ed3ae9b8f3e84a0a4ee7726d2bc7fa47d84577
+  data.tar.gz: c32b3430c2e8713fd7c86310d65570bb2cda13895a537a4ac60e4b5aa81e99529e1e57f1c4f676382e82e48c47e7006df3592dbb9c1c9caec4050ab48748c5fe

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.3.0 (2021-06-10)
+------------------
+
+* Feature - Release BatchGetRecord API for AWS SageMaker Feature Store Runtime.
+
 1.2.0 (2021-03-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/aws-sdk-sagemakerfeaturestoreruntime.rb

@@ -28,7 +28,7 @@ require_relative 'aws-sdk-sagemakerfeaturestoreruntime/customizations'
 # structure.
 #
 #     sage_maker_feature_store_runtime = Aws::SageMakerFeatureStoreRuntime::Client.new
-#     resp = sage_maker_feature_store_runtime.delete_record(params)
+#     resp = sage_maker_feature_store_runtime.batch_get_record(params)
 #
 # See {Client} for more information.
 #
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-sagemakerfeaturestoreruntime/customizations'
 # @!group service
 module Aws::SageMakerFeatureStoreRuntime
 
-  GEM_VERSION = '1.2.0'
+  GEM_VERSION = '1.3.0'
 
 end

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

@@ -327,6 +327,60 @@ module Aws::SageMakerFeatureStoreRuntime
 
     # @!group API Operations
 
+    # Retrieves a batch of `Records` from a `FeatureGroup`.
+    #
+    # @option params [required, Array<Types::BatchGetRecordIdentifier>] :identifiers
+    #   A list of `FeatureGroup` names, with their corresponding
+    #   `RecordIdentifier` value, and Feature name that have been requested to
+    #   be retrieved in batch.
+    #
+    # @return [Types::BatchGetRecordResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetRecordResponse#records #records} => Array&lt;Types::BatchGetRecordResultDetail&gt;
+    #   * {Types::BatchGetRecordResponse#errors #errors} => Array&lt;Types::BatchGetRecordError&gt;
+    #   * {Types::BatchGetRecordResponse#unprocessed_identifiers #unprocessed_identifiers} => Array&lt;Types::BatchGetRecordIdentifier&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_record({
+    #     identifiers: [ # required
+    #       {
+    #         feature_group_name: "FeatureGroupName", # required
+    #         record_identifiers_value_as_string: ["ValueAsString"], # required
+    #         feature_names: ["FeatureName"],
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.records #=> Array
+    #   resp.records[0].feature_group_name #=> String
+    #   resp.records[0].record_identifier_value_as_string #=> String
+    #   resp.records[0].record #=> Array
+    #   resp.records[0].record[0].feature_name #=> String
+    #   resp.records[0].record[0].value_as_string #=> String
+    #   resp.errors #=> Array
+    #   resp.errors[0].feature_group_name #=> String
+    #   resp.errors[0].record_identifier_value_as_string #=> String
+    #   resp.errors[0].error_code #=> String
+    #   resp.errors[0].error_message #=> String
+    #   resp.unprocessed_identifiers #=> Array
+    #   resp.unprocessed_identifiers[0].feature_group_name #=> String
+    #   resp.unprocessed_identifiers[0].record_identifiers_value_as_string #=> Array
+    #   resp.unprocessed_identifiers[0].record_identifiers_value_as_string[0] #=> String
+    #   resp.unprocessed_identifiers[0].feature_names #=> Array
+    #   resp.unprocessed_identifiers[0].feature_names[0] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord AWS API Documentation
+    #
+    # @overload batch_get_record(params = {})
+    # @param [Hash] params ({})
+    def batch_get_record(params = {}, options = {})
+      req = build_request(:batch_get_record, params)
+      req.send_request(options)
+    end
+
     # Deletes a `Record` from a `FeatureGroup`. A new record will show up in
     # the `OfflineStore` when the `DeleteRecord` API is called. This record
     # will have a value of `True` in the `is_deleted` column.
@@ -460,7 +514,7 @@ module Aws::SageMakerFeatureStoreRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sagemakerfeaturestoreruntime'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -14,6 +14,14 @@ module Aws::SageMakerFeatureStoreRuntime
     include Seahorse::Model
 
     AccessForbidden = Shapes::StructureShape.new(name: 'AccessForbidden')
+    BatchGetRecordError = Shapes::StructureShape.new(name: 'BatchGetRecordError')
+    BatchGetRecordErrors = Shapes::ListShape.new(name: 'BatchGetRecordErrors')
+    BatchGetRecordIdentifier = Shapes::StructureShape.new(name: 'BatchGetRecordIdentifier')
+    BatchGetRecordIdentifiers = Shapes::ListShape.new(name: 'BatchGetRecordIdentifiers')
+    BatchGetRecordRequest = Shapes::StructureShape.new(name: 'BatchGetRecordRequest')
+    BatchGetRecordResponse = Shapes::StructureShape.new(name: 'BatchGetRecordResponse')
+    BatchGetRecordResultDetail = Shapes::StructureShape.new(name: 'BatchGetRecordResultDetail')
+    BatchGetRecordResultDetails = Shapes::ListShape.new(name: 'BatchGetRecordResultDetails')
     DeleteRecordRequest = Shapes::StructureShape.new(name: 'DeleteRecordRequest')
     FeatureGroupName = Shapes::StringShape.new(name: 'FeatureGroupName')
     FeatureName = Shapes::StringShape.new(name: 'FeatureName')
@@ -25,14 +33,46 @@ module Aws::SageMakerFeatureStoreRuntime
     Message = Shapes::StringShape.new(name: 'Message')
     PutRecordRequest = Shapes::StructureShape.new(name: 'PutRecordRequest')
     Record = Shapes::ListShape.new(name: 'Record')
+    RecordIdentifiers = Shapes::ListShape.new(name: 'RecordIdentifiers')
     ResourceNotFound = Shapes::StructureShape.new(name: 'ResourceNotFound')
     ServiceUnavailable = Shapes::StructureShape.new(name: 'ServiceUnavailable')
+    UnprocessedIdentifiers = Shapes::ListShape.new(name: 'UnprocessedIdentifiers')
     ValidationError = Shapes::StructureShape.new(name: 'ValidationError')
     ValueAsString = Shapes::StringShape.new(name: 'ValueAsString')
 
     AccessForbidden.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
     AccessForbidden.struct_class = Types::AccessForbidden
 
+    BatchGetRecordError.add_member(:feature_group_name, Shapes::ShapeRef.new(shape: ValueAsString, required: true, location_name: "FeatureGroupName"))
+    BatchGetRecordError.add_member(:record_identifier_value_as_string, Shapes::ShapeRef.new(shape: ValueAsString, required: true, location_name: "RecordIdentifierValueAsString"))
+    BatchGetRecordError.add_member(:error_code, Shapes::ShapeRef.new(shape: ValueAsString, required: true, location_name: "ErrorCode"))
+    BatchGetRecordError.add_member(:error_message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "ErrorMessage"))
+    BatchGetRecordError.struct_class = Types::BatchGetRecordError
+
+    BatchGetRecordErrors.member = Shapes::ShapeRef.new(shape: BatchGetRecordError)
+
+    BatchGetRecordIdentifier.add_member(:feature_group_name, Shapes::ShapeRef.new(shape: FeatureGroupName, required: true, location_name: "FeatureGroupName"))
+    BatchGetRecordIdentifier.add_member(:record_identifiers_value_as_string, Shapes::ShapeRef.new(shape: RecordIdentifiers, required: true, location_name: "RecordIdentifiersValueAsString"))
+    BatchGetRecordIdentifier.add_member(:feature_names, Shapes::ShapeRef.new(shape: FeatureNames, location_name: "FeatureNames"))
+    BatchGetRecordIdentifier.struct_class = Types::BatchGetRecordIdentifier
+
+    BatchGetRecordIdentifiers.member = Shapes::ShapeRef.new(shape: BatchGetRecordIdentifier)
+
+    BatchGetRecordRequest.add_member(:identifiers, Shapes::ShapeRef.new(shape: BatchGetRecordIdentifiers, required: true, location_name: "Identifiers"))
+    BatchGetRecordRequest.struct_class = Types::BatchGetRecordRequest
+
+    BatchGetRecordResponse.add_member(:records, Shapes::ShapeRef.new(shape: BatchGetRecordResultDetails, required: true, location_name: "Records"))
+    BatchGetRecordResponse.add_member(:errors, Shapes::ShapeRef.new(shape: BatchGetRecordErrors, required: true, location_name: "Errors"))
+    BatchGetRecordResponse.add_member(:unprocessed_identifiers, Shapes::ShapeRef.new(shape: UnprocessedIdentifiers, required: true, location_name: "UnprocessedIdentifiers"))
+    BatchGetRecordResponse.struct_class = Types::BatchGetRecordResponse
+
+    BatchGetRecordResultDetail.add_member(:feature_group_name, Shapes::ShapeRef.new(shape: ValueAsString, required: true, location_name: "FeatureGroupName"))
+    BatchGetRecordResultDetail.add_member(:record_identifier_value_as_string, Shapes::ShapeRef.new(shape: ValueAsString, required: true, location_name: "RecordIdentifierValueAsString"))
+    BatchGetRecordResultDetail.add_member(:record, Shapes::ShapeRef.new(shape: Record, required: true, location_name: "Record"))
+    BatchGetRecordResultDetail.struct_class = Types::BatchGetRecordResultDetail
+
+    BatchGetRecordResultDetails.member = Shapes::ShapeRef.new(shape: BatchGetRecordResultDetail)
+
     DeleteRecordRequest.add_member(:feature_group_name, Shapes::ShapeRef.new(shape: FeatureGroupName, required: true, location: "uri", location_name: "FeatureGroupName"))
     DeleteRecordRequest.add_member(:record_identifier_value_as_string, Shapes::ShapeRef.new(shape: ValueAsString, required: true, location: "querystring", location_name: "RecordIdentifierValueAsString"))
     DeleteRecordRequest.add_member(:event_time, Shapes::ShapeRef.new(shape: ValueAsString, required: true, location: "querystring", location_name: "EventTime"))
@@ -61,12 +101,16 @@ module Aws::SageMakerFeatureStoreRuntime
 
     Record.member = Shapes::ShapeRef.new(shape: FeatureValue)
 
+    RecordIdentifiers.member = Shapes::ShapeRef.new(shape: ValueAsString)
+
     ResourceNotFound.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
     ResourceNotFound.struct_class = Types::ResourceNotFound
 
     ServiceUnavailable.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
     ServiceUnavailable.struct_class = Types::ServiceUnavailable
 
+    UnprocessedIdentifiers.member = Shapes::ShapeRef.new(shape: BatchGetRecordIdentifier)
+
     ValidationError.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
     ValidationError.struct_class = Types::ValidationError
 
@@ -88,6 +132,18 @@ module Aws::SageMakerFeatureStoreRuntime
         "uid" => "sagemaker-featurestore-runtime-2020-07-01",
       }
 
+      api.add_operation(:batch_get_record, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "BatchGetRecord"
+        o.http_method = "POST"
+        o.http_request_uri = "/BatchGetRecord"
+        o.input = Shapes::ShapeRef.new(shape: BatchGetRecordRequest)
+        o.output = Shapes::ShapeRef.new(shape: BatchGetRecordResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationError)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailure)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailable)
+        o.errors << Shapes::ShapeRef.new(shape: AccessForbidden)
+      end)
+
       api.add_operation(:delete_record, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteRecord"
         o.http_method = "DELETE"

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

@@ -23,6 +23,156 @@ module Aws::SageMakerFeatureStoreRuntime
       include Aws::Structure
     end
 
+    # The error that has occurred when attempting to retrieve a batch of
+    # Records.
+    #
+    # @!attribute [rw] feature_group_name
+    #   The name of the feature group that the record belongs to.
+    #   @return [String]
+    #
+    # @!attribute [rw] record_identifier_value_as_string
+    #   The value for the `RecordIdentifier` in string format of a Record
+    #   from a `FeatureGroup` that is causing an error when attempting to be
+    #   retrieved.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_code
+    #   The error code of an error that has occured when attempting to
+    #   retrieve a batch of Records. For more information on errors, see [
+    #   Errors][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_GetRecord.html#API_feature_store_GetRecord_Errors
+    #   @return [String]
+    #
+    # @!attribute [rw] error_message
+    #   The error message of an error that has occured when attempting to
+    #   retrieve a record in the batch.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecordError AWS API Documentation
+    #
+    class BatchGetRecordError < Struct.new(
+      :feature_group_name,
+      :record_identifier_value_as_string,
+      :error_code,
+      :error_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The identifier that identifies the batch of Records you are retrieving
+    # in a batch.
+    #
+    # @note When making an API call, you may pass BatchGetRecordIdentifier
+    #   data as a hash:
+    #
+    #       {
+    #         feature_group_name: "FeatureGroupName", # required
+    #         record_identifiers_value_as_string: ["ValueAsString"], # required
+    #         feature_names: ["FeatureName"],
+    #       }
+    #
+    # @!attribute [rw] feature_group_name
+    #   A `FeatureGroupName` containing Records you are retrieving in a
+    #   batch.
+    #   @return [String]
+    #
+    # @!attribute [rw] record_identifiers_value_as_string
+    #   The value for a list of record identifiers in string format.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] feature_names
+    #   List of names of Features to be retrieved. If not specified, the
+    #   latest value for all the Features are returned.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecordIdentifier AWS API Documentation
+    #
+    class BatchGetRecordIdentifier < Struct.new(
+      :feature_group_name,
+      :record_identifiers_value_as_string,
+      :feature_names)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass BatchGetRecordRequest
+    #   data as a hash:
+    #
+    #       {
+    #         identifiers: [ # required
+    #           {
+    #             feature_group_name: "FeatureGroupName", # required
+    #             record_identifiers_value_as_string: ["ValueAsString"], # required
+    #             feature_names: ["FeatureName"],
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] identifiers
+    #   A list of `FeatureGroup` names, with their corresponding
+    #   `RecordIdentifier` value, and Feature name that have been requested
+    #   to be retrieved in batch.
+    #   @return [Array<Types::BatchGetRecordIdentifier>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecordRequest AWS API Documentation
+    #
+    class BatchGetRecordRequest < Struct.new(
+      :identifiers)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] records
+    #   A list of Records you requested to be retrieved in batch.
+    #   @return [Array<Types::BatchGetRecordResultDetail>]
+    #
+    # @!attribute [rw] errors
+    #   A list of errors that have occured when retrieving a batch of
+    #   Records.
+    #   @return [Array<Types::BatchGetRecordError>]
+    #
+    # @!attribute [rw] unprocessed_identifiers
+    #   A unprocessed list of `FeatureGroup` names, with their corresponding
+    #   `RecordIdentifier` value, and Feature name.
+    #   @return [Array<Types::BatchGetRecordIdentifier>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecordResponse AWS API Documentation
+    #
+    class BatchGetRecordResponse < Struct.new(
+      :records,
+      :errors,
+      :unprocessed_identifiers)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output of Records that have been retrieved in a batch.
+    #
+    # @!attribute [rw] feature_group_name
+    #   The `FeatureGroupName` containing Records you retrieved in a batch.
+    #   @return [String]
+    #
+    # @!attribute [rw] record_identifier_value_as_string
+    #   The value of the record identifer in string format.
+    #   @return [String]
+    #
+    # @!attribute [rw] record
+    #   The `Record` retrieved.
+    #   @return [Array<Types::FeatureValue>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecordResultDetail AWS API Documentation
+    #
+    class BatchGetRecordResultDetail < Struct.new(
+      :feature_group_name,
+      :record_identifier_value_as_string,
+      :record)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DeleteRecordRequest
     #   data as a hash:
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-sagemakerfeaturestoreruntime
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-sagemakerfeaturestoreruntime
-  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-sagemakerfeaturestoreruntime/CHANGELOG.md
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-sagemakerfeaturestoreruntime
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-sagemakerfeaturestoreruntime/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon SageMaker Feature Store Runtime