SageMakerFeatureStoreRuntime / Client / get_record
get_record#
- SageMakerFeatureStoreRuntime.Client.get_record(**kwargs)#
Use for
OnlineStore
serving from aFeatureStore
. Only the latest records stored in theOnlineStore
can be retrieved. If no Record withRecordIdentifierValue
is found, then an empty result is returned.See also: AWS API Documentation
Request Syntax
response = client.get_record( FeatureGroupName='string', RecordIdentifierValueAsString='string', FeatureNames=[ 'string', ], ExpirationTimeResponse='Enabled'|'Disabled' )
- Parameters:
FeatureGroupName (string) –
[REQUIRED]
The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record.
RecordIdentifierValueAsString (string) –
[REQUIRED]
The value that corresponds to
RecordIdentifier
type and uniquely identifies the record in theFeatureGroup
.FeatureNames (list) –
List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.
(string) –
ExpirationTimeResponse (string) – Parameter to request
ExpiresAt
in response. IfEnabled
,GetRecord
will return the value ofExpiresAt
, if it is not null. IfDisabled
and null,GetRecord
will return null.
- Return type:
dict
- Returns:
Response Syntax
{ 'Record': [ { 'FeatureName': 'string', 'ValueAsString': 'string', 'ValueAsStringList': [ 'string', ] }, ], 'ExpiresAt': 'string' }
Response Structure
(dict) –
Record (list) –
The record you requested. A list of
FeatureValues
.(dict) –
The value associated with a feature.
FeatureName (string) –
The name of a feature that a feature value corresponds to.
ValueAsString (string) –
The value in string format associated with a feature. Used when your
CollectionType
isNone
. Note that features types can beString
,Integral
, orFractional
. This value represents all three types as a string.ValueAsStringList (list) –
The list of values in string format associated with a feature. Used when your
CollectionType
is aList
,Set
, orVector
. Note that features types can beString
,Integral
, orFractional
. These values represents all three types as a string.(string) –
ExpiresAt (string) –
The
ExpiresAt
ISO string of the requested record.
Exceptions
SageMakerFeatureStoreRuntime.Client.exceptions.ValidationError
SageMakerFeatureStoreRuntime.Client.exceptions.ResourceNotFound
SageMakerFeatureStoreRuntime.Client.exceptions.InternalFailure
SageMakerFeatureStoreRuntime.Client.exceptions.ServiceUnavailable
SageMakerFeatureStoreRuntime.Client.exceptions.AccessForbidden