Documentation

Specifies a JSON data store stored in Amazon S3.

See: newS3JsonSource smart constructor.

Create a value of S3JsonSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalOptions:S3JsonSource', s3JsonSource_additionalOptions - Specifies additional connection options.

$sel:compressionType:S3JsonSource', s3JsonSource_compressionType - Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").

$sel:exclusions:S3JsonSource', s3JsonSource_exclusions - A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.

$sel:groupFiles:S3JsonSource', s3JsonSource_groupFiles - Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".

$sel:groupSize:S3JsonSource', s3JsonSource_groupSize - The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

$sel:jsonPath:S3JsonSource', s3JsonSource_jsonPath - A JsonPath string defining the JSON data.

$sel:maxBand:S3JsonSource', s3JsonSource_maxBand - This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

$sel:maxFilesInBand:S3JsonSource', s3JsonSource_maxFilesInBand - This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

$sel:multiline:S3JsonSource', s3JsonSource_multiline - A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.

$sel:outputSchemas:S3JsonSource', s3JsonSource_outputSchemas - Specifies the data schema for the S3 JSON source.

$sel:recurse:S3JsonSource', s3JsonSource_recurse - If set to true, recursively reads files in all subdirectories under the specified paths.

$sel:name:S3JsonSource', s3JsonSource_name - The name of the data store.

$sel:paths:S3JsonSource', s3JsonSource_paths - A list of the Amazon S3 paths to read from.

Specifies additional connection options.

Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").

A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.

Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".

The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

A JsonPath string defining the JSON data.

This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.

Specifies the data schema for the S3 JSON source.

If set to true, recursively reads files in all subdirectories under the specified paths.

The name of the data store.

A list of the Amazon S3 paths to read from.