{ "version":"2.0", "metadata":{ "apiVersion":"2020-07-01", "endpointPrefix":"featurestore-runtime.sagemaker", "jsonVersion":"1.1", "protocol":"rest-json", "protocols":["rest-json"], "serviceFullName":"Amazon SageMaker Feature Store Runtime", "serviceId":"SageMaker FeatureStore Runtime", "signatureVersion":"v4", "signingName":"sagemaker", "uid":"sagemaker-featurestore-runtime-2020-07-01", "auth":["aws.auth#sigv4"] }, "operations":{ "BatchGetRecord":{ "name":"BatchGetRecord", "http":{ "method":"POST", "requestUri":"/BatchGetRecord" }, "input":{"shape":"BatchGetRecordRequest"}, "output":{"shape":"BatchGetRecordResponse"}, "errors":[ {"shape":"ValidationError"}, {"shape":"InternalFailure"}, {"shape":"ServiceUnavailable"}, {"shape":"AccessForbidden"} ], "documentation":"

Retrieves a batch of Records from a FeatureGroup.

" }, "DeleteRecord":{ "name":"DeleteRecord", "http":{ "method":"DELETE", "requestUri":"/FeatureGroup/{FeatureGroupName}" }, "input":{"shape":"DeleteRecordRequest"}, "errors":[ {"shape":"ValidationError"}, {"shape":"InternalFailure"}, {"shape":"ServiceUnavailable"}, {"shape":"AccessForbidden"} ], "documentation":"

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

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:

When a record is deleted from the OnlineStore, the deleted record marker is appended to the OfflineStore. If you have the Iceberg table format enabled for your OfflineStore, you can remove all history of a record from the OfflineStore using Amazon Athena or Apache Spark. For information on how to hard delete a record from the OfflineStore with the Iceberg table format enabled, see Delete records from the offline store.

" }, "GetRecord":{ "name":"GetRecord", "http":{ "method":"GET", "requestUri":"/FeatureGroup/{FeatureGroupName}" }, "input":{"shape":"GetRecordRequest"}, "output":{"shape":"GetRecordResponse"}, "errors":[ {"shape":"ValidationError"}, {"shape":"ResourceNotFound"}, {"shape":"InternalFailure"}, {"shape":"ServiceUnavailable"}, {"shape":"AccessForbidden"} ], "documentation":"

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.

" }, "PutRecord":{ "name":"PutRecord", "http":{ "method":"PUT", "requestUri":"/FeatureGroup/{FeatureGroupName}" }, "input":{"shape":"PutRecordRequest"}, "errors":[ {"shape":"ValidationError"}, {"shape":"InternalFailure"}, {"shape":"ServiceUnavailable"}, {"shape":"AccessForbidden"} ], "documentation":"

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.

" } }, "shapes":{ "AccessForbidden":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

You do not have permission to perform an action.

", "error":{"httpStatusCode":403}, "exception":true, "synthetic":true }, "BatchGetRecordError":{ "type":"structure", "required":[ "FeatureGroupName", "RecordIdentifierValueAsString", "ErrorCode", "ErrorMessage" ], "members":{ "FeatureGroupName":{ "shape":"ValueAsString", "documentation":"

The name of the feature group that the record belongs to.

" }, "RecordIdentifierValueAsString":{ "shape":"ValueAsString", "documentation":"

The value for the RecordIdentifier in string format of a Record from a FeatureGroup that is causing an error when attempting to be retrieved.

" }, "ErrorCode":{ "shape":"ValueAsString", "documentation":"

The error code of an error that has occurred when attempting to retrieve a batch of Records. For more information on errors, see Errors.

" }, "ErrorMessage":{ "shape":"Message", "documentation":"

The error message of an error that has occurred when attempting to retrieve a record in the batch.

" } }, "documentation":"

The error that has occurred when attempting to retrieve a batch of Records.

" }, "BatchGetRecordErrors":{ "type":"list", "member":{"shape":"BatchGetRecordError"}, "min":0 }, "BatchGetRecordIdentifier":{ "type":"structure", "required":[ "FeatureGroupName", "RecordIdentifiersValueAsString" ], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupNameOrArn", "documentation":"

The name or Amazon Resource Name (ARN) of the FeatureGroup containing the records you are retrieving in a batch.

" }, "RecordIdentifiersValueAsString":{ "shape":"RecordIdentifiers", "documentation":"

The value for a list of record identifiers in string format.

" }, "FeatureNames":{ "shape":"FeatureNames", "documentation":"

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

" } }, "documentation":"

The identifier that identifies the batch of Records you are retrieving in a batch.

" }, "BatchGetRecordIdentifiers":{ "type":"list", "member":{"shape":"BatchGetRecordIdentifier"}, "max":100, "min":1 }, "BatchGetRecordRequest":{ "type":"structure", "required":["Identifiers"], "members":{ "Identifiers":{ "shape":"BatchGetRecordIdentifiers", "documentation":"

A list containing the name or Amazon Resource Name (ARN) of the FeatureGroup, the list of names of Features to be retrieved, and the corresponding RecordIdentifier values as strings.

" }, "ExpirationTimeResponse":{ "shape":"ExpirationTimeResponse", "documentation":"

Parameter to request ExpiresAt in response. If Enabled, BatchGetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null, BatchGetRecord will return null.

" } } }, "BatchGetRecordResponse":{ "type":"structure", "required":[ "Records", "Errors", "UnprocessedIdentifiers" ], "members":{ "Records":{ "shape":"BatchGetRecordResultDetails", "documentation":"

A list of Records you requested to be retrieved in batch.

" }, "Errors":{ "shape":"BatchGetRecordErrors", "documentation":"

A list of errors that have occurred when retrieving a batch of Records.

" }, "UnprocessedIdentifiers":{ "shape":"UnprocessedIdentifiers", "documentation":"

A unprocessed list of FeatureGroup names, with their corresponding RecordIdentifier value, and Feature name.

" } } }, "BatchGetRecordResultDetail":{ "type":"structure", "required":[ "FeatureGroupName", "RecordIdentifierValueAsString", "Record" ], "members":{ "FeatureGroupName":{ "shape":"ValueAsString", "documentation":"

The FeatureGroupName containing Records you retrieved in a batch.

" }, "RecordIdentifierValueAsString":{ "shape":"ValueAsString", "documentation":"

The value of the record identifier in string format.

" }, "Record":{ "shape":"Record", "documentation":"

The Record retrieved.

" }, "ExpiresAt":{ "shape":"ExpiresAt", "documentation":"

The ExpiresAt ISO string of the requested record.

" } }, "documentation":"

The output of records that have been retrieved in a batch.

" }, "BatchGetRecordResultDetails":{ "type":"list", "member":{"shape":"BatchGetRecordResultDetail"}, "min":0 }, "DeleteRecordRequest":{ "type":"structure", "required":[ "FeatureGroupName", "RecordIdentifierValueAsString", "EventTime" ], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupNameOrArn", "documentation":"

The name or Amazon Resource Name (ARN) of the feature group to delete the record from.

", "location":"uri", "locationName":"FeatureGroupName" }, "RecordIdentifierValueAsString":{ "shape":"ValueAsString", "documentation":"

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

", "location":"querystring", "locationName":"RecordIdentifierValueAsString" }, "EventTime":{ "shape":"ValueAsString", "documentation":"

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

", "location":"querystring", "locationName":"EventTime" }, "TargetStores":{ "shape":"TargetStores", "documentation":"

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.

", "location":"querystring", "locationName":"TargetStores" }, "DeletionMode":{ "shape":"DeletionMode", "documentation":"

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

", "location":"querystring", "locationName":"DeletionMode" } } }, "DeletionMode":{ "type":"string", "enum":[ "SoftDelete", "HardDelete" ] }, "ExpirationTimeResponse":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "ExpiresAt":{"type":"string"}, "FeatureGroupNameOrArn":{ "type":"string", "max":150, "min":1, "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})" }, "FeatureName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}" }, "FeatureNames":{ "type":"list", "member":{"shape":"FeatureName"}, "min":1 }, "FeatureValue":{ "type":"structure", "required":["FeatureName"], "members":{ "FeatureName":{ "shape":"FeatureName", "documentation":"

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

" }, "ValueAsString":{ "shape":"ValueAsString", "documentation":"

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

" }, "ValueAsStringList":{ "shape":"ValueAsStringList", "documentation":"

The list of values in string format associated with a feature. Used when your CollectionType is a List, Set, or Vector. Note that features types can be String, Integral, or Fractional. These values represents all three types as a string.

" } }, "documentation":"

The value associated with a feature.

" }, "GetRecordRequest":{ "type":"structure", "required":[ "FeatureGroupName", "RecordIdentifierValueAsString" ], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupNameOrArn", "documentation":"

The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record.

", "location":"uri", "locationName":"FeatureGroupName" }, "RecordIdentifierValueAsString":{ "shape":"ValueAsString", "documentation":"

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

", "location":"querystring", "locationName":"RecordIdentifierValueAsString" }, "FeatureNames":{ "shape":"FeatureNames", "documentation":"

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

", "location":"querystring", "locationName":"FeatureName" }, "ExpirationTimeResponse":{ "shape":"ExpirationTimeResponse", "documentation":"

Parameter to request ExpiresAt in response. If Enabled, GetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null, GetRecord will return null.

", "location":"querystring", "locationName":"ExpirationTimeResponse" } } }, "GetRecordResponse":{ "type":"structure", "members":{ "Record":{ "shape":"Record", "documentation":"

The record you requested. A list of FeatureValues.

" }, "ExpiresAt":{ "shape":"ExpiresAt", "documentation":"

The ExpiresAt ISO string of the requested record.

" } } }, "InternalFailure":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "synthetic":true }, "Message":{ "type":"string", "max":2048 }, "PutRecordRequest":{ "type":"structure", "required":[ "FeatureGroupName", "Record" ], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupNameOrArn", "documentation":"

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

", "location":"uri", "locationName":"FeatureGroupName" }, "Record":{ "shape":"Record", "documentation":"

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:

" }, "TargetStores":{ "shape":"TargetStores", "documentation":"

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.

" }, "TtlDuration":{ "shape":"TtlDuration", "documentation":"

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.

" } } }, "Record":{ "type":"list", "member":{"shape":"FeatureValue"}, "min":1 }, "RecordIdentifiers":{ "type":"list", "member":{"shape":"ValueAsString"}, "max":100, "min":1 }, "ResourceNotFound":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

A resource that is required to perform an action was not found.

", "error":{"httpStatusCode":404}, "exception":true }, "ServiceUnavailable":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

The service is currently unavailable.

", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "synthetic":true }, "TargetStore":{ "type":"string", "enum":[ "OnlineStore", "OfflineStore" ] }, "TargetStores":{ "type":"list", "member":{"shape":"TargetStore"}, "max":2, "min":1 }, "TtlDuration":{ "type":"structure", "required":[ "Unit", "Value" ], "members":{ "Unit":{ "shape":"TtlDurationUnit", "documentation":"

TtlDuration time unit.

" }, "Value":{ "shape":"TtlDurationValue", "documentation":"

TtlDuration time value.

" } }, "documentation":"

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.

" }, "TtlDurationUnit":{ "type":"string", "enum":[ "Seconds", "Minutes", "Hours", "Days", "Weeks" ] }, "TtlDurationValue":{ "type":"integer", "min":1 }, "UnprocessedIdentifiers":{ "type":"list", "member":{"shape":"BatchGetRecordIdentifier"}, "min":0 }, "ValidationError":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

There was an error validating your request.

", "error":{"httpStatusCode":400}, "exception":true, "synthetic":true }, "ValueAsString":{ "type":"string", "max":358400, "pattern":".*" }, "ValueAsStringList":{ "type":"list", "member":{"shape":"ValueAsString"}, "max":358400, "min":0 } }, "documentation":"

Contains all data plane API operations and data types for the Amazon SageMaker Feature Store. Use this API to put, delete, and retrieve (get) features from a feature store.

Use the following operations to configure your OnlineStore and OfflineStore features, and to create and manage feature groups:

" }