SageMakerFeatureStoreRuntime / Client / delete_record

delete_record#

SageMakerFeatureStoreRuntime.Client.delete_record(**kwargs)#

Deletes a Record from a FeatureGroup. When the DeleteRecord API is called a new record will be added to the OfflineStore and the Record will be removed from the OnlineStore. This record will have a value of True in the is_deleted column.

See also: AWS API Documentation

Request Syntax

response = client.delete_record(
    FeatureGroupName='string',
    RecordIdentifierValueAsString='string',
    EventTime='string',
    TargetStores=[
        'OnlineStore'|'OfflineStore',
    ]
)
Parameters:
  • FeatureGroupName (string) –

    [REQUIRED]

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

  • RecordIdentifierValueAsString (string) –

    [REQUIRED]

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

  • EventTime (string) –

    [REQUIRED]

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

  • TargetStores (list) –

    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.

    • (string) –

Returns:

None

Exceptions

  • SageMakerFeatureStoreRuntime.Client.exceptions.ValidationError

  • SageMakerFeatureStoreRuntime.Client.exceptions.InternalFailure

  • SageMakerFeatureStoreRuntime.Client.exceptions.ServiceUnavailable

  • SageMakerFeatureStoreRuntime.Client.exceptions.AccessForbidden