Own AWS? Customize your docs with AI search, analytics, and more.

DELETE

/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

Deletes a <code>Record</code> from a <code>FeatureGroup</code> in the <code>OnlineStore</code>. Feature Store supports both <code>SOFT_DELETE</code> and <code>HARD_DELETE</code>. For <code>SOFT_DELETE</code> (default), feature columns are set to <code>null</code> and the record is no longer retrievable by <code>GetRecord</code> or <code>BatchGetRecord</code>. For<code> HARD_DELETE</code>, the complete <code>Record</code> is removed from the <code>OnlineStore</code>. In both cases, Feature Store appends the deleted record marker to the <code>OfflineStore</code> with feature values set to <code>null</code>, <code>is_deleted</code> value set to <code>True</code>, and <code>EventTime</code> set to the delete input <code>EventTime</code>. Note that the <code>EventTime</code> specified in <code>DeleteRecord</code> should be set later than the <code>EventTime</code> of the existing record in the <code>OnlineStore</code> for that <code>RecordIdentifer</code>. If it is not, the deletion does not occur: <ul> <li> For <code>SOFT_DELETE</code>, the existing (undeleted) record remains in the <code>OnlineStore</code>, though the delete record marker is still written to the <code>OfflineStore</code>. </li> <li> <code>HARD_DELETE</code> returns <code>EventTime</code>: <code>400 ValidationException</code> to indicate that the delete operation failed. No delete record marker is written to the <code>OfflineStore</code>. </li> </ul>

Access Token Required: API Key

Path Parameters

FeatureGroupNamestringrequired

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

Query Params

RecordIdentifierValueAsStringstringrequired

The value for the <code>RecordIdentifier</code> that uniquely identifies the record, in string format.

EventTimestringrequired

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

TargetStoresarray

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 <code>FeatureGroup</code>.

DeletionModestring

The name of the deletion mode for deleting the record. By default, the deletion mode is set to <code>SoftDelete</code>.

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

Access Token Required: API Key

Path Parameters

FeatureGroupNamestringrequired

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

Query Params

RecordIdentifierValueAsStringstringrequired

The value for the <code>RecordIdentifier</code> that uniquely identifies the record, in string format.

EventTimestringrequired

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

TargetStoresarray

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 <code>FeatureGroup</code>.

DeletionModestring

The name of the deletion mode for deleting the record. By default, the deletion mode is set to <code>SoftDelete</code>.

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

Access Token Required: API Key

Path Parameters

FeatureGroupNamestringrequired

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

Query Params

RecordIdentifierValueAsStringstringrequired

The value for the <code>RecordIdentifier</code> that uniquely identifies the record, in string format.

EventTimestringrequired

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

TargetStoresarray

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 <code>FeatureGroup</code>.

DeletionModestring

The name of the deletion mode for deleting the record. By default, the deletion mode is set to <code>SoftDelete</code>.

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime

Access Token Required: API Key

Path Parameters

FeatureGroupNamestringrequired

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

Query Params

RecordIdentifierValueAsStringstringrequired

The value for the <code>RecordIdentifier</code> that uniquely identifies the record, in string format.

EventTimestringrequired

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

TargetStoresarray

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 <code>FeatureGroup</code>.

DeletionModestring

The name of the deletion mode for deleting the record. By default, the deletion mode is set to <code>SoftDelete</code>.

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://featurestore-runtime.sagemaker.{region}.amazonaws.com/FeatureGroup/{FeatureGroupName}#RecordIdentifierValueAsString&EventTime' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}