Put Record

sagemakerfeaturestoreruntime_put_record

R Documentation

The PutRecord API is used to ingest a list of Records into your feature group

Description

The put_record 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 put_record 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.

Usage

sagemakerfeaturestoreruntime_put_record(FeatureGroupName, Record,
  TargetStores, TtlDuration)

Arguments

FeatureGroupName	[required] The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.
Record	[required] 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 get_record to retrieve the latest record. Update the record returned from get_record. Use put_record to update feature values.
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.
TtlDuration	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 delete_record API in the Amazon SageMaker API Reference guide.

Value

An empty list.

Request syntax

svc$put_record(
  FeatureGroupName = "string",
  Record = list(
    list(
      FeatureName = "string",
      ValueAsString = "string",
      ValueAsStringList = list(
        "string"
      )
    )
  ),
  TargetStores = list(
    "OnlineStore"|"OfflineStore"
  ),
  TtlDuration = list(
    Unit = "Seconds"|"Minutes"|"Hours"|"Days"|"Weeks",
    Value = 123
  )
)