@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSageMakerFeatureStoreRuntime
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSageMakerFeatureStoreRuntime instead.
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:
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
BatchGetRecordResult |
batchGetRecord(BatchGetRecordRequest batchGetRecordRequest)
Retrieves a batch of
Records from a FeatureGroup. |
DeleteRecordResult |
deleteRecord(DeleteRecordRequest deleteRecordRequest)
Deletes a
Record from a FeatureGroup in the OnlineStore. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetRecordResult |
getRecord(GetRecordRequest getRecordRequest)
Use for
OnlineStore serving from a FeatureStore. |
PutRecordResult |
putRecord(PutRecordRequest putRecordRequest)
Used for data ingestion into the
FeatureStore. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
static final String ENDPOINT_PREFIX
BatchGetRecordResult batchGetRecord(BatchGetRecordRequest batchGetRecordRequest)
Retrieves a batch of Records from a FeatureGroup.
batchGetRecordRequest - ValidationErrorException - There was an error validating your request.InternalFailureException - An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web
Services customer support.ServiceUnavailableException - The service is currently unavailable.AccessForbiddenException - You do not have permission to perform an action.DeleteRecordResult deleteRecord(DeleteRecordRequest deleteRecordRequest)
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.
deleteRecordRequest - ValidationErrorException - There was an error validating your request.InternalFailureException - An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web
Services customer support.ServiceUnavailableException - The service is currently unavailable.AccessForbiddenException - You do not have permission to perform an action.GetRecordResult getRecord(GetRecordRequest getRecordRequest)
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.
getRecordRequest - ValidationErrorException - There was an error validating your request.ResourceNotFoundException - A resource that is required to perform an action was not found.InternalFailureException - An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web
Services customer support.ServiceUnavailableException - The service is currently unavailable.AccessForbiddenException - You do not have permission to perform an action.PutRecordResult putRecord(PutRecordRequest putRecordRequest)
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.
putRecordRequest - ValidationErrorException - There was an error validating your request.InternalFailureException - An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web
Services customer support.ServiceUnavailableException - The service is currently unavailable.AccessForbiddenException - You do not have permission to perform an action.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.