Class: Aws::SageMakerFeatureStoreRuntime::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SageMakerFeatureStoreRuntime::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb
Overview
An API client for SageMakerFeatureStoreRuntime. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::SageMakerFeatureStoreRuntime::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#batch_get_record(params = {}) ⇒ Types::BatchGetRecordResponse
Retrieves a batch of ‘Records` from a `FeatureGroup`.
-
#delete_record(params = {}) ⇒ Struct
Deletes a ‘Record` from a `FeatureGroup` in the `OnlineStore`.
-
#get_record(params = {}) ⇒ Types::GetRecordResponse
Use for ‘OnlineStore` serving from a `FeatureStore`.
-
#put_record(params = {}) ⇒ Struct
The ‘PutRecord` API is used to ingest a list of `Records` into your feature group.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 422 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
726 727 728 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 726 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
729 730 731 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 729 def errors_module Errors end |
Instance Method Details
#batch_get_record(params = {}) ⇒ Types::BatchGetRecordResponse
Retrieves a batch of ‘Records` from a `FeatureGroup`.
486 487 488 489 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 486 def batch_get_record(params = {}, = {}) req = build_request(:batch_get_record, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
704 705 706 707 708 709 710 711 712 713 714 715 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 704 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-sagemakerfeaturestoreruntime' context[:gem_version] = '1.36.0' Seahorse::Client::Request.new(handlers, context) end |
#delete_record(params = {}) ⇒ Struct
Deletes a ‘Record` from a `FeatureGroup` in the `OnlineStore`. Feature Store supports both `SoftDelete` and `HardDelete`. For `SoftDelete` (default), feature columns are set to `null` and the record is no longer retrievable by `GetRecord` or `BatchGetRecord`. For `HardDelete`, the complete `Record` is removed from the `OnlineStore`. In both cases, Feature Store appends the deleted record marker to the `OfflineStore`. The deleted record marker is a record with the same `RecordIdentifer` as the original, but with `is_deleted` value set to `True`, `EventTime` set to the delete input `EventTime`, and other feature values set to `null`.
Note that the ‘EventTime` specified in `DeleteRecord` should be set later than the `EventTime` of the existing record in the `OnlineStore` for that `RecordIdentifer`. If it is not, the deletion does not occur:
-
For ‘SoftDelete`, the existing (not deleted) record remains in the `OnlineStore`, though the delete record marker is still written to the `OfflineStore`.
-
‘HardDelete` returns `EventTime`: `400 ValidationException` to indicate that the delete operation failed. No delete record marker is written to the `OfflineStore`.
When a record is deleted from the ‘OnlineStore`, the deleted record marker is appended to the `OfflineStore`. If you have the Iceberg table format enabled for your `OfflineStore`, you can remove all history of a record from the `OfflineStore` using Amazon Athena or Apache Spark. For information on how to hard delete a record from the `OfflineStore` with the Iceberg table format enabled, see [Delete records from the offline store].
563 564 565 566 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 563 def delete_record(params = {}, = {}) req = build_request(:delete_record, params) req.send_request() end |
#get_record(params = {}) ⇒ Types::GetRecordResponse
Use for ‘OnlineStore` serving from a `FeatureStore`. Only the latest records stored in the `OnlineStore` can be retrieved. If no Record with `RecordIdentifierValue` is found, then an empty result is returned.
617 618 619 620 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 617 def get_record(params = {}, = {}) req = build_request(:get_record, params) req.send_request() end |
#put_record(params = {}) ⇒ Struct
The ‘PutRecord` API is used to ingest a list of `Records` into your feature group.
If a new record’s ‘EventTime` is greater, the new record is written to both the `OnlineStore` and `OfflineStore`. Otherwise, the record is a historic record and it is written only to the `OfflineStore`.
You can specify the ingestion to be applied to the ‘OnlineStore`, `OfflineStore`, or both by using the `TargetStores` request parameter.
You can set the ingested record to expire at a given time to live (TTL) duration after the record’s event time, ‘ExpiresAt` = `EventTime` + `TtlDuration`, by specifying the `TtlDuration` parameter. A record level `TtlDuration` is set when specifying the `TtlDuration` parameter using the `PutRecord` API call. If the input `TtlDuration` is `null` or unspecified, `TtlDuration` is set to the default feature group level `TtlDuration`. A record level `TtlDuration` supersedes the group level `TtlDuration`.
695 696 697 698 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 695 def put_record(params = {}, = {}) req = build_request(:put_record, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
719 720 721 |
# File 'lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 719 def waiter_names [] end |