| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- BatchDeleteRecipeVersion
- CreateDataset
- CreateProfileJob
- CreateProject
- CreateRecipe
- CreateRecipeJob
- CreateRuleset
- CreateSchedule
- DeleteDataset
- DeleteJob
- DeleteProject
- DeleteRecipeVersion
- DeleteRuleset
- DeleteSchedule
- DescribeDataset
- DescribeJob
- DescribeJobRun
- DescribeProject
- DescribeRecipe
- DescribeRuleset
- DescribeSchedule
- ListDatasets (Paginated)
- ListJobRuns (Paginated)
- ListJobs (Paginated)
- ListProjects (Paginated)
- ListRecipeVersions (Paginated)
- ListRecipes (Paginated)
- ListRulesets (Paginated)
- ListSchedules (Paginated)
- ListTagsForResource
- PublishRecipe
- SendProjectSessionAction
- StartJobRun
- StartProjectSession
- StopJobRun
- TagResource
- UntagResource
- UpdateDataset
- UpdateProfileJob
- UpdateProject
- UpdateRecipe
- UpdateRecipeJob
- UpdateRuleset
- UpdateSchedule
- Types
- 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
Derived from API version 2017-07-25 of the AWS service descriptions, licensed under Apache 2.0.
Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.
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
- data BatchDeleteRecipeVersion = BatchDeleteRecipeVersion' Text (NonEmpty Text)
- newBatchDeleteRecipeVersion :: Text -> NonEmpty Text -> BatchDeleteRecipeVersion
- data BatchDeleteRecipeVersionResponse = BatchDeleteRecipeVersionResponse' (Maybe [RecipeVersionErrorDetail]) Int Text
- newBatchDeleteRecipeVersionResponse :: Int -> Text -> BatchDeleteRecipeVersionResponse
- data CreateDataset = CreateDataset' (Maybe InputFormat) (Maybe FormatOptions) (Maybe PathOptions) (Maybe (HashMap Text Text)) Text Input
- newCreateDataset :: Text -> Input -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' Int Text
- newCreateDatasetResponse :: Int -> Text -> CreateDatasetResponse
- data CreateProfileJob = CreateProfileJob' (Maybe ProfileConfiguration) (Maybe Text) (Maybe EncryptionMode) (Maybe JobSample) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe (NonEmpty ValidationConfiguration)) Text Text S3Location Text
- newCreateProfileJob :: Text -> Text -> S3Location -> Text -> CreateProfileJob
- data CreateProfileJobResponse = CreateProfileJobResponse' Int Text
- newCreateProfileJobResponse :: Int -> Text -> CreateProfileJobResponse
- data CreateProject = CreateProject' (Maybe Sample) (Maybe (HashMap Text Text)) Text Text Text Text
- newCreateProject :: Text -> Text -> Text -> Text -> CreateProject
- data CreateProjectResponse = CreateProjectResponse' Int Text
- newCreateProjectResponse :: Int -> Text -> CreateProjectResponse
- data CreateRecipe = CreateRecipe' (Maybe Text) (Maybe (HashMap Text Text)) Text [RecipeStep]
- newCreateRecipe :: Text -> CreateRecipe
- data CreateRecipeResponse = CreateRecipeResponse' Int Text
- newCreateRecipeResponse :: Int -> Text -> CreateRecipeResponse
- data CreateRecipeJob = CreateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe EncryptionMode) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe RecipeReference) (Maybe (HashMap Text Text)) (Maybe Natural) Text Text
- newCreateRecipeJob :: Text -> Text -> CreateRecipeJob
- data CreateRecipeJobResponse = CreateRecipeJobResponse' Int Text
- newCreateRecipeJobResponse :: Int -> Text -> CreateRecipeJobResponse
- data CreateRuleset = CreateRuleset' (Maybe Text) (Maybe (HashMap Text Text)) Text Text (NonEmpty Rule)
- newCreateRuleset :: Text -> Text -> NonEmpty Rule -> CreateRuleset
- data CreateRulesetResponse = CreateRulesetResponse' Int Text
- newCreateRulesetResponse :: Int -> Text -> CreateRulesetResponse
- data CreateSchedule = CreateSchedule' (Maybe [Text]) (Maybe (HashMap Text Text)) Text Text
- newCreateSchedule :: Text -> Text -> CreateSchedule
- data CreateScheduleResponse = CreateScheduleResponse' Int Text
- newCreateScheduleResponse :: Int -> Text -> CreateScheduleResponse
- data DeleteDataset = DeleteDataset' Text
- newDeleteDataset :: Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' Int Text
- newDeleteDatasetResponse :: Int -> Text -> DeleteDatasetResponse
- data DeleteJob = DeleteJob' Text
- newDeleteJob :: Text -> DeleteJob
- data DeleteJobResponse = DeleteJobResponse' Int Text
- newDeleteJobResponse :: Int -> Text -> DeleteJobResponse
- data DeleteProject = DeleteProject' Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' Int Text
- newDeleteProjectResponse :: Int -> Text -> DeleteProjectResponse
- data DeleteRecipeVersion = DeleteRecipeVersion' Text Text
- newDeleteRecipeVersion :: Text -> Text -> DeleteRecipeVersion
- data DeleteRecipeVersionResponse = DeleteRecipeVersionResponse' Int Text Text
- newDeleteRecipeVersionResponse :: Int -> Text -> Text -> DeleteRecipeVersionResponse
- data DeleteRuleset = DeleteRuleset' Text
- newDeleteRuleset :: Text -> DeleteRuleset
- data DeleteRulesetResponse = DeleteRulesetResponse' Int Text
- newDeleteRulesetResponse :: Int -> Text -> DeleteRulesetResponse
- data DeleteSchedule = DeleteSchedule' Text
- newDeleteSchedule :: Text -> DeleteSchedule
- data DeleteScheduleResponse = DeleteScheduleResponse' Int Text
- newDeleteScheduleResponse :: Int -> Text -> DeleteScheduleResponse
- data DescribeDataset = DescribeDataset' Text
- newDescribeDataset :: Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe POSIX) (Maybe Text) (Maybe InputFormat) (Maybe FormatOptions) (Maybe Text) (Maybe POSIX) (Maybe PathOptions) (Maybe Text) (Maybe Source) (Maybe (HashMap Text Text)) Int Text Input
- newDescribeDatasetResponse :: Int -> Text -> Input -> DescribeDatasetResponse
- data DescribeJob = DescribeJob' Text
- newDescribeJob :: Text -> DescribeJob
- data DescribeJobResponse = DescribeJobResponse' (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe EncryptionMode) (Maybe JobSample) (Maybe Text) (Maybe POSIX) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe ProfileConfiguration) (Maybe Text) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe JobType) (Maybe (NonEmpty ValidationConfiguration)) Int Text
- newDescribeJobResponse :: Int -> Text -> DescribeJobResponse
- data DescribeJobRun = DescribeJobRun' Text Text
- newDescribeJobRun :: Text -> Text -> DescribeJobRun
- data DescribeJobRunResponse = DescribeJobRunResponse' (Maybe Int) (Maybe POSIX) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe JobSample) (Maybe Text) (Maybe LogSubscription) (Maybe (NonEmpty Output)) (Maybe ProfileConfiguration) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty ValidationConfiguration)) Int Text
- newDescribeJobRunResponse :: Int -> Text -> DescribeJobRunResponse
- data DescribeProject = DescribeProject' Text
- newDescribeProject :: Text -> DescribeProject
- data DescribeProjectResponse = DescribeProjectResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe SessionStatus) (Maybe (HashMap Text Text)) Int Text
- newDescribeProjectResponse :: Int -> Text -> DescribeProjectResponse
- data DescribeRecipe = DescribeRecipe' (Maybe Text) Text
- newDescribeRecipe :: Text -> DescribeRecipe
- data DescribeRecipeResponse = DescribeRecipeResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe (HashMap Text Text)) Int Text
- newDescribeRecipeResponse :: Int -> Text -> DescribeRecipeResponse
- data DescribeRuleset = DescribeRuleset' Text
- newDescribeRuleset :: Text -> DescribeRuleset
- data DescribeRulesetResponse = DescribeRulesetResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty Rule)) (Maybe (HashMap Text Text)) (Maybe Text) Int Text
- newDescribeRulesetResponse :: Int -> Text -> DescribeRulesetResponse
- data DescribeSchedule = DescribeSchedule' Text
- newDescribeSchedule :: Text -> DescribeSchedule
- data DescribeScheduleResponse = DescribeScheduleResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Int Text
- newDescribeScheduleResponse :: Int -> Text -> DescribeScheduleResponse
- data ListDatasets = ListDatasets' (Maybe Natural) (Maybe Text)
- newListDatasets :: ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe Text) Int [Dataset]
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data ListJobRuns = ListJobRuns' (Maybe Natural) (Maybe Text) Text
- newListJobRuns :: Text -> ListJobRuns
- data ListJobRunsResponse = ListJobRunsResponse' (Maybe Text) Int [JobRun]
- newListJobRunsResponse :: Int -> ListJobRunsResponse
- data ListJobs = ListJobs' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text)
- newListJobs :: ListJobs
- data ListJobsResponse = ListJobsResponse' (Maybe Text) Int [Job]
- newListJobsResponse :: Int -> ListJobsResponse
- data ListProjects = ListProjects' (Maybe Natural) (Maybe Text)
- newListProjects :: ListProjects
- data ListProjectsResponse = ListProjectsResponse' (Maybe Text) Int [Project]
- newListProjectsResponse :: Int -> ListProjectsResponse
- data ListRecipeVersions = ListRecipeVersions' (Maybe Natural) (Maybe Text) Text
- newListRecipeVersions :: Text -> ListRecipeVersions
- data ListRecipeVersionsResponse = ListRecipeVersionsResponse' (Maybe Text) Int [Recipe]
- newListRecipeVersionsResponse :: Int -> ListRecipeVersionsResponse
- data ListRecipes = ListRecipes' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListRecipes :: ListRecipes
- data ListRecipesResponse = ListRecipesResponse' (Maybe Text) Int [Recipe]
- newListRecipesResponse :: Int -> ListRecipesResponse
- data ListRulesets = ListRulesets' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListRulesets :: ListRulesets
- data ListRulesetsResponse = ListRulesetsResponse' (Maybe Text) Int [RulesetItem]
- newListRulesetsResponse :: Int -> ListRulesetsResponse
- data ListSchedules = ListSchedules' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListSchedules :: ListSchedules
- data ListSchedulesResponse = ListSchedulesResponse' (Maybe Text) Int [Schedule]
- newListSchedulesResponse :: Int -> ListSchedulesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PublishRecipe = PublishRecipe' (Maybe Text) Text
- newPublishRecipe :: Text -> PublishRecipe
- data PublishRecipeResponse = PublishRecipeResponse' Int Text
- newPublishRecipeResponse :: Int -> Text -> PublishRecipeResponse
- data SendProjectSessionAction = SendProjectSessionAction' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe RecipeStep) (Maybe Natural) (Maybe ViewFrame) Text
- newSendProjectSessionAction :: Text -> SendProjectSessionAction
- data SendProjectSessionActionResponse = SendProjectSessionActionResponse' (Maybe Int) (Maybe Text) Int Text
- newSendProjectSessionActionResponse :: Int -> Text -> SendProjectSessionActionResponse
- data StartJobRun = StartJobRun' Text
- newStartJobRun :: Text -> StartJobRun
- data StartJobRunResponse = StartJobRunResponse' Int Text
- newStartJobRunResponse :: Int -> Text -> StartJobRunResponse
- data StartProjectSession = StartProjectSession' (Maybe Bool) Text
- newStartProjectSession :: Text -> StartProjectSession
- data StartProjectSessionResponse = StartProjectSessionResponse' (Maybe (Sensitive Text)) Int Text
- newStartProjectSessionResponse :: Int -> Text -> StartProjectSessionResponse
- data StopJobRun = StopJobRun' Text Text
- newStopJobRun :: Text -> Text -> StopJobRun
- data StopJobRunResponse = StopJobRunResponse' Int Text
- newStopJobRunResponse :: Int -> Text -> StopJobRunResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDataset = UpdateDataset' (Maybe InputFormat) (Maybe FormatOptions) (Maybe PathOptions) Text Input
- newUpdateDataset :: Text -> Input -> UpdateDataset
- data UpdateDatasetResponse = UpdateDatasetResponse' Int Text
- newUpdateDatasetResponse :: Int -> Text -> UpdateDatasetResponse
- data UpdateProfileJob = UpdateProfileJob' (Maybe ProfileConfiguration) (Maybe Text) (Maybe EncryptionMode) (Maybe JobSample) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe Natural) (Maybe (NonEmpty ValidationConfiguration)) Text S3Location Text
- newUpdateProfileJob :: Text -> S3Location -> Text -> UpdateProfileJob
- data UpdateProfileJobResponse = UpdateProfileJobResponse' Int Text
- newUpdateProfileJobResponse :: Int -> Text -> UpdateProfileJobResponse
- data UpdateProject = UpdateProject' (Maybe Sample) Text Text
- newUpdateProject :: Text -> Text -> UpdateProject
- data UpdateProjectResponse = UpdateProjectResponse' (Maybe POSIX) Int Text
- newUpdateProjectResponse :: Int -> Text -> UpdateProjectResponse
- data UpdateRecipe = UpdateRecipe' (Maybe Text) (Maybe [RecipeStep]) Text
- newUpdateRecipe :: Text -> UpdateRecipe
- data UpdateRecipeResponse = UpdateRecipeResponse' Int Text
- newUpdateRecipeResponse :: Int -> Text -> UpdateRecipeResponse
- data UpdateRecipeJob = UpdateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe EncryptionMode) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe Natural) Text Text
- newUpdateRecipeJob :: Text -> Text -> UpdateRecipeJob
- data UpdateRecipeJobResponse = UpdateRecipeJobResponse' Int Text
- newUpdateRecipeJobResponse :: Int -> Text -> UpdateRecipeJobResponse
- data UpdateRuleset = UpdateRuleset' (Maybe Text) Text (NonEmpty Rule)
- newUpdateRuleset :: Text -> NonEmpty Rule -> UpdateRuleset
- data UpdateRulesetResponse = UpdateRulesetResponse' Int Text
- newUpdateRulesetResponse :: Int -> Text -> UpdateRulesetResponse
- data UpdateSchedule = UpdateSchedule' (Maybe [Text]) Text Text
- newUpdateSchedule :: Text -> Text -> UpdateSchedule
- data UpdateScheduleResponse = UpdateScheduleResponse' Int Text
- newUpdateScheduleResponse :: Int -> Text -> UpdateScheduleResponse
- 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' (NonEmpty Text)
- newAllowedStatistics :: NonEmpty Text -> AllowedStatistics
- data ColumnSelector = ColumnSelector' (Maybe Text) (Maybe Text)
- newColumnSelector :: ColumnSelector
- data ColumnStatisticsConfiguration = ColumnStatisticsConfiguration' (Maybe (NonEmpty ColumnSelector)) StatisticsConfiguration
- newColumnStatisticsConfiguration :: StatisticsConfiguration -> ColumnStatisticsConfiguration
- data ConditionExpression = ConditionExpression' (Maybe Text) Text Text
- newConditionExpression :: Text -> Text -> ConditionExpression
- data CsvOptions = CsvOptions' (Maybe Text) (Maybe Bool)
- newCsvOptions :: CsvOptions
- data CsvOutputOptions = CsvOutputOptions' (Maybe Text)
- newCsvOutputOptions :: CsvOutputOptions
- data DataCatalogInputDefinition = DataCatalogInputDefinition' (Maybe Text) (Maybe S3Location) Text Text
- newDataCatalogInputDefinition :: Text -> Text -> DataCatalogInputDefinition
- data DataCatalogOutput = DataCatalogOutput' (Maybe Text) (Maybe DatabaseTableOutputOptions) (Maybe Bool) (Maybe S3TableOutputOptions) Text Text
- newDataCatalogOutput :: Text -> Text -> DataCatalogOutput
- data DatabaseInputDefinition = DatabaseInputDefinition' (Maybe Text) (Maybe Text) (Maybe S3Location) Text
- newDatabaseInputDefinition :: Text -> DatabaseInputDefinition
- data DatabaseOutput = DatabaseOutput' (Maybe DatabaseOutputMode) Text DatabaseTableOutputOptions
- newDatabaseOutput :: Text -> DatabaseTableOutputOptions -> DatabaseOutput
- data DatabaseTableOutputOptions = DatabaseTableOutputOptions' (Maybe S3Location) Text
- newDatabaseTableOutputOptions :: Text -> DatabaseTableOutputOptions
- data Dataset = Dataset' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe InputFormat) (Maybe FormatOptions) (Maybe Text) (Maybe POSIX) (Maybe PathOptions) (Maybe Text) (Maybe Source) (Maybe (HashMap Text Text)) Text Input
- newDataset :: Text -> Input -> Dataset
- data DatasetParameter = DatasetParameter' (Maybe Bool) (Maybe DatetimeOptions) (Maybe FilterExpression) Text ParameterType
- newDatasetParameter :: Text -> ParameterType -> DatasetParameter
- data DatetimeOptions = DatetimeOptions' (Maybe Text) (Maybe Text) Text
- newDatetimeOptions :: Text -> DatetimeOptions
- data EntityDetectorConfiguration = EntityDetectorConfiguration' (Maybe (NonEmpty AllowedStatistics)) (NonEmpty Text)
- newEntityDetectorConfiguration :: NonEmpty Text -> EntityDetectorConfiguration
- data ExcelOptions = ExcelOptions' (Maybe Bool) (Maybe (NonEmpty Natural)) (Maybe (NonEmpty Text))
- newExcelOptions :: ExcelOptions
- data FilesLimit = FilesLimit' (Maybe Order) (Maybe OrderedBy) Natural
- newFilesLimit :: Natural -> FilesLimit
- data FilterExpression = FilterExpression' Text (HashMap Text Text)
- newFilterExpression :: Text -> FilterExpression
- data FormatOptions = FormatOptions' (Maybe CsvOptions) (Maybe ExcelOptions) (Maybe JsonOptions)
- newFormatOptions :: FormatOptions
- data Input = Input' (Maybe DataCatalogInputDefinition) (Maybe DatabaseInputDefinition) (Maybe Metadata) (Maybe S3Location)
- newInput :: Input
- data Job = Job' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe EncryptionMode) (Maybe JobSample) (Maybe Text) (Maybe POSIX) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe JobType) (Maybe (NonEmpty ValidationConfiguration)) Text
- newJob :: Text -> Job
- data JobRun = JobRun' (Maybe Int) (Maybe POSIX) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobSample) (Maybe Text) (Maybe LogSubscription) (Maybe (NonEmpty Output)) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty ValidationConfiguration))
- newJobRun :: JobRun
- data JobSample = JobSample' (Maybe SampleMode) (Maybe Integer)
- newJobSample :: JobSample
- data JsonOptions = JsonOptions' (Maybe Bool)
- newJsonOptions :: JsonOptions
- data Metadata = Metadata' (Maybe Text)
- newMetadata :: Metadata
- data Output = Output' (Maybe CompressionFormat) (Maybe OutputFormat) (Maybe OutputFormatOptions) (Maybe Natural) (Maybe Bool) (Maybe [Text]) S3Location
- newOutput :: S3Location -> Output
- data OutputFormatOptions = OutputFormatOptions' (Maybe CsvOutputOptions)
- newOutputFormatOptions :: OutputFormatOptions
- data PathOptions = PathOptions' (Maybe FilesLimit) (Maybe FilterExpression) (Maybe (HashMap Text DatasetParameter))
- newPathOptions :: PathOptions
- data ProfileConfiguration = ProfileConfiguration' (Maybe (NonEmpty ColumnStatisticsConfiguration)) (Maybe StatisticsConfiguration) (Maybe EntityDetectorConfiguration) (Maybe (NonEmpty ColumnSelector))
- newProfileConfiguration :: ProfileConfiguration
- data Project = Project' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe (HashMap Text Text)) Text Text
- newProject :: Text -> Text -> Project
- data Recipe = Recipe' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe (HashMap Text Text)) Text
- newRecipe :: Text -> Recipe
- data RecipeAction = RecipeAction' (Maybe (HashMap Text Text)) Text
- newRecipeAction :: Text -> RecipeAction
- data RecipeReference = RecipeReference' (Maybe Text) Text
- newRecipeReference :: Text -> RecipeReference
- data RecipeStep = RecipeStep' (Maybe [ConditionExpression]) RecipeAction
- newRecipeStep :: RecipeAction -> RecipeStep
- data RecipeVersionErrorDetail = RecipeVersionErrorDetail' (Maybe Text) (Maybe Text) (Maybe Text)
- newRecipeVersionErrorDetail :: RecipeVersionErrorDetail
- data Rule = Rule' (Maybe (NonEmpty ColumnSelector)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Threshold) Text Text
- newRule :: Text -> Text -> Rule
- data RulesetItem = RulesetItem' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text Text)) Text Text
- newRulesetItem :: Text -> Text -> RulesetItem
- data S3Location = S3Location' (Maybe Text) (Maybe Text) Text
- newS3Location :: Text -> S3Location
- data S3TableOutputOptions = S3TableOutputOptions' S3Location
- newS3TableOutputOptions :: S3Location -> S3TableOutputOptions
- data Sample = Sample' (Maybe Natural) SampleType
- newSample :: SampleType -> Sample
- data Schedule = Schedule' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newSchedule :: Text -> Schedule
- data StatisticOverride = StatisticOverride' Text (HashMap Text Text)
- newStatisticOverride :: Text -> StatisticOverride
- data StatisticsConfiguration = StatisticsConfiguration' (Maybe (NonEmpty Text)) (Maybe (NonEmpty StatisticOverride))
- newStatisticsConfiguration :: StatisticsConfiguration
- data Threshold = Threshold' (Maybe ThresholdType) (Maybe ThresholdUnit) Double
- newThreshold :: Double -> Threshold
- data ValidationConfiguration = ValidationConfiguration' (Maybe ValidationMode) Text
- newValidationConfiguration :: Text -> ValidationConfiguration
- data ViewFrame = ViewFrame' (Maybe AnalyticsMode) (Maybe Natural) (Maybe [Text]) (Maybe Int) (Maybe Natural) Natural
- newViewFrame :: Natural -> ViewFrame
Service Configuration
defaultService :: Service Source #
API version 2017-07-25 of the Amazon Glue DataBrew SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DataBrew.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Access to the specified resource was denied.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting a resource can cause an inconsistent state.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal service failure occurred.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
One or more resources can't be found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
A service quota is exceeded.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input parameters for this request failed validation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchDeleteRecipeVersion
data BatchDeleteRecipeVersion Source #
See: newBatchDeleteRecipeVersion smart constructor.
Constructors
| BatchDeleteRecipeVersion' Text (NonEmpty Text) |
Instances
newBatchDeleteRecipeVersion Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchDeleteRecipeVersion |
Create a value of BatchDeleteRecipeVersion 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:
BatchDeleteRecipeVersion, batchDeleteRecipeVersion_name - The name of the recipe whose versions are to be deleted.
$sel:recipeVersions:BatchDeleteRecipeVersion', batchDeleteRecipeVersion_recipeVersions - An array of version identifiers, for the recipe versions to be deleted.
You can specify numeric versions (X.Y) or LATEST_WORKING.
LATEST_PUBLISHED is not supported.
data BatchDeleteRecipeVersionResponse Source #
See: newBatchDeleteRecipeVersionResponse smart constructor.
Constructors
| BatchDeleteRecipeVersionResponse' (Maybe [RecipeVersionErrorDetail]) Int Text |
Instances
newBatchDeleteRecipeVersionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> BatchDeleteRecipeVersionResponse |
Create a value of BatchDeleteRecipeVersionResponse 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:errors:BatchDeleteRecipeVersionResponse', batchDeleteRecipeVersionResponse_errors - Errors, if any, that occurred while attempting to delete the recipe
versions.
$sel:httpStatus:BatchDeleteRecipeVersionResponse', batchDeleteRecipeVersionResponse_httpStatus - The response's http status code.
BatchDeleteRecipeVersion, batchDeleteRecipeVersionResponse_name - The name of the recipe that was modified.
CreateDataset
data CreateDataset Source #
See: newCreateDataset smart constructor.
Constructors
| CreateDataset' (Maybe InputFormat) (Maybe FormatOptions) (Maybe PathOptions) (Maybe (HashMap Text Text)) Text Input |
Instances
Arguments
| :: Text | |
| -> Input | |
| -> CreateDataset |
Create a value of CreateDataset 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:
CreateDataset, createDataset_format - The file format of a dataset that is created from an Amazon S3 file or
folder.
CreateDataset, createDataset_formatOptions - Undocumented member.
CreateDataset, createDataset_pathOptions - A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
CreateDataset, createDataset_tags - Metadata tags to apply to this dataset.
CreateDataset, createDataset_name - The name of the dataset to be created. Valid characters are alphanumeric
(A-Z, a-z, 0-9), hyphen (-), period (.), and space.
CreateDataset, createDataset_input - Undocumented member.
data CreateDatasetResponse Source #
See: newCreateDatasetResponse smart constructor.
Constructors
| CreateDatasetResponse' Int Text |
Instances
newCreateDatasetResponse Source #
Create a value of CreateDatasetResponse 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:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.
CreateDataset, createDatasetResponse_name - The name of the dataset that you created.
CreateProfileJob
data CreateProfileJob Source #
See: newCreateProfileJob smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> S3Location | |
| -> Text | |
| -> CreateProfileJob |
Create a value of CreateProfileJob 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:configuration:CreateProfileJob', createProfileJob_configuration - Configuration for profile jobs. Used to select columns, do evaluations,
and override default parameters of evaluations. When configuration is
null, the profile job will run with default settings.
CreateProfileJob, createProfileJob_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
CreateProfileJob, createProfileJob_encryptionMode - The encryption mode for the job, which can be one of the following:
SSE-KMS-SSE-KMS- Server-side encryption with KMS-managed keys.SSE-S3- Server-side encryption with keys managed by Amazon S3.
CreateProfileJob, createProfileJob_jobSample - Sample configuration for profile jobs only. Determines the number of
rows on which the profile job will be executed. If a JobSample value is
not provided, the default value will be used. The default value is
CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
CreateProfileJob, createProfileJob_logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is
enabled, CloudWatch writes one log stream for each job run.
CreateProfileJob, createProfileJob_maxCapacity - The maximum number of nodes that DataBrew can use when the job processes
data.
CreateProfileJob, createProfileJob_maxRetries - The maximum number of times to retry the job after a job run fails.
CreateProfileJob, createProfileJob_tags - Metadata tags to apply to this job.
CreateProfileJob, createProfileJob_timeout - The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
CreateProfileJob, createProfileJob_validationConfigurations - List of validation configurations that are applied to the profile job.
CreateProfileJob, createProfileJob_datasetName - The name of the dataset that this job is to act upon.
CreateProfileJob, createProfileJob_name - The name of the job to be created. Valid characters are alphanumeric
(A-Z, a-z, 0-9), hyphen (-), period (.), and space.
$sel:outputLocation:CreateProfileJob', createProfileJob_outputLocation - Undocumented member.
CreateProfileJob, createProfileJob_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role to be assumed when DataBrew runs the job.
data CreateProfileJobResponse Source #
See: newCreateProfileJobResponse smart constructor.
Constructors
| CreateProfileJobResponse' Int Text |
Instances
newCreateProfileJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateProfileJobResponse |
Create a value of CreateProfileJobResponse 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:httpStatus:CreateProfileJobResponse', createProfileJobResponse_httpStatus - The response's http status code.
CreateProfileJob, createProfileJobResponse_name - The name of the job that was created.
CreateProject
data CreateProject Source #
See: newCreateProject smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateProject |
Create a value of CreateProject 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:
CreateProject, createProject_sample - Undocumented member.
CreateProject, createProject_tags - Metadata tags to apply to this project.
CreateProject, createProject_datasetName - The name of an existing dataset to associate this project with.
CreateProject, createProject_name - A unique name for the new project. Valid characters are alphanumeric
(A-Z, a-z, 0-9), hyphen (-), period (.), and space.
CreateProject, createProject_recipeName - The name of an existing recipe to associate with the project.
CreateProject, createProject_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role to be assumed for this request.
data CreateProjectResponse Source #
See: newCreateProjectResponse smart constructor.
Constructors
| CreateProjectResponse' Int Text |
Instances
newCreateProjectResponse Source #
Create a value of CreateProjectResponse 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:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.
CreateProject, createProjectResponse_name - The name of the project that you created.
CreateRecipe
data CreateRecipe Source #
See: newCreateRecipe smart constructor.
Constructors
| CreateRecipe' (Maybe Text) (Maybe (HashMap Text Text)) Text [RecipeStep] |
Instances
Arguments
| :: Text | |
| -> CreateRecipe |
Create a value of CreateRecipe 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:
CreateRecipe, createRecipe_description - A description for the recipe.
CreateRecipe, createRecipe_tags - Metadata tags to apply to this recipe.
CreateRecipe, createRecipe_name - A unique name for the recipe. Valid characters are alphanumeric (A-Z,
a-z, 0-9), hyphen (-), period (.), and space.
CreateRecipe, createRecipe_steps - An array containing the steps to be performed by the recipe. Each recipe
step consists of one recipe action and (optionally) an array of
condition expressions.
data CreateRecipeResponse Source #
See: newCreateRecipeResponse smart constructor.
Constructors
| CreateRecipeResponse' Int Text |
Instances
newCreateRecipeResponse Source #
Create a value of CreateRecipeResponse 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:httpStatus:CreateRecipeResponse', createRecipeResponse_httpStatus - The response's http status code.
CreateRecipe, createRecipeResponse_name - The name of the recipe that you created.
CreateRecipeJob
data CreateRecipeJob Source #
See: newCreateRecipeJob smart constructor.
Constructors
| CreateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe EncryptionMode) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe RecipeReference) (Maybe (HashMap Text Text)) (Maybe Natural) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateRecipeJob |
Create a value of CreateRecipeJob 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:
CreateRecipeJob, createRecipeJob_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running the job.
CreateRecipeJob, createRecipeJob_databaseOutputs - Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write to.
CreateRecipeJob, createRecipeJob_datasetName - The name of the dataset that this job processes.
CreateRecipeJob, createRecipeJob_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
CreateRecipeJob, createRecipeJob_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.
CreateRecipeJob, createRecipeJob_logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is
enabled, CloudWatch writes one log stream for each job run.
CreateRecipeJob, createRecipeJob_maxCapacity - The maximum number of nodes that DataBrew can consume when the job
processes data.
CreateRecipeJob, createRecipeJob_maxRetries - The maximum number of times to retry the job after a job run fails.
CreateRecipeJob, createRecipeJob_outputs - One or more artifacts that represent the output from running the job.
CreateRecipeJob, createRecipeJob_projectName - Either the name of an existing project, or a combination of a recipe and
a dataset to associate with the recipe.
CreateRecipeJob, createRecipeJob_recipeReference - Undocumented member.
CreateRecipeJob, createRecipeJob_tags - Metadata tags to apply to this job.
CreateRecipeJob, createRecipeJob_timeout - The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
CreateRecipeJob, createRecipeJob_name - A unique name for the job. Valid characters are alphanumeric (A-Z, a-z,
0-9), hyphen (-), period (.), and space.
CreateRecipeJob, createRecipeJob_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role to be assumed when DataBrew runs the job.
data CreateRecipeJobResponse Source #
See: newCreateRecipeJobResponse smart constructor.
Constructors
| CreateRecipeJobResponse' Int Text |
Instances
newCreateRecipeJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateRecipeJobResponse |
Create a value of CreateRecipeJobResponse 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:httpStatus:CreateRecipeJobResponse', createRecipeJobResponse_httpStatus - The response's http status code.
CreateRecipeJob, createRecipeJobResponse_name - The name of the job that you created.
CreateRuleset
data CreateRuleset Source #
See: newCreateRuleset smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty Rule | |
| -> CreateRuleset |
Create a value of CreateRuleset 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:
CreateRuleset, createRuleset_description - The description of the ruleset.
CreateRuleset, createRuleset_tags - Metadata tags to apply to the ruleset.
CreateRuleset, createRuleset_name - The name of the ruleset to be created. Valid characters are alphanumeric
(A-Z, a-z, 0-9), hyphen (-), period (.), and space.
CreateRuleset, createRuleset_targetArn - The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset
is associated with.
$sel:rules:CreateRuleset', createRuleset_rules - A list of rules that are defined with the ruleset. A rule includes one
or more checks to be validated on a DataBrew dataset.
data CreateRulesetResponse Source #
See: newCreateRulesetResponse smart constructor.
Constructors
| CreateRulesetResponse' Int Text |
Instances
newCreateRulesetResponse Source #
Create a value of CreateRulesetResponse 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:httpStatus:CreateRulesetResponse', createRulesetResponse_httpStatus - The response's http status code.
CreateRuleset, createRulesetResponse_name - The unique name of the created ruleset.
CreateSchedule
data CreateSchedule Source #
See: newCreateSchedule smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSchedule |
Create a value of CreateSchedule 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:
CreateSchedule, createSchedule_jobNames - The name or names of one or more jobs to be run.
CreateSchedule, createSchedule_tags - Metadata tags to apply to this schedule.
CreateSchedule, createSchedule_cronExpression - The date or dates and time or times when the jobs are to be run. For
more information, see
Cron expressions
in the Glue DataBrew Developer Guide.
CreateSchedule, createSchedule_name - A unique name for the schedule. Valid characters are alphanumeric (A-Z,
a-z, 0-9), hyphen (-), period (.), and space.
data CreateScheduleResponse Source #
See: newCreateScheduleResponse smart constructor.
Constructors
| CreateScheduleResponse' Int Text |
Instances
newCreateScheduleResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateScheduleResponse |
Create a value of CreateScheduleResponse 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:httpStatus:CreateScheduleResponse', createScheduleResponse_httpStatus - The response's http status code.
CreateSchedule, createScheduleResponse_name - The name of the schedule that was created.
DeleteDataset
data DeleteDataset Source #
See: newDeleteDataset smart constructor.
Constructors
| DeleteDataset' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDataset |
Create a value of DeleteDataset 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:
DeleteDataset, deleteDataset_name - The name of the dataset to be deleted.
data DeleteDatasetResponse Source #
See: newDeleteDatasetResponse smart constructor.
Constructors
| DeleteDatasetResponse' Int Text |
Instances
newDeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse 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:httpStatus:DeleteDatasetResponse', deleteDatasetResponse_httpStatus - The response's http status code.
DeleteDataset, deleteDatasetResponse_name - The name of the dataset that you deleted.
DeleteJob
See: newDeleteJob smart constructor.
Constructors
| DeleteJob' Text |
Instances
Create a value of DeleteJob 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:
DeleteJob, deleteJob_name - The name of the job to be deleted.
data DeleteJobResponse Source #
See: newDeleteJobResponse smart constructor.
Constructors
| DeleteJobResponse' Int Text |
Instances
Arguments
| :: Int | |
| -> Text | |
| -> DeleteJobResponse |
Create a value of DeleteJobResponse 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:httpStatus:DeleteJobResponse', deleteJobResponse_httpStatus - The response's http status code.
DeleteJob, deleteJobResponse_name - The name of the job that you deleted.
DeleteProject
data DeleteProject Source #
See: newDeleteProject smart constructor.
Constructors
| DeleteProject' Text |
Instances
Arguments
| :: Text | |
| -> DeleteProject |
Create a value of DeleteProject 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:
DeleteProject, deleteProject_name - The name of the project to be deleted.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse smart constructor.
Constructors
| DeleteProjectResponse' Int Text |
Instances
newDeleteProjectResponse Source #
Create a value of DeleteProjectResponse 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:httpStatus:DeleteProjectResponse', deleteProjectResponse_httpStatus - The response's http status code.
DeleteProject, deleteProjectResponse_name - The name of the project that you deleted.
DeleteRecipeVersion
data DeleteRecipeVersion Source #
See: newDeleteRecipeVersion smart constructor.
Constructors
| DeleteRecipeVersion' Text Text |
Instances
newDeleteRecipeVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteRecipeVersion |
Create a value of DeleteRecipeVersion 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:
DeleteRecipeVersion, deleteRecipeVersion_name - The name of the recipe.
DeleteRecipeVersion, deleteRecipeVersion_recipeVersion - The version of the recipe to be deleted. You can specify a numeric
versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not
supported.
data DeleteRecipeVersionResponse Source #
See: newDeleteRecipeVersionResponse smart constructor.
Constructors
| DeleteRecipeVersionResponse' Int Text Text |
Instances
newDeleteRecipeVersionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> DeleteRecipeVersionResponse |
Create a value of DeleteRecipeVersionResponse 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:httpStatus:DeleteRecipeVersionResponse', deleteRecipeVersionResponse_httpStatus - The response's http status code.
DeleteRecipeVersion, deleteRecipeVersionResponse_name - The name of the recipe that was deleted.
DeleteRecipeVersion, deleteRecipeVersionResponse_recipeVersion - The version of the recipe that was deleted.
DeleteRuleset
data DeleteRuleset Source #
See: newDeleteRuleset smart constructor.
Constructors
| DeleteRuleset' Text |
Instances
Arguments
| :: Text | |
| -> DeleteRuleset |
Create a value of DeleteRuleset 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:
DeleteRuleset, deleteRuleset_name - The name of the ruleset to be deleted.
data DeleteRulesetResponse Source #
See: newDeleteRulesetResponse smart constructor.
Constructors
| DeleteRulesetResponse' Int Text |
Instances
newDeleteRulesetResponse Source #
Create a value of DeleteRulesetResponse 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:httpStatus:DeleteRulesetResponse', deleteRulesetResponse_httpStatus - The response's http status code.
DeleteRuleset, deleteRulesetResponse_name - The name of the deleted ruleset.
DeleteSchedule
data DeleteSchedule Source #
See: newDeleteSchedule smart constructor.
Constructors
| DeleteSchedule' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSchedule |
Create a value of DeleteSchedule 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:
DeleteSchedule, deleteSchedule_name - The name of the schedule to be deleted.
data DeleteScheduleResponse Source #
See: newDeleteScheduleResponse smart constructor.
Constructors
| DeleteScheduleResponse' Int Text |
Instances
newDeleteScheduleResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DeleteScheduleResponse |
Create a value of DeleteScheduleResponse 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:httpStatus:DeleteScheduleResponse', deleteScheduleResponse_httpStatus - The response's http status code.
DeleteSchedule, deleteScheduleResponse_name - The name of the schedule that was deleted.
DescribeDataset
data DescribeDataset Source #
See: newDescribeDataset smart constructor.
Constructors
| DescribeDataset' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDataset |
Create a value of DescribeDataset 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:
DescribeDataset, describeDataset_name - The name of the dataset to be described.
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse smart constructor.
Constructors
| DescribeDatasetResponse' (Maybe POSIX) (Maybe Text) (Maybe InputFormat) (Maybe FormatOptions) (Maybe Text) (Maybe POSIX) (Maybe PathOptions) (Maybe Text) (Maybe Source) (Maybe (HashMap Text Text)) Int Text Input |
Instances
newDescribeDatasetResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Input | |
| -> DescribeDatasetResponse |
Create a value of DescribeDatasetResponse 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:
DescribeDatasetResponse, describeDatasetResponse_createDate - The date and time that the dataset was created.
DescribeDatasetResponse, describeDatasetResponse_createdBy - The identifier (user name) of the user who created the dataset.
DescribeDatasetResponse, describeDatasetResponse_format - The file format of a dataset that is created from an Amazon S3 file or
folder.
DescribeDatasetResponse, describeDatasetResponse_formatOptions - Undocumented member.
DescribeDatasetResponse, describeDatasetResponse_lastModifiedBy - The identifier (user name) of the user who last modified the dataset.
DescribeDatasetResponse, describeDatasetResponse_lastModifiedDate - The date and time that the dataset was last modified.
DescribeDatasetResponse, describeDatasetResponse_pathOptions - A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
DescribeDatasetResponse, describeDatasetResponse_resourceArn - The Amazon Resource Name (ARN) of the dataset.
DescribeDatasetResponse, describeDatasetResponse_source - The location of the data for this dataset, Amazon S3 or the Glue Data
Catalog.
DescribeDatasetResponse, describeDatasetResponse_tags - Metadata tags associated with this dataset.
$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.
DescribeDataset, describeDatasetResponse_name - The name of the dataset.
DescribeDatasetResponse, describeDatasetResponse_input - Undocumented member.
DescribeJob
data DescribeJob Source #
See: newDescribeJob smart constructor.
Constructors
| DescribeJob' Text |
Instances
Arguments
| :: Text | |
| -> DescribeJob |
Create a value of DescribeJob 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:
DescribeJob, describeJob_name - The name of the job to be described.
data DescribeJobResponse Source #
See: newDescribeJobResponse smart constructor.
Constructors
| DescribeJobResponse' (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe EncryptionMode) (Maybe JobSample) (Maybe Text) (Maybe POSIX) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe ProfileConfiguration) (Maybe Text) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe JobType) (Maybe (NonEmpty ValidationConfiguration)) Int Text |
Instances
newDescribeJobResponse Source #
Create a value of DescribeJobResponse 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:
DescribeJobResponse, describeJobResponse_createDate - The date and time that the job was created.
DescribeJobResponse, describeJobResponse_createdBy - The identifier (user name) of the user associated with the creation of
the job.
DescribeJobResponse, describeJobResponse_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running the job.
DescribeJobResponse, describeJobResponse_databaseOutputs - Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
DescribeJobResponse, describeJobResponse_datasetName - The dataset that the job acts upon.
DescribeJobResponse, describeJobResponse_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
DescribeJobResponse, describeJobResponse_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.
DescribeJobResponse, describeJobResponse_jobSample - Sample configuration for profile jobs only. Determines the number of
rows on which the profile job will be executed.
DescribeJobResponse, describeJobResponse_lastModifiedBy - The identifier (user name) of the user who last modified the job.
DescribeJobResponse, describeJobResponse_lastModifiedDate - The date and time that the job was last modified.
DescribeJobResponse, describeJobResponse_logSubscription - Indicates whether Amazon CloudWatch logging is enabled for this job.
DescribeJobResponse, describeJobResponse_maxCapacity - The maximum number of compute nodes that DataBrew can consume when the
job processes data.
DescribeJobResponse, describeJobResponse_maxRetries - The maximum number of times to retry the job after a job run fails.
DescribeJobResponse, describeJobResponse_outputs - One or more artifacts that represent the output from running the job.
$sel:profileConfiguration:DescribeJobResponse', describeJobResponse_profileConfiguration - Configuration for profile jobs. Used to select columns, do evaluations,
and override default parameters of evaluations. When configuration is
null, the profile job will run with default settings.
DescribeJobResponse, describeJobResponse_projectName - The DataBrew project associated with this job.
DescribeJobResponse, describeJobResponse_recipeReference - Undocumented member.
DescribeJobResponse, describeJobResponse_resourceArn - The Amazon Resource Name (ARN) of the job.
DescribeJobResponse, describeJobResponse_roleArn - The ARN of the Identity and Access Management (IAM) role to be assumed
when DataBrew runs the job.
DescribeJobResponse, describeJobResponse_tags - Metadata tags associated with this job.
DescribeJobResponse, describeJobResponse_timeout - The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
DescribeJobResponse, describeJobResponse_type - The job type, which must be one of the following:
PROFILE- The job analyzes the dataset to determine its size, data types, data distribution, and more.RECIPE- The job applies one or more transformations to a dataset.
DescribeJobResponse, describeJobResponse_validationConfigurations - List of validation configurations that are applied to the profile job.
$sel:httpStatus:DescribeJobResponse', describeJobResponse_httpStatus - The response's http status code.
DescribeJob, describeJobResponse_name - The name of the job.
DescribeJobRun
data DescribeJobRun Source #
See: newDescribeJobRun smart constructor.
Constructors
| DescribeJobRun' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeJobRun |
Create a value of DescribeJobRun 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:
DescribeJobRun, describeJobRun_name - The name of the job being processed during this run.
DescribeJobRun, describeJobRun_runId - The unique identifier of the job run.
data DescribeJobRunResponse Source #
See: newDescribeJobRunResponse smart constructor.
Constructors
| DescribeJobRunResponse' (Maybe Int) (Maybe POSIX) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe JobSample) (Maybe Text) (Maybe LogSubscription) (Maybe (NonEmpty Output)) (Maybe ProfileConfiguration) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty ValidationConfiguration)) Int Text |
Instances
newDescribeJobRunResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeJobRunResponse |
Create a value of DescribeJobRunResponse 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:
DescribeJobRunResponse, describeJobRunResponse_attempt - The number of times that DataBrew has attempted to run the job.
DescribeJobRunResponse, describeJobRunResponse_completedOn - The date and time when the job completed processing.
DescribeJobRunResponse, describeJobRunResponse_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running the job.
DescribeJobRunResponse, describeJobRunResponse_databaseOutputs - Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
DescribeJobRunResponse, describeJobRunResponse_datasetName - The name of the dataset for the job to process.
DescribeJobRunResponse, describeJobRunResponse_errorMessage - A message indicating an error (if any) that was encountered when the job
ran.
DescribeJobRunResponse, describeJobRunResponse_executionTime - The amount of time, in seconds, during which the job run consumed
resources.
DescribeJobRunResponse, describeJobRunResponse_jobSample - Sample configuration for profile jobs only. Determines the number of
rows on which the profile job will be executed. If a JobSample value is
not provided, the default value will be used. The default value is
CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
DescribeJobRunResponse, describeJobRunResponse_logGroupName - The name of an Amazon CloudWatch log group, where the job writes
diagnostic messages when it runs.
DescribeJobRunResponse, describeJobRunResponse_logSubscription - The current status of Amazon CloudWatch logging for the job run.
DescribeJobRunResponse, describeJobRunResponse_outputs - One or more output artifacts from a job run.
$sel:profileConfiguration:DescribeJobRunResponse', describeJobRunResponse_profileConfiguration - Configuration for profile jobs. Used to select columns, do evaluations,
and override default parameters of evaluations. When configuration is
null, the profile job will run with default settings.
DescribeJobRunResponse, describeJobRunResponse_recipeReference - Undocumented member.
DescribeJobRun, describeJobRunResponse_runId - The unique identifier of the job run.
DescribeJobRunResponse, describeJobRunResponse_startedBy - The Amazon Resource Name (ARN) of the user who started the job run.
DescribeJobRunResponse, describeJobRunResponse_startedOn - The date and time when the job run began.
DescribeJobRunResponse, describeJobRunResponse_state - The current state of the job run entity itself.
DescribeJobRunResponse, describeJobRunResponse_validationConfigurations - List of validation configurations that are applied to the profile job.
$sel:httpStatus:DescribeJobRunResponse', describeJobRunResponse_httpStatus - The response's http status code.
DescribeJobRunResponse, describeJobRunResponse_jobName - The name of the job being processed during this run.
DescribeProject
data DescribeProject Source #
See: newDescribeProject smart constructor.
Constructors
| DescribeProject' Text |
Instances
Arguments
| :: Text | |
| -> DescribeProject |
Create a value of DescribeProject 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:
DescribeProject, describeProject_name - The name of the project to be described.
data DescribeProjectResponse Source #
See: newDescribeProjectResponse smart constructor.
Constructors
| DescribeProjectResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe SessionStatus) (Maybe (HashMap Text Text)) Int Text |
Instances
newDescribeProjectResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeProjectResponse |
Create a value of DescribeProjectResponse 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:
DescribeProjectResponse, describeProjectResponse_createDate - The date and time that the project was created.
DescribeProjectResponse, describeProjectResponse_createdBy - The identifier (user name) of the user who created the project.
DescribeProjectResponse, describeProjectResponse_datasetName - The dataset associated with the project.
DescribeProjectResponse, describeProjectResponse_lastModifiedBy - The identifier (user name) of the user who last modified the project.
DescribeProjectResponse, describeProjectResponse_lastModifiedDate - The date and time that the project was last modified.
DescribeProjectResponse, describeProjectResponse_openDate - The date and time when the project was opened.
DescribeProjectResponse, describeProjectResponse_openedBy - The identifier (user name) of the user that opened the project for use.
DescribeProjectResponse, describeProjectResponse_recipeName - The recipe associated with this job.
DescribeProjectResponse, describeProjectResponse_resourceArn - The Amazon Resource Name (ARN) of the project.
DescribeProjectResponse, describeProjectResponse_roleArn - The ARN of the Identity and Access Management (IAM) role to be assumed
when DataBrew runs the job.
DescribeProjectResponse, describeProjectResponse_sample - Undocumented member.
$sel:sessionStatus:DescribeProjectResponse', describeProjectResponse_sessionStatus - Describes the current state of the session:
PROVISIONING- allocating resources for the session.INITIALIZING- getting the session ready for first use.ASSIGNED- the session is ready for use.
DescribeProjectResponse, describeProjectResponse_tags - Metadata tags associated with this project.
$sel:httpStatus:DescribeProjectResponse', describeProjectResponse_httpStatus - The response's http status code.
DescribeProject, describeProjectResponse_name - The name of the project.
DescribeRecipe
data DescribeRecipe Source #
See: newDescribeRecipe smart constructor.
Constructors
| DescribeRecipe' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DescribeRecipe |
Create a value of DescribeRecipe 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:
DescribeRecipe, describeRecipe_recipeVersion - The recipe version identifier. If this parameter isn't specified, then
the latest published version is returned.
DescribeRecipe, describeRecipe_name - The name of the recipe to be described.
data DescribeRecipeResponse Source #
See: newDescribeRecipeResponse smart constructor.
Constructors
| DescribeRecipeResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe (HashMap Text Text)) Int Text |
Instances
newDescribeRecipeResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeRecipeResponse |
Create a value of DescribeRecipeResponse 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:
DescribeRecipeResponse, describeRecipeResponse_createDate - The date and time that the recipe was created.
DescribeRecipeResponse, describeRecipeResponse_createdBy - The identifier (user name) of the user who created the recipe.
DescribeRecipeResponse, describeRecipeResponse_description - The description of the recipe.
DescribeRecipeResponse, describeRecipeResponse_lastModifiedBy - The identifier (user name) of the user who last modified the recipe.
DescribeRecipeResponse, describeRecipeResponse_lastModifiedDate - The date and time that the recipe was last modified.
DescribeRecipeResponse, describeRecipeResponse_projectName - The name of the project associated with this recipe.
DescribeRecipeResponse, describeRecipeResponse_publishedBy - The identifier (user name) of the user who last published the recipe.
DescribeRecipeResponse, describeRecipeResponse_publishedDate - The date and time when the recipe was last published.
DescribeRecipe, describeRecipeResponse_recipeVersion - The recipe version identifier.
DescribeRecipeResponse, describeRecipeResponse_resourceArn - The ARN of the recipe.
DescribeRecipeResponse, describeRecipeResponse_steps - One or more steps to be performed by the recipe. Each step consists of
an action, and the conditions under which the action should succeed.
DescribeRecipeResponse, describeRecipeResponse_tags - Metadata tags associated with this project.
$sel:httpStatus:DescribeRecipeResponse', describeRecipeResponse_httpStatus - The response's http status code.
DescribeRecipe, describeRecipeResponse_name - The name of the recipe.
DescribeRuleset
data DescribeRuleset Source #
See: newDescribeRuleset smart constructor.
Constructors
| DescribeRuleset' Text |
Instances
Arguments
| :: Text | |
| -> DescribeRuleset |
Create a value of DescribeRuleset 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:
DescribeRuleset, describeRuleset_name - The name of the ruleset to be described.
data DescribeRulesetResponse Source #
See: newDescribeRulesetResponse smart constructor.
Constructors
| DescribeRulesetResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty Rule)) (Maybe (HashMap Text Text)) (Maybe Text) Int Text |
Instances
newDescribeRulesetResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeRulesetResponse |
Create a value of DescribeRulesetResponse 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:
DescribeRulesetResponse, describeRulesetResponse_createDate - The date and time that the ruleset was created.
DescribeRulesetResponse, describeRulesetResponse_createdBy - The Amazon Resource Name (ARN) of the user who created the ruleset.
DescribeRulesetResponse, describeRulesetResponse_description - The description of the ruleset.
DescribeRulesetResponse, describeRulesetResponse_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the
ruleset.
DescribeRulesetResponse, describeRulesetResponse_lastModifiedDate - The modification date and time of the ruleset.
DescribeRulesetResponse, describeRulesetResponse_resourceArn - The Amazon Resource Name (ARN) for the ruleset.
$sel:rules:DescribeRulesetResponse', describeRulesetResponse_rules - A list of rules that are defined with the ruleset. A rule includes one
or more checks to be validated on a DataBrew dataset.
DescribeRulesetResponse, describeRulesetResponse_tags - Metadata tags that have been applied to the ruleset.
DescribeRulesetResponse, describeRulesetResponse_targetArn - The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset
is associated with.
$sel:httpStatus:DescribeRulesetResponse', describeRulesetResponse_httpStatus - The response's http status code.
DescribeRuleset, describeRulesetResponse_name - The name of the ruleset.
DescribeSchedule
data DescribeSchedule Source #
See: newDescribeSchedule smart constructor.
Constructors
| DescribeSchedule' Text |
Instances
Arguments
| :: Text | |
| -> DescribeSchedule |
Create a value of DescribeSchedule 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:
DescribeSchedule, describeSchedule_name - The name of the schedule to be described.
data DescribeScheduleResponse Source #
See: newDescribeScheduleResponse smart constructor.
Constructors
| DescribeScheduleResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Int Text |
Instances
newDescribeScheduleResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeScheduleResponse |
Create a value of DescribeScheduleResponse 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:
DescribeScheduleResponse, describeScheduleResponse_createDate - The date and time that the schedule was created.
DescribeScheduleResponse, describeScheduleResponse_createdBy - The identifier (user name) of the user who created the schedule.
DescribeScheduleResponse, describeScheduleResponse_cronExpression - The date or dates and time or times when the jobs are to be run for the
schedule. For more information, see
Cron expressions
in the Glue DataBrew Developer Guide.
DescribeScheduleResponse, describeScheduleResponse_jobNames - The name or names of one or more jobs to be run by using the schedule.
DescribeScheduleResponse, describeScheduleResponse_lastModifiedBy - The identifier (user name) of the user who last modified the schedule.
DescribeScheduleResponse, describeScheduleResponse_lastModifiedDate - The date and time that the schedule was last modified.
DescribeScheduleResponse, describeScheduleResponse_resourceArn - The Amazon Resource Name (ARN) of the schedule.
DescribeScheduleResponse, describeScheduleResponse_tags - Metadata tags associated with this schedule.
$sel:httpStatus:DescribeScheduleResponse', describeScheduleResponse_httpStatus - The response's http status code.
DescribeSchedule, describeScheduleResponse_name - The name of the schedule.
ListDatasets (Paginated)
data ListDatasets Source #
See: newListDatasets smart constructor.
Constructors
| ListDatasets' (Maybe Natural) (Maybe Text) |
Instances
newListDatasets :: ListDatasets Source #
Create a value of ListDatasets 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:maxResults:ListDatasets', listDatasets_maxResults - The maximum number of results to return in this request.
ListDatasets, listDatasets_nextToken - The token returned by a previous call to retrieve the next set of
results.
data ListDatasetsResponse Source #
See: newListDatasetsResponse smart constructor.
Constructors
| ListDatasetsResponse' (Maybe Text) Int [Dataset] |
Instances
newListDatasetsResponse Source #
Arguments
| :: Int | |
| -> ListDatasetsResponse |
Create a value of ListDatasetsResponse 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:
ListDatasets, listDatasetsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListDatasetsResponse', listDatasetsResponse_httpStatus - The response's http status code.
$sel:datasets:ListDatasetsResponse', listDatasetsResponse_datasets - A list of datasets that are defined.
ListJobRuns (Paginated)
data ListJobRuns Source #
See: newListJobRuns smart constructor.
Instances
Arguments
| :: Text | |
| -> ListJobRuns |
Create a value of ListJobRuns 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:maxResults:ListJobRuns', listJobRuns_maxResults - The maximum number of results to return in this request.
ListJobRuns, listJobRuns_nextToken - The token returned by a previous call to retrieve the next set of
results.
ListJobRuns, listJobRuns_name - The name of the job.
data ListJobRunsResponse Source #
See: newListJobRunsResponse smart constructor.
Constructors
| ListJobRunsResponse' (Maybe Text) Int [JobRun] |
Instances
newListJobRunsResponse Source #
Arguments
| :: Int | |
| -> ListJobRunsResponse |
Create a value of ListJobRunsResponse 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:
ListJobRuns, listJobRunsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListJobRunsResponse', listJobRunsResponse_httpStatus - The response's http status code.
$sel:jobRuns:ListJobRunsResponse', listJobRunsResponse_jobRuns - A list of job runs that have occurred for the specified job.
ListJobs (Paginated)
See: newListJobs smart constructor.
Instances
newListJobs :: ListJobs Source #
Create a value of ListJobs 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:
ListJobs, listJobs_datasetName - The name of a dataset. Using this parameter indicates to return only
those jobs that act on the specified dataset.
$sel:maxResults:ListJobs', listJobs_maxResults - The maximum number of results to return in this request.
ListJobs, listJobs_nextToken - A token generated by DataBrew that specifies where to continue
pagination if a previous request was truncated. To get the next set of
pages, pass in the NextToken value from the response object of the
previous page call.
ListJobs, listJobs_projectName - The name of a project. Using this parameter indicates to return only
those jobs that are associated with the specified project.
data ListJobsResponse Source #
See: newListJobsResponse smart constructor.
Constructors
| ListJobsResponse' (Maybe Text) Int [Job] |
Instances
Arguments
| :: Int | |
| -> ListJobsResponse |
Create a value of ListJobsResponse 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:
ListJobs, listJobsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.
$sel:jobs:ListJobsResponse', listJobsResponse_jobs - A list of jobs that are defined.
ListProjects (Paginated)
data ListProjects Source #
See: newListProjects smart constructor.
Constructors
| ListProjects' (Maybe Natural) (Maybe Text) |
Instances
newListProjects :: ListProjects Source #
Create a value of ListProjects 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:maxResults:ListProjects', listProjects_maxResults - The maximum number of results to return in this request.
ListProjects, listProjects_nextToken - The token returned by a previous call to retrieve the next set of
results.
data ListProjectsResponse Source #
See: newListProjectsResponse smart constructor.
Constructors
| ListProjectsResponse' (Maybe Text) Int [Project] |
Instances
newListProjectsResponse Source #
Arguments
| :: Int | |
| -> ListProjectsResponse |
Create a value of ListProjectsResponse 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:
ListProjects, listProjectsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.
$sel:projects:ListProjectsResponse', listProjectsResponse_projects - A list of projects that are defined .
ListRecipeVersions (Paginated)
data ListRecipeVersions Source #
See: newListRecipeVersions smart constructor.
Instances
newListRecipeVersions Source #
Arguments
| :: Text | |
| -> ListRecipeVersions |
Create a value of ListRecipeVersions 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:maxResults:ListRecipeVersions', listRecipeVersions_maxResults - The maximum number of results to return in this request.
ListRecipeVersions, listRecipeVersions_nextToken - The token returned by a previous call to retrieve the next set of
results.
ListRecipeVersions, listRecipeVersions_name - The name of the recipe for which to return version information.
data ListRecipeVersionsResponse Source #
See: newListRecipeVersionsResponse smart constructor.
Constructors
| ListRecipeVersionsResponse' (Maybe Text) Int [Recipe] |
Instances
newListRecipeVersionsResponse Source #
Create a value of ListRecipeVersionsResponse 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:
ListRecipeVersions, listRecipeVersionsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListRecipeVersionsResponse', listRecipeVersionsResponse_httpStatus - The response's http status code.
$sel:recipes:ListRecipeVersionsResponse', listRecipeVersionsResponse_recipes - A list of versions for the specified recipe.
ListRecipes (Paginated)
data ListRecipes Source #
See: newListRecipes smart constructor.
Instances
newListRecipes :: ListRecipes Source #
Create a value of ListRecipes 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:maxResults:ListRecipes', listRecipes_maxResults - The maximum number of results to return in this request.
ListRecipes, listRecipes_nextToken - The token returned by a previous call to retrieve the next set of
results.
ListRecipes, listRecipes_recipeVersion - Return only those recipes with a version identifier of LATEST_WORKING
or LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes
returns all of the LATEST_PUBLISHED recipe versions.
Valid values: LATEST_WORKING | LATEST_PUBLISHED
data ListRecipesResponse Source #
See: newListRecipesResponse smart constructor.
Constructors
| ListRecipesResponse' (Maybe Text) Int [Recipe] |
Instances
newListRecipesResponse Source #
Arguments
| :: Int | |
| -> ListRecipesResponse |
Create a value of ListRecipesResponse 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:
ListRecipes, listRecipesResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListRecipesResponse', listRecipesResponse_httpStatus - The response's http status code.
$sel:recipes:ListRecipesResponse', listRecipesResponse_recipes - A list of recipes that are defined.
ListRulesets (Paginated)
data ListRulesets Source #
See: newListRulesets smart constructor.
Instances
newListRulesets :: ListRulesets Source #
Create a value of ListRulesets 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:maxResults:ListRulesets', listRulesets_maxResults - The maximum number of results to return in this request.
ListRulesets, listRulesets_nextToken - A token generated by DataBrew that specifies where to continue
pagination if a previous request was truncated. To get the next set of
pages, pass in the NextToken value from the response object of the
previous page call.
ListRulesets, listRulesets_targetArn - The Amazon Resource Name (ARN) of a resource (dataset). Using this
parameter indicates to return only those rulesets that are associated
with the specified resource.
data ListRulesetsResponse Source #
See: newListRulesetsResponse smart constructor.
Constructors
| ListRulesetsResponse' (Maybe Text) Int [RulesetItem] |
Instances
newListRulesetsResponse Source #
Arguments
| :: Int | |
| -> ListRulesetsResponse |
Create a value of ListRulesetsResponse 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:
ListRulesets, listRulesetsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListRulesetsResponse', listRulesetsResponse_httpStatus - The response's http status code.
$sel:rulesets:ListRulesetsResponse', listRulesetsResponse_rulesets - A list of RulesetItem. RulesetItem contains meta data of a ruleset.
ListSchedules (Paginated)
data ListSchedules Source #
See: newListSchedules smart constructor.
Instances
newListSchedules :: ListSchedules Source #
Create a value of ListSchedules 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:
ListSchedules, listSchedules_jobName - The name of the job that these schedules apply to.
$sel:maxResults:ListSchedules', listSchedules_maxResults - The maximum number of results to return in this request.
ListSchedules, listSchedules_nextToken - The token returned by a previous call to retrieve the next set of
results.
data ListSchedulesResponse Source #
See: newListSchedulesResponse smart constructor.
Constructors
| ListSchedulesResponse' (Maybe Text) Int [Schedule] |
Instances
newListSchedulesResponse Source #
Create a value of ListSchedulesResponse 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:
ListSchedules, listSchedulesResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set
of results.
$sel:httpStatus:ListSchedulesResponse', listSchedulesResponse_httpStatus - The response's http status code.
$sel:schedules:ListSchedulesResponse', listSchedulesResponse_schedules - A list of schedules that are defined.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:
ListTagsForResource, listTagsForResource_resourceArn - The Amazon Resource Name (ARN) string that uniquely identifies the
DataBrew resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResourceResponse, listTagsForResourceResponse_tags - A list of tags associated with the DataBrew resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
PublishRecipe
data PublishRecipe Source #
See: newPublishRecipe smart constructor.
Constructors
| PublishRecipe' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> PublishRecipe |
Create a value of PublishRecipe 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:
PublishRecipe, publishRecipe_description - A description of the recipe to be published, for this version of the
recipe.
PublishRecipe, publishRecipe_name - The name of the recipe to be published.
data PublishRecipeResponse Source #
See: newPublishRecipeResponse smart constructor.
Constructors
| PublishRecipeResponse' Int Text |
Instances
newPublishRecipeResponse Source #
Create a value of PublishRecipeResponse 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:httpStatus:PublishRecipeResponse', publishRecipeResponse_httpStatus - The response's http status code.
PublishRecipe, publishRecipeResponse_name - The name of the recipe that you published.
SendProjectSessionAction
data SendProjectSessionAction Source #
See: newSendProjectSessionAction smart constructor.
Constructors
| SendProjectSessionAction' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe RecipeStep) (Maybe Natural) (Maybe ViewFrame) Text |
Instances
newSendProjectSessionAction Source #
Arguments
| :: Text | |
| -> SendProjectSessionAction |
Create a value of SendProjectSessionAction 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:clientSessionId:SendProjectSessionAction', sendProjectSessionAction_clientSessionId - A unique identifier for an interactive session that's currently open
and ready for work. The action will be performed on this session.
$sel:preview:SendProjectSessionAction', sendProjectSessionAction_preview - If true, the result of the recipe step will be returned, but not
applied.
$sel:recipeStep:SendProjectSessionAction', sendProjectSessionAction_recipeStep - Undocumented member.
$sel:stepIndex:SendProjectSessionAction', sendProjectSessionAction_stepIndex - The index from which to preview a step. This index is used to preview
the result of steps that have already been applied, so that the
resulting view frame is from earlier in the view frame stack.
$sel:viewFrame:SendProjectSessionAction', sendProjectSessionAction_viewFrame - Undocumented member.
SendProjectSessionAction, sendProjectSessionAction_name - The name of the project to apply the action to.
data SendProjectSessionActionResponse Source #
See: newSendProjectSessionActionResponse smart constructor.
Instances
newSendProjectSessionActionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> SendProjectSessionActionResponse |
Create a value of SendProjectSessionActionResponse 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:actionId:SendProjectSessionActionResponse', sendProjectSessionActionResponse_actionId - A unique identifier for the action that was performed.
$sel:result:SendProjectSessionActionResponse', sendProjectSessionActionResponse_result - A message indicating the result of performing the action.
$sel:httpStatus:SendProjectSessionActionResponse', sendProjectSessionActionResponse_httpStatus - The response's http status code.
SendProjectSessionAction, sendProjectSessionActionResponse_name - The name of the project that was affected by the action.
StartJobRun
data StartJobRun Source #
See: newStartJobRun smart constructor.
Constructors
| StartJobRun' Text |
Instances
Arguments
| :: Text | |
| -> StartJobRun |
Create a value of StartJobRun 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:
StartJobRun, startJobRun_name - The name of the job to be run.
data StartJobRunResponse Source #
See: newStartJobRunResponse smart constructor.
Constructors
| StartJobRunResponse' Int Text |
Instances
newStartJobRunResponse Source #
Create a value of StartJobRunResponse 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:httpStatus:StartJobRunResponse', startJobRunResponse_httpStatus - The response's http status code.
StartJobRunResponse, startJobRunResponse_runId - A system-generated identifier for this particular job run.
StartProjectSession
data StartProjectSession Source #
See: newStartProjectSession smart constructor.
Constructors
| StartProjectSession' (Maybe Bool) Text |
Instances
newStartProjectSession Source #
Arguments
| :: Text | |
| -> StartProjectSession |
Create a value of StartProjectSession 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:assumeControl:StartProjectSession', startProjectSession_assumeControl - A value that, if true, enables you to take control of a session, even if
a different client is currently accessing the project.
StartProjectSession, startProjectSession_name - The name of the project to act upon.
data StartProjectSessionResponse Source #
See: newStartProjectSessionResponse smart constructor.
Instances
newStartProjectSessionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> StartProjectSessionResponse |
Create a value of StartProjectSessionResponse 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:clientSessionId:StartProjectSessionResponse', startProjectSessionResponse_clientSessionId - A system-generated identifier for the session.
$sel:httpStatus:StartProjectSessionResponse', startProjectSessionResponse_httpStatus - The response's http status code.
StartProjectSession, startProjectSessionResponse_name - The name of the project to be acted upon.
StopJobRun
data StopJobRun Source #
See: newStopJobRun smart constructor.
Constructors
| StopJobRun' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StopJobRun |
Create a value of StopJobRun 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:
StopJobRun, stopJobRun_name - The name of the job to be stopped.
StopJobRun, stopJobRun_runId - The ID of the job run to be stopped.
data StopJobRunResponse Source #
See: newStopJobRunResponse smart constructor.
Constructors
| StopJobRunResponse' Int Text |
Instances
newStopJobRunResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> StopJobRunResponse |
Create a value of StopJobRunResponse 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:httpStatus:StopJobRunResponse', stopJobRunResponse_httpStatus - The response's http status code.
StopJobRun, stopJobRunResponse_runId - The ID of the job run that you stopped.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:
TagResource, tagResource_resourceArn - The DataBrew resource to which tags should be added. The value for this
parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a
dataset, a job, a project, or a recipe.
TagResource, tagResource_tags - One or more tags to be assigned to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource 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:
UntagResource, untagResource_resourceArn - A DataBrew resource from which you want to remove a tag or tags. The
value for this parameter is an Amazon Resource Name (ARN).
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag keys (names) of one or more tags to be removed.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateDataset
data UpdateDataset Source #
See: newUpdateDataset smart constructor.
Constructors
| UpdateDataset' (Maybe InputFormat) (Maybe FormatOptions) (Maybe PathOptions) Text Input |
Instances
Arguments
| :: Text | |
| -> Input | |
| -> UpdateDataset |
Create a value of UpdateDataset 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:
UpdateDataset, updateDataset_format - The file format of a dataset that is created from an Amazon S3 file or
folder.
UpdateDataset, updateDataset_formatOptions - Undocumented member.
UpdateDataset, updateDataset_pathOptions - A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
UpdateDataset, updateDataset_name - The name of the dataset to be updated.
UpdateDataset, updateDataset_input - Undocumented member.
data UpdateDatasetResponse Source #
See: newUpdateDatasetResponse smart constructor.
Constructors
| UpdateDatasetResponse' Int Text |
Instances
newUpdateDatasetResponse Source #
Create a value of UpdateDatasetResponse 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:httpStatus:UpdateDatasetResponse', updateDatasetResponse_httpStatus - The response's http status code.
UpdateDataset, updateDatasetResponse_name - The name of the dataset that you updated.
UpdateProfileJob
data UpdateProfileJob Source #
See: newUpdateProfileJob smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> S3Location | |
| -> Text | |
| -> UpdateProfileJob |
Create a value of UpdateProfileJob 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:configuration:UpdateProfileJob', updateProfileJob_configuration - Configuration for profile jobs. Used to select columns, do evaluations,
and override default parameters of evaluations. When configuration is
null, the profile job will run with default settings.
UpdateProfileJob, updateProfileJob_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
UpdateProfileJob, updateProfileJob_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.
UpdateProfileJob, updateProfileJob_jobSample - Sample configuration for Profile Jobs only. Determines the number of
rows on which the Profile job will be executed. If a JobSample value is
not provided for profile jobs, the default value will be used. The
default value is CUSTOM_ROWS for the mode parameter and 20000 for the
size parameter.
UpdateProfileJob, updateProfileJob_logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is
enabled, CloudWatch writes one log stream for each job run.
UpdateProfileJob, updateProfileJob_maxCapacity - The maximum number of compute nodes that DataBrew can use when the job
processes data.
UpdateProfileJob, updateProfileJob_maxRetries - The maximum number of times to retry the job after a job run fails.
UpdateProfileJob, updateProfileJob_timeout - The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
UpdateProfileJob, updateProfileJob_validationConfigurations - List of validation configurations that are applied to the profile job.
UpdateProfileJob, updateProfileJob_name - The name of the job to be updated.
$sel:outputLocation:UpdateProfileJob', updateProfileJob_outputLocation - Undocumented member.
UpdateProfileJob, updateProfileJob_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role to be assumed when DataBrew runs the job.
data UpdateProfileJobResponse Source #
See: newUpdateProfileJobResponse smart constructor.
Constructors
| UpdateProfileJobResponse' Int Text |
Instances
newUpdateProfileJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UpdateProfileJobResponse |
Create a value of UpdateProfileJobResponse 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:httpStatus:UpdateProfileJobResponse', updateProfileJobResponse_httpStatus - The response's http status code.
UpdateProfileJob, updateProfileJobResponse_name - The name of the job that was updated.
UpdateProject
data UpdateProject Source #
See: newUpdateProject smart constructor.
Constructors
| UpdateProject' (Maybe Sample) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateProject |
Create a value of UpdateProject 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:
UpdateProject, updateProject_sample - Undocumented member.
UpdateProject, updateProject_roleArn - The Amazon Resource Name (ARN) of the IAM role to be assumed for this
request.
UpdateProject, updateProject_name - The name of the project to be updated.
data UpdateProjectResponse Source #
See: newUpdateProjectResponse smart constructor.
Constructors
| UpdateProjectResponse' (Maybe POSIX) Int Text |
Instances
newUpdateProjectResponse Source #
Create a value of UpdateProjectResponse 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:
UpdateProjectResponse, updateProjectResponse_lastModifiedDate - The date and time that the project was last modified.
$sel:httpStatus:UpdateProjectResponse', updateProjectResponse_httpStatus - The response's http status code.
UpdateProject, updateProjectResponse_name - The name of the project that you updated.
UpdateRecipe
data UpdateRecipe Source #
See: newUpdateRecipe smart constructor.
Constructors
| UpdateRecipe' (Maybe Text) (Maybe [RecipeStep]) Text |
Instances
Arguments
| :: Text | |
| -> UpdateRecipe |
Create a value of UpdateRecipe 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:
UpdateRecipe, updateRecipe_description - A description of the recipe.
UpdateRecipe, updateRecipe_steps - One or more steps to be performed by the recipe. Each step consists of
an action, and the conditions under which the action should succeed.
UpdateRecipe, updateRecipe_name - The name of the recipe to be updated.
data UpdateRecipeResponse Source #
See: newUpdateRecipeResponse smart constructor.
Constructors
| UpdateRecipeResponse' Int Text |
Instances
newUpdateRecipeResponse Source #
Create a value of UpdateRecipeResponse 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:httpStatus:UpdateRecipeResponse', updateRecipeResponse_httpStatus - The response's http status code.
UpdateRecipe, updateRecipeResponse_name - The name of the recipe that was updated.
UpdateRecipeJob
data UpdateRecipeJob Source #
See: newUpdateRecipeJob smart constructor.
Constructors
| UpdateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe EncryptionMode) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe Natural) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateRecipeJob |
Create a value of UpdateRecipeJob 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:
UpdateRecipeJob, updateRecipeJob_dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from
running the job.
UpdateRecipeJob, updateRecipeJob_databaseOutputs - Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
UpdateRecipeJob, updateRecipeJob_encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
UpdateRecipeJob, updateRecipeJob_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.
UpdateRecipeJob, updateRecipeJob_logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is
enabled, CloudWatch writes one log stream for each job run.
UpdateRecipeJob, updateRecipeJob_maxCapacity - The maximum number of nodes that DataBrew can consume when the job
processes data.
UpdateRecipeJob, updateRecipeJob_maxRetries - The maximum number of times to retry the job after a job run fails.
UpdateRecipeJob, updateRecipeJob_outputs - One or more artifacts that represent the output from running the job.
UpdateRecipeJob, updateRecipeJob_timeout - The job's timeout in minutes. A job that attempts to run longer than
this timeout period ends with a status of TIMEOUT.
UpdateRecipeJob, updateRecipeJob_name - The name of the job to update.
UpdateRecipeJob, updateRecipeJob_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role to be assumed when DataBrew runs the job.
data UpdateRecipeJobResponse Source #
See: newUpdateRecipeJobResponse smart constructor.
Constructors
| UpdateRecipeJobResponse' Int Text |
Instances
newUpdateRecipeJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UpdateRecipeJobResponse |
Create a value of UpdateRecipeJobResponse 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:httpStatus:UpdateRecipeJobResponse', updateRecipeJobResponse_httpStatus - The response's http status code.
UpdateRecipeJob, updateRecipeJobResponse_name - The name of the job that you updated.
UpdateRuleset
data UpdateRuleset Source #
See: newUpdateRuleset smart constructor.
Instances
Arguments
| :: Text | |
| -> NonEmpty Rule | |
| -> UpdateRuleset |
Create a value of UpdateRuleset 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:
UpdateRuleset, updateRuleset_description - The description of the ruleset.
UpdateRuleset, updateRuleset_name - The name of the ruleset to be updated.
$sel:rules:UpdateRuleset', updateRuleset_rules - A list of rules that are defined with the ruleset. A rule includes one
or more checks to be validated on a DataBrew dataset.
data UpdateRulesetResponse Source #
See: newUpdateRulesetResponse smart constructor.
Constructors
| UpdateRulesetResponse' Int Text |
Instances
newUpdateRulesetResponse Source #
Create a value of UpdateRulesetResponse 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:httpStatus:UpdateRulesetResponse', updateRulesetResponse_httpStatus - The response's http status code.
UpdateRuleset, updateRulesetResponse_name - The name of the updated ruleset.
UpdateSchedule
data UpdateSchedule Source #
See: newUpdateSchedule smart constructor.
Constructors
| UpdateSchedule' (Maybe [Text]) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSchedule |
Create a value of UpdateSchedule 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:
UpdateSchedule, updateSchedule_jobNames - The name or names of one or more jobs to be run for this schedule.
UpdateSchedule, updateSchedule_cronExpression - The date or dates and time or times when the jobs are to be run. For
more information, see
Cron expressions
in the Glue DataBrew Developer Guide.
UpdateSchedule, updateSchedule_name - The name of the schedule to update.
data UpdateScheduleResponse Source #
See: newUpdateScheduleResponse smart constructor.
Constructors
| UpdateScheduleResponse' Int Text |
Instances
newUpdateScheduleResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UpdateScheduleResponse |
Create a value of UpdateScheduleResponse 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:httpStatus:UpdateScheduleResponse', updateScheduleResponse_httpStatus - The response's http status code.
UpdateSchedule, updateScheduleResponse_name - The name of the schedule that was updated.
Types
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' (NonEmpty Text) |
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.
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' (Maybe Text) (Maybe Text) |
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.
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' (Maybe (NonEmpty ColumnSelector)) StatisticsConfiguration |
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.
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' (Maybe Text) Text Text |
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.
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' (Maybe Text) (Maybe Bool) |
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.
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' (Maybe Text) |
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.
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' (Maybe Text) (Maybe S3Location) Text Text |
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.
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' (Maybe Text) (Maybe DatabaseTableOutputOptions) (Maybe Bool) (Maybe S3TableOutputOptions) Text Text |
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.
DatabaseInputDefinition
data DatabaseInputDefinition Source #
Connection information for dataset input files stored in a database.
See: newDatabaseInputDefinition smart constructor.
Constructors
| DatabaseInputDefinition' (Maybe Text) (Maybe Text) (Maybe S3Location) Text |
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.
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' (Maybe DatabaseOutputMode) Text DatabaseTableOutputOptions |
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.
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' (Maybe S3Location) Text |
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.
Dataset
Represents a dataset that can be processed by DataBrew.
See: newDataset smart constructor.
Constructors
| Dataset' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe InputFormat) (Maybe FormatOptions) (Maybe Text) (Maybe POSIX) (Maybe PathOptions) (Maybe Text) (Maybe Source) (Maybe (HashMap Text Text)) Text Input |
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.
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' (Maybe Bool) (Maybe DatetimeOptions) (Maybe FilterExpression) Text ParameterType |
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'.
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.
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".
EntityDetectorConfiguration
data EntityDetectorConfiguration Source #
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
See: newEntityDetectorConfiguration smart constructor.
Constructors
| EntityDetectorConfiguration' (Maybe (NonEmpty AllowedStatistics)) (NonEmpty Text) |
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.
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.
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.
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.
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.
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' Text (HashMap Text Text) |
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.
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' (Maybe CsvOptions) (Maybe ExcelOptions) (Maybe JsonOptions) |
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.
Input
Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.
See: newInput smart constructor.
Constructors
| Input' (Maybe DataCatalogInputDefinition) (Maybe DatabaseInputDefinition) (Maybe Metadata) (Maybe S3Location) |
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.
Job
Represents all of the attributes of a DataBrew job.
See: newJob smart constructor.
Constructors
| Job' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe EncryptionMode) (Maybe JobSample) (Maybe Text) (Maybe POSIX) (Maybe LogSubscription) (Maybe Int) (Maybe Natural) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe JobType) (Maybe (NonEmpty ValidationConfiguration)) Text |
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.
JobRun
Represents one run of a DataBrew job.
See: newJobRun smart constructor.
Constructors
| JobRun' (Maybe Int) (Maybe POSIX) (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobSample) (Maybe Text) (Maybe LogSubscription) (Maybe (NonEmpty Output)) (Maybe RecipeReference) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty ValidationConfiguration)) |
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.
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' (Maybe SampleMode) (Maybe Integer) |
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
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' (Maybe Bool) |
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.
Metadata
Contains additional resource information needed for specific datasets.
See: newMetadata smart constructor.
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.
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' (Maybe CompressionFormat) (Maybe OutputFormat) (Maybe OutputFormatOptions) (Maybe Natural) (Maybe Bool) (Maybe [Text]) S3Location |
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.
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' (Maybe CsvOutputOptions) |
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.
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' (Maybe FilesLimit) (Maybe FilterExpression) (Maybe (HashMap Text DatasetParameter)) |
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.
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' (Maybe (NonEmpty ColumnStatisticsConfiguration)) (Maybe StatisticsConfiguration) (Maybe EntityDetectorConfiguration) (Maybe (NonEmpty ColumnSelector)) |
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.
Project
Represents all of the attributes of a DataBrew project.
See: newProject smart constructor.
Constructors
| Project' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe (HashMap Text Text)) Text Text |
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.
Recipe
Represents one or more actions to be performed on a DataBrew dataset.
See: newRecipe smart constructor.
Constructors
| Recipe' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe (HashMap Text Text)) Text |
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.
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.
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.
RecipeReference
data RecipeReference Source #
Represents the name and version of a DataBrew recipe.
See: newRecipeReference smart constructor.
Constructors
| RecipeReference' (Maybe Text) Text |
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.
RecipeStep
data RecipeStep Source #
Represents a single step from a DataBrew recipe to be performed.
See: newRecipeStep smart constructor.
Constructors
| RecipeStep' (Maybe [ConditionExpression]) RecipeAction |
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.
RecipeVersionErrorDetail
data RecipeVersionErrorDetail Source #
Represents any errors encountered when attempting to delete multiple recipe versions.
See: newRecipeVersionErrorDetail smart constructor.
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.
Rule
Represents a single data quality requirement that should be validated in the scope of this dataset.
See: newRule smart constructor.
Constructors
| Rule' (Maybe (NonEmpty ColumnSelector)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Threshold) Text Text |
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
RulesetItem
data RulesetItem Source #
Contains metadata about the ruleset.
See: newRulesetItem smart constructor.
Constructors
| RulesetItem' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text Text)) Text Text |
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.
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.
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.
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' S3Location |
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.
Sample
Represents the sample size and sampling type for DataBrew to use for interactive data analysis.
See: newSample smart constructor.
Constructors
| Sample' (Maybe Natural) SampleType |
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.
Schedule
Represents one or more dates and times when a job is to run.
See: newSchedule smart constructor.
Constructors
| Schedule' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Text |
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.
StatisticOverride
data StatisticOverride Source #
Override of a particular evaluation for a profile job.
See: newStatisticOverride smart constructor.
Constructors
| StatisticOverride' Text (HashMap Text Text) |
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.
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' (Maybe (NonEmpty Text)) (Maybe (NonEmpty StatisticOverride)) |
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.
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' (Maybe ThresholdType) (Maybe ThresholdUnit) Double |
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.
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' (Maybe ValidationMode) Text |
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.
ViewFrame
Represents the data being transformed during an action.
See: newViewFrame smart constructor.
Constructors
| ViewFrame' (Maybe AnalyticsMode) (Maybe Natural) (Maybe [Text]) (Maybe Int) (Maybe Natural) Natural |
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.