Skip to content
v2.274.0

IItemReader Interface ​

Base interface for Item Reader configurations.

Properties ​

bucketIBucketbucketIBucketbucketIBucketBucketIBucketBucketIBucketrequired#
S3 Bucket containing objects to iterate over or a file with a list to iterate over.
bucketNamePathmay be undefinedstringbucket_name_pathmay be undefinedstrbucketNamePathmay be undefinedStringBucketNamePathmay be undefinedstringBucketNamePathmay be undefined*string#
S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
maxItemsmay be undefinednumbermax_itemsmay be undefinedint | floatmaxItemsmay be undefinedNumberMaxItemsmay be undefineddoubleMaxItemsmay be undefined*float64#
Limits the number of items passed to the Distributed Map state.

Default: Distributed Map state will iterate over all items provided by the ItemReader

resourcestringresourcestrresourceStringResourcestringResource*stringrequired#
The Amazon S3 API action that Step Functions must invoke depending on the specified dataset.

Methods ​

providePolicyStatements(): PolicyStatement[]def provide_policy_statements(self, ) -> typing.List[PolicyStatement]public List<PolicyStatement> providePolicyStatements()public PolicyStatement[] ProvidePolicyStatements()func ProvidePolicyStatements() *[]PolicyStatement#
Compile policy statements to provide relevent permissions to the state machine.
render(queryLanguage?: QueryLanguage): anydef render(self, query_language: typing.Optional[QueryLanguage] = None) -> Anypublic Object render(QueryLanguage queryLanguage)public object Render(QueryLanguage? queryLanguage = null)func Render(QueryLanguage QueryLanguage) interface{}#
Render the ItemReader as JSON object.
validateItemReader(): string[]def validate_item_reader(self, ) -> typing.List[str]public List<String> validateItemReader()public string[] ValidateItemReader()func ValidateItemReader() *[]*string#
Validate that ItemReader contains exactly either.