Package-level declarations

Types

Link copied to clipboard
data class DatasetCsvOptions(val delimiter: String? = null, val headerRow: Boolean? = null)

Csv options

Link copied to clipboard
data class DatasetDatabaseInputDefinition(val databaseTableName: String? = null, val glueConnectionName: String, val queryString: String? = null, val tempDirectory: DatasetS3Location? = null)
Link copied to clipboard
data class DatasetDataCatalogInputDefinition(val catalogId: String? = null, val databaseName: String? = null, val tableName: String? = null, val tempDirectory: DatasetS3Location? = null)
Link copied to clipboard
data class DatasetDatetimeOptions(val format: String, val localeCode: String? = null, val timezoneOffset: String? = null)
Link copied to clipboard
data class DatasetExcelOptions(val headerRow: Boolean? = null, val sheetIndexes: List<Int>? = null, val sheetNames: List<String>? = null)
Link copied to clipboard
data class DatasetFilesLimit(val maxFiles: Int, val order: DatasetFilesLimitOrder? = null, val orderedBy: DatasetFilesLimitOrderedBy? = null)
Link copied to clipboard
data class DatasetFilterExpression(val expression: String, val valuesMap: List<DatasetFilterValue>)
Link copied to clipboard
data class DatasetFilterValue(val value: String, val valueReference: String)

A key-value pair to associate expression variable names with their values

Link copied to clipboard
data class DatasetFormatOptions(val csv: DatasetCsvOptions? = null, val excel: DatasetExcelOptions? = null, val json: DatasetJsonOptions? = null)

Format options for dataset

Link copied to clipboard
data class DatasetInput(val dataCatalogInputDefinition: DatasetDataCatalogInputDefinition? = null, val databaseInputDefinition: DatasetDatabaseInputDefinition? = null, val metadata: DatasetMetadata? = null, val s3InputDefinition: DatasetS3Location? = null)

Input

Link copied to clipboard
data class DatasetJsonOptions(val multiLine: Boolean? = null)

Json options

Link copied to clipboard
data class DatasetMetadata(val sourceArn: String? = null)
Link copied to clipboard
data class DatasetParameter(val createColumn: Boolean? = null, val datetimeOptions: DatasetDatetimeOptions? = null, val filter: DatasetFilterExpression? = null, val name: String, val type: DatasetParameterType)
Link copied to clipboard
data class DatasetPathOptions(val filesLimit: DatasetFilesLimit? = null, val lastModifiedDateCondition: DatasetFilterExpression? = null, val parameters: List<DatasetPathParameter>? = null)

Path options for dataset

Link copied to clipboard
data class DatasetPathParameter(val datasetParameter: DatasetParameter, val pathParameterName: String)

A key-value pair to associate dataset parameter name with its definition.

Link copied to clipboard
data class DatasetS3Location(val bucket: String, val bucketOwner: String? = null, val key: String? = null)

Input location

Link copied to clipboard
data class GetDatasetResult(val format: DatasetFormat? = null, val formatOptions: DatasetFormatOptions? = null, val input: DatasetInput? = null, val pathOptions: DatasetPathOptions? = null, val source: DatasetSource? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetJobResult(val dataCatalogOutputs: List<JobDataCatalogOutput>? = null, val databaseOutputs: List<JobDatabaseOutput>? = null, val datasetName: String? = null, val encryptionKeyArn: String? = null, val encryptionMode: JobEncryptionMode? = null, val jobSample: JobSample? = null, val logSubscription: JobLogSubscription? = null, val maxCapacity: Int? = null, val maxRetries: Int? = null, val outputLocation: JobOutputLocation? = null, val outputs: List<JobOutput>? = null, val profileConfiguration: JobProfileConfiguration? = null, val projectName: String? = null, val recipe: JobRecipe? = null, val roleArn: String? = null, val tags: List<Tag>? = null, val timeout: Int? = null, val validationConfigurations: List<JobValidationConfiguration>? = null)
Link copied to clipboard
data class GetProjectResult(val datasetName: String? = null, val recipeName: String? = null, val roleArn: String? = null, val sample: ProjectSample? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetRecipeResult(val description: String? = null, val steps: List<RecipeStep>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetRulesetResult(val description: String? = null, val rules: List<RulesetRule>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetScheduleResult(val cronExpression: String? = null, val jobNames: List<String>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class JobAllowedStatistics(val statistics: List<String>)
Link copied to clipboard
data class JobColumnSelector(val name: String? = null, val regex: String? = null)
Link copied to clipboard
data class JobColumnStatisticsConfiguration(val selectors: List<JobColumnSelector>? = null, val statistics: JobStatisticsConfiguration)
Link copied to clipboard
data class JobCsvOutputOptions(val delimiter: String? = null)

Output Csv options

Link copied to clipboard
data class JobDatabaseOutput(val databaseOptions: JobDatabaseTableOutputOptions, val databaseOutputMode: JobDatabaseOutputDatabaseOutputMode? = null, val glueConnectionName: String)
Link copied to clipboard
data class JobDatabaseTableOutputOptions(val tableName: String, val tempDirectory: JobS3Location? = null)
Link copied to clipboard
data class JobDataCatalogOutput(val catalogId: String? = null, val databaseName: String, val databaseOptions: JobDatabaseTableOutputOptions? = null, val overwrite: Boolean? = null, val s3Options: JobS3TableOutputOptions? = null, val tableName: String)
Link copied to clipboard
data class JobEntityDetectorConfiguration(val allowedStatistics: JobAllowedStatistics? = null, val entityTypes: List<String>)
Link copied to clipboard
data class JobOutput(val compressionFormat: JobOutputCompressionFormat? = null, val format: JobOutputFormat? = null, val formatOptions: JobOutputFormatOptions? = null, val location: JobS3Location, val maxOutputFiles: Int? = null, val overwrite: Boolean? = null, val partitionColumns: List<String>? = null)
Link copied to clipboard
data class JobOutputFormatOptions(val csv: JobCsvOutputOptions? = null)

Format options for job Output

Link copied to clipboard
data class JobOutputLocation(val bucket: String, val bucketOwner: String? = null, val key: String? = null)

Output location

Link copied to clipboard
data class JobProfileConfiguration(val columnStatisticsConfigurations: List<JobColumnStatisticsConfiguration>? = null, val datasetStatisticsConfiguration: JobStatisticsConfiguration? = null, val entityDetectorConfiguration: JobEntityDetectorConfiguration? = null, val profileColumns: List<JobColumnSelector>? = null)
Link copied to clipboard
data class JobRecipe(val name: String, val version: String? = null)
Link copied to clipboard
data class JobS3Location(val bucket: String, val bucketOwner: String? = null, val key: String? = null)

S3 Output location

Link copied to clipboard
data class JobS3TableOutputOptions(val location: JobS3Location)
Link copied to clipboard
data class JobSample(val mode: JobSampleMode? = null, val size: Int? = null)

Job Sample

Link copied to clipboard
data class JobStatisticOverride(val parameters: Map<String, String>, val statistic: String)
Link copied to clipboard
data class JobStatisticsConfiguration(val includedStatistics: List<String>? = null, val overrides: List<JobStatisticOverride>? = null)
Link copied to clipboard
data class JobValidationConfiguration(val rulesetArn: String, val validationMode: JobValidationMode? = null)

Configuration to attach Rulesets to the job

Link copied to clipboard
data class ProjectSample(val size: Int? = null, val type: ProjectSampleType)
Link copied to clipboard
data class RecipeAction(val operation: String, val parameters: Either<RecipeParameters, Map<String, String>>? = null)
Link copied to clipboard
data class RecipeConditionExpression(val condition: String, val targetColumn: String, val value: String? = null)

Condition expressions applied to the step action

Link copied to clipboard
data class RecipeDataCatalogInputDefinition(val catalogId: String? = null, val databaseName: String? = null, val tableName: String? = null, val tempDirectory: RecipeS3Location? = null)
Link copied to clipboard
data class RecipeParameters(val aggregateFunction: String? = null, val base: String? = null, val caseStatement: String? = null, val categoryMap: String? = null, val charsToRemove: String? = null, val collapseConsecutiveWhitespace: String? = null, val columnDataType: String? = null, val columnRange: String? = null, val count: String? = null, val customCharacters: String? = null, val customStopWords: String? = null, val customValue: String? = null, val datasetsColumns: String? = null, val dateAddValue: String? = null, val dateTimeFormat: String? = null, val dateTimeParameters: String? = null, val deleteOtherRows: String? = null, val delimiter: String? = null, val endPattern: String? = null, val endPosition: String? = null, val endValue: String? = null, val expandContractions: String? = null, val exponent: String? = null, val falseString: String? = null, val groupByAggFunctionOptions: String? = null, val groupByColumns: String? = null, val hiddenColumns: String? = null, val ignoreCase: String? = null, val includeInSplit: String? = null, val input: RecipeParametersInputProperties? = null, val interval: String? = null, val isText: String? = null, val joinKeys: String? = null, val joinType: String? = null, val leftColumns: String? = null, val limit: String? = null, val lowerBound: String? = null, val mapType: String? = null, val modeType: String? = null, val multiLine: Boolean? = null, val numRows: String? = null, val numRowsAfter: String? = null, val numRowsBefore: String? = null, val orderByColumn: String? = null, val orderByColumns: String? = null, val other: String? = null, val pattern: String? = null, val patternOption1: String? = null, val patternOption2: String? = null, val patternOptions: String? = null, val period: String? = null, val position: String? = null, val removeAllPunctuation: String? = null, val removeAllQuotes: String? = null, val removeAllWhitespace: String? = null, val removeCustomCharacters: String? = null, val removeCustomValue: String? = null, val removeLeadingAndTrailingPunctuation: String? = null, val removeLeadingAndTrailingQuotes: String? = null, val removeLeadingAndTrailingWhitespace: String? = null, val removeLetters: String? = null, val removeNumbers: String? = null, val removeSourceColumn: String? = null, val removeSpecialCharacters: String? = null, val rightColumns: String? = null, val sampleSize: String? = null, val sampleType: String? = null, val secondInput: String? = null, val secondaryInputs: List<RecipeSecondaryInput>? = null, val sheetIndexes: List<Int>? = null, val sheetNames: List<String>? = null, val sourceColumn: String? = null, val sourceColumn1: String? = null, val sourceColumn2: String? = null, val sourceColumns: String? = null, val startColumnIndex: String? = null, val startPattern: String? = null, val startPosition: String? = null, val startValue: String? = null, val stemmingMode: String? = null, val stepCount: String? = null, val stepIndex: String? = null, val stopWordsMode: String? = null, val strategy: String? = null, val targetColumn: String? = null, val targetColumnNames: String? = null, val targetDateFormat: String? = null, val targetIndex: String? = null, val timeZone: String? = null, val tokenizerPattern: String? = null, val trueString: String? = null, val udfLang: String? = null, val units: String? = null, val unpivotColumn: String? = null, val upperBound: String? = null, val useNewDataFrame: String? = null, val value: String? = null, val value1: String? = null, val value2: String? = null, val valueColumn: String? = null, val viewFrame: String? = null)
Link copied to clipboard
data class RecipeParametersInputProperties(val dataCatalogInputDefinition: RecipeDataCatalogInputDefinition? = null, val s3InputDefinition: RecipeS3Location? = null)

Input

Link copied to clipboard
data class RecipeS3Location(val bucket: String, val key: String? = null)

Input location

Link copied to clipboard
data class RecipeSecondaryInput(val dataCatalogInputDefinition: RecipeDataCatalogInputDefinition? = null, val s3InputDefinition: RecipeS3Location? = null)

Secondary input

Link copied to clipboard
data class RecipeStep(val action: RecipeAction, val conditionExpressions: List<RecipeConditionExpression>? = null)
Link copied to clipboard
data class RulesetColumnSelector(val name: String? = null, val regex: String? = null)

Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression

Link copied to clipboard
data class RulesetRule(val checkExpression: String, val columnSelectors: List<RulesetColumnSelector>? = null, val disabled: Boolean? = null, val name: String, val substitutionMap: List<RulesetSubstitutionValue>? = null, val threshold: RulesetThreshold? = null)

Data quality rule for a target resource (dataset)

Link copied to clipboard
data class RulesetSubstitutionValue(val value: String, val valueReference: String)

A key-value pair to associate expression's substitution variable names with their values

Link copied to clipboard
data class RulesetThreshold(val type: RulesetThresholdType? = null, val unit: RulesetThresholdUnit? = null, val value: Double)