GetRecord - Amazon SageMaker

GetRecord

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.

Request Syntax

GET /FeatureGroup/FeatureGroupName?ExpirationTimeResponse=ExpirationTimeResponse&FeatureName=FeatureNames&RecordIdentifierValueAsString=RecordIdentifierValueAsString HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ExpirationTimeResponse

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.

Valid Values: Enabled | Disabled

FeatureGroupName

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

Length Constraints: Minimum length of 1. Maximum length of 150.

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})

Required: Yes

FeatureNames

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

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}

RecordIdentifierValueAsString

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

Length Constraints: Maximum length of 358400.

Pattern: .*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ExpiresAt": "string", "Record": [ { "FeatureName": "string", "ValueAsString": "string", "ValueAsStringList": [ "string" ] } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ExpiresAt

The ExpiresAt ISO string of the requested record.

Type: String

Record

The record you requested. A list of FeatureValues.

Type: Array of FeatureValue objects

Array Members: Minimum number of 1 item.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessForbidden

You do not have permission to perform an action.

HTTP Status Code: 403

InternalFailure

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

HTTP Status Code: 500

ResourceNotFound

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

HTTP Status Code: 404

ServiceUnavailable

The service is currently unavailable.

HTTP Status Code: 503

ValidationError

There was an error validating your request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: