PUTRECORD()`¶

About 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 + 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.

Method Signature¶

METHODS /AWS1/IF_SGF~PUTRECORD
  IMPORTING
    !IV_FEATUREGROUPNAME TYPE /AWS1/SGFFEATUREGROUPNAMEORARN OPTIONAL
    !IT_RECORD TYPE /AWS1/CL_SGFFEATUREVALUE=>TT_RECORD OPTIONAL
    !IT_TARGETSTORES TYPE /AWS1/CL_SGFTARGETSTORES_W=>TT_TARGETSTORES OPTIONAL
    !IO_TTLDURATION TYPE REF TO /AWS1/CL_SGFTTLDURATION OPTIONAL
  RAISING
    /AWS1/CX_SGFACCESSFORBIDDEN
    /AWS1/CX_SGFINTERNALFAILURE
    /AWS1/CX_SGFSERVICEUNAVAILABLE
    /AWS1/CX_SGFVALIDATIONERROR
    /AWS1/CX_SGFCLIENTEXC
    /AWS1/CX_SGFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_featuregroupname` `TYPE /AWS1/SGFFEATUREGROUPNAMEORARN` `/AWS1/SGFFEATUREGROUPNAMEORARN`¶

The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.

`it_record` `TYPE /AWS1/CL_SGFFEATUREVALUE=>TT_RECORD` `TT_RECORD`¶

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.

Optional arguments:¶

`it_targetstores` `TYPE /AWS1/CL_SGFTARGETSTORES_W=>TT_TARGETSTORES` `TT_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.

`io_ttlduration` `TYPE REF TO /AWS1/CL_SGFTTLDURATION` `/AWS1/CL_SGFTTLDURATION`¶

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.

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->putrecord(
  io_ttlduration = new /aws1/cl_sgfttlduration(
    iv_unit = |string|
    iv_value = 123
  )
  it_record = VALUE /aws1/cl_sgffeaturevalue=>tt_record(
    (
      new /aws1/cl_sgffeaturevalue(
        it_valueasstringlist = VALUE /aws1/cl_sgfvalueasstrlist_w=>tt_valueasstringlist(
          ( new /aws1/cl_sgfvalueasstrlist_w( |string| ) )
        )
        iv_featurename = |string|
        iv_valueasstring = |string|
      )
    )
  )
  it_targetstores = VALUE /aws1/cl_sgftargetstores_w=>tt_targetstores(
    ( new /aws1/cl_sgftargetstores_w( |string| ) )
  )
  iv_featuregroupname = |string|
).

/AWS1/IF_SGF=>PUTRECORD()¶