SageMakerFeatureStoreRuntime / Client / delete_record

delete_record#

SageMakerFeatureStoreRuntime.Client.delete_record(**kwargs)#

Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both SOFT_DELETE and HARD_DELETE. For SOFT_DELETE (default), feature columns are set to null and the record is no longer retrievable by GetRecord or BatchGetRecord. For `` HARD_DELETE``, the complete Record is removed from the OnlineStore. In both cases, Feature Store appends the deleted record marker to the OfflineStore with feature values set to null, is_deleted value set to True, and EventTime set to the delete input EventTime.

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 SOFT_DELETE, the existing (undeleted) record remains in the OnlineStore, though the delete record marker is still written to the OfflineStore.

  • HARD_DELETE returns EventTime: 400 ValidationException to indicate that the delete operation failed. No delete record marker is written to the OfflineStore.

See also: AWS API Documentation

Request Syntax

response = client.delete_record(
    FeatureGroupName='string',
    RecordIdentifierValueAsString='string',
    EventTime='string',
    TargetStores=[
        'OnlineStore'|'OfflineStore',
    ],
    DeletionMode='SoftDelete'|'HardDelete'
)
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) –

  • DeletionMode (string) – The name of the deletion mode for deleting the record. By default, the deletion mode is set to SoftDelete.

Returns:

None

Exceptions

  • SageMakerFeatureStoreRuntime.Client.exceptions.ValidationError

  • SageMakerFeatureStoreRuntime.Client.exceptions.InternalFailure

  • SageMakerFeatureStoreRuntime.Client.exceptions.ServiceUnavailable

  • SageMakerFeatureStoreRuntime.Client.exceptions.AccessForbidden