Class: Aws::SageMakerFeatureStoreRuntime::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SageMakerFeatureStoreRuntime::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-sagemakerfeaturestoreruntime/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_record(params = {}) ⇒ Types::BatchGetRecordResponse
Retrieves a batch of
Recordsfrom aFeatureGroup. -
#delete_record(params = {}) ⇒ Struct
Deletes a
Recordfrom aFeatureGroupin theOnlineStore. -
#get_record(params = {}) ⇒ Types::GetRecordResponse
Use for
OnlineStoreserving from aFeatureStore. -
#put_record(params = {}) ⇒ Struct
The
PutRecordAPI is used to ingest a list ofRecordsinto your feature group.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-sagemakerfeaturestoreruntime/lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#batch_get_record(params = {}) ⇒ Types::BatchGetRecordResponse
Retrieves a batch of Records from a FeatureGroup.
537 538 539 540 |
# File 'gems/aws-sdk-sagemakerfeaturestoreruntime/lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 537 def batch_get_record(params = {}, = {}) req = build_request(:batch_get_record, params) req.send_request() 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 theOnlineStore, though the delete record marker is still written to theOfflineStore.HardDeletereturnsEventTime:400 ValidationExceptionto indicate that the delete operation failed. No delete record marker is written to theOfflineStore.
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.
614 615 616 617 |
# File 'gems/aws-sdk-sagemakerfeaturestoreruntime/lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 614 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.
668 669 670 671 |
# File 'gems/aws-sdk-sagemakerfeaturestoreruntime/lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 668 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.
746 747 748 749 |
# File 'gems/aws-sdk-sagemakerfeaturestoreruntime/lib/aws-sdk-sagemakerfeaturestoreruntime/client.rb', line 746 def put_record(params = {}, = {}) req = build_request(:put_record, params) req.send_request() end |