| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DataBrew.Types
Contents
- Service Configuration
- Errors
- AnalyticsMode
- CompressionFormat
- DatabaseOutputMode
- EncryptionMode
- InputFormat
- JobRunState
- JobType
- LogSubscription
- Order
- OrderedBy
- OutputFormat
- ParameterType
- SampleMode
- SampleType
- SessionStatus
- Source
- ThresholdType
- ThresholdUnit
- ValidationMode
- AllowedStatistics
- ColumnSelector
- ColumnStatisticsConfiguration
- ConditionExpression
- CsvOptions
- CsvOutputOptions
- DataCatalogInputDefinition
- DataCatalogOutput
- DatabaseInputDefinition
- DatabaseOutput
- DatabaseTableOutputOptions
- Dataset
- DatasetParameter
- DatetimeOptions
- EntityDetectorConfiguration
- ExcelOptions
- FilesLimit
- FilterExpression
- FormatOptions
- Input
- Job
- JobRun
- JobSample
- JsonOptions
- Metadata
- Output
- OutputFormatOptions
- PathOptions
- ProfileConfiguration
- Project
- Recipe
- RecipeAction
- RecipeReference
- RecipeStep
- RecipeVersionErrorDetail
- Rule
- RulesetItem
- S3Location
- S3TableOutputOptions
- Sample
- Schedule
- StatisticOverride
- StatisticsConfiguration
- Threshold
- ValidationConfiguration
- ViewFrame
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype AnalyticsMode where
- AnalyticsMode' { }
- pattern AnalyticsMode_DISABLE :: AnalyticsMode
- pattern AnalyticsMode_ENABLE :: AnalyticsMode
- newtype CompressionFormat where
- CompressionFormat' { }
- pattern CompressionFormat_BROTLI :: CompressionFormat
- pattern CompressionFormat_BZIP2 :: CompressionFormat
- pattern CompressionFormat_DEFLATE :: CompressionFormat
- pattern CompressionFormat_GZIP :: CompressionFormat
- pattern CompressionFormat_LZ4 :: CompressionFormat
- pattern CompressionFormat_LZO :: CompressionFormat
- pattern CompressionFormat_SNAPPY :: CompressionFormat
- pattern CompressionFormat_ZLIB :: CompressionFormat
- pattern CompressionFormat_ZSTD :: CompressionFormat
- newtype DatabaseOutputMode where
- newtype EncryptionMode where
- EncryptionMode' { }
- pattern EncryptionMode_SSE_KMS :: EncryptionMode
- pattern EncryptionMode_SSE_S3 :: EncryptionMode
- newtype InputFormat where
- InputFormat' { }
- pattern InputFormat_CSV :: InputFormat
- pattern InputFormat_EXCEL :: InputFormat
- pattern InputFormat_JSON :: InputFormat
- pattern InputFormat_ORC :: InputFormat
- pattern InputFormat_PARQUET :: InputFormat
- newtype JobRunState where
- JobRunState' { }
- pattern JobRunState_FAILED :: JobRunState
- pattern JobRunState_RUNNING :: JobRunState
- pattern JobRunState_STARTING :: JobRunState
- pattern JobRunState_STOPPED :: JobRunState
- pattern JobRunState_STOPPING :: JobRunState
- pattern JobRunState_SUCCEEDED :: JobRunState
- pattern JobRunState_TIMEOUT :: JobRunState
- newtype JobType where
- JobType' {
- fromJobType :: Text
- pattern JobType_PROFILE :: JobType
- pattern JobType_RECIPE :: JobType
- JobType' {
- newtype LogSubscription where
- LogSubscription' { }
- pattern LogSubscription_DISABLE :: LogSubscription
- pattern LogSubscription_ENABLE :: LogSubscription
- newtype Order where
- Order' { }
- pattern Order_ASCENDING :: Order
- pattern Order_DESCENDING :: Order
- newtype OrderedBy where
- OrderedBy' { }
- pattern OrderedBy_LAST_MODIFIED_DATE :: OrderedBy
- newtype OutputFormat where
- OutputFormat' { }
- pattern OutputFormat_AVRO :: OutputFormat
- pattern OutputFormat_CSV :: OutputFormat
- pattern OutputFormat_GLUEPARQUET :: OutputFormat
- pattern OutputFormat_JSON :: OutputFormat
- pattern OutputFormat_ORC :: OutputFormat
- pattern OutputFormat_PARQUET :: OutputFormat
- pattern OutputFormat_TABLEAUHYPER :: OutputFormat
- pattern OutputFormat_XML :: OutputFormat
- newtype ParameterType where
- ParameterType' { }
- pattern ParameterType_Datetime :: ParameterType
- pattern ParameterType_Number :: ParameterType
- pattern ParameterType_String :: ParameterType
- newtype SampleMode where
- SampleMode' { }
- pattern SampleMode_CUSTOM_ROWS :: SampleMode
- pattern SampleMode_FULL_DATASET :: SampleMode
- newtype SampleType where
- SampleType' { }
- pattern SampleType_FIRST_N :: SampleType
- pattern SampleType_LAST_N :: SampleType
- pattern SampleType_RANDOM :: SampleType
- newtype SessionStatus where
- SessionStatus' { }
- pattern SessionStatus_ASSIGNED :: SessionStatus
- pattern SessionStatus_FAILED :: SessionStatus
- pattern SessionStatus_INITIALIZING :: SessionStatus
- pattern SessionStatus_PROVISIONING :: SessionStatus
- pattern SessionStatus_READY :: SessionStatus
- pattern SessionStatus_RECYCLING :: SessionStatus
- pattern SessionStatus_ROTATING :: SessionStatus
- pattern SessionStatus_TERMINATED :: SessionStatus
- pattern SessionStatus_TERMINATING :: SessionStatus
- pattern SessionStatus_UPDATING :: SessionStatus
- newtype Source where
- Source' {
- fromSource :: Text
- pattern Source_DATABASE :: Source
- pattern Source_DATA_CATALOG :: Source
- pattern Source_S3 :: Source
- Source' {
- newtype ThresholdType where
- ThresholdType' { }
- pattern ThresholdType_GREATER_THAN :: ThresholdType
- pattern ThresholdType_GREATER_THAN_OR_EQUAL :: ThresholdType
- pattern ThresholdType_LESS_THAN :: ThresholdType
- pattern ThresholdType_LESS_THAN_OR_EQUAL :: ThresholdType
- newtype ThresholdUnit where
- ThresholdUnit' { }
- pattern ThresholdUnit_COUNT :: ThresholdUnit
- pattern ThresholdUnit_PERCENTAGE :: ThresholdUnit
- newtype ValidationMode where
- ValidationMode' { }
- pattern ValidationMode_CHECK_ALL :: ValidationMode
- data AllowedStatistics = AllowedStatistics' {}
- newAllowedStatistics :: NonEmpty Text -> AllowedStatistics
- allowedStatistics_statistics :: Lens' AllowedStatistics (NonEmpty Text)
- data ColumnSelector = ColumnSelector' {}
- newColumnSelector :: ColumnSelector
- columnSelector_name :: Lens' ColumnSelector (Maybe Text)
- columnSelector_regex :: Lens' ColumnSelector (Maybe Text)
- data ColumnStatisticsConfiguration = ColumnStatisticsConfiguration' {}
- newColumnStatisticsConfiguration :: StatisticsConfiguration -> ColumnStatisticsConfiguration
- columnStatisticsConfiguration_selectors :: Lens' ColumnStatisticsConfiguration (Maybe (NonEmpty ColumnSelector))
- columnStatisticsConfiguration_statistics :: Lens' ColumnStatisticsConfiguration StatisticsConfiguration
- data ConditionExpression = ConditionExpression' {}
- newConditionExpression :: Text -> Text -> ConditionExpression
- conditionExpression_value :: Lens' ConditionExpression (Maybe Text)
- conditionExpression_condition :: Lens' ConditionExpression Text
- conditionExpression_targetColumn :: Lens' ConditionExpression Text
- data CsvOptions = CsvOptions' {}
- newCsvOptions :: CsvOptions
- csvOptions_delimiter :: Lens' CsvOptions (Maybe Text)
- csvOptions_headerRow :: Lens' CsvOptions (Maybe Bool)
- data CsvOutputOptions = CsvOutputOptions' {}
- newCsvOutputOptions :: CsvOutputOptions
- csvOutputOptions_delimiter :: Lens' CsvOutputOptions (Maybe Text)
- data DataCatalogInputDefinition = DataCatalogInputDefinition' {}
- newDataCatalogInputDefinition :: Text -> Text -> DataCatalogInputDefinition
- dataCatalogInputDefinition_catalogId :: Lens' DataCatalogInputDefinition (Maybe Text)
- dataCatalogInputDefinition_tempDirectory :: Lens' DataCatalogInputDefinition (Maybe S3Location)
- dataCatalogInputDefinition_databaseName :: Lens' DataCatalogInputDefinition Text
- dataCatalogInputDefinition_tableName :: Lens' DataCatalogInputDefinition Text
- data DataCatalogOutput = DataCatalogOutput' {}
- newDataCatalogOutput :: Text -> Text -> DataCatalogOutput
- dataCatalogOutput_catalogId :: Lens' DataCatalogOutput (Maybe Text)
- dataCatalogOutput_databaseOptions :: Lens' DataCatalogOutput (Maybe DatabaseTableOutputOptions)
- dataCatalogOutput_overwrite :: Lens' DataCatalogOutput (Maybe Bool)
- dataCatalogOutput_s3Options :: Lens' DataCatalogOutput (Maybe S3TableOutputOptions)
- dataCatalogOutput_databaseName :: Lens' DataCatalogOutput Text
- dataCatalogOutput_tableName :: Lens' DataCatalogOutput Text
- data DatabaseInputDefinition = DatabaseInputDefinition' {}
- newDatabaseInputDefinition :: Text -> DatabaseInputDefinition
- databaseInputDefinition_databaseTableName :: Lens' DatabaseInputDefinition (Maybe Text)
- databaseInputDefinition_queryString :: Lens' DatabaseInputDefinition (Maybe Text)
- databaseInputDefinition_tempDirectory :: Lens' DatabaseInputDefinition (Maybe S3Location)
- databaseInputDefinition_glueConnectionName :: Lens' DatabaseInputDefinition Text
- data DatabaseOutput = DatabaseOutput' {}
- newDatabaseOutput :: Text -> DatabaseTableOutputOptions -> DatabaseOutput
- databaseOutput_databaseOutputMode :: Lens' DatabaseOutput (Maybe DatabaseOutputMode)
- databaseOutput_glueConnectionName :: Lens' DatabaseOutput Text
- databaseOutput_databaseOptions :: Lens' DatabaseOutput DatabaseTableOutputOptions
- data DatabaseTableOutputOptions = DatabaseTableOutputOptions' {}
- newDatabaseTableOutputOptions :: Text -> DatabaseTableOutputOptions
- databaseTableOutputOptions_tempDirectory :: Lens' DatabaseTableOutputOptions (Maybe S3Location)
- databaseTableOutputOptions_tableName :: Lens' DatabaseTableOutputOptions Text
- data Dataset = Dataset' {
- accountId :: Maybe Text
- createDate :: Maybe POSIX
- createdBy :: Maybe Text
- format :: Maybe InputFormat
- formatOptions :: Maybe FormatOptions
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- pathOptions :: Maybe PathOptions
- resourceArn :: Maybe Text
- source :: Maybe Source
- tags :: Maybe (HashMap Text Text)
- name :: Text
- input :: Input
- newDataset :: Text -> Input -> Dataset
- dataset_accountId :: Lens' Dataset (Maybe Text)
- dataset_createDate :: Lens' Dataset (Maybe UTCTime)
- dataset_createdBy :: Lens' Dataset (Maybe Text)
- dataset_format :: Lens' Dataset (Maybe InputFormat)
- dataset_formatOptions :: Lens' Dataset (Maybe FormatOptions)
- dataset_lastModifiedBy :: Lens' Dataset (Maybe Text)
- dataset_lastModifiedDate :: Lens' Dataset (Maybe UTCTime)
- dataset_pathOptions :: Lens' Dataset (Maybe PathOptions)
- dataset_resourceArn :: Lens' Dataset (Maybe Text)
- dataset_source :: Lens' Dataset (Maybe Source)
- dataset_tags :: Lens' Dataset (Maybe (HashMap Text Text))
- dataset_name :: Lens' Dataset Text
- dataset_input :: Lens' Dataset Input
- data DatasetParameter = DatasetParameter' {}
- newDatasetParameter :: Text -> ParameterType -> DatasetParameter
- datasetParameter_createColumn :: Lens' DatasetParameter (Maybe Bool)
- datasetParameter_datetimeOptions :: Lens' DatasetParameter (Maybe DatetimeOptions)
- datasetParameter_filter :: Lens' DatasetParameter (Maybe FilterExpression)
- datasetParameter_name :: Lens' DatasetParameter Text
- datasetParameter_type :: Lens' DatasetParameter ParameterType
- data DatetimeOptions = DatetimeOptions' {
- localeCode :: Maybe Text
- timezoneOffset :: Maybe Text
- format :: Text
- newDatetimeOptions :: Text -> DatetimeOptions
- datetimeOptions_localeCode :: Lens' DatetimeOptions (Maybe Text)
- datetimeOptions_timezoneOffset :: Lens' DatetimeOptions (Maybe Text)
- datetimeOptions_format :: Lens' DatetimeOptions Text
- data EntityDetectorConfiguration = EntityDetectorConfiguration' {}
- newEntityDetectorConfiguration :: NonEmpty Text -> EntityDetectorConfiguration
- entityDetectorConfiguration_allowedStatistics :: Lens' EntityDetectorConfiguration (Maybe (NonEmpty AllowedStatistics))
- entityDetectorConfiguration_entityTypes :: Lens' EntityDetectorConfiguration (NonEmpty Text)
- data ExcelOptions = ExcelOptions' {}
- newExcelOptions :: ExcelOptions
- excelOptions_headerRow :: Lens' ExcelOptions (Maybe Bool)
- excelOptions_sheetIndexes :: Lens' ExcelOptions (Maybe (NonEmpty Natural))
- excelOptions_sheetNames :: Lens' ExcelOptions (Maybe (NonEmpty Text))
- data FilesLimit = FilesLimit' {}
- newFilesLimit :: Natural -> FilesLimit
- filesLimit_order :: Lens' FilesLimit (Maybe Order)
- filesLimit_orderedBy :: Lens' FilesLimit (Maybe OrderedBy)
- filesLimit_maxFiles :: Lens' FilesLimit Natural
- data FilterExpression = FilterExpression' {}
- newFilterExpression :: Text -> FilterExpression
- filterExpression_expression :: Lens' FilterExpression Text
- filterExpression_valuesMap :: Lens' FilterExpression (HashMap Text Text)
- data FormatOptions = FormatOptions' {
- csv :: Maybe CsvOptions
- excel :: Maybe ExcelOptions
- json :: Maybe JsonOptions
- newFormatOptions :: FormatOptions
- formatOptions_csv :: Lens' FormatOptions (Maybe CsvOptions)
- formatOptions_excel :: Lens' FormatOptions (Maybe ExcelOptions)
- formatOptions_json :: Lens' FormatOptions (Maybe JsonOptions)
- data Input = Input' {}
- newInput :: Input
- input_dataCatalogInputDefinition :: Lens' Input (Maybe DataCatalogInputDefinition)
- input_databaseInputDefinition :: Lens' Input (Maybe DatabaseInputDefinition)
- input_metadata :: Lens' Input (Maybe Metadata)
- input_s3InputDefinition :: Lens' Input (Maybe S3Location)
- data Job = Job' {
- accountId :: Maybe Text
- createDate :: Maybe POSIX
- createdBy :: Maybe Text
- dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
- databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
- datasetName :: Maybe Text
- encryptionKeyArn :: Maybe Text
- encryptionMode :: Maybe EncryptionMode
- jobSample :: Maybe JobSample
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- logSubscription :: Maybe LogSubscription
- maxCapacity :: Maybe Int
- maxRetries :: Maybe Natural
- outputs :: Maybe (NonEmpty Output)
- projectName :: Maybe Text
- recipeReference :: Maybe RecipeReference
- resourceArn :: Maybe Text
- roleArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe Natural
- type' :: Maybe JobType
- validationConfigurations :: Maybe (NonEmpty ValidationConfiguration)
- name :: Text
- newJob :: Text -> Job
- job_accountId :: Lens' Job (Maybe Text)
- job_createDate :: Lens' Job (Maybe UTCTime)
- job_createdBy :: Lens' Job (Maybe Text)
- job_dataCatalogOutputs :: Lens' Job (Maybe (NonEmpty DataCatalogOutput))
- job_databaseOutputs :: Lens' Job (Maybe (NonEmpty DatabaseOutput))
- job_datasetName :: Lens' Job (Maybe Text)
- job_encryptionKeyArn :: Lens' Job (Maybe Text)
- job_encryptionMode :: Lens' Job (Maybe EncryptionMode)
- job_jobSample :: Lens' Job (Maybe JobSample)
- job_lastModifiedBy :: Lens' Job (Maybe Text)
- job_lastModifiedDate :: Lens' Job (Maybe UTCTime)
- job_logSubscription :: Lens' Job (Maybe LogSubscription)
- job_maxCapacity :: Lens' Job (Maybe Int)
- job_maxRetries :: Lens' Job (Maybe Natural)
- job_outputs :: Lens' Job (Maybe (NonEmpty Output))
- job_projectName :: Lens' Job (Maybe Text)
- job_recipeReference :: Lens' Job (Maybe RecipeReference)
- job_resourceArn :: Lens' Job (Maybe Text)
- job_roleArn :: Lens' Job (Maybe Text)
- job_tags :: Lens' Job (Maybe (HashMap Text Text))
- job_timeout :: Lens' Job (Maybe Natural)
- job_type :: Lens' Job (Maybe JobType)
- job_validationConfigurations :: Lens' Job (Maybe (NonEmpty ValidationConfiguration))
- job_name :: Lens' Job Text
- data JobRun = JobRun' {
- attempt :: Maybe Int
- completedOn :: Maybe POSIX
- dataCatalogOutputs :: Maybe (NonEmpty DataCatalogOutput)
- databaseOutputs :: Maybe (NonEmpty DatabaseOutput)
- datasetName :: Maybe Text
- errorMessage :: Maybe Text
- executionTime :: Maybe Int
- jobName :: Maybe Text
- jobSample :: Maybe JobSample
- logGroupName :: Maybe Text
- logSubscription :: Maybe LogSubscription
- outputs :: Maybe (NonEmpty Output)
- recipeReference :: Maybe RecipeReference
- runId :: Maybe Text
- startedBy :: Maybe Text
- startedOn :: Maybe POSIX
- state :: Maybe JobRunState
- validationConfigurations :: Maybe (NonEmpty ValidationConfiguration)
- newJobRun :: JobRun
- jobRun_attempt :: Lens' JobRun (Maybe Int)
- jobRun_completedOn :: Lens' JobRun (Maybe UTCTime)
- jobRun_dataCatalogOutputs :: Lens' JobRun (Maybe (NonEmpty DataCatalogOutput))
- jobRun_databaseOutputs :: Lens' JobRun (Maybe (NonEmpty DatabaseOutput))
- jobRun_datasetName :: Lens' JobRun (Maybe Text)
- jobRun_errorMessage :: Lens' JobRun (Maybe Text)
- jobRun_executionTime :: Lens' JobRun (Maybe Int)
- jobRun_jobName :: Lens' JobRun (Maybe Text)
- jobRun_jobSample :: Lens' JobRun (Maybe JobSample)
- jobRun_logGroupName :: Lens' JobRun (Maybe Text)
- jobRun_logSubscription :: Lens' JobRun (Maybe LogSubscription)
- jobRun_outputs :: Lens' JobRun (Maybe (NonEmpty Output))
- jobRun_recipeReference :: Lens' JobRun (Maybe RecipeReference)
- jobRun_runId :: Lens' JobRun (Maybe Text)
- jobRun_startedBy :: Lens' JobRun (Maybe Text)
- jobRun_startedOn :: Lens' JobRun (Maybe UTCTime)
- jobRun_state :: Lens' JobRun (Maybe JobRunState)
- jobRun_validationConfigurations :: Lens' JobRun (Maybe (NonEmpty ValidationConfiguration))
- data JobSample = JobSample' {}
- newJobSample :: JobSample
- jobSample_mode :: Lens' JobSample (Maybe SampleMode)
- jobSample_size :: Lens' JobSample (Maybe Integer)
- data JsonOptions = JsonOptions' {}
- newJsonOptions :: JsonOptions
- jsonOptions_multiLine :: Lens' JsonOptions (Maybe Bool)
- data Metadata = Metadata' {}
- newMetadata :: Metadata
- metadata_sourceArn :: Lens' Metadata (Maybe Text)
- data Output = Output' {}
- newOutput :: S3Location -> Output
- output_compressionFormat :: Lens' Output (Maybe CompressionFormat)
- output_format :: Lens' Output (Maybe OutputFormat)
- output_formatOptions :: Lens' Output (Maybe OutputFormatOptions)
- output_maxOutputFiles :: Lens' Output (Maybe Natural)
- output_overwrite :: Lens' Output (Maybe Bool)
- output_partitionColumns :: Lens' Output (Maybe [Text])
- output_location :: Lens' Output S3Location
- data OutputFormatOptions = OutputFormatOptions' {}
- newOutputFormatOptions :: OutputFormatOptions
- outputFormatOptions_csv :: Lens' OutputFormatOptions (Maybe CsvOutputOptions)
- data PathOptions = PathOptions' {}
- newPathOptions :: PathOptions
- pathOptions_filesLimit :: Lens' PathOptions (Maybe FilesLimit)
- pathOptions_lastModifiedDateCondition :: Lens' PathOptions (Maybe FilterExpression)
- pathOptions_parameters :: Lens' PathOptions (Maybe (HashMap Text DatasetParameter))
- data ProfileConfiguration = ProfileConfiguration' {}
- newProfileConfiguration :: ProfileConfiguration
- profileConfiguration_columnStatisticsConfigurations :: Lens' ProfileConfiguration (Maybe (NonEmpty ColumnStatisticsConfiguration))
- profileConfiguration_datasetStatisticsConfiguration :: Lens' ProfileConfiguration (Maybe StatisticsConfiguration)
- profileConfiguration_entityDetectorConfiguration :: Lens' ProfileConfiguration (Maybe EntityDetectorConfiguration)
- profileConfiguration_profileColumns :: Lens' ProfileConfiguration (Maybe (NonEmpty ColumnSelector))
- data Project = Project' {
- accountId :: Maybe Text
- createDate :: Maybe POSIX
- createdBy :: Maybe Text
- datasetName :: Maybe Text
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- openDate :: Maybe POSIX
- openedBy :: Maybe Text
- resourceArn :: Maybe Text
- roleArn :: Maybe Text
- sample :: Maybe Sample
- tags :: Maybe (HashMap Text Text)
- name :: Text
- recipeName :: Text
- newProject :: Text -> Text -> Project
- project_accountId :: Lens' Project (Maybe Text)
- project_createDate :: Lens' Project (Maybe UTCTime)
- project_createdBy :: Lens' Project (Maybe Text)
- project_datasetName :: Lens' Project (Maybe Text)
- project_lastModifiedBy :: Lens' Project (Maybe Text)
- project_lastModifiedDate :: Lens' Project (Maybe UTCTime)
- project_openDate :: Lens' Project (Maybe UTCTime)
- project_openedBy :: Lens' Project (Maybe Text)
- project_resourceArn :: Lens' Project (Maybe Text)
- project_roleArn :: Lens' Project (Maybe Text)
- project_sample :: Lens' Project (Maybe Sample)
- project_tags :: Lens' Project (Maybe (HashMap Text Text))
- project_name :: Lens' Project Text
- project_recipeName :: Lens' Project Text
- data Recipe = Recipe' {
- createDate :: Maybe POSIX
- createdBy :: Maybe Text
- description :: Maybe Text
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- projectName :: Maybe Text
- publishedBy :: Maybe Text
- publishedDate :: Maybe POSIX
- recipeVersion :: Maybe Text
- resourceArn :: Maybe Text
- steps :: Maybe [RecipeStep]
- tags :: Maybe (HashMap Text Text)
- name :: Text
- newRecipe :: Text -> Recipe
- recipe_createDate :: Lens' Recipe (Maybe UTCTime)
- recipe_createdBy :: Lens' Recipe (Maybe Text)
- recipe_description :: Lens' Recipe (Maybe Text)
- recipe_lastModifiedBy :: Lens' Recipe (Maybe Text)
- recipe_lastModifiedDate :: Lens' Recipe (Maybe UTCTime)
- recipe_projectName :: Lens' Recipe (Maybe Text)
- recipe_publishedBy :: Lens' Recipe (Maybe Text)
- recipe_publishedDate :: Lens' Recipe (Maybe UTCTime)
- recipe_recipeVersion :: Lens' Recipe (Maybe Text)
- recipe_resourceArn :: Lens' Recipe (Maybe Text)
- recipe_steps :: Lens' Recipe (Maybe [RecipeStep])
- recipe_tags :: Lens' Recipe (Maybe (HashMap Text Text))
- recipe_name :: Lens' Recipe Text
- data RecipeAction = RecipeAction' {}
- newRecipeAction :: Text -> RecipeAction
- recipeAction_parameters :: Lens' RecipeAction (Maybe (HashMap Text Text))
- recipeAction_operation :: Lens' RecipeAction Text
- data RecipeReference = RecipeReference' {
- recipeVersion :: Maybe Text
- name :: Text
- newRecipeReference :: Text -> RecipeReference
- recipeReference_recipeVersion :: Lens' RecipeReference (Maybe Text)
- recipeReference_name :: Lens' RecipeReference Text
- data RecipeStep = RecipeStep' {}
- newRecipeStep :: RecipeAction -> RecipeStep
- recipeStep_conditionExpressions :: Lens' RecipeStep (Maybe [ConditionExpression])
- recipeStep_action :: Lens' RecipeStep RecipeAction
- data RecipeVersionErrorDetail = RecipeVersionErrorDetail' {}
- newRecipeVersionErrorDetail :: RecipeVersionErrorDetail
- recipeVersionErrorDetail_errorCode :: Lens' RecipeVersionErrorDetail (Maybe Text)
- recipeVersionErrorDetail_errorMessage :: Lens' RecipeVersionErrorDetail (Maybe Text)
- recipeVersionErrorDetail_recipeVersion :: Lens' RecipeVersionErrorDetail (Maybe Text)
- data Rule = Rule' {}
- newRule :: Text -> Text -> Rule
- rule_columnSelectors :: Lens' Rule (Maybe (NonEmpty ColumnSelector))
- rule_disabled :: Lens' Rule (Maybe Bool)
- rule_substitutionMap :: Lens' Rule (Maybe (HashMap Text Text))
- rule_threshold :: Lens' Rule (Maybe Threshold)
- rule_name :: Lens' Rule Text
- rule_checkExpression :: Lens' Rule Text
- data RulesetItem = RulesetItem' {}
- newRulesetItem :: Text -> Text -> RulesetItem
- rulesetItem_accountId :: Lens' RulesetItem (Maybe Text)
- rulesetItem_createDate :: Lens' RulesetItem (Maybe UTCTime)
- rulesetItem_createdBy :: Lens' RulesetItem (Maybe Text)
- rulesetItem_description :: Lens' RulesetItem (Maybe Text)
- rulesetItem_lastModifiedBy :: Lens' RulesetItem (Maybe Text)
- rulesetItem_lastModifiedDate :: Lens' RulesetItem (Maybe UTCTime)
- rulesetItem_resourceArn :: Lens' RulesetItem (Maybe Text)
- rulesetItem_ruleCount :: Lens' RulesetItem (Maybe Natural)
- rulesetItem_tags :: Lens' RulesetItem (Maybe (HashMap Text Text))
- rulesetItem_name :: Lens' RulesetItem Text
- rulesetItem_targetArn :: Lens' RulesetItem Text
- data S3Location = S3Location' {}
- newS3Location :: Text -> S3Location
- s3Location_bucketOwner :: Lens' S3Location (Maybe Text)
- s3Location_key :: Lens' S3Location (Maybe Text)
- s3Location_bucket :: Lens' S3Location Text
- data S3TableOutputOptions = S3TableOutputOptions' {}
- newS3TableOutputOptions :: S3Location -> S3TableOutputOptions
- s3TableOutputOptions_location :: Lens' S3TableOutputOptions S3Location
- data Sample = Sample' {
- size :: Maybe Natural
- type' :: SampleType
- newSample :: SampleType -> Sample
- sample_size :: Lens' Sample (Maybe Natural)
- sample_type :: Lens' Sample SampleType
- data Schedule = Schedule' {}
- newSchedule :: Text -> Schedule
- schedule_accountId :: Lens' Schedule (Maybe Text)
- schedule_createDate :: Lens' Schedule (Maybe UTCTime)
- schedule_createdBy :: Lens' Schedule (Maybe Text)
- schedule_cronExpression :: Lens' Schedule (Maybe Text)
- schedule_jobNames :: Lens' Schedule (Maybe [Text])
- schedule_lastModifiedBy :: Lens' Schedule (Maybe Text)
- schedule_lastModifiedDate :: Lens' Schedule (Maybe UTCTime)
- schedule_resourceArn :: Lens' Schedule (Maybe Text)
- schedule_tags :: Lens' Schedule (Maybe (HashMap Text Text))
- schedule_name :: Lens' Schedule Text
- data StatisticOverride = StatisticOverride' {}
- newStatisticOverride :: Text -> StatisticOverride
- statisticOverride_statistic :: Lens' StatisticOverride Text
- statisticOverride_parameters :: Lens' StatisticOverride (HashMap Text Text)
- data StatisticsConfiguration = StatisticsConfiguration' {}
- newStatisticsConfiguration :: StatisticsConfiguration
- statisticsConfiguration_includedStatistics :: Lens' StatisticsConfiguration (Maybe (NonEmpty Text))
- statisticsConfiguration_overrides :: Lens' StatisticsConfiguration (Maybe (NonEmpty StatisticOverride))
- data Threshold = Threshold' {
- type' :: Maybe ThresholdType
- unit :: Maybe ThresholdUnit
- value :: Double
- newThreshold :: Double -> Threshold
- threshold_type :: Lens' Threshold (Maybe ThresholdType)
- threshold_unit :: Lens' Threshold (Maybe ThresholdUnit)
- threshold_value :: Lens' Threshold Double
- data ValidationConfiguration = ValidationConfiguration' {}
- newValidationConfiguration :: Text -> ValidationConfiguration
- validationConfiguration_validationMode :: Lens' ValidationConfiguration (Maybe ValidationMode)
- validationConfiguration_rulesetArn :: Lens' ValidationConfiguration Text
- data ViewFrame = ViewFrame' {}
- newViewFrame :: Natural -> ViewFrame
- viewFrame_analytics :: Lens' ViewFrame (Maybe AnalyticsMode)
- viewFrame_columnRange :: Lens' ViewFrame (Maybe Natural)
- viewFrame_hiddenColumns :: Lens' ViewFrame (Maybe [Text])
- viewFrame_rowRange :: Lens' ViewFrame (Maybe Int)
- viewFrame_startRowIndex :: Lens' ViewFrame (Maybe Natural)
- viewFrame_startColumnIndex :: Lens' ViewFrame Natural
Service Configuration
defaultService :: Service Source #
API version 2017-07-25 of the Amazon Glue DataBrew SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Access to the specified resource was denied.
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting a resource can cause an inconsistent state.
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal service failure occurred.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
One or more resources can't be found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
A service quota is exceeded.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input parameters for this request failed validation.
AnalyticsMode
newtype AnalyticsMode Source #
Constructors
| AnalyticsMode' | |
Fields | |
Bundled Patterns
| pattern AnalyticsMode_DISABLE :: AnalyticsMode | |
| pattern AnalyticsMode_ENABLE :: AnalyticsMode |
Instances
CompressionFormat
newtype CompressionFormat Source #
Constructors
| CompressionFormat' | |
Fields | |
Bundled Patterns
| pattern CompressionFormat_BROTLI :: CompressionFormat | |
| pattern CompressionFormat_BZIP2 :: CompressionFormat | |
| pattern CompressionFormat_DEFLATE :: CompressionFormat | |
| pattern CompressionFormat_GZIP :: CompressionFormat | |
| pattern CompressionFormat_LZ4 :: CompressionFormat | |
| pattern CompressionFormat_LZO :: CompressionFormat | |
| pattern CompressionFormat_SNAPPY :: CompressionFormat | |
| pattern CompressionFormat_ZLIB :: CompressionFormat | |
| pattern CompressionFormat_ZSTD :: CompressionFormat |
Instances
DatabaseOutputMode
newtype DatabaseOutputMode Source #
Constructors
| DatabaseOutputMode' | |
Fields | |
Bundled Patterns
| pattern DatabaseOutputMode_NEW_TABLE :: DatabaseOutputMode |
Instances
EncryptionMode
newtype EncryptionMode Source #
Constructors
| EncryptionMode' | |
Fields | |
Bundled Patterns
| pattern EncryptionMode_SSE_KMS :: EncryptionMode | |
| pattern EncryptionMode_SSE_S3 :: EncryptionMode |
Instances
InputFormat
newtype InputFormat Source #
Constructors
| InputFormat' | |
Fields | |
Bundled Patterns
| pattern InputFormat_CSV :: InputFormat | |
| pattern InputFormat_EXCEL :: InputFormat | |
| pattern InputFormat_JSON :: InputFormat | |
| pattern InputFormat_ORC :: InputFormat | |
| pattern InputFormat_PARQUET :: InputFormat |
Instances
JobRunState
newtype JobRunState Source #
Constructors
| JobRunState' | |
Fields | |
Bundled Patterns
| pattern JobRunState_FAILED :: JobRunState | |
| pattern JobRunState_RUNNING :: JobRunState | |
| pattern JobRunState_STARTING :: JobRunState | |
| pattern JobRunState_STOPPED :: JobRunState | |
| pattern JobRunState_STOPPING :: JobRunState | |
| pattern JobRunState_SUCCEEDED :: JobRunState | |
| pattern JobRunState_TIMEOUT :: JobRunState |
Instances
JobType
Constructors
| JobType' | |
Fields
| |
Bundled Patterns
| pattern JobType_PROFILE :: JobType | |
| pattern JobType_RECIPE :: JobType |
Instances
LogSubscription
newtype LogSubscription Source #
Constructors
| LogSubscription' | |
Fields | |
Bundled Patterns
| pattern LogSubscription_DISABLE :: LogSubscription | |
| pattern LogSubscription_ENABLE :: LogSubscription |
Instances
Order
Bundled Patterns
| pattern Order_ASCENDING :: Order | |
| pattern Order_DESCENDING :: Order |
Instances
OrderedBy
Constructors
| OrderedBy' | |
Fields | |
Bundled Patterns
| pattern OrderedBy_LAST_MODIFIED_DATE :: OrderedBy |
Instances
OutputFormat
newtype OutputFormat Source #
Constructors
| OutputFormat' | |
Fields | |
Bundled Patterns
| pattern OutputFormat_AVRO :: OutputFormat | |
| pattern OutputFormat_CSV :: OutputFormat | |
| pattern OutputFormat_GLUEPARQUET :: OutputFormat | |
| pattern OutputFormat_JSON :: OutputFormat | |
| pattern OutputFormat_ORC :: OutputFormat | |
| pattern OutputFormat_PARQUET :: OutputFormat | |
| pattern OutputFormat_TABLEAUHYPER :: OutputFormat | |
| pattern OutputFormat_XML :: OutputFormat |
Instances
ParameterType
newtype ParameterType Source #
Constructors
| ParameterType' | |
Fields | |
Bundled Patterns
| pattern ParameterType_Datetime :: ParameterType | |
| pattern ParameterType_Number :: ParameterType | |
| pattern ParameterType_String :: ParameterType |
Instances
SampleMode
newtype SampleMode Source #
Constructors
| SampleMode' | |
Fields | |
Bundled Patterns
| pattern SampleMode_CUSTOM_ROWS :: SampleMode | |
| pattern SampleMode_FULL_DATASET :: SampleMode |
Instances
SampleType
newtype SampleType Source #
Constructors
| SampleType' | |
Fields | |
Bundled Patterns
| pattern SampleType_FIRST_N :: SampleType | |
| pattern SampleType_LAST_N :: SampleType | |
| pattern SampleType_RANDOM :: SampleType |
Instances
SessionStatus
newtype SessionStatus Source #
Constructors
| SessionStatus' | |
Fields | |
Bundled Patterns
| pattern SessionStatus_ASSIGNED :: SessionStatus | |
| pattern SessionStatus_FAILED :: SessionStatus | |
| pattern SessionStatus_INITIALIZING :: SessionStatus | |
| pattern SessionStatus_PROVISIONING :: SessionStatus | |
| pattern SessionStatus_READY :: SessionStatus | |
| pattern SessionStatus_RECYCLING :: SessionStatus | |
| pattern SessionStatus_ROTATING :: SessionStatus | |
| pattern SessionStatus_TERMINATED :: SessionStatus | |
| pattern SessionStatus_TERMINATING :: SessionStatus | |
| pattern SessionStatus_UPDATING :: SessionStatus |
Instances
Source
Constructors
| Source' | |
Fields
| |
Bundled Patterns
| pattern Source_DATABASE :: Source | |
| pattern Source_DATA_CATALOG :: Source | |
| pattern Source_S3 :: Source |
Instances
ThresholdType
newtype ThresholdType Source #
Constructors
| ThresholdType' | |
Fields | |
Bundled Patterns
| pattern ThresholdType_GREATER_THAN :: ThresholdType | |
| pattern ThresholdType_GREATER_THAN_OR_EQUAL :: ThresholdType | |
| pattern ThresholdType_LESS_THAN :: ThresholdType | |
| pattern ThresholdType_LESS_THAN_OR_EQUAL :: ThresholdType |
Instances
ThresholdUnit
newtype ThresholdUnit Source #
Constructors
| ThresholdUnit' | |
Fields | |
Bundled Patterns
| pattern ThresholdUnit_COUNT :: ThresholdUnit | |
| pattern ThresholdUnit_PERCENTAGE :: ThresholdUnit |
Instances
ValidationMode
newtype ValidationMode Source #
Constructors
| ValidationMode' | |
Fields | |
Bundled Patterns
| pattern ValidationMode_CHECK_ALL :: ValidationMode |
Instances
AllowedStatistics
data AllowedStatistics Source #
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
See: newAllowedStatistics smart constructor.
Constructors
| AllowedStatistics' | |
Fields
| |
Instances
Arguments
| :: NonEmpty Text | |
| -> AllowedStatistics |
Create a value of AllowedStatistics 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:statistics:AllowedStatistics', allowedStatistics_statistics - One or more column statistics to allow for columns that contain detected
entities.
allowedStatistics_statistics :: Lens' AllowedStatistics (NonEmpty Text) Source #
One or more column statistics to allow for columns that contain detected entities.
ColumnSelector
data ColumnSelector Source #
Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression.
See: newColumnSelector smart constructor.
Constructors
| ColumnSelector' | |
Instances
newColumnSelector :: ColumnSelector Source #
Create a value of ColumnSelector 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:name:ColumnSelector', columnSelector_name - The name of a column from a dataset.
$sel:regex:ColumnSelector', columnSelector_regex - A regular expression for selecting a column from a dataset.
columnSelector_name :: Lens' ColumnSelector (Maybe Text) Source #
The name of a column from a dataset.
columnSelector_regex :: Lens' ColumnSelector (Maybe Text) Source #
A regular expression for selecting a column from a dataset.
ColumnStatisticsConfiguration
data ColumnStatisticsConfiguration Source #
Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns.
See: newColumnStatisticsConfiguration smart constructor.
Constructors
| ColumnStatisticsConfiguration' | |
Fields
| |
Instances
newColumnStatisticsConfiguration Source #
Arguments
| :: StatisticsConfiguration | |
| -> ColumnStatisticsConfiguration |
Create a value of ColumnStatisticsConfiguration 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:selectors:ColumnStatisticsConfiguration', columnStatisticsConfiguration_selectors - List of column selectors. Selectors can be used to select columns from
the dataset. When selectors are undefined, configuration will be applied
to all supported columns.
$sel:statistics:ColumnStatisticsConfiguration', columnStatisticsConfiguration_statistics - Configuration for evaluations. Statistics can be used to select
evaluations and override parameters of evaluations.
columnStatisticsConfiguration_selectors :: Lens' ColumnStatisticsConfiguration (Maybe (NonEmpty ColumnSelector)) Source #
List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
columnStatisticsConfiguration_statistics :: Lens' ColumnStatisticsConfiguration StatisticsConfiguration Source #
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
ConditionExpression
data ConditionExpression Source #
Represents an individual condition that evaluates to true or false.
Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.
If a recipe requires more than one condition, then the recipe must
specify multiple ConditionExpression elements. Each condition is
applied to the rows in a dataset first, before the recipe action is
performed.
See: newConditionExpression smart constructor.
Constructors
| ConditionExpression' | |
Fields
| |
Instances
newConditionExpression Source #
Arguments
| :: Text | |
| -> Text | |
| -> ConditionExpression |
Create a value of ConditionExpression 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:value:ConditionExpression', conditionExpression_value - A value that the condition must evaluate to for the condition to
succeed.
$sel:condition:ConditionExpression', conditionExpression_condition - A specific condition to apply to a recipe action. For more information,
see
Recipe structure
in the Glue DataBrew Developer Guide.
$sel:targetColumn:ConditionExpression', conditionExpression_targetColumn - A column to apply this condition to.
conditionExpression_value :: Lens' ConditionExpression (Maybe Text) Source #
A value that the condition must evaluate to for the condition to succeed.
conditionExpression_condition :: Lens' ConditionExpression Text Source #
A specific condition to apply to a recipe action. For more information, see Recipe structure in the Glue DataBrew Developer Guide.
conditionExpression_targetColumn :: Lens' ConditionExpression Text Source #
A column to apply this condition to.
CsvOptions
data CsvOptions Source #
Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.
See: newCsvOptions smart constructor.
Constructors
| CsvOptions' | |
Instances
newCsvOptions :: CsvOptions Source #
Create a value of CsvOptions 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:delimiter:CsvOptions', csvOptions_delimiter - A single character that specifies the delimiter being used in the CSV
file.
$sel:headerRow:CsvOptions', csvOptions_headerRow - A variable that specifies whether the first row in the file is parsed as
the header. If this value is false, column names are auto-generated.
csvOptions_delimiter :: Lens' CsvOptions (Maybe Text) Source #
A single character that specifies the delimiter being used in the CSV file.
csvOptions_headerRow :: Lens' CsvOptions (Maybe Bool) Source #
A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
CsvOutputOptions
data CsvOutputOptions Source #
Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file.
See: newCsvOutputOptions smart constructor.
Constructors
| CsvOutputOptions' | |
Instances
newCsvOutputOptions :: CsvOutputOptions Source #
Create a value of CsvOutputOptions 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:delimiter:CsvOutputOptions', csvOutputOptions_delimiter - A single character that specifies the delimiter used to create CSV job
output.
csvOutputOptions_delimiter :: Lens' CsvOutputOptions (Maybe Text) Source #
A single character that specifies the delimiter used to create CSV job output.
DataCatalogInputDefinition
data DataCatalogInputDefinition Source #
Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew dataset.
See: newDataCatalogInputDefinition smart constructor.
Constructors
| DataCatalogInputDefinition' | |
Fields
| |
Instances
newDataCatalogInputDefinition Source #
Arguments
| :: Text | |
| -> Text | |
| -> DataCatalogInputDefinition |
Create a value of DataCatalogInputDefinition 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:catalogId:DataCatalogInputDefinition', dataCatalogInputDefinition_catalogId - The unique identifier of the Amazon Web Services account that holds the
Data Catalog that stores the data.
$sel:tempDirectory:DataCatalogInputDefinition', dataCatalogInputDefinition_tempDirectory - Represents an Amazon location where DataBrew can store intermediate
results.
$sel:databaseName:DataCatalogInputDefinition', dataCatalogInputDefinition_databaseName - The name of a database in the Data Catalog.
$sel:tableName:DataCatalogInputDefinition', dataCatalogInputDefinition_tableName - The name of a database table in the Data Catalog. This table corresponds
to a DataBrew dataset.
dataCatalogInputDefinition_catalogId :: Lens' DataCatalogInputDefinition (Maybe Text) Source #
The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
dataCatalogInputDefinition_tempDirectory :: Lens' DataCatalogInputDefinition (Maybe S3Location) Source #
Represents an Amazon location where DataBrew can store intermediate results.
dataCatalogInputDefinition_databaseName :: Lens' DataCatalogInputDefinition Text Source #
The name of a database in the Data Catalog.
dataCatalogInputDefinition_tableName :: Lens' DataCatalogInputDefinition Text Source #
The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.
DataCatalogOutput
data DataCatalogOutput Source #
Represents options that specify how and where in the Glue Data Catalog DataBrew writes the output generated by recipe jobs.
See: newDataCatalogOutput smart constructor.
Constructors
| DataCatalogOutput' | |
Fields
| |
Instances
Create a value of DataCatalogOutput 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:catalogId:DataCatalogOutput', dataCatalogOutput_catalogId - The unique identifier of the Amazon Web Services account that holds the
Data Catalog that stores the data.
$sel:databaseOptions:DataCatalogOutput', dataCatalogOutput_databaseOptions - Represents options that specify how and where DataBrew writes the
database output generated by recipe jobs.
$sel:overwrite:DataCatalogOutput', dataCatalogOutput_overwrite - A value that, if true, means that any data in the location specified for
output is overwritten with new output. Not supported with
DatabaseOptions.
$sel:s3Options:DataCatalogOutput', dataCatalogOutput_s3Options - Represents options that specify how and where DataBrew writes the Amazon
S3 output generated by recipe jobs.
$sel:databaseName:DataCatalogOutput', dataCatalogOutput_databaseName - The name of a database in the Data Catalog.
DataCatalogOutput, dataCatalogOutput_tableName - The name of a table in the Data Catalog.
dataCatalogOutput_catalogId :: Lens' DataCatalogOutput (Maybe Text) Source #
The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
dataCatalogOutput_databaseOptions :: Lens' DataCatalogOutput (Maybe DatabaseTableOutputOptions) Source #
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
dataCatalogOutput_overwrite :: Lens' DataCatalogOutput (Maybe Bool) Source #
A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.
dataCatalogOutput_s3Options :: Lens' DataCatalogOutput (Maybe S3TableOutputOptions) Source #
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
dataCatalogOutput_databaseName :: Lens' DataCatalogOutput Text Source #
The name of a database in the Data Catalog.
dataCatalogOutput_tableName :: Lens' DataCatalogOutput Text Source #
The name of a table in the Data Catalog.
DatabaseInputDefinition
data DatabaseInputDefinition Source #
Connection information for dataset input files stored in a database.
See: newDatabaseInputDefinition smart constructor.
Constructors
| DatabaseInputDefinition' | |
Fields
| |
Instances
newDatabaseInputDefinition Source #
Create a value of DatabaseInputDefinition 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:databaseTableName:DatabaseInputDefinition', databaseInputDefinition_databaseTableName - The table within the target database.
$sel:queryString:DatabaseInputDefinition', databaseInputDefinition_queryString - Custom SQL to run against the provided Glue connection. This SQL will be
used as the input for DataBrew projects and jobs.
$sel:tempDirectory:DatabaseInputDefinition', databaseInputDefinition_tempDirectory - Undocumented member.
$sel:glueConnectionName:DatabaseInputDefinition', databaseInputDefinition_glueConnectionName - The Glue Connection that stores the connection information for the
target database.
databaseInputDefinition_databaseTableName :: Lens' DatabaseInputDefinition (Maybe Text) Source #
The table within the target database.
databaseInputDefinition_queryString :: Lens' DatabaseInputDefinition (Maybe Text) Source #
Custom SQL to run against the provided Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
databaseInputDefinition_tempDirectory :: Lens' DatabaseInputDefinition (Maybe S3Location) Source #
Undocumented member.
databaseInputDefinition_glueConnectionName :: Lens' DatabaseInputDefinition Text Source #
The Glue Connection that stores the connection information for the target database.
DatabaseOutput
data DatabaseOutput Source #
Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.
See: newDatabaseOutput smart constructor.
Constructors
| DatabaseOutput' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DatabaseTableOutputOptions | |
| -> DatabaseOutput |
Create a value of DatabaseOutput 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:databaseOutputMode:DatabaseOutput', databaseOutput_databaseOutputMode - The output mode to write into the database. Currently supported option:
NEW_TABLE.
$sel:glueConnectionName:DatabaseOutput', databaseOutput_glueConnectionName - The Glue connection that stores the connection information for the
target database.
$sel:databaseOptions:DatabaseOutput', databaseOutput_databaseOptions - Represents options that specify how and where DataBrew writes the
database output generated by recipe jobs.
databaseOutput_databaseOutputMode :: Lens' DatabaseOutput (Maybe DatabaseOutputMode) Source #
The output mode to write into the database. Currently supported option: NEW_TABLE.
databaseOutput_glueConnectionName :: Lens' DatabaseOutput Text Source #
The Glue connection that stores the connection information for the target database.
databaseOutput_databaseOptions :: Lens' DatabaseOutput DatabaseTableOutputOptions Source #
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
DatabaseTableOutputOptions
data DatabaseTableOutputOptions Source #
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
See: newDatabaseTableOutputOptions smart constructor.
Constructors
| DatabaseTableOutputOptions' | |
Fields
| |
Instances
newDatabaseTableOutputOptions Source #
Create a value of DatabaseTableOutputOptions 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:tempDirectory:DatabaseTableOutputOptions', databaseTableOutputOptions_tempDirectory - Represents an Amazon S3 location (bucket name and object key) where
DataBrew can store intermediate results.
$sel:tableName:DatabaseTableOutputOptions', databaseTableOutputOptions_tableName - A prefix for the name of a table DataBrew will create in the database.
databaseTableOutputOptions_tempDirectory :: Lens' DatabaseTableOutputOptions (Maybe S3Location) Source #
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
databaseTableOutputOptions_tableName :: Lens' DatabaseTableOutputOptions Text Source #
A prefix for the name of a table DataBrew will create in the database.
Dataset
Represents a dataset that can be processed by DataBrew.
See: newDataset smart constructor.
Constructors
| Dataset' | |
Fields
| |
Instances
Create a value of Dataset 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:accountId:Dataset', dataset_accountId - The ID of the Amazon Web Services account that owns the dataset.
$sel:createDate:Dataset', dataset_createDate - The date and time that the dataset was created.
$sel:createdBy:Dataset', dataset_createdBy - The Amazon Resource Name (ARN) of the user who created the dataset.
$sel:format:Dataset', dataset_format - The file format of a dataset that is created from an Amazon S3 file or
folder.
$sel:formatOptions:Dataset', dataset_formatOptions - A set of options that define how DataBrew interprets the data in the
dataset.
$sel:lastModifiedBy:Dataset', dataset_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the
dataset.
$sel:lastModifiedDate:Dataset', dataset_lastModifiedDate - The last modification date and time of the dataset.
$sel:pathOptions:Dataset', dataset_pathOptions - A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
$sel:resourceArn:Dataset', dataset_resourceArn - The unique Amazon Resource Name (ARN) for the dataset.
$sel:source:Dataset', dataset_source - The location of the data for the dataset, either Amazon S3 or the Glue
Data Catalog.
$sel:tags:Dataset', dataset_tags - Metadata tags that have been applied to the dataset.
$sel:name:Dataset', dataset_name - The unique name of the dataset.
$sel:input:Dataset', dataset_input - Information on how DataBrew can find the dataset, in either the Glue
Data Catalog or Amazon S3.
dataset_accountId :: Lens' Dataset (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the dataset.
dataset_createDate :: Lens' Dataset (Maybe UTCTime) Source #
The date and time that the dataset was created.
dataset_createdBy :: Lens' Dataset (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who created the dataset.
dataset_format :: Lens' Dataset (Maybe InputFormat) Source #
The file format of a dataset that is created from an Amazon S3 file or folder.
dataset_formatOptions :: Lens' Dataset (Maybe FormatOptions) Source #
A set of options that define how DataBrew interprets the data in the dataset.
dataset_lastModifiedBy :: Lens' Dataset (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who last modified the dataset.
dataset_lastModifiedDate :: Lens' Dataset (Maybe UTCTime) Source #
The last modification date and time of the dataset.
dataset_pathOptions :: Lens' Dataset (Maybe PathOptions) Source #
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
dataset_resourceArn :: Lens' Dataset (Maybe Text) Source #
The unique Amazon Resource Name (ARN) for the dataset.
dataset_source :: Lens' Dataset (Maybe Source) Source #
The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.
dataset_tags :: Lens' Dataset (Maybe (HashMap Text Text)) Source #
Metadata tags that have been applied to the dataset.
dataset_input :: Lens' Dataset Input Source #
Information on how DataBrew can find the dataset, in either the Glue Data Catalog or Amazon S3.
DatasetParameter
data DatasetParameter Source #
Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
See: newDatasetParameter smart constructor.
Constructors
| DatasetParameter' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ParameterType | |
| -> DatasetParameter |
Create a value of DatasetParameter 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:createColumn:DatasetParameter', datasetParameter_createColumn - Optional boolean value that defines whether the captured value of this
parameter should be used to create a new column in a dataset.
$sel:datetimeOptions:DatasetParameter', datasetParameter_datetimeOptions - Additional parameter options such as a format and a timezone. Required
for datetime parameters.
$sel:filter':DatasetParameter', datasetParameter_filter - The optional filter expression structure to apply additional matching
criteria to the parameter.
$sel:name:DatasetParameter', datasetParameter_name - The name of the parameter that is used in the dataset's Amazon S3 path.
$sel:type':DatasetParameter', datasetParameter_type - The type of the dataset parameter, can be one of a 'String',
'Number' or 'Datetime'.
datasetParameter_createColumn :: Lens' DatasetParameter (Maybe Bool) Source #
Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
datasetParameter_datetimeOptions :: Lens' DatasetParameter (Maybe DatetimeOptions) Source #
Additional parameter options such as a format and a timezone. Required for datetime parameters.
datasetParameter_filter :: Lens' DatasetParameter (Maybe FilterExpression) Source #
The optional filter expression structure to apply additional matching criteria to the parameter.
datasetParameter_name :: Lens' DatasetParameter Text Source #
The name of the parameter that is used in the dataset's Amazon S3 path.
datasetParameter_type :: Lens' DatasetParameter ParameterType Source #
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
DatetimeOptions
data DatetimeOptions Source #
Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.
See: newDatetimeOptions smart constructor.
Constructors
| DatetimeOptions' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DatetimeOptions |
Create a value of DatetimeOptions 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:localeCode:DatetimeOptions', datetimeOptions_localeCode - Optional value for a non-US locale code, needed for correct
interpretation of some date formats.
$sel:timezoneOffset:DatetimeOptions', datetimeOptions_timezoneOffset - Optional value for a timezone offset of the datetime parameter value in
the Amazon S3 path. Shouldn't be used if Format for this parameter
includes timezone fields. If no offset specified, UTC is assumed.
$sel:format:DatetimeOptions', datetimeOptions_format - Required option, that defines the datetime format used for a date
parameter in the Amazon S3 path. Should use only supported datetime
specifiers and separation characters, all literal a-z or A-Z characters
should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm".
datetimeOptions_localeCode :: Lens' DatetimeOptions (Maybe Text) Source #
Optional value for a non-US locale code, needed for correct interpretation of some date formats.
datetimeOptions_timezoneOffset :: Lens' DatetimeOptions (Maybe Text) Source #
Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed.
datetimeOptions_format :: Lens' DatetimeOptions Text Source #
Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. Should use only supported datetime specifiers and separation characters, all literal a-z or A-Z characters should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm".
EntityDetectorConfiguration
data EntityDetectorConfiguration Source #
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
See: newEntityDetectorConfiguration smart constructor.
Constructors
| EntityDetectorConfiguration' | |
Fields
| |
Instances
newEntityDetectorConfiguration Source #
Arguments
| :: NonEmpty Text | |
| -> EntityDetectorConfiguration |
Create a value of EntityDetectorConfiguration 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:allowedStatistics:EntityDetectorConfiguration', entityDetectorConfiguration_allowedStatistics - Configuration of statistics that are allowed to be run on columns that
contain detected entities. When undefined, no statistics will be
computed on columns that contain detected entities.
$sel:entityTypes:EntityDetectorConfiguration', entityDetectorConfiguration_entityTypes - Entity types to detect. Can be any of the following:
- USA_SSN
- USA_ITIN
- USA_PASSPORT_NUMBER
- PHONE_NUMBER
- USA_DRIVING_LICENSE
- BANK_ACCOUNT
- CREDIT_CARD
- IP_ADDRESS
- MAC_ADDRESS
- USA_DEA_NUMBER
- USA_HCPCS_CODE
- USA_NATIONAL_PROVIDER_IDENTIFIER
- USA_NATIONAL_DRUG_CODE
- USA_HEALTH_INSURANCE_CLAIM_NUMBER
- USA_MEDICARE_BENEFICIARY_IDENTIFIER
- USA_CPT_CODE
- PERSON_NAME
- DATE
The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.
entityDetectorConfiguration_allowedStatistics :: Lens' EntityDetectorConfiguration (Maybe (NonEmpty AllowedStatistics)) Source #
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
entityDetectorConfiguration_entityTypes :: Lens' EntityDetectorConfiguration (NonEmpty Text) Source #
Entity types to detect. Can be any of the following:
- USA_SSN
- USA_ITIN
- USA_PASSPORT_NUMBER
- PHONE_NUMBER
- USA_DRIVING_LICENSE
- BANK_ACCOUNT
- CREDIT_CARD
- IP_ADDRESS
- MAC_ADDRESS
- USA_DEA_NUMBER
- USA_HCPCS_CODE
- USA_NATIONAL_PROVIDER_IDENTIFIER
- USA_NATIONAL_DRUG_CODE
- USA_HEALTH_INSURANCE_CLAIM_NUMBER
- USA_MEDICARE_BENEFICIARY_IDENTIFIER
- USA_CPT_CODE
- PERSON_NAME
- DATE
The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.
ExcelOptions
data ExcelOptions Source #
Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.
See: newExcelOptions smart constructor.
Constructors
| ExcelOptions' | |
Fields
| |
Instances
newExcelOptions :: ExcelOptions Source #
Create a value of ExcelOptions 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:headerRow:ExcelOptions', excelOptions_headerRow - A variable that specifies whether the first row in the file is parsed as
the header. If this value is false, column names are auto-generated.
$sel:sheetIndexes:ExcelOptions', excelOptions_sheetIndexes - One or more sheet numbers in the Excel file that will be included in the
dataset.
$sel:sheetNames:ExcelOptions', excelOptions_sheetNames - One or more named sheets in the Excel file that will be included in the
dataset.
excelOptions_headerRow :: Lens' ExcelOptions (Maybe Bool) Source #
A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
excelOptions_sheetIndexes :: Lens' ExcelOptions (Maybe (NonEmpty Natural)) Source #
One or more sheet numbers in the Excel file that will be included in the dataset.
excelOptions_sheetNames :: Lens' ExcelOptions (Maybe (NonEmpty Text)) Source #
One or more named sheets in the Excel file that will be included in the dataset.
FilesLimit
data FilesLimit Source #
Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path.
See: newFilesLimit smart constructor.
Constructors
| FilesLimit' | |
Fields
| |
Instances
Arguments
| :: Natural | |
| -> FilesLimit |
Create a value of FilesLimit 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:order:FilesLimit', filesLimit_order - A criteria to use for Amazon S3 files sorting before their selection. By
default uses DESCENDING order, i.e. most recent files are selected
first. Another possible value is ASCENDING.
$sel:orderedBy:FilesLimit', filesLimit_orderedBy - A criteria to use for Amazon S3 files sorting before their selection. By
default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's
the only allowed value.
$sel:maxFiles:FilesLimit', filesLimit_maxFiles - The number of Amazon S3 files to select.
filesLimit_order :: Lens' FilesLimit (Maybe Order) Source #
A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Another possible value is ASCENDING.
filesLimit_orderedBy :: Lens' FilesLimit (Maybe OrderedBy) Source #
A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed value.
filesLimit_maxFiles :: Lens' FilesLimit Natural Source #
The number of Amazon S3 files to select.
FilterExpression
data FilterExpression Source #
Represents a structure for defining parameter conditions. Supported conditions are described here: Supported conditions for dynamic datasets in the Glue DataBrew Developer Guide.
See: newFilterExpression smart constructor.
Constructors
| FilterExpression' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> FilterExpression |
Create a value of FilterExpression 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:expression:FilterExpression', filterExpression_expression - The expression which includes condition names followed by substitution
variables, possibly grouped and combined with other conditions. For
example, "(starts_with :prefix1 or starts_with :prefix2) and (ends_with
:suffix1 or ends_with :suffix2)". Substitution variables should start
with ':' symbol.
$sel:valuesMap:FilterExpression', filterExpression_valuesMap - The map of substitution variable names to their values used in this
filter expression.
filterExpression_expression :: Lens' FilterExpression Text Source #
The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, "(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)". Substitution variables should start with ':' symbol.
filterExpression_valuesMap :: Lens' FilterExpression (HashMap Text Text) Source #
The map of substitution variable names to their values used in this filter expression.
FormatOptions
data FormatOptions Source #
Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
See: newFormatOptions smart constructor.
Constructors
| FormatOptions' | |
Fields
| |
Instances
newFormatOptions :: FormatOptions Source #
Create a value of FormatOptions 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:csv:FormatOptions', formatOptions_csv - Options that define how CSV input is to be interpreted by DataBrew.
$sel:excel:FormatOptions', formatOptions_excel - Options that define how Excel input is to be interpreted by DataBrew.
$sel:json:FormatOptions', formatOptions_json - Options that define how JSON input is to be interpreted by DataBrew.
formatOptions_csv :: Lens' FormatOptions (Maybe CsvOptions) Source #
Options that define how CSV input is to be interpreted by DataBrew.
formatOptions_excel :: Lens' FormatOptions (Maybe ExcelOptions) Source #
Options that define how Excel input is to be interpreted by DataBrew.
formatOptions_json :: Lens' FormatOptions (Maybe JsonOptions) Source #
Options that define how JSON input is to be interpreted by DataBrew.
Input
Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.
See: newInput smart constructor.
Constructors
| Input' | |
Fields
| |
Instances
Create a value of Input 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:dataCatalogInputDefinition:Input', input_dataCatalogInputDefinition - The Glue Data Catalog parameters for the data.
$sel:databaseInputDefinition:Input', input_databaseInputDefinition - Connection information for dataset input files stored in a database.
$sel:metadata:Input', input_metadata - Contains additional resource information needed for specific datasets.
$sel:s3InputDefinition:Input', input_s3InputDefinition - The Amazon S3 location where the data is stored.
input_dataCatalogInputDefinition :: Lens' Input (Maybe DataCatalogInputDefinition) Source #
The Glue Data Catalog parameters for the data.
input_databaseInputDefinition :: Lens' Input (Maybe DatabaseInputDefinition) Source #
Connection information for dataset input files stored in a database.
input_metadata :: Lens' Input (Maybe Metadata) Source #
Contains additional resource information needed for specific datasets.
input_s3InputDefinition :: Lens' Input (Maybe S3Location) Source #
The Amazon S3 location where the data is stored.
Job
Represents all of the attributes of a DataBrew job.
See: newJob smart constructor.
Constructors
| Job' | |
Fields
| |
Instances
Create a value of Job 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:accountId:Job', job_accountId - The ID of the Amazon Web Services account that owns the job.
$sel:createDate:Job', job_createDate - The date and time that the job was created.
$sel:createdBy:Job', job_createdBy - The Amazon Resource Name (ARN) of the user who created the job.
$sel:dataCatalogOutputs:Job', job_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:databaseOutputs:Job', job_databaseOutputs - Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
$sel:datasetName:Job', job_datasetName - A dataset that the job is to process.
$sel:encryptionKeyArn:Job', job_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job output. For more information, see
Encrypting data written by DataBrew jobs
$sel:encryptionMode:Job', job_encryptionMode - The encryption mode for the job, which can be one of the following:
SSE-KMS- Server-side encryption with keys managed by KMS.SSE-S3- Server-side encryption with keys managed by Amazon S3.
$sel:jobSample:Job', job_jobSample - A sample configuration for profile jobs only, which determines the
number of rows on which the profile job is run. If a JobSample value
isn't provided, the default value is used. The default value is
CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
$sel:lastModifiedBy:Job', job_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the job.
$sel:lastModifiedDate:Job', job_lastModifiedDate - The modification date and time of the job.
$sel:logSubscription:Job', job_logSubscription - The current status of Amazon CloudWatch logging for the job.
$sel:maxCapacity:Job', job_maxCapacity - The maximum number of nodes that can be consumed when the job processes
data.
$sel:maxRetries:Job', job_maxRetries - The maximum number of times to retry the job after a job run fails.
$sel:outputs:Job', job_outputs - One or more artifacts that represent output from running the job.
$sel:projectName:Job', job_projectName - The name of the project that the job is associated with.
$sel:recipeReference:Job', job_recipeReference - A set of steps that the job runs.
$sel:resourceArn:Job', job_resourceArn - The unique Amazon Resource Name (ARN) for the job.
$sel:roleArn:Job', job_roleArn - The Amazon Resource Name (ARN) of the role to be assumed for this job.
$sel:tags:Job', job_tags - Metadata tags that have been applied to the job.
$sel:timeout:Job', job_timeout - The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
$sel:type':Job', job_type - The job type of the job, which must be one of the following:
PROFILE- A job to analyze a dataset, to determine its size, data types, data distribution, and more.RECIPE- A job to apply one or more transformations to a dataset.
$sel:validationConfigurations:Job', job_validationConfigurations - List of validation configurations that are applied to the profile job.
job_accountId :: Lens' Job (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the job.
job_createdBy :: Lens' Job (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who created the job.
job_dataCatalogOutputs :: Lens' Job (Maybe (NonEmpty DataCatalogOutput)) Source #
One or more artifacts that represent the Glue Data Catalog output from running the job.
job_databaseOutputs :: Lens' Job (Maybe (NonEmpty DatabaseOutput)) Source #
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
job_encryptionKeyArn :: Lens' Job (Maybe Text) Source #
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs
job_encryptionMode :: Lens' Job (Maybe EncryptionMode) Source #
The encryption mode for the job, which can be one of the following:
SSE-KMS- Server-side encryption with keys managed by KMS.SSE-S3- Server-side encryption with keys managed by Amazon S3.
job_jobSample :: Lens' Job (Maybe JobSample) Source #
A sample configuration for profile jobs only, which determines the
number of rows on which the profile job is run. If a JobSample value
isn't provided, the default value is used. The default value is
CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
job_lastModifiedBy :: Lens' Job (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who last modified the job.
job_lastModifiedDate :: Lens' Job (Maybe UTCTime) Source #
The modification date and time of the job.
job_logSubscription :: Lens' Job (Maybe LogSubscription) Source #
The current status of Amazon CloudWatch logging for the job.
job_maxCapacity :: Lens' Job (Maybe Int) Source #
The maximum number of nodes that can be consumed when the job processes data.
job_maxRetries :: Lens' Job (Maybe Natural) Source #
The maximum number of times to retry the job after a job run fails.
job_outputs :: Lens' Job (Maybe (NonEmpty Output)) Source #
One or more artifacts that represent output from running the job.
job_projectName :: Lens' Job (Maybe Text) Source #
The name of the project that the job is associated with.
job_recipeReference :: Lens' Job (Maybe RecipeReference) Source #
A set of steps that the job runs.
job_resourceArn :: Lens' Job (Maybe Text) Source #
The unique Amazon Resource Name (ARN) for the job.
job_roleArn :: Lens' Job (Maybe Text) Source #
The Amazon Resource Name (ARN) of the role to be assumed for this job.
job_tags :: Lens' Job (Maybe (HashMap Text Text)) Source #
Metadata tags that have been applied to the job.
job_timeout :: Lens' Job (Maybe Natural) Source #
The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
job_type :: Lens' Job (Maybe JobType) Source #
The job type of the job, which must be one of the following:
PROFILE- A job to analyze a dataset, to determine its size, data types, data distribution, and more.RECIPE- A job to apply one or more transformations to a dataset.
job_validationConfigurations :: Lens' Job (Maybe (NonEmpty ValidationConfiguration)) Source #
List of validation configurations that are applied to the profile job.
JobRun
Represents one run of a DataBrew job.
See: newJobRun smart constructor.
Constructors
| JobRun' | |
Fields
| |
Instances
Create a value of JobRun 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:attempt:JobRun', jobRun_attempt - The number of times that DataBrew has attempted to run the job.
$sel:completedOn:JobRun', jobRun_completedOn - The date and time when the job completed processing.
$sel:dataCatalogOutputs:JobRun', jobRun_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:databaseOutputs:JobRun', jobRun_databaseOutputs - Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
$sel:datasetName:JobRun', jobRun_datasetName - The name of the dataset for the job to process.
$sel:errorMessage:JobRun', jobRun_errorMessage - A message indicating an error (if any) that was encountered when the job
ran.
$sel:executionTime:JobRun', jobRun_executionTime - The amount of time, in seconds, during which a job run consumed
resources.
$sel:jobName:JobRun', jobRun_jobName - The name of the job being processed during this run.
$sel:jobSample:JobRun', jobRun_jobSample - A sample configuration for profile jobs only, which determines the
number of rows on which the profile job is run. If a JobSample value
isn't provided, the default is used. The default value is CUSTOM_ROWS
for the mode parameter and 20,000 for the size parameter.
$sel:logGroupName:JobRun', jobRun_logGroupName - The name of an Amazon CloudWatch log group, where the job writes
diagnostic messages when it runs.
$sel:logSubscription:JobRun', jobRun_logSubscription - The current status of Amazon CloudWatch logging for the job run.
$sel:outputs:JobRun', jobRun_outputs - One or more output artifacts from a job run.
$sel:recipeReference:JobRun', jobRun_recipeReference - The set of steps processed by the job.
$sel:runId:JobRun', jobRun_runId - The unique identifier of the job run.
$sel:startedBy:JobRun', jobRun_startedBy - The Amazon Resource Name (ARN) of the user who initiated the job run.
$sel:startedOn:JobRun', jobRun_startedOn - The date and time when the job run began.
$sel:state:JobRun', jobRun_state - The current state of the job run entity itself.
$sel:validationConfigurations:JobRun', jobRun_validationConfigurations - List of validation configurations that are applied to the profile job
run.
jobRun_attempt :: Lens' JobRun (Maybe Int) Source #
The number of times that DataBrew has attempted to run the job.
jobRun_completedOn :: Lens' JobRun (Maybe UTCTime) Source #
The date and time when the job completed processing.
jobRun_dataCatalogOutputs :: Lens' JobRun (Maybe (NonEmpty DataCatalogOutput)) Source #
One or more artifacts that represent the Glue Data Catalog output from running the job.
jobRun_databaseOutputs :: Lens' JobRun (Maybe (NonEmpty DatabaseOutput)) Source #
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
jobRun_datasetName :: Lens' JobRun (Maybe Text) Source #
The name of the dataset for the job to process.
jobRun_errorMessage :: Lens' JobRun (Maybe Text) Source #
A message indicating an error (if any) that was encountered when the job ran.
jobRun_executionTime :: Lens' JobRun (Maybe Int) Source #
The amount of time, in seconds, during which a job run consumed resources.
jobRun_jobName :: Lens' JobRun (Maybe Text) Source #
The name of the job being processed during this run.
jobRun_jobSample :: Lens' JobRun (Maybe JobSample) Source #
A sample configuration for profile jobs only, which determines the
number of rows on which the profile job is run. If a JobSample value
isn't provided, the default is used. The default value is CUSTOM_ROWS
for the mode parameter and 20,000 for the size parameter.
jobRun_logGroupName :: Lens' JobRun (Maybe Text) Source #
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
jobRun_logSubscription :: Lens' JobRun (Maybe LogSubscription) Source #
The current status of Amazon CloudWatch logging for the job run.
jobRun_outputs :: Lens' JobRun (Maybe (NonEmpty Output)) Source #
One or more output artifacts from a job run.
jobRun_recipeReference :: Lens' JobRun (Maybe RecipeReference) Source #
The set of steps processed by the job.
jobRun_startedBy :: Lens' JobRun (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who initiated the job run.
jobRun_state :: Lens' JobRun (Maybe JobRunState) Source #
The current state of the job run entity itself.
jobRun_validationConfigurations :: Lens' JobRun (Maybe (NonEmpty ValidationConfiguration)) Source #
List of validation configurations that are applied to the profile job run.
JobSample
A sample configuration for profile jobs only, which determines the
number of rows on which the profile job is run. If a JobSample value
isn't provided, the default is used. The default value is CUSTOM_ROWS
for the mode parameter and 20,000 for the size parameter.
See: newJobSample smart constructor.
Constructors
| JobSample' | |
Fields
| |
Instances
| FromJSON JobSample Source # | |
| ToJSON JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample | |
| Generic JobSample Source # | |
| Read JobSample Source # | |
| Show JobSample Source # | |
| NFData JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample | |
| Eq JobSample Source # | |
| Hashable JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample | |
| type Rep JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample type Rep JobSample = D1 ('MetaData "JobSample" "Amazonka.DataBrew.Types.JobSample" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "JobSample'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SampleMode)) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) | |
newJobSample :: JobSample Source #
Create a value of JobSample 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:mode:JobSample', jobSample_mode - A value that determines whether the profile job is run on the entire
dataset or a specified number of rows. This value must be one of the
following:
- FULL_DATASET - The profile job is run on the entire dataset.
- CUSTOM_ROWS - The profile job is run on the number of rows specified
in the
Sizeparameter.
$sel:size:JobSample', jobSample_size - The Size parameter is only required when the mode is CUSTOM_ROWS. The
profile job is run on the specified number of rows. The maximum value
for size is Long.MAX_VALUE.
Long.MAX_VALUE = 9223372036854775807
jobSample_mode :: Lens' JobSample (Maybe SampleMode) Source #
A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:
- FULL_DATASET - The profile job is run on the entire dataset.
- CUSTOM_ROWS - The profile job is run on the number of rows specified
in the
Sizeparameter.
jobSample_size :: Lens' JobSample (Maybe Integer) Source #
The Size parameter is only required when the mode is CUSTOM_ROWS. The
profile job is run on the specified number of rows. The maximum value
for size is Long.MAX_VALUE.
Long.MAX_VALUE = 9223372036854775807
JsonOptions
data JsonOptions Source #
Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew.
See: newJsonOptions smart constructor.
Constructors
| JsonOptions' | |
Instances
newJsonOptions :: JsonOptions Source #
Create a value of JsonOptions 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:multiLine:JsonOptions', jsonOptions_multiLine - A value that specifies whether JSON input contains embedded new line
characters.
jsonOptions_multiLine :: Lens' JsonOptions (Maybe Bool) Source #
A value that specifies whether JSON input contains embedded new line characters.
Metadata
Contains additional resource information needed for specific datasets.
See: newMetadata smart constructor.
Constructors
| Metadata' | |
Instances
| FromJSON Metadata Source # | |
| ToJSON Metadata Source # | |
Defined in Amazonka.DataBrew.Types.Metadata | |
| Generic Metadata Source # | |
| Read Metadata Source # | |
| Show Metadata Source # | |
| NFData Metadata Source # | |
Defined in Amazonka.DataBrew.Types.Metadata | |
| Eq Metadata Source # | |
| Hashable Metadata Source # | |
Defined in Amazonka.DataBrew.Types.Metadata | |
| type Rep Metadata Source # | |
Defined in Amazonka.DataBrew.Types.Metadata | |
newMetadata :: Metadata Source #
Create a value of Metadata 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:sourceArn:Metadata', metadata_sourceArn - The Amazon Resource Name (ARN) associated with the dataset. Currently,
DataBrew only supports ARNs from Amazon AppFlow.
metadata_sourceArn :: Lens' Metadata (Maybe Text) Source #
The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow.
Output
Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.
See: newOutput smart constructor.
Constructors
| Output' | |
Fields
| |
Instances
Arguments
| :: S3Location | |
| -> Output |
Create a value of Output 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:compressionFormat:Output', output_compressionFormat - The compression algorithm used to compress the output text of the job.
$sel:format:Output', output_format - The data format of the output of the job.
$sel:formatOptions:Output', output_formatOptions - Represents options that define how DataBrew formats job output files.
$sel:maxOutputFiles:Output', output_maxOutputFiles - Maximum number of files to be generated by the job and written to the
output folder. For output partitioned by column(s), the MaxOutputFiles
value is the maximum number of files per partition.
$sel:overwrite:Output', output_overwrite - A value that, if true, means that any data in the location specified for
output is overwritten with new output.
$sel:partitionColumns:Output', output_partitionColumns - The names of one or more partition columns for the output of the job.
$sel:location:Output', output_location - The location in Amazon S3 where the job writes its output.
output_compressionFormat :: Lens' Output (Maybe CompressionFormat) Source #
The compression algorithm used to compress the output text of the job.
output_format :: Lens' Output (Maybe OutputFormat) Source #
The data format of the output of the job.
output_formatOptions :: Lens' Output (Maybe OutputFormatOptions) Source #
Represents options that define how DataBrew formats job output files.
output_maxOutputFiles :: Lens' Output (Maybe Natural) Source #
Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.
output_overwrite :: Lens' Output (Maybe Bool) Source #
A value that, if true, means that any data in the location specified for output is overwritten with new output.
output_partitionColumns :: Lens' Output (Maybe [Text]) Source #
The names of one or more partition columns for the output of the job.
output_location :: Lens' Output S3Location Source #
The location in Amazon S3 where the job writes its output.
OutputFormatOptions
data OutputFormatOptions Source #
Represents a set of options that define the structure of comma-separated (CSV) job output.
See: newOutputFormatOptions smart constructor.
Constructors
| OutputFormatOptions' | |
Fields
| |
Instances
newOutputFormatOptions :: OutputFormatOptions Source #
Create a value of OutputFormatOptions 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:csv:OutputFormatOptions', outputFormatOptions_csv - Represents a set of options that define the structure of comma-separated
value (CSV) job output.
outputFormatOptions_csv :: Lens' OutputFormatOptions (Maybe CsvOutputOptions) Source #
Represents a set of options that define the structure of comma-separated value (CSV) job output.
PathOptions
data PathOptions Source #
Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.
See: newPathOptions smart constructor.
Constructors
| PathOptions' | |
Fields
| |
Instances
newPathOptions :: PathOptions Source #
Create a value of PathOptions 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:filesLimit:PathOptions', pathOptions_filesLimit - If provided, this structure imposes a limit on a number of files that
should be selected.
$sel:lastModifiedDateCondition:PathOptions', pathOptions_lastModifiedDateCondition - If provided, this structure defines a date range for matching Amazon S3
objects based on their LastModifiedDate attribute in Amazon S3.
$sel:parameters:PathOptions', pathOptions_parameters - A structure that maps names of parameters used in the Amazon S3 path of
a dataset to their definitions.
pathOptions_filesLimit :: Lens' PathOptions (Maybe FilesLimit) Source #
If provided, this structure imposes a limit on a number of files that should be selected.
pathOptions_lastModifiedDateCondition :: Lens' PathOptions (Maybe FilterExpression) Source #
If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.
pathOptions_parameters :: Lens' PathOptions (Maybe (HashMap Text DatasetParameter)) Source #
A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
ProfileConfiguration
data ProfileConfiguration Source #
Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.
See: newProfileConfiguration smart constructor.
Constructors
| ProfileConfiguration' | |
Fields
| |
Instances
newProfileConfiguration :: ProfileConfiguration Source #
Create a value of ProfileConfiguration 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:columnStatisticsConfigurations:ProfileConfiguration', profileConfiguration_columnStatisticsConfigurations - List of configurations for column evaluations.
ColumnStatisticsConfigurations are used to select evaluations and
override parameters of evaluations for particular columns. When
ColumnStatisticsConfigurations is undefined, the profile job will
profile all supported columns and run all supported evaluations.
$sel:datasetStatisticsConfiguration:ProfileConfiguration', profileConfiguration_datasetStatisticsConfiguration - Configuration for inter-column evaluations. Configuration can be used to
select evaluations and override parameters of evaluations. When
configuration is undefined, the profile job will run all supported
inter-column evaluations.
$sel:entityDetectorConfiguration:ProfileConfiguration', profileConfiguration_entityDetectorConfiguration - Configuration of entity detection for a profile job. When undefined,
entity detection is disabled.
$sel:profileColumns:ProfileConfiguration', profileConfiguration_profileColumns - List of column selectors. ProfileColumns can be used to select columns
from the dataset. When ProfileColumns is undefined, the profile job will
profile all supported columns.
profileConfiguration_columnStatisticsConfigurations :: Lens' ProfileConfiguration (Maybe (NonEmpty ColumnStatisticsConfiguration)) Source #
List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
profileConfiguration_datasetStatisticsConfiguration :: Lens' ProfileConfiguration (Maybe StatisticsConfiguration) Source #
Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
profileConfiguration_entityDetectorConfiguration :: Lens' ProfileConfiguration (Maybe EntityDetectorConfiguration) Source #
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
profileConfiguration_profileColumns :: Lens' ProfileConfiguration (Maybe (NonEmpty ColumnSelector)) Source #
List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.
Project
Represents all of the attributes of a DataBrew project.
See: newProject smart constructor.
Constructors
| Project' | |
Fields
| |
Instances
Create a value of Project 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:accountId:Project', project_accountId - The ID of the Amazon Web Services account that owns the project.
$sel:createDate:Project', project_createDate - The date and time that the project was created.
$sel:createdBy:Project', project_createdBy - The Amazon Resource Name (ARN) of the user who crated the project.
$sel:datasetName:Project', project_datasetName - The dataset that the project is to act upon.
$sel:lastModifiedBy:Project', project_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the
project.
$sel:lastModifiedDate:Project', project_lastModifiedDate - The last modification date and time for the project.
$sel:openDate:Project', project_openDate - The date and time when the project was opened.
$sel:openedBy:Project', project_openedBy - The Amazon Resource Name (ARN) of the user that opened the project for
use.
$sel:resourceArn:Project', project_resourceArn - The Amazon Resource Name (ARN) for the project.
$sel:roleArn:Project', project_roleArn - The Amazon Resource Name (ARN) of the role that will be assumed for this
project.
$sel:sample:Project', project_sample - The sample size and sampling type to apply to the data. If this
parameter isn't specified, then the sample consists of the first 500
rows from the dataset.
$sel:tags:Project', project_tags - Metadata tags that have been applied to the project.
$sel:name:Project', project_name - The unique name of a project.
$sel:recipeName:Project', project_recipeName - The name of a recipe that will be developed during a project session.
project_accountId :: Lens' Project (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the project.
project_createDate :: Lens' Project (Maybe UTCTime) Source #
The date and time that the project was created.
project_createdBy :: Lens' Project (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who crated the project.
project_datasetName :: Lens' Project (Maybe Text) Source #
The dataset that the project is to act upon.
project_lastModifiedBy :: Lens' Project (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who last modified the project.
project_lastModifiedDate :: Lens' Project (Maybe UTCTime) Source #
The last modification date and time for the project.
project_openDate :: Lens' Project (Maybe UTCTime) Source #
The date and time when the project was opened.
project_openedBy :: Lens' Project (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user that opened the project for use.
project_resourceArn :: Lens' Project (Maybe Text) Source #
The Amazon Resource Name (ARN) for the project.
project_roleArn :: Lens' Project (Maybe Text) Source #
The Amazon Resource Name (ARN) of the role that will be assumed for this project.
project_sample :: Lens' Project (Maybe Sample) Source #
The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.
project_tags :: Lens' Project (Maybe (HashMap Text Text)) Source #
Metadata tags that have been applied to the project.
project_recipeName :: Lens' Project Text Source #
The name of a recipe that will be developed during a project session.
Recipe
Represents one or more actions to be performed on a DataBrew dataset.
See: newRecipe smart constructor.
Constructors
| Recipe' | |
Fields
| |
Instances
Create a value of Recipe 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:createDate:Recipe', recipe_createDate - The date and time that the recipe was created.
$sel:createdBy:Recipe', recipe_createdBy - The Amazon Resource Name (ARN) of the user who created the recipe.
$sel:description:Recipe', recipe_description - The description of the recipe.
$sel:lastModifiedBy:Recipe', recipe_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the recipe.
$sel:lastModifiedDate:Recipe', recipe_lastModifiedDate - The last modification date and time of the recipe.
$sel:projectName:Recipe', recipe_projectName - The name of the project that the recipe is associated with.
$sel:publishedBy:Recipe', recipe_publishedBy - The Amazon Resource Name (ARN) of the user who published the recipe.
$sel:publishedDate:Recipe', recipe_publishedDate - The date and time when the recipe was published.
$sel:recipeVersion:Recipe', recipe_recipeVersion - The identifier for the version for the recipe. Must be one of the
following:
- Numeric version (
X.Y) -XandYstand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. BothXandYare required, and "0.0" isn't a valid version. LATEST_WORKING- the most recent valid version being developed in a DataBrew project.LATEST_PUBLISHED- the most recent published version.
$sel:resourceArn:Recipe', recipe_resourceArn - The Amazon Resource Name (ARN) for the recipe.
$sel:steps:Recipe', recipe_steps - A list of steps that are defined by the recipe.
$sel:tags:Recipe', recipe_tags - Metadata tags that have been applied to the recipe.
$sel:name:Recipe', recipe_name - The unique name for the recipe.
recipe_createDate :: Lens' Recipe (Maybe UTCTime) Source #
The date and time that the recipe was created.
recipe_createdBy :: Lens' Recipe (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who created the recipe.
recipe_lastModifiedBy :: Lens' Recipe (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who last modified the recipe.
recipe_lastModifiedDate :: Lens' Recipe (Maybe UTCTime) Source #
The last modification date and time of the recipe.
recipe_projectName :: Lens' Recipe (Maybe Text) Source #
The name of the project that the recipe is associated with.
recipe_publishedBy :: Lens' Recipe (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who published the recipe.
recipe_publishedDate :: Lens' Recipe (Maybe UTCTime) Source #
The date and time when the recipe was published.
recipe_recipeVersion :: Lens' Recipe (Maybe Text) Source #
The identifier for the version for the recipe. Must be one of the following:
- Numeric version (
X.Y) -XandYstand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. BothXandYare required, and "0.0" isn't a valid version. LATEST_WORKING- the most recent valid version being developed in a DataBrew project.LATEST_PUBLISHED- the most recent published version.
recipe_resourceArn :: Lens' Recipe (Maybe Text) Source #
The Amazon Resource Name (ARN) for the recipe.
recipe_steps :: Lens' Recipe (Maybe [RecipeStep]) Source #
A list of steps that are defined by the recipe.
recipe_tags :: Lens' Recipe (Maybe (HashMap Text Text)) Source #
Metadata tags that have been applied to the recipe.
RecipeAction
data RecipeAction Source #
Represents a transformation and associated parameters that are used to apply a change to a DataBrew dataset. For more information, see Recipe actions reference.
See: newRecipeAction smart constructor.
Constructors
| RecipeAction' | |
Instances
Arguments
| :: Text | |
| -> RecipeAction |
Create a value of RecipeAction 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:parameters:RecipeAction', recipeAction_parameters - Contextual parameters for the transformation.
$sel:operation:RecipeAction', recipeAction_operation - The name of a valid DataBrew transformation to be performed on the data.
recipeAction_parameters :: Lens' RecipeAction (Maybe (HashMap Text Text)) Source #
Contextual parameters for the transformation.
recipeAction_operation :: Lens' RecipeAction Text Source #
The name of a valid DataBrew transformation to be performed on the data.
RecipeReference
data RecipeReference Source #
Represents the name and version of a DataBrew recipe.
See: newRecipeReference smart constructor.
Constructors
| RecipeReference' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RecipeReference |
Create a value of RecipeReference 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:recipeVersion:RecipeReference', recipeReference_recipeVersion - The identifier for the version for the recipe.
$sel:name:RecipeReference', recipeReference_name - The name of the recipe.
recipeReference_recipeVersion :: Lens' RecipeReference (Maybe Text) Source #
The identifier for the version for the recipe.
recipeReference_name :: Lens' RecipeReference Text Source #
The name of the recipe.
RecipeStep
data RecipeStep Source #
Represents a single step from a DataBrew recipe to be performed.
See: newRecipeStep smart constructor.
Constructors
| RecipeStep' | |
Fields
| |
Instances
Arguments
| :: RecipeAction | |
| -> RecipeStep |
Create a value of RecipeStep 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:conditionExpressions:RecipeStep', recipeStep_conditionExpressions - One or more conditions that must be met for the recipe step to succeed.
All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.
$sel:action:RecipeStep', recipeStep_action - The particular action to be performed in the recipe step.
recipeStep_conditionExpressions :: Lens' RecipeStep (Maybe [ConditionExpression]) Source #
One or more conditions that must be met for the recipe step to succeed.
All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.
recipeStep_action :: Lens' RecipeStep RecipeAction Source #
The particular action to be performed in the recipe step.
RecipeVersionErrorDetail
data RecipeVersionErrorDetail Source #
Represents any errors encountered when attempting to delete multiple recipe versions.
See: newRecipeVersionErrorDetail smart constructor.
Constructors
| RecipeVersionErrorDetail' | |
Fields
| |
Instances
newRecipeVersionErrorDetail :: RecipeVersionErrorDetail Source #
Create a value of RecipeVersionErrorDetail 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:errorCode:RecipeVersionErrorDetail', recipeVersionErrorDetail_errorCode - The HTTP status code for the error.
$sel:errorMessage:RecipeVersionErrorDetail', recipeVersionErrorDetail_errorMessage - The text of the error message.
$sel:recipeVersion:RecipeVersionErrorDetail', recipeVersionErrorDetail_recipeVersion - The identifier for the recipe version associated with this error.
recipeVersionErrorDetail_errorCode :: Lens' RecipeVersionErrorDetail (Maybe Text) Source #
The HTTP status code for the error.
recipeVersionErrorDetail_errorMessage :: Lens' RecipeVersionErrorDetail (Maybe Text) Source #
The text of the error message.
recipeVersionErrorDetail_recipeVersion :: Lens' RecipeVersionErrorDetail (Maybe Text) Source #
The identifier for the recipe version associated with this error.
Rule
Represents a single data quality requirement that should be validated in the scope of this dataset.
See: newRule smart constructor.
Constructors
| Rule' | |
Fields
| |
Instances
Create a value of Rule 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:columnSelectors:Rule', rule_columnSelectors - List of column selectors. Selectors can be used to select columns using
a name or regular expression from the dataset. Rule will be applied to
selected columns.
$sel:disabled:Rule', rule_disabled - A value that specifies whether the rule is disabled. Once a rule is
disabled, a profile job will not validate it during a job run. Default
value is false.
$sel:substitutionMap:Rule', rule_substitutionMap - The map of substitution variable names to their values used in a check
expression. Variable names should start with a ':' (colon). Variable
values can either be actual values or column names. To differentiate
between the two, column names should be enclosed in backticks, for
example, ":col1": "`Column A`".
$sel:threshold:Rule', rule_threshold - The threshold used with a non-aggregate check expression. Non-aggregate
check expressions will be applied to each row in a specific column, and
the threshold will be used to determine whether the validation succeeds.
Rule, rule_name - The name of the rule.
$sel:checkExpression:Rule', rule_checkExpression - The expression which includes column references, condition names
followed by variable references, possibly grouped and combined with
other conditions. For example,
(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2).
Column and value references are substitution variables that should start
with the ':' symbol. Depending on the context, substitution
variables' values can be either an actual value or a column name. These
values are defined in the SubstitutionMap. If a CheckExpression starts
with a column reference, then ColumnSelectors in the rule should be
null. If ColumnSelectors has been defined, then there should be no
column reference in the left side of a condition, for example,
is_between :val1 and :val2.
For more information, see Available checks
rule_columnSelectors :: Lens' Rule (Maybe (NonEmpty ColumnSelector)) Source #
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
rule_disabled :: Lens' Rule (Maybe Bool) Source #
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
rule_substitutionMap :: Lens' Rule (Maybe (HashMap Text Text)) Source #
The map of substitution variable names to their values used in a check
expression. Variable names should start with a ':' (colon). Variable
values can either be actual values or column names. To differentiate
between the two, column names should be enclosed in backticks, for
example, ":col1": "`Column A`".
rule_threshold :: Lens' Rule (Maybe Threshold) Source #
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
rule_checkExpression :: Lens' Rule Text Source #
The expression which includes column references, condition names
followed by variable references, possibly grouped and combined with
other conditions. For example,
(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2).
Column and value references are substitution variables that should start
with the ':' symbol. Depending on the context, substitution
variables' values can be either an actual value or a column name. These
values are defined in the SubstitutionMap. If a CheckExpression starts
with a column reference, then ColumnSelectors in the rule should be
null. If ColumnSelectors has been defined, then there should be no
column reference in the left side of a condition, for example,
is_between :val1 and :val2.
For more information, see Available checks
RulesetItem
data RulesetItem Source #
Contains metadata about the ruleset.
See: newRulesetItem smart constructor.
Constructors
| RulesetItem' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RulesetItem |
Create a value of RulesetItem 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:accountId:RulesetItem', rulesetItem_accountId - The ID of the Amazon Web Services account that owns the ruleset.
$sel:createDate:RulesetItem', rulesetItem_createDate - The date and time that the ruleset was created.
$sel:createdBy:RulesetItem', rulesetItem_createdBy - The Amazon Resource Name (ARN) of the user who created the ruleset.
$sel:description:RulesetItem', rulesetItem_description - The description of the ruleset.
$sel:lastModifiedBy:RulesetItem', rulesetItem_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the
ruleset.
$sel:lastModifiedDate:RulesetItem', rulesetItem_lastModifiedDate - The modification date and time of the ruleset.
$sel:resourceArn:RulesetItem', rulesetItem_resourceArn - The Amazon Resource Name (ARN) for the ruleset.
$sel:ruleCount:RulesetItem', rulesetItem_ruleCount - The number of rules that are defined in the ruleset.
$sel:tags:RulesetItem', rulesetItem_tags - Metadata tags that have been applied to the ruleset.
$sel:name:RulesetItem', rulesetItem_name - The name of the ruleset.
$sel:targetArn:RulesetItem', rulesetItem_targetArn - The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset
is associated with.
rulesetItem_accountId :: Lens' RulesetItem (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the ruleset.
rulesetItem_createDate :: Lens' RulesetItem (Maybe UTCTime) Source #
The date and time that the ruleset was created.
rulesetItem_createdBy :: Lens' RulesetItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who created the ruleset.
rulesetItem_description :: Lens' RulesetItem (Maybe Text) Source #
The description of the ruleset.
rulesetItem_lastModifiedBy :: Lens' RulesetItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who last modified the ruleset.
rulesetItem_lastModifiedDate :: Lens' RulesetItem (Maybe UTCTime) Source #
The modification date and time of the ruleset.
rulesetItem_resourceArn :: Lens' RulesetItem (Maybe Text) Source #
The Amazon Resource Name (ARN) for the ruleset.
rulesetItem_ruleCount :: Lens' RulesetItem (Maybe Natural) Source #
The number of rules that are defined in the ruleset.
rulesetItem_tags :: Lens' RulesetItem (Maybe (HashMap Text Text)) Source #
Metadata tags that have been applied to the ruleset.
rulesetItem_name :: Lens' RulesetItem Text Source #
The name of the ruleset.
rulesetItem_targetArn :: Lens' RulesetItem Text Source #
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
S3Location
data S3Location Source #
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
See: newS3Location smart constructor.
Constructors
| S3Location' | |
Instances
Arguments
| :: Text | |
| -> S3Location |
Create a value of S3Location 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:bucketOwner:S3Location', s3Location_bucketOwner - The Amazon Web Services account ID of the bucket owner.
$sel:key:S3Location', s3Location_key - The unique name of the object in the bucket.
$sel:bucket:S3Location', s3Location_bucket - The Amazon S3 bucket name.
s3Location_bucketOwner :: Lens' S3Location (Maybe Text) Source #
The Amazon Web Services account ID of the bucket owner.
s3Location_key :: Lens' S3Location (Maybe Text) Source #
The unique name of the object in the bucket.
s3Location_bucket :: Lens' S3Location Text Source #
The Amazon S3 bucket name.
S3TableOutputOptions
data S3TableOutputOptions Source #
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
See: newS3TableOutputOptions smart constructor.
Constructors
| S3TableOutputOptions' | |
Fields
| |
Instances
newS3TableOutputOptions Source #
Create a value of S3TableOutputOptions 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:location:S3TableOutputOptions', s3TableOutputOptions_location - Represents an Amazon S3 location (bucket name and object key) where
DataBrew can write output from a job.
s3TableOutputOptions_location :: Lens' S3TableOutputOptions S3Location Source #
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
Sample
Represents the sample size and sampling type for DataBrew to use for interactive data analysis.
See: newSample smart constructor.
Constructors
| Sample' | |
Fields
| |
Instances
| FromJSON Sample Source # | |
| ToJSON Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample | |
| Generic Sample Source # | |
| Read Sample Source # | |
| Show Sample Source # | |
| NFData Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample | |
| Eq Sample Source # | |
| Hashable Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample | |
| type Rep Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample type Rep Sample = D1 ('MetaData "Sample" "Amazonka.DataBrew.Types.Sample" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "Sample'" 'PrefixI 'True) (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SampleType))) | |
Arguments
| :: SampleType | |
| -> Sample |
Create a value of Sample 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:size:Sample', sample_size - The number of rows in the sample.
$sel:type':Sample', sample_type - The way in which DataBrew obtains rows from a dataset.
sample_type :: Lens' Sample SampleType Source #
The way in which DataBrew obtains rows from a dataset.
Schedule
Represents one or more dates and times when a job is to run.
See: newSchedule smart constructor.
Constructors
| Schedule' | |
Fields
| |
Instances
Create a value of Schedule 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:accountId:Schedule', schedule_accountId - The ID of the Amazon Web Services account that owns the schedule.
$sel:createDate:Schedule', schedule_createDate - The date and time that the schedule was created.
$sel:createdBy:Schedule', schedule_createdBy - The Amazon Resource Name (ARN) of the user who created the schedule.
$sel:cronExpression:Schedule', schedule_cronExpression - The dates and times when the job is to run. For more information, see
Cron expressions
in the Glue DataBrew Developer Guide.
$sel:jobNames:Schedule', schedule_jobNames - A list of jobs to be run, according to the schedule.
$sel:lastModifiedBy:Schedule', schedule_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the
schedule.
$sel:lastModifiedDate:Schedule', schedule_lastModifiedDate - The date and time when the schedule was last modified.
$sel:resourceArn:Schedule', schedule_resourceArn - The Amazon Resource Name (ARN) of the schedule.
$sel:tags:Schedule', schedule_tags - Metadata tags that have been applied to the schedule.
$sel:name:Schedule', schedule_name - The name of the schedule.
schedule_accountId :: Lens' Schedule (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the schedule.
schedule_createDate :: Lens' Schedule (Maybe UTCTime) Source #
The date and time that the schedule was created.
schedule_createdBy :: Lens' Schedule (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who created the schedule.
schedule_cronExpression :: Lens' Schedule (Maybe Text) Source #
The dates and times when the job is to run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
schedule_jobNames :: Lens' Schedule (Maybe [Text]) Source #
A list of jobs to be run, according to the schedule.
schedule_lastModifiedBy :: Lens' Schedule (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user who last modified the schedule.
schedule_lastModifiedDate :: Lens' Schedule (Maybe UTCTime) Source #
The date and time when the schedule was last modified.
schedule_resourceArn :: Lens' Schedule (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schedule.
schedule_tags :: Lens' Schedule (Maybe (HashMap Text Text)) Source #
Metadata tags that have been applied to the schedule.
StatisticOverride
data StatisticOverride Source #
Override of a particular evaluation for a profile job.
See: newStatisticOverride smart constructor.
Constructors
| StatisticOverride' | |
Instances
Arguments
| :: Text | |
| -> StatisticOverride |
Create a value of StatisticOverride 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:statistic:StatisticOverride', statisticOverride_statistic - The name of an evaluation
$sel:parameters:StatisticOverride', statisticOverride_parameters - A map that includes overrides of an evaluation’s parameters.
statisticOverride_statistic :: Lens' StatisticOverride Text Source #
The name of an evaluation
statisticOverride_parameters :: Lens' StatisticOverride (HashMap Text Text) Source #
A map that includes overrides of an evaluation’s parameters.
StatisticsConfiguration
data StatisticsConfiguration Source #
Configuration of evaluations for a profile job. This configuration can be used to select evaluations and override the parameters of selected evaluations.
See: newStatisticsConfiguration smart constructor.
Constructors
| StatisticsConfiguration' | |
Fields
| |
Instances
newStatisticsConfiguration :: StatisticsConfiguration Source #
Create a value of StatisticsConfiguration 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:includedStatistics:StatisticsConfiguration', statisticsConfiguration_includedStatistics - List of included evaluations. When the list is undefined, all supported
evaluations will be included.
$sel:overrides:StatisticsConfiguration', statisticsConfiguration_overrides - List of overrides for evaluations.
statisticsConfiguration_includedStatistics :: Lens' StatisticsConfiguration (Maybe (NonEmpty Text)) Source #
List of included evaluations. When the list is undefined, all supported evaluations will be included.
statisticsConfiguration_overrides :: Lens' StatisticsConfiguration (Maybe (NonEmpty StatisticOverride)) Source #
List of overrides for evaluations.
Threshold
The threshold used with a non-aggregate check expression. The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds.
See: newThreshold smart constructor.
Constructors
| Threshold' | |
Fields
| |
Instances
| FromJSON Threshold Source # | |
| ToJSON Threshold Source # | |
Defined in Amazonka.DataBrew.Types.Threshold | |
| Generic Threshold Source # | |
| Read Threshold Source # | |
| Show Threshold Source # | |
| NFData Threshold Source # | |
Defined in Amazonka.DataBrew.Types.Threshold | |
| Eq Threshold Source # | |
| Hashable Threshold Source # | |
Defined in Amazonka.DataBrew.Types.Threshold | |
| type Rep Threshold Source # | |
Defined in Amazonka.DataBrew.Types.Threshold type Rep Threshold = D1 ('MetaData "Threshold" "Amazonka.DataBrew.Types.Threshold" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "Threshold'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThresholdType)) :*: (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThresholdUnit)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))) | |
Create a value of Threshold 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:type':Threshold', threshold_type - The type of a threshold. Used for comparison of an actual count of rows
that satisfy the rule to the threshold value.
$sel:unit:Threshold', threshold_unit - Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full
sample size used for validation.
$sel:value:Threshold', threshold_value - The value of a threshold.
threshold_type :: Lens' Threshold (Maybe ThresholdType) Source #
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
threshold_unit :: Lens' Threshold (Maybe ThresholdUnit) Source #
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
ValidationConfiguration
data ValidationConfiguration Source #
Configuration for data quality validation. Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation.
See: newValidationConfiguration smart constructor.
Constructors
| ValidationConfiguration' | |
Fields
| |
Instances
newValidationConfiguration Source #
Create a value of ValidationConfiguration 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:validationMode:ValidationConfiguration', validationConfiguration_validationMode - Mode of data quality validation. Default mode is “CHECK_ALL” which
verifies all rules defined in the selected ruleset.
$sel:rulesetArn:ValidationConfiguration', validationConfiguration_rulesetArn - The Amazon Resource Name (ARN) for the ruleset to be validated in the
profile job. The TargetArn of the selected ruleset should be the same as
the Amazon Resource Name (ARN) of the dataset that is associated with
the profile job.
validationConfiguration_validationMode :: Lens' ValidationConfiguration (Maybe ValidationMode) Source #
Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.
validationConfiguration_rulesetArn :: Lens' ValidationConfiguration Text Source #
The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.
ViewFrame
Represents the data being transformed during an action.
See: newViewFrame smart constructor.
Constructors
| ViewFrame' | |
Fields
| |
Instances
Create a value of ViewFrame 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:analytics:ViewFrame', viewFrame_analytics - Controls if analytics computation is enabled or disabled. Enabled by
default.
$sel:columnRange:ViewFrame', viewFrame_columnRange - The number of columns to include in the view frame, beginning with the
StartColumnIndex value and ignoring any columns in the HiddenColumns
list.
$sel:hiddenColumns:ViewFrame', viewFrame_hiddenColumns - A list of columns to hide in the view frame.
$sel:rowRange:ViewFrame', viewFrame_rowRange - The number of rows to include in the view frame, beginning with the
StartRowIndex value.
$sel:startRowIndex:ViewFrame', viewFrame_startRowIndex - The starting index for the range of rows to return in the view frame.
$sel:startColumnIndex:ViewFrame', viewFrame_startColumnIndex - The starting index for the range of columns to return in the view frame.
viewFrame_analytics :: Lens' ViewFrame (Maybe AnalyticsMode) Source #
Controls if analytics computation is enabled or disabled. Enabled by default.
viewFrame_columnRange :: Lens' ViewFrame (Maybe Natural) Source #
The number of columns to include in the view frame, beginning with the
StartColumnIndex value and ignoring any columns in the HiddenColumns
list.
viewFrame_rowRange :: Lens' ViewFrame (Maybe Int) Source #
The number of rows to include in the view frame, beginning with the
StartRowIndex value.