SageMakerFeatureStoreRuntime / Paginator / ListRecords

ListRecords¶

class SageMakerFeatureStoreRuntime.Paginator.ListRecords¶

paginator = client.get_paginator('list_records')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SageMakerFeatureStoreRuntime.Client.list_records().

Request Syntax

response_iterator = paginator.paginate(
    FeatureGroupName='string',
    IncludeSoftDeletedRecords=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

FeatureGroupName (string) –
[REQUIRED]

The name or Amazon Resource Name (ARN) of the feature group to list records from.
IncludeSoftDeletedRecords (boolean) – If set to true, the result includes records that have been soft deleted.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

(dict) –
- RecordIdentifiers (list) –
  
  A list of record identifier values for the records stored in the OnlineStore.
  - (string) –