View Source aws_sagemaker_featurestore_runtime (aws v1.0.4)
Contains all data plane API operations and data types for the Amazon SageMaker Feature Store.
Use this API to put, delete, and retrieve (get) features from a feature store.
Use the following operations to configure your OnlineStore
and OfflineStore
features, and to create and manage feature groups:
CreateFeatureGroup: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFeatureGroup.html
DeleteFeatureGroup: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteFeatureGroup.html
DescribeFeatureGroup: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeFeatureGroup.html
ListFeatureGroups: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListFeatureGroups.html
Summary
Functions
Records
from a FeatureGroup
.Deletes a Record
from a FeatureGroup
in the OnlineStore
.
Use for OnlineStore
serving from a FeatureStore
.
The PutRecord
API is used to ingest a list of Records
into your feature group.
Functions
Records
from a FeatureGroup
.
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
.HardDelete
returnsEventTime
:400 ValidationException
to indicate that the delete operation failed. No delete record marker is written to theOfflineStore
.
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: https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records-offline-store.html#feature-store-delete-records-offline-store.
get_record(Client, FeatureGroupName, RecordIdentifierValueAsString)
View SourceUse for OnlineStore
serving from a FeatureStore
.
OnlineStore
can be retrieved. If no Record with RecordIdentifierValue
is found, then an empty result is returned.
get_record(Client, FeatureGroupName, RecordIdentifierValueAsString, QueryMap, HeadersMap)
View Sourceget_record(Client, FeatureGroupName, RecordIdentifierValueAsString, QueryMap, HeadersMap, Options0)
View SourceThe 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.
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
.