Amazon SageMaker Feature Store Runtime

2020/12/01 - Amazon SageMaker Feature Store Runtime - 3 new api methods

Changes  Update sagemaker client to latest version

GetRecord (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.get_record(
    FeatureGroupName='string',
    RecordIdentifierValueAsString='string',
    FeatureNames=[
        'string',
    ]
)
type FeatureGroupName:

string

param FeatureGroupName:

[REQUIRED]

The name of the feature group in which you want to put the records.

type RecordIdentifierValueAsString:

string

param RecordIdentifierValueAsString:

[REQUIRED]

The value that corresponds to RecordIdentifier type and uniquely identifies the record in the FeatureGroup.

type FeatureNames:

list

param FeatureNames:

List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Record': [
        {
            'FeatureName': 'string',
            'ValueAsString': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Record (list) --

      The record you requested. A list of FeatureValues.

      • (dict) --

        The value associated with a feature.

        • FeatureName (string) --

          The name of a feature that a feature value corresponds to.

        • ValueAsString (string) --

          The value associated with a feature, in string format. Note that features types can be String, Integral, or Fractional. This value represents all three types as a string.

DeleteRecord (new) Link ¶

Deletes a Record from a FeatureGroup. A new record will show up in the OfflineStore when the DeleteRecord API is called. This record will have a value of True in the is_deleted column.

See also: AWS API Documentation

Request Syntax

client.delete_record(
    FeatureGroupName='string',
    RecordIdentifierValueAsString='string',
    EventTime='string'
)
type FeatureGroupName:

string

param FeatureGroupName:

[REQUIRED]

The name of the feature group to delete the record from.

type RecordIdentifierValueAsString:

string

param RecordIdentifierValueAsString:

[REQUIRED]

The value for the RecordIdentifier that uniquely identifies the record, in string format.

type EventTime:

string

param EventTime:

[REQUIRED]

Timestamp indicating when the deletion event occurred. EventTime can be used to query data at a certain point in time.

returns:

None

PutRecord (new) Link ¶

Used for data ingestion into the FeatureStore. The PutRecord API writes to both the OnlineStore and OfflineStore. If the record is the latest record for the recordIdentifier, the record is written to both the OnlineStore and OfflineStore. If the record is a historic record, it is written only to the OfflineStore.

See also: AWS API Documentation

Request Syntax

client.put_record(
    FeatureGroupName='string',
    Record=[
        {
            'FeatureName': 'string',
            'ValueAsString': 'string'
        },
    ]
)
type FeatureGroupName:

string

param FeatureGroupName:

[REQUIRED]

The name of the feature group that you want to insert the record into.

type Record:

list

param 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 GetRecord to retrieve the latest record.

  • Update the record returned from GetRecord.

  • Use PutRecord to update feature values.

  • (dict) --

    The value associated with a feature.

    • FeatureName (string) -- [REQUIRED]

      The name of a feature that a feature value corresponds to.

    • ValueAsString (string) -- [REQUIRED]

      The value associated with a feature, in string format. Note that features types can be String, Integral, or Fractional. This value represents all three types as a string.

returns:

None