Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListRecords

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.

Request Syntax


POST /FeatureGroup/FeatureGroupName/ListRecords HTTP/1.1
Content-type: application/json

{
   "IncludeSoftDeletedRecords": boolean,
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

FeatureGroupName

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

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

Request Body

The request accepts the following data in JSON format.

IncludeSoftDeletedRecords

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

Type: Boolean

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A token to resume pagination of ListRecords results.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RecordIdentifiers": [ "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.

NextToken

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

Type: String

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

RecordIdentifiers

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

Type: Array of strings

Length Constraints: Maximum length of 358400.

Pattern: .*

Errors

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

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