com.amazonaws.services.sagemakerfeaturestoreruntime

Interface AmazonSageMakerFeatureStoreRuntime

All Known Subinterfaces:

AmazonSageMakerFeatureStoreRuntimeAsync

All Known Implementing Classes:

AbstractAmazonSageMakerFeatureStoreRuntime, AbstractAmazonSageMakerFeatureStoreRuntimeAsync, AmazonSageMakerFeatureStoreRuntimeAsyncClient, AmazonSageMakerFeatureStoreRuntimeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSageMakerFeatureStoreRuntime

Interface for accessing Amazon SageMaker Feature Store Runtime.

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:

• CreateFeatureGroup

• DeleteFeatureGroup

• DescribeFeatureGroup

• ListFeatureGroups

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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) The PutRecord API is used to ingest a list of Records into your feature group.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchGetRecord

BatchGetRecordResult batchGetRecord(BatchGetRecordRequest batchGetRecordRequest)

Retrieves a batch of Records from a FeatureGroup.

Parameters:

batchGetRecordRequest -

Returns:

Result of the BatchGetRecord operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteRecord

DeleteRecordResult deleteRecord(DeleteRecordRequest deleteRecordRequest)

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:

• For SoftDelete, the existing (not deleted) record remains in the OnlineStore, though the delete record marker is still written to the OfflineStore.

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

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.

Parameters:

deleteRecordRequest -

Returns:

Result of the DeleteRecord operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRecord

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.

Parameters:

getRecordRequest -

Returns:

Result of the GetRecord operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putRecord

PutRecordResult putRecord(PutRecordRequest putRecordRequest)

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.

Parameters:

putRecordRequest -

Returns:

Result of the PutRecord operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.