# Amazon SageMaker Feature Store Runtime The following actions are supported by Amazon SageMaker Feature Store Runtime: + [BatchGetRecord](API_feature_store_BatchGetRecord.md) + [DeleteRecord](API_feature_store_DeleteRecord.md) + [GetRecord](API_feature_store_GetRecord.md) + [PutRecord](API_feature_store_PutRecord.md) # BatchGetRecord Retrieves a batch of `Records` from a `FeatureGroup`. ## Request Syntax ``` POST /BatchGetRecord HTTP/1.1 Content-type: application/json { "ExpirationTimeResponse": "string", "Identifiers": [ { "FeatureGroupName": "string", "FeatureNames": [ "string" ], "RecordIdentifiersValueAsString": [ "string" ] } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ExpirationTimeResponse](#API_feature_store_BatchGetRecord_RequestSyntax) ** 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. Type: String Valid Values: `Enabled | Disabled` Required: No ** [Identifiers](#API_feature_store_BatchGetRecord_RequestSyntax) ** A list containing the name or Amazon Resource Name (ARN) of the `FeatureGroup`, the list of names of `Feature`s to be retrieved, and the corresponding `RecordIdentifier` values as strings. Type: Array of [BatchGetRecordIdentifier](API_feature_store_BatchGetRecordIdentifier.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "FeatureGroupName": "string", "RecordIdentifierValueAsString": "string" } ], "Records": [ { "ExpiresAt": "string", "FeatureGroupName": "string", "Record": [ { "FeatureName": "string", "ValueAsString": "string", "ValueAsStringList": [ "string" ] } ], "RecordIdentifierValueAsString": "string" } ], "UnprocessedIdentifiers": [ { "FeatureGroupName": "string", "FeatureNames": [ "string" ], "RecordIdentifiersValueAsString": [ "string" ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_feature_store_BatchGetRecord_ResponseSyntax) ** A list of errors that have occurred when retrieving a batch of Records. Type: Array of [BatchGetRecordError](API_feature_store_BatchGetRecordError.md) objects Array Members: Minimum number of 0 items. ** [Records](#API_feature_store_BatchGetRecord_ResponseSyntax) ** A list of Records you requested to be retrieved in batch. Type: Array of [BatchGetRecordResultDetail](API_feature_store_BatchGetRecordResultDetail.md) objects Array Members: Minimum number of 0 items. ** [UnprocessedIdentifiers](#API_feature_store_BatchGetRecord_ResponseSyntax) ** A unprocessed list of `FeatureGroup` names, with their corresponding `RecordIdentifier` value, and Feature name. Type: Array of [BatchGetRecordIdentifier](API_feature_store_BatchGetRecordIdentifier.md) objects Array Members: Minimum number of 0 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) # DeleteRecord 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](https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records.html#feature-store-delete-records-offline-store). ## Request Syntax ``` DELETE /FeatureGroup/FeatureGroupName?DeletionMode=DeletionMode&EventTime=EventTime&RecordIdentifierValueAsString=RecordIdentifierValueAsString&TargetStores=TargetStores HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DeletionMode](#API_feature_store_DeleteRecord_RequestSyntax) ** The name of the deletion mode for deleting the record. By default, the deletion mode is set to `SoftDelete`. Valid Values: `SoftDelete | HardDelete` ** [EventTime](#API_feature_store_DeleteRecord_RequestSyntax) ** Timestamp indicating when the deletion event occurred. `EventTime` can be used to query data at a certain point in time. Length Constraints: Maximum length of 358400. Pattern: `.*` Required: Yes ** [FeatureGroupName](#API_feature_store_DeleteRecord_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group to delete the record from. Length Constraints: Minimum length of 1. Maximum length of 150. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})` Required: Yes ** [RecordIdentifierValueAsString](#API_feature_store_DeleteRecord_RequestSyntax) ** The value for the `RecordIdentifier` that uniquely identifies the record, in string format. Length Constraints: Maximum length of 358400. Pattern: `.*` Required: Yes ** [TargetStores](#API_feature_store_DeleteRecord_RequestSyntax) ** 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`. Array Members: Minimum number of 1 item. Maximum number of 2 items. Valid Values: `OnlineStore | OfflineStore` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) # GetRecord 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. ## Request Syntax ``` GET /FeatureGroup/FeatureGroupName?ExpirationTimeResponse=ExpirationTimeResponse&FeatureName=FeatureNames&RecordIdentifierValueAsString=RecordIdentifierValueAsString HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ExpirationTimeResponse](#API_feature_store_GetRecord_RequestSyntax) ** 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. Valid Values: `Enabled | Disabled` ** [FeatureGroupName](#API_feature_store_GetRecord_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record. Length Constraints: Minimum length of 1. Maximum length of 150. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})` Required: Yes ** [FeatureNames](#API_feature_store_GetRecord_RequestSyntax) ** List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned. Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` ** [RecordIdentifierValueAsString](#API_feature_store_GetRecord_RequestSyntax) ** The value that corresponds to `RecordIdentifier` type and uniquely identifies the record in the `FeatureGroup`. Length Constraints: Maximum length of 358400. Pattern: `.*` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ExpiresAt": "string", "Record": [ { "FeatureName": "string", "ValueAsString": "string", "ValueAsStringList": [ "string" ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExpiresAt](#API_feature_store_GetRecord_ResponseSyntax) ** The `ExpiresAt` ISO string of the requested record. Type: String ** [Record](#API_feature_store_GetRecord_ResponseSyntax) ** The record you requested. A list of `FeatureValues`. Type: Array of [FeatureValue](API_feature_store_FeatureValue.md) objects Array Members: Minimum number of 1 item. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ResourceNotFound ** A resource that is required to perform an action was not found. HTTP Status Code: 404 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) # PutRecord 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` \$1 `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`. ## Request Syntax ``` PUT /FeatureGroup/FeatureGroupName HTTP/1.1 Content-type: application/json { "Record": [ { "FeatureName": "string", "ValueAsString": "string", "ValueAsStringList": [ "string" ] } ], "TargetStores": [ "string" ], "TtlDuration": { "Unit": "string", "Value": number } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [FeatureGroupName](#API_feature_store_PutRecord_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into. Length Constraints: Minimum length of 1. Maximum length of 150. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Record](#API_feature_store_PutRecord_RequestSyntax) ** 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. Type: Array of [FeatureValue](API_feature_store_FeatureValue.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [TargetStores](#API_feature_store_PutRecord_RequestSyntax) ** 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`. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 2 items. Valid Values: `OnlineStore | OfflineStore` Required: No ** [TtlDuration](#API_feature_store_PutRecord_RequestSyntax) ** Time to live duration, where the record is hard deleted after the expiration time is reached; `ExpiresAt` = `EventTime` \$1 `TtlDuration`. For information on HardDelete, see the [DeleteRecord](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) API in the Amazon SageMaker API Reference guide. Type: [TtlDuration](API_feature_store_TtlDuration.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/PutRecord)