SageMakerFeatureStoreRuntime / Client / list_records

list_records

SageMakerFeatureStoreRuntime.Client.list_records(**kwargs)

Lists the RecordIdentifier values of all records stored in a FeatureGroup’s OnlineStore. This enables you to discover which records exist without retrieving the full record data.

See also: AWS API Documentation

Request Syntax

response = client.list_records(
    FeatureGroupName='string',
    MaxResults=123,
    NextToken='string',
    IncludeSoftDeletedRecords=True|False
)
Parameters:

  • FeatureGroupName (string) –

    [REQUIRED]

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

  • MaxResults (integer) – The maximum number of record identifiers to return in a single page of results. For the InMemory tier, this value is a hint and not a strict requirement. The response may contain more or fewer results than the specified MaxResults.

  • NextToken (string) – A token to resume pagination of ListRecords results.

  • IncludeSoftDeletedRecords (boolean) – If set to true, the result includes records that have been soft deleted.

Return type:

dict

Returns:

Response Syntax

{
    'RecordIdentifiers': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RecordIdentifiers (list) –

      A list of record identifier values for the records stored in the OnlineStore.

      • (string) –

    • NextToken (string) –

      A token to resume pagination if the response includes more record identifiers than MaxResults.

Exceptions

  • SageMakerFeatureStoreRuntime.Client.exceptions.ValidationError

  • SageMakerFeatureStoreRuntime.Client.exceptions.ResourceNotFound

  • SageMakerFeatureStoreRuntime.Client.exceptions.InternalFailure

  • SageMakerFeatureStoreRuntime.Client.exceptions.ServiceUnavailable

  • SageMakerFeatureStoreRuntime.Client.exceptions.AccessForbidden