Skip to content

Lists the RecordIdentifier values of all records stored in a FeatureGroup's OnlineStore

Description

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.

Usage

sagemakerfeaturestoreruntime_list_records(FeatureGroupName, MaxResults,
  NextToken, IncludeSoftDeletedRecords)

Arguments

  • FeatureGroupName

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

  • MaxResults

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

A token to resume pagination of list_records results.

  • IncludeSoftDeletedRecords

If set to true, the result includes records that have been soft deleted.

Value

A list with the following syntax:

list(
  RecordIdentifiers = list(
    "string"
  ),
  NextToken = "string"
)

Request syntax

svc$list_records(
  FeatureGroupName = "string",
  MaxResults = 123,
  NextToken = "string",
  IncludeSoftDeletedRecords = TRUE|FALSE
)