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:
Retrieves a batch of Records from a FeatureGroup.
Writes a batch of Records to one or more FeatureGroups. Use this API for bulk ingestion of records into the OnlineStore and OfflineStore.
You can set the ingested records to expire at a given time to live (TTL) duration after the record's event time by specifying the TtlDuration parameter. A request level TtlDuration applies to all entries that do not specify their own TtlDuration.
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.
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.
Lists the RecordIdentifier values of all records stored in a FeatureGroup's OnlineStore. This enables you to discover which records exist without retrieving the full record data.
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.
Updates one or more feature values for an existing record in the specified feature group. Features that you do not include in the request remain unchanged. You can update up to 100 features per call.
This operation is available only for feature groups that use the Standard_V2 or InMemory online store type.
The record must already exist. If the record does not exist or has been soft-deleted, the operation returns a ResourceNotFound error. To create a record, use PutRecord.
If you provide an EventTime that is older than the record's current EventTime, the service rejects the update with a ConflictException. If the EventTime is equal to or newer than the current value, the service applies the update. If you omit EventTime, the service keeps the record's existing EventTime and applies the update.
If you specify a TtlDuration, you must also provide an EventTime in the request. Otherwise, the operation returns a ValidationError.
You do not have permission to perform an action.
", "refs": {} }, "BatchGetRecordError": { "base": "The error that has occurred when attempting to retrieve a batch of Records.
", "refs": { "BatchGetRecordErrors$member": null } }, "BatchGetRecordErrors": { "base": null, "refs": { "BatchGetRecordResponse$Errors": "A list of errors that have occurred when retrieving a batch of Records.
" } }, "BatchGetRecordIdentifier": { "base": "The identifier that identifies the batch of Records you are retrieving in a batch.
", "refs": { "BatchGetRecordIdentifiers$member": null, "UnprocessedIdentifiers$member": null } }, "BatchGetRecordIdentifiers": { "base": null, "refs": { "BatchGetRecordRequest$Identifiers": "A list containing the name or Amazon Resource Name (ARN) of the FeatureGroup, the list of names of Features to be retrieved, and the corresponding RecordIdentifier values as strings.
The output of records that have been retrieved in a batch.
", "refs": { "BatchGetRecordResultDetails$member": null } }, "BatchGetRecordResultDetails": { "base": null, "refs": { "BatchGetRecordResponse$Records": "A list of Records you requested to be retrieved in batch.
" } }, "BatchWriteRecordEntries": { "base": null, "refs": { "BatchWriteRecordRequest$Entries": "A list of records to write. Each entry specifies the FeatureGroup, the record data, and optionally target stores and a TTL duration.
An entry to write as part of a BatchWriteRecord request.
The entry that failed to be written.
", "UnprocessedBatchWriteRecordEntries$member": null } }, "BatchWriteRecordError": { "base": "The error that has occurred when attempting to write a record in a batch.
", "refs": { "BatchWriteRecordErrors$member": null } }, "BatchWriteRecordErrors": { "base": null, "refs": { "BatchWriteRecordResponse$Errors": "A list of errors that occurred when writing records in the batch.
" } }, "BatchWriteRecordRequest": { "base": null, "refs": {} }, "BatchWriteRecordResponse": { "base": null, "refs": {} }, "Boolean": { "base": null, "refs": { "ListRecordsRequest$IncludeSoftDeletedRecords": "If set to true, the result includes records that have been soft deleted.
The service rejected the update because the provided EventTime is older than the record's current EventTime. To persist the update, retrieve the record's latest EventTime and resubmit the request with an EventTime that is equal to or newer than the current value.
The name of the deletion mode for deleting the record. By default, the deletion mode is set to SoftDelete.
Parameter to request ExpiresAt in response. If Enabled, BatchGetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null, BatchGetRecord will return null.
Parameter to request ExpiresAt in response. If Enabled, GetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null, GetRecord will return null.
The ExpiresAt ISO string of the requested record.
The ExpiresAt ISO string of the requested record.
The name or Amazon Resource Name (ARN) of the FeatureGroup containing the records you are retrieving in a batch.
The name or Amazon Resource Name (ARN) of the FeatureGroup to write the record to.
The name or Amazon Resource Name (ARN) of the feature group to delete the record from.
", "GetRecordRequest$FeatureGroupName": "The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record.
", "ListRecordsRequest$FeatureGroupName": "The name or Amazon Resource Name (ARN) of the feature group to list records from.
", "PutRecordRequest$FeatureGroupName": "The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.
", "UpdateRecordRequest$FeatureGroupName": "The identifier for the feature group that contains the record to update. You can specify one of the following:
The feature group name.
The feature group Amazon Resource Name (ARN).
The name of a feature that a feature value corresponds to.
" } }, "FeatureNames": { "base": null, "refs": { "BatchGetRecordIdentifier$FeatureNames": "List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.
", "GetRecordRequest$FeatureNames": "List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.
" } }, "FeatureValue": { "base": "The value associated with a feature.
", "refs": { "Record$member": null } }, "GetRecordRequest": { "base": null, "refs": {} }, "GetRecordResponse": { "base": null, "refs": {} }, "InternalFailure": { "base": "An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
", "refs": {} }, "ListRecordsMaxResults": { "base": null, "refs": { "ListRecordsRequest$MaxResults": "The maximum number of record identifiers to return in a single page of results. For the InMemory tier, this value is a hint and not a strict requirement. The response may contain more or fewer results than the specified MaxResults.
A token to resume pagination of ListRecords results.
A token to resume pagination if the response includes more record identifiers than MaxResults.
The error message of an error that has occurred when attempting to retrieve a record in the batch.
", "BatchWriteRecordError$ErrorMessage": "The error message for the failed record write.
", "ConflictException$Message": null, "InternalFailure$Message": null, "ResourceNotFound$Message": null, "ServiceUnavailable$Message": null, "ValidationError$Message": null } }, "PutRecordRequest": { "base": null, "refs": {} }, "Record": { "base": null, "refs": { "BatchGetRecordResultDetail$Record": "The Record retrieved.
List of FeatureValues to be inserted. This will be a full over-write.
", "GetRecordResponse$Record": "The record you requested. A list of FeatureValues.
List of FeatureValues to be inserted. This will be a full over-write. If you only want to update few of the feature values, do the following:
Use GetRecord to retrieve the latest record.
Update the record returned from GetRecord.
Use PutRecord to update feature values.
The feature values to write to the record.
" } }, "RecordIdentifierList": { "base": null, "refs": { "ListRecordsResponse$RecordIdentifiers": "A list of record identifier values for the records stored in the OnlineStore.
The value for a list of record identifiers in string format.
" } }, "ResourceNotFound": { "base": "A resource that is required to perform an action was not found.
", "refs": {} }, "ServiceUnavailable": { "base": "The service is currently unavailable.
", "refs": {} }, "TargetStore": { "base": null, "refs": { "TargetStores$member": null } }, "TargetStores": { "base": null, "refs": { "BatchWriteRecordEntry$TargetStores": "A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the FeatureGroup.
A list of stores from which you're deleting the record. By default, Feature Store deletes the record from all of the stores that you're using for the FeatureGroup.
A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the FeatureGroup.
The target stores for the record update. By default, Amazon SageMaker Feature Store updates the record in all stores associated with the FeatureGroup.
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Time to live duration for this entry, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. This overrides the request level TtlDuration.
Time to live duration applied to all entries in the batch that do not specify their own TtlDuration; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
The time-to-live (TTL) duration for the record. Amazon SageMaker Feature Store deletes the record when EventTime + TtlDuration elapses. If you omit this parameter, the record's existing TTL setting remains unchanged. For information about HardDelete, see the DeleteRecord operation in the Amazon SageMaker API Reference.
TtlDuration time unit.
TtlDuration time value.
A list of entries that were not processed. These entries can be retried.
" } }, "UnprocessedIdentifiers": { "base": null, "refs": { "BatchGetRecordResponse$UnprocessedIdentifiers": "A unprocessed list of FeatureGroup names, with their corresponding RecordIdentifier value, and Feature name.
There was an error validating your request.
", "refs": {} }, "ValueAsString": { "base": null, "refs": { "BatchGetRecordError$FeatureGroupName": "The name of the feature group that the record belongs to.
", "BatchGetRecordError$RecordIdentifierValueAsString": "The value for the RecordIdentifier in string format of a Record from a FeatureGroup that is causing an error when attempting to be retrieved.
The error code of an error that has occurred when attempting to retrieve a batch of Records. For more information on errors, see Errors.
", "BatchGetRecordResultDetail$FeatureGroupName": "The FeatureGroupName containing Records you retrieved in a batch.
The value of the record identifier in string format.
", "BatchWriteRecordError$ErrorCode": "The error code for the failed record write.
", "DeleteRecordRequest$RecordIdentifierValueAsString": "The value for the RecordIdentifier that uniquely identifies the record, in string format.
Timestamp indicating when the deletion event occurred. EventTime can be used to query data at a certain point in time.
The value in string format associated with a feature. Used when your CollectionType is None. Note that features types can be String, Integral, or Fractional. This value represents all three types as a string.
The value that corresponds to RecordIdentifier type and uniquely identifies the record in the FeatureGroup.
The value that uniquely identifies the record in the feature group. This must match the value defined by the feature group's record identifier feature.
", "ValueAsStringList$member": null } }, "ValueAsStringList": { "base": null, "refs": { "FeatureValue$ValueAsStringList": "The list of values in string format associated with a feature. Used when your CollectionType is a List, Set, or Vector. Note that features types can be String, Integral, or Fractional. These values represents all three types as a string.