Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- ListProjects (Paginated)
- DeleteProject
- UpdateProject
- ListSchedules (Paginated)
- DescribeDataset
- ListTagsForResource
- DescribeProject
- CreateRecipeJob
- ListRecipeVersions (Paginated)
- DeleteDataset
- UpdateDataset
- StopJobRun
- UpdateRecipeJob
- ListJobs (Paginated)
- CreateDataset
- DeleteJob
- CreateRecipe
- UpdateSchedule
- DeleteSchedule
- BatchDeleteRecipeVersion
- ListJobRuns (Paginated)
- DescribeJob
- UpdateProfileJob
- DescribeRecipe
- CreateProfileJob
- TagResource
- DescribeSchedule
- DescribeJobRun
- StartProjectSession
- DeleteRecipeVersion
- ListDatasets (Paginated)
- UntagResource
- StartJobRun
- UpdateRecipe
- CreateSchedule
- ListRecipes (Paginated)
- PublishRecipe
- CreateProject
- SendProjectSessionAction
- Types
- CompressionFormat
- DatabaseOutputMode
- EncryptionMode
- InputFormat
- JobRunState
- JobType
- LogSubscription
- Order
- OrderedBy
- OutputFormat
- ParameterType
- SampleMode
- SampleType
- SessionStatus
- Source
- ColumnSelector
- ColumnStatisticsConfiguration
- ConditionExpression
- CsvOptions
- CsvOutputOptions
- DataCatalogInputDefinition
- DataCatalogOutput
- DatabaseInputDefinition
- DatabaseOutput
- DatabaseTableOutputOptions
- Dataset
- DatasetParameter
- DatetimeOptions
- ExcelOptions
- FilesLimit
- FilterExpression
- FormatOptions
- Input
- Job
- JobRun
- JobSample
- JsonOptions
- Output
- OutputFormatOptions
- PathOptions
- ProfileConfiguration
- Project
- Recipe
- RecipeAction
- RecipeReference
- RecipeStep
- RecipeVersionErrorDetail
- S3Location
- S3TableOutputOptions
- Sample
- Schedule
- StatisticOverride
- StatisticsConfiguration
- ViewFrame
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
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListProjects = ListProjects' (Maybe Text) (Maybe Natural)
- newListProjects :: ListProjects
- data ListProjectsResponse = ListProjectsResponse' (Maybe Text) Int [Project]
- newListProjectsResponse :: Int -> ListProjectsResponse
- data DeleteProject = DeleteProject' Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' Int Text
- newDeleteProjectResponse :: Int -> Text -> DeleteProjectResponse
- data UpdateProject = UpdateProject' (Maybe Sample) Text Text
- newUpdateProject :: Text -> Text -> UpdateProject
- data UpdateProjectResponse = UpdateProjectResponse' (Maybe POSIX) Int Text
- newUpdateProjectResponse :: Int -> Text -> UpdateProjectResponse
- data ListSchedules = ListSchedules' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListSchedules :: ListSchedules
- data ListSchedulesResponse = ListSchedulesResponse' (Maybe Text) Int [Schedule]
- newListSchedulesResponse :: Int -> ListSchedulesResponse
- data DescribeDataset = DescribeDataset' Text
- newDescribeDataset :: Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe POSIX) (Maybe PathOptions) (Maybe POSIX) (Maybe FormatOptions) (Maybe InputFormat) (Maybe Text) (Maybe Text) (Maybe Source) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Input
- newDescribeDatasetResponse :: Int -> Text -> Input -> DescribeDatasetResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DescribeProject = DescribeProject' Text
- newDescribeProject :: Text -> DescribeProject
- data DescribeProjectResponse = DescribeProjectResponse' (Maybe POSIX) (Maybe SessionStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int Text
- newDescribeProjectResponse :: Int -> Text -> DescribeProjectResponse
- data CreateRecipeJob = CreateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe RecipeReference) (Maybe (NonEmpty DatabaseOutput)) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe LogSubscription) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Natural) (Maybe (HashMap Text Text)) Text Text
- newCreateRecipeJob :: Text -> Text -> CreateRecipeJob
- data CreateRecipeJobResponse = CreateRecipeJobResponse' Int Text
- newCreateRecipeJobResponse :: Int -> Text -> CreateRecipeJobResponse
- data ListRecipeVersions = ListRecipeVersions' (Maybe Text) (Maybe Natural) Text
- newListRecipeVersions :: Text -> ListRecipeVersions
- data ListRecipeVersionsResponse = ListRecipeVersionsResponse' (Maybe Text) Int [Recipe]
- newListRecipeVersionsResponse :: Int -> ListRecipeVersionsResponse
- data DeleteDataset = DeleteDataset' Text
- newDeleteDataset :: Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' Int Text
- newDeleteDatasetResponse :: Int -> Text -> DeleteDatasetResponse
- data UpdateDataset = UpdateDataset' (Maybe PathOptions) (Maybe FormatOptions) (Maybe InputFormat) Text Input
- newUpdateDataset :: Text -> Input -> UpdateDataset
- data UpdateDatasetResponse = UpdateDatasetResponse' Int Text
- newUpdateDatasetResponse :: Int -> Text -> UpdateDatasetResponse
- data StopJobRun = StopJobRun' Text Text
- newStopJobRun :: Text -> Text -> StopJobRun
- data StopJobRunResponse = StopJobRunResponse' Int Text
- newStopJobRunResponse :: Int -> Text -> StopJobRunResponse
- data UpdateRecipeJob = UpdateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe LogSubscription) (Maybe Natural) (Maybe Text) (Maybe Int) (Maybe Natural) Text Text
- newUpdateRecipeJob :: Text -> Text -> UpdateRecipeJob
- data UpdateRecipeJobResponse = UpdateRecipeJobResponse' Int Text
- newUpdateRecipeJobResponse :: Int -> Text -> UpdateRecipeJobResponse
- data ListJobs = ListJobs' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListJobs :: ListJobs
- data ListJobsResponse = ListJobsResponse' (Maybe Text) Int [Job]
- newListJobsResponse :: Int -> ListJobsResponse
- data CreateDataset = CreateDataset' (Maybe PathOptions) (Maybe FormatOptions) (Maybe InputFormat) (Maybe (HashMap Text Text)) Text Input
- newCreateDataset :: Text -> Input -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' Int Text
- newCreateDatasetResponse :: Int -> Text -> CreateDatasetResponse
- data DeleteJob = DeleteJob' Text
- newDeleteJob :: Text -> DeleteJob
- data DeleteJobResponse = DeleteJobResponse' Int Text
- newDeleteJobResponse :: Int -> Text -> DeleteJobResponse
- data CreateRecipe = CreateRecipe' (Maybe Text) (Maybe (HashMap Text Text)) Text [RecipeStep]
- newCreateRecipe :: Text -> CreateRecipe
- data CreateRecipeResponse = CreateRecipeResponse' Int Text
- newCreateRecipeResponse :: Int -> Text -> CreateRecipeResponse
- data UpdateSchedule = UpdateSchedule' (Maybe [Text]) Text Text
- newUpdateSchedule :: Text -> Text -> UpdateSchedule
- data UpdateScheduleResponse = UpdateScheduleResponse' Int Text
- newUpdateScheduleResponse :: Int -> Text -> UpdateScheduleResponse
- data DeleteSchedule = DeleteSchedule' Text
- newDeleteSchedule :: Text -> DeleteSchedule
- data DeleteScheduleResponse = DeleteScheduleResponse' Int Text
- newDeleteScheduleResponse :: Int -> Text -> DeleteScheduleResponse
- data BatchDeleteRecipeVersion = BatchDeleteRecipeVersion' Text (NonEmpty Text)
- newBatchDeleteRecipeVersion :: Text -> NonEmpty Text -> BatchDeleteRecipeVersion
- data BatchDeleteRecipeVersionResponse = BatchDeleteRecipeVersionResponse' (Maybe [RecipeVersionErrorDetail]) Int Text
- newBatchDeleteRecipeVersionResponse :: Int -> Text -> BatchDeleteRecipeVersionResponse
- data ListJobRuns = ListJobRuns' (Maybe Text) (Maybe Natural) Text
- newListJobRuns :: Text -> ListJobRuns
- data ListJobRunsResponse = ListJobRunsResponse' (Maybe Text) Int [JobRun]
- newListJobRunsResponse :: Int -> ListJobRunsResponse
- data DescribeJob = DescribeJob' Text
- newDescribeJob :: Text -> DescribeJob
- data DescribeJobResponse = DescribeJobResponse' (Maybe (NonEmpty DataCatalogOutput)) (Maybe POSIX) (Maybe POSIX) (Maybe RecipeReference) (Maybe ProfileConfiguration) (Maybe Text) (Maybe (NonEmpty DatabaseOutput)) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe LogSubscription) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobType) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe JobSample) Int Text
- newDescribeJobResponse :: Int -> Text -> DescribeJobResponse
- data UpdateProfileJob = UpdateProfileJob' (Maybe EncryptionMode) (Maybe LogSubscription) (Maybe Natural) (Maybe Text) (Maybe Int) (Maybe ProfileConfiguration) (Maybe Natural) (Maybe JobSample) Text S3Location Text
- newUpdateProfileJob :: Text -> S3Location -> Text -> UpdateProfileJob
- data UpdateProfileJobResponse = UpdateProfileJobResponse' Int Text
- newUpdateProfileJobResponse :: Int -> Text -> UpdateProfileJobResponse
- data DescribeRecipe = DescribeRecipe' (Maybe Text) Text
- newDescribeRecipe :: Text -> DescribeRecipe
- data DescribeRecipeResponse = DescribeRecipeResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int Text
- newDescribeRecipeResponse :: Int -> Text -> DescribeRecipeResponse
- data CreateProfileJob = CreateProfileJob' (Maybe EncryptionMode) (Maybe LogSubscription) (Maybe Natural) (Maybe Text) (Maybe Int) (Maybe ProfileConfiguration) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe JobSample) Text Text S3Location Text
- newCreateProfileJob :: Text -> Text -> S3Location -> Text -> CreateProfileJob
- data CreateProfileJobResponse = CreateProfileJobResponse' Int Text
- newCreateProfileJobResponse :: Int -> Text -> CreateProfileJobResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data DescribeSchedule = DescribeSchedule' Text
- newDescribeSchedule :: Text -> DescribeSchedule
- data DescribeScheduleResponse = DescribeScheduleResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) Int Text
- newDescribeScheduleResponse :: Int -> Text -> DescribeScheduleResponse
- data DescribeJobRun = DescribeJobRun' Text Text
- newDescribeJobRun :: Text -> Text -> DescribeJobRun
- data DescribeJobRunResponse = DescribeJobRunResponse' (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty DataCatalogOutput)) (Maybe POSIX) (Maybe RecipeReference) (Maybe ProfileConfiguration) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe Int) (Maybe LogSubscription) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobSample) Int Text
- newDescribeJobRunResponse :: Int -> Text -> DescribeJobRunResponse
- data StartProjectSession = StartProjectSession' (Maybe Bool) Text
- newStartProjectSession :: Text -> StartProjectSession
- data StartProjectSessionResponse = StartProjectSessionResponse' (Maybe Text) Int Text
- newStartProjectSessionResponse :: Int -> Text -> StartProjectSessionResponse
- data DeleteRecipeVersion = DeleteRecipeVersion' Text Text
- newDeleteRecipeVersion :: Text -> Text -> DeleteRecipeVersion
- data DeleteRecipeVersionResponse = DeleteRecipeVersionResponse' Int Text Text
- newDeleteRecipeVersionResponse :: Int -> Text -> Text -> DeleteRecipeVersionResponse
- data ListDatasets = ListDatasets' (Maybe Text) (Maybe Natural)
- newListDatasets :: ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe Text) Int [Dataset]
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data StartJobRun = StartJobRun' Text
- newStartJobRun :: Text -> StartJobRun
- data StartJobRunResponse = StartJobRunResponse' Int Text
- newStartJobRunResponse :: Int -> Text -> StartJobRunResponse
- data UpdateRecipe = UpdateRecipe' (Maybe [RecipeStep]) (Maybe Text) Text
- newUpdateRecipe :: Text -> UpdateRecipe
- data UpdateRecipeResponse = UpdateRecipeResponse' Int Text
- newUpdateRecipeResponse :: Int -> Text -> UpdateRecipeResponse
- 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 ListRecipes = ListRecipes' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListRecipes :: ListRecipes
- data ListRecipesResponse = ListRecipesResponse' (Maybe Text) Int [Recipe]
- newListRecipesResponse :: Int -> ListRecipesResponse
- data PublishRecipe = PublishRecipe' (Maybe Text) Text
- newPublishRecipe :: Text -> PublishRecipe
- data PublishRecipeResponse = PublishRecipeResponse' Int Text
- newPublishRecipeResponse :: Int -> Text -> PublishRecipeResponse
- 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 SendProjectSessionAction = SendProjectSessionAction' (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe RecipeStep) (Maybe ViewFrame) Text
- newSendProjectSessionAction :: Text -> SendProjectSessionAction
- data SendProjectSessionActionResponse = SendProjectSessionActionResponse' (Maybe Int) (Maybe Text) Int Text
- newSendProjectSessionActionResponse :: Int -> Text -> SendProjectSessionActionResponse
- 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_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' {
- 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 Bool) (Maybe Text)
- newCsvOptions :: CsvOptions
- data CsvOutputOptions = CsvOutputOptions' (Maybe Text)
- newCsvOutputOptions :: CsvOutputOptions
- data DataCatalogInputDefinition = DataCatalogInputDefinition' (Maybe S3Location) (Maybe Text) Text Text
- newDataCatalogInputDefinition :: Text -> Text -> DataCatalogInputDefinition
- data DataCatalogOutput = DataCatalogOutput' (Maybe DatabaseTableOutputOptions) (Maybe S3TableOutputOptions) (Maybe Text) (Maybe Bool) Text Text
- newDataCatalogOutput :: Text -> Text -> DataCatalogOutput
- data DatabaseInputDefinition = DatabaseInputDefinition' (Maybe S3Location) Text Text
- newDatabaseInputDefinition :: Text -> 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 POSIX) (Maybe PathOptions) (Maybe POSIX) (Maybe FormatOptions) (Maybe InputFormat) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Source) (Maybe Text) (Maybe (HashMap Text Text)) Text Input
- newDataset :: Text -> Input -> Dataset
- data DatasetParameter = DatasetParameter' (Maybe Bool) (Maybe FilterExpression) (Maybe DatetimeOptions) Text ParameterType
- newDatasetParameter :: Text -> ParameterType -> DatasetParameter
- data DatetimeOptions = DatetimeOptions' (Maybe Text) (Maybe Text) Text
- newDatetimeOptions :: Text -> DatetimeOptions
- data ExcelOptions = ExcelOptions' (Maybe (NonEmpty Natural)) (Maybe (NonEmpty Text)) (Maybe Bool)
- newExcelOptions :: ExcelOptions
- data FilesLimit = FilesLimit' (Maybe OrderedBy) (Maybe Order) Natural
- newFilesLimit :: Natural -> FilesLimit
- data FilterExpression = FilterExpression' Text (HashMap Text Text)
- newFilterExpression :: Text -> FilterExpression
- data FormatOptions = FormatOptions' (Maybe JsonOptions) (Maybe CsvOptions) (Maybe ExcelOptions)
- newFormatOptions :: FormatOptions
- data Input = Input' (Maybe DataCatalogInputDefinition) (Maybe S3Location) (Maybe DatabaseInputDefinition)
- newInput :: Input
- data Job = Job' (Maybe (NonEmpty DataCatalogOutput)) (Maybe POSIX) (Maybe POSIX) (Maybe RecipeReference) (Maybe Text) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe LogSubscription) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobType) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe JobSample) Text
- newJob :: Text -> Job
- data JobRun = JobRun' (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty DataCatalogOutput)) (Maybe Text) (Maybe POSIX) (Maybe RecipeReference) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe Int) (Maybe LogSubscription) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobSample)
- newJobRun :: JobRun
- data JobSample = JobSample' (Maybe Integer) (Maybe SampleMode)
- newJobSample :: JobSample
- data JsonOptions = JsonOptions' (Maybe Bool)
- newJsonOptions :: JsonOptions
- data Output = Output' (Maybe [Text]) (Maybe OutputFormatOptions) (Maybe OutputFormat) (Maybe CompressionFormat) (Maybe Bool) S3Location
- newOutput :: S3Location -> Output
- data OutputFormatOptions = OutputFormatOptions' (Maybe CsvOutputOptions)
- newOutputFormatOptions :: OutputFormatOptions
- data PathOptions = PathOptions' (Maybe FilterExpression) (Maybe (HashMap Text DatasetParameter)) (Maybe FilesLimit)
- newPathOptions :: PathOptions
- data ProfileConfiguration = ProfileConfiguration' (Maybe StatisticsConfiguration) (Maybe (NonEmpty ColumnStatisticsConfiguration)) (Maybe (NonEmpty ColumnSelector))
- newProfileConfiguration :: ProfileConfiguration
- data Project = Project' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text
- newProject :: Text -> Text -> Project
- data Recipe = Recipe' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (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 S3Location = S3Location' (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 POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (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 StatisticOverride)) (Maybe (NonEmpty Text))
- newStatisticsConfiguration :: StatisticsConfiguration
- data ViewFrame = ViewFrame' (Maybe [Text]) (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
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input parameters for this request failed validation.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Access to the specified resource was denied.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Updating or deleting a resource can cause an inconsistent state.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A service quota is exceeded.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal service failure occurred.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more resources can't be found.
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.
ListProjects (Paginated)
data ListProjects Source #
See: newListProjects
smart constructor.
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:nextToken:ListProjects'
, listProjects_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:maxResults:ListProjects'
, listProjects_maxResults
- The maximum number of results to return in this request.
data ListProjectsResponse Source #
See: newListProjectsResponse
smart constructor.
Instances
newListProjectsResponse Source #
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:
$sel:nextToken: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 .
DeleteProject
data DeleteProject Source #
See: newDeleteProject
smart constructor.
Instances
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:
$sel:name:DeleteProject'
, deleteProject_name
- The name of the project to be deleted.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse
smart constructor.
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.
$sel:name:DeleteProject'
, deleteProjectResponse_name
- The name of the project that you deleted.
UpdateProject
data UpdateProject Source #
See: newUpdateProject
smart constructor.
Instances
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:
$sel:sample:UpdateProject'
, updateProject_sample
- Undocumented member.
$sel:roleArn:UpdateProject'
, updateProject_roleArn
- The Amazon Resource Name (ARN) of the IAM role to be assumed for this
request.
$sel:name:UpdateProject'
, updateProject_name
- The name of the project to be updated.
data UpdateProjectResponse Source #
See: newUpdateProjectResponse
smart constructor.
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:
$sel:lastModifiedDate:UpdateProjectResponse'
, updateProjectResponse_lastModifiedDate
- The date and time that the project was last modified.
$sel:httpStatus:UpdateProjectResponse'
, updateProjectResponse_httpStatus
- The response's http status code.
$sel:name:UpdateProject'
, updateProjectResponse_name
- The name of the project that you updated.
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:
$sel:jobName:ListSchedules'
, listSchedules_jobName
- The name of the job that these schedules apply to.
$sel:nextToken:ListSchedules'
, listSchedules_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:maxResults:ListSchedules'
, listSchedules_maxResults
- The maximum number of results to return in this request.
data ListSchedulesResponse Source #
See: newListSchedulesResponse
smart constructor.
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:
$sel:nextToken: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.
DescribeDataset
data DescribeDataset Source #
See: newDescribeDataset
smart constructor.
Instances
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:
$sel:name:DescribeDataset'
, describeDataset_name
- The name of the dataset to be described.
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse
smart constructor.
DescribeDatasetResponse' (Maybe POSIX) (Maybe PathOptions) (Maybe POSIX) (Maybe FormatOptions) (Maybe InputFormat) (Maybe Text) (Maybe Text) (Maybe Source) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Input |
Instances
newDescribeDatasetResponse Source #
:: 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:
$sel:lastModifiedDate:DescribeDatasetResponse'
, describeDatasetResponse_lastModifiedDate
- The date and time that the dataset was last modified.
$sel:pathOptions:DescribeDatasetResponse'
, describeDatasetResponse_pathOptions
- A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
$sel:createDate:DescribeDatasetResponse'
, describeDatasetResponse_createDate
- The date and time that the dataset was created.
$sel:formatOptions:DescribeDatasetResponse'
, describeDatasetResponse_formatOptions
- Undocumented member.
$sel:format:DescribeDatasetResponse'
, describeDatasetResponse_format
- The file format of a dataset that is created from an Amazon S3 file or
folder.
$sel:createdBy:DescribeDatasetResponse'
, describeDatasetResponse_createdBy
- The identifier (user name) of the user who created the dataset.
$sel:resourceArn:DescribeDatasetResponse'
, describeDatasetResponse_resourceArn
- The Amazon Resource Name (ARN) of the dataset.
$sel:source:DescribeDatasetResponse'
, describeDatasetResponse_source
- The location of the data for this dataset, Amazon S3 or the Glue Data
Catalog.
$sel:lastModifiedBy:DescribeDatasetResponse'
, describeDatasetResponse_lastModifiedBy
- The identifier (user name) of the user who last modified the dataset.
$sel:tags:DescribeDatasetResponse'
, describeDatasetResponse_tags
- Metadata tags associated with this dataset.
$sel:httpStatus:DescribeDatasetResponse'
, describeDatasetResponse_httpStatus
- The response's http status code.
$sel:name:DescribeDataset'
, describeDatasetResponse_name
- The name of the dataset.
$sel:input:DescribeDatasetResponse'
, describeDatasetResponse_input
- Undocumented member.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
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:
$sel:resourceArn: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:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A list of tags associated with the DataBrew resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
DescribeProject
data DescribeProject Source #
See: newDescribeProject
smart constructor.
Instances
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:
$sel:name:DescribeProject'
, describeProject_name
- The name of the project to be described.
data DescribeProjectResponse Source #
See: newDescribeProjectResponse
smart constructor.
DescribeProjectResponse' (Maybe POSIX) (Maybe SessionStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int Text |
Instances
newDescribeProjectResponse Source #
:: 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:
$sel:lastModifiedDate:DescribeProjectResponse'
, describeProjectResponse_lastModifiedDate
- The date and time that the project was last modified.
$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.
$sel:openDate:DescribeProjectResponse'
, describeProjectResponse_openDate
- The date and time when the project was opened.
$sel:createDate:DescribeProjectResponse'
, describeProjectResponse_createDate
- The date and time that the project was created.
$sel:createdBy:DescribeProjectResponse'
, describeProjectResponse_createdBy
- The identifier (user name) of the user who created the project.
$sel:resourceArn:DescribeProjectResponse'
, describeProjectResponse_resourceArn
- The Amazon Resource Name (ARN) of the project.
$sel:recipeName:DescribeProjectResponse'
, describeProjectResponse_recipeName
- The recipe associated with this job.
$sel:datasetName:DescribeProjectResponse'
, describeProjectResponse_datasetName
- The dataset associated with the project.
$sel:lastModifiedBy:DescribeProjectResponse'
, describeProjectResponse_lastModifiedBy
- The identifier (user name) of the user who last modified the project.
$sel:sample:DescribeProjectResponse'
, describeProjectResponse_sample
- Undocumented member.
$sel:openedBy:DescribeProjectResponse'
, describeProjectResponse_openedBy
- The identifier (user name) of the user that opened the project for use.
$sel:tags:DescribeProjectResponse'
, describeProjectResponse_tags
- Metadata tags associated with this project.
$sel:roleArn:DescribeProjectResponse'
, describeProjectResponse_roleArn
- The ARN of the Identity and Access Management (IAM) role to be assumed
when DataBrew runs the job.
$sel:httpStatus:DescribeProjectResponse'
, describeProjectResponse_httpStatus
- The response's http status code.
$sel:name:DescribeProject'
, describeProjectResponse_name
- The name of the project.
CreateRecipeJob
data CreateRecipeJob Source #
See: newCreateRecipeJob
smart constructor.
CreateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe RecipeReference) (Maybe (NonEmpty DatabaseOutput)) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe LogSubscription) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Natural) (Maybe (HashMap Text Text)) Text Text |
Instances
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:
$sel:dataCatalogOutputs:CreateRecipeJob'
, createRecipeJob_dataCatalogOutputs
- One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:recipeReference:CreateRecipeJob'
, createRecipeJob_recipeReference
- Undocumented member.
$sel:databaseOutputs:CreateRecipeJob'
, createRecipeJob_databaseOutputs
- Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write to.
$sel:encryptionMode: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.
$sel:outputs:CreateRecipeJob'
, createRecipeJob_outputs
- One or more artifacts that represent the output from running the job.
$sel:logSubscription: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.
$sel:projectName:CreateRecipeJob'
, createRecipeJob_projectName
- Either the name of an existing project, or a combination of a recipe and
a dataset to associate with the recipe.
$sel:maxRetries:CreateRecipeJob'
, createRecipeJob_maxRetries
- The maximum number of times to retry the job after a job run fails.
$sel:datasetName:CreateRecipeJob'
, createRecipeJob_datasetName
- The name of the dataset that this job processes.
$sel:encryptionKeyArn:CreateRecipeJob'
, createRecipeJob_encryptionKeyArn
- The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
$sel:maxCapacity:CreateRecipeJob'
, createRecipeJob_maxCapacity
- The maximum number of nodes that DataBrew can consume when the job
processes data.
$sel:timeout: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
.
$sel:tags:CreateRecipeJob'
, createRecipeJob_tags
- Metadata tags to apply to this job.
$sel:name:CreateRecipeJob'
, createRecipeJob_name
- A unique name for the job. Valid characters are alphanumeric (A-Z, a-z,
0-9), hyphen (-), period (.), and space.
$sel:roleArn: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.
Instances
newCreateRecipeJobResponse Source #
:: 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.
$sel:name:CreateRecipeJob'
, createRecipeJobResponse_name
- The name of the job that you created.
ListRecipeVersions (Paginated)
data ListRecipeVersions Source #
See: newListRecipeVersions
smart constructor.
Instances
newListRecipeVersions Source #
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:nextToken:ListRecipeVersions'
, listRecipeVersions_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:maxResults:ListRecipeVersions'
, listRecipeVersions_maxResults
- The maximum number of results to return in this request.
$sel:name:ListRecipeVersions'
, listRecipeVersions_name
- The name of the recipe for which to return version information.
data ListRecipeVersionsResponse Source #
See: newListRecipeVersionsResponse
smart constructor.
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:
$sel:nextToken: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.
DeleteDataset
data DeleteDataset Source #
See: newDeleteDataset
smart constructor.
Instances
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:
$sel:name:DeleteDataset'
, deleteDataset_name
- The name of the dataset to be deleted.
data DeleteDatasetResponse Source #
See: newDeleteDatasetResponse
smart constructor.
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.
$sel:name:DeleteDataset'
, deleteDatasetResponse_name
- The name of the dataset that you deleted.
UpdateDataset
data UpdateDataset Source #
See: newUpdateDataset
smart constructor.
Instances
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:
$sel:pathOptions:UpdateDataset'
, updateDataset_pathOptions
- A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
$sel:formatOptions:UpdateDataset'
, updateDataset_formatOptions
- Undocumented member.
$sel:format:UpdateDataset'
, updateDataset_format
- The file format of a dataset that is created from an Amazon S3 file or
folder.
$sel:name:UpdateDataset'
, updateDataset_name
- The name of the dataset to be updated.
$sel:input:UpdateDataset'
, updateDataset_input
- Undocumented member.
data UpdateDatasetResponse Source #
See: newUpdateDatasetResponse
smart constructor.
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.
$sel:name:UpdateDataset'
, updateDatasetResponse_name
- The name of the dataset that you updated.
StopJobRun
data StopJobRun Source #
See: newStopJobRun
smart constructor.
Instances
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:
$sel:name:StopJobRun'
, stopJobRun_name
- The name of the job to be stopped.
$sel:runId:StopJobRun'
, stopJobRun_runId
- The ID of the job run to be stopped.
data StopJobRunResponse Source #
See: newStopJobRunResponse
smart constructor.
Instances
newStopJobRunResponse Source #
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.
$sel:runId:StopJobRun'
, stopJobRunResponse_runId
- The ID of the job run that you stopped.
UpdateRecipeJob
data UpdateRecipeJob Source #
See: newUpdateRecipeJob
smart constructor.
UpdateRecipeJob' (Maybe (NonEmpty DataCatalogOutput)) (Maybe (NonEmpty DatabaseOutput)) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe LogSubscription) (Maybe Natural) (Maybe Text) (Maybe Int) (Maybe Natural) Text Text |
Instances
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:
$sel:dataCatalogOutputs:UpdateRecipeJob'
, updateRecipeJob_dataCatalogOutputs
- One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:databaseOutputs:UpdateRecipeJob'
, updateRecipeJob_databaseOutputs
- Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
$sel:encryptionMode: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.
$sel:outputs:UpdateRecipeJob'
, updateRecipeJob_outputs
- One or more artifacts that represent the output from running the job.
$sel:logSubscription: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.
$sel:maxRetries:UpdateRecipeJob'
, updateRecipeJob_maxRetries
- The maximum number of times to retry the job after a job run fails.
$sel:encryptionKeyArn:UpdateRecipeJob'
, updateRecipeJob_encryptionKeyArn
- The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
$sel:maxCapacity:UpdateRecipeJob'
, updateRecipeJob_maxCapacity
- The maximum number of nodes that DataBrew can consume when the job
processes data.
$sel:timeout: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
.
$sel:name:UpdateRecipeJob'
, updateRecipeJob_name
- The name of the job to update.
$sel:roleArn: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.
Instances
newUpdateRecipeJobResponse Source #
:: 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.
$sel:name:UpdateRecipeJob'
, updateRecipeJobResponse_name
- The name of the job that you updated.
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:
$sel:nextToken: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.
$sel:projectName:ListJobs'
, listJobs_projectName
- The name of a project. Using this parameter indicates to return only
those jobs that are associated with the specified project.
$sel:datasetName: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.
data ListJobsResponse Source #
See: newListJobsResponse
smart constructor.
ListJobsResponse' (Maybe Text) Int [Job] |
Instances
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:
$sel:nextToken: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.
CreateDataset
data CreateDataset Source #
See: newCreateDataset
smart constructor.
CreateDataset' (Maybe PathOptions) (Maybe FormatOptions) (Maybe InputFormat) (Maybe (HashMap Text Text)) Text Input |
Instances
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:
$sel:pathOptions:CreateDataset'
, createDataset_pathOptions
- A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
$sel:formatOptions:CreateDataset'
, createDataset_formatOptions
- Undocumented member.
$sel:format:CreateDataset'
, createDataset_format
- The file format of a dataset that is created from an Amazon S3 file or
folder.
$sel:tags:CreateDataset'
, createDataset_tags
- Metadata tags to apply to this dataset.
$sel:name: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.
$sel:input:CreateDataset'
, createDataset_input
- Undocumented member.
data CreateDatasetResponse Source #
See: newCreateDatasetResponse
smart constructor.
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.
$sel:name:CreateDataset'
, createDatasetResponse_name
- The name of the dataset that you created.
DeleteJob
See: newDeleteJob
smart constructor.
Instances
Eq DeleteJob Source # | |
Read DeleteJob Source # | |
Show DeleteJob Source # | |
Generic DeleteJob Source # | |
NFData DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob | |
Hashable DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob | |
AWSRequest DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob type AWSResponse DeleteJob # request :: DeleteJob -> Request DeleteJob # response :: MonadResource m => Logger -> Service -> Proxy DeleteJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteJob))) # | |
ToHeaders DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob | |
ToPath DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob toPath :: DeleteJob -> ByteString # | |
ToQuery DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob toQuery :: DeleteJob -> QueryString # | |
type Rep DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob | |
type AWSResponse DeleteJob Source # | |
Defined in Amazonka.DataBrew.DeleteJob |
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:
$sel:name:DeleteJob'
, deleteJob_name
- The name of the job to be deleted.
data DeleteJobResponse Source #
See: newDeleteJobResponse
smart constructor.
Instances
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.
$sel:name:DeleteJob'
, deleteJobResponse_name
- The name of the job that you deleted.
CreateRecipe
data CreateRecipe Source #
See: newCreateRecipe
smart constructor.
CreateRecipe' (Maybe Text) (Maybe (HashMap Text Text)) Text [RecipeStep] |
Instances
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:
$sel:description:CreateRecipe'
, createRecipe_description
- A description for the recipe.
$sel:tags:CreateRecipe'
, createRecipe_tags
- Metadata tags to apply to this recipe.
$sel:name:CreateRecipe'
, createRecipe_name
- A unique name for the recipe. Valid characters are alphanumeric (A-Z,
a-z, 0-9), hyphen (-), period (.), and space.
$sel:steps: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.
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.
$sel:name:CreateRecipe'
, createRecipeResponse_name
- The name of the recipe that you created.
UpdateSchedule
data UpdateSchedule Source #
See: newUpdateSchedule
smart constructor.
UpdateSchedule' (Maybe [Text]) Text Text |
Instances
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:
$sel:jobNames:UpdateSchedule'
, updateSchedule_jobNames
- The name or names of one or more jobs to be run for this schedule.
$sel:cronExpression: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.
$sel:name:UpdateSchedule'
, updateSchedule_name
- The name of the schedule to update.
data UpdateScheduleResponse Source #
See: newUpdateScheduleResponse
smart constructor.
Instances
newUpdateScheduleResponse Source #
:: 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.
$sel:name:UpdateSchedule'
, updateScheduleResponse_name
- The name of the schedule that was updated.
DeleteSchedule
data DeleteSchedule Source #
See: newDeleteSchedule
smart constructor.
Instances
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:
$sel:name:DeleteSchedule'
, deleteSchedule_name
- The name of the schedule to be deleted.
data DeleteScheduleResponse Source #
See: newDeleteScheduleResponse
smart constructor.
Instances
newDeleteScheduleResponse Source #
:: 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.
$sel:name:DeleteSchedule'
, deleteScheduleResponse_name
- The name of the schedule that was deleted.
BatchDeleteRecipeVersion
data BatchDeleteRecipeVersion Source #
See: newBatchDeleteRecipeVersion
smart constructor.
Instances
newBatchDeleteRecipeVersion Source #
:: 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:
$sel:name: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.
Instances
newBatchDeleteRecipeVersionResponse Source #
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.
$sel:name:BatchDeleteRecipeVersion'
, batchDeleteRecipeVersionResponse_name
- The name of the recipe that was modified.
ListJobRuns (Paginated)
data ListJobRuns Source #
See: newListJobRuns
smart constructor.
Instances
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:nextToken:ListJobRuns'
, listJobRuns_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:maxResults:ListJobRuns'
, listJobRuns_maxResults
- The maximum number of results to return in this request.
$sel:name:ListJobRuns'
, listJobRuns_name
- The name of the job.
data ListJobRunsResponse Source #
See: newListJobRunsResponse
smart constructor.
Instances
newListJobRunsResponse Source #
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:
$sel:nextToken: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.
DescribeJob
data DescribeJob Source #
See: newDescribeJob
smart constructor.
Instances
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:
$sel:name:DescribeJob'
, describeJob_name
- The name of the job to be described.
data DescribeJobResponse Source #
See: newDescribeJobResponse
smart constructor.
DescribeJobResponse' (Maybe (NonEmpty DataCatalogOutput)) (Maybe POSIX) (Maybe POSIX) (Maybe RecipeReference) (Maybe ProfileConfiguration) (Maybe Text) (Maybe (NonEmpty DatabaseOutput)) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe LogSubscription) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobType) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe JobSample) 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:
$sel:dataCatalogOutputs:DescribeJobResponse'
, describeJobResponse_dataCatalogOutputs
- One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:lastModifiedDate:DescribeJobResponse'
, describeJobResponse_lastModifiedDate
- The date and time that the job was last modified.
$sel:createDate:DescribeJobResponse'
, describeJobResponse_createDate
- The date and time that the job was created.
$sel:recipeReference:DescribeJobResponse'
, describeJobResponse_recipeReference
- Undocumented member.
$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.
$sel:createdBy:DescribeJobResponse'
, describeJobResponse_createdBy
- The identifier (user name) of the user associated with the creation of
the job.
$sel:databaseOutputs:DescribeJobResponse'
, describeJobResponse_databaseOutputs
- Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
$sel:encryptionMode: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.
$sel:outputs:DescribeJobResponse'
, describeJobResponse_outputs
- One or more artifacts that represent the output from running the job.
$sel:resourceArn:DescribeJobResponse'
, describeJobResponse_resourceArn
- The Amazon Resource Name (ARN) of the job.
$sel:logSubscription:DescribeJobResponse'
, describeJobResponse_logSubscription
- Indicates whether Amazon CloudWatch logging is enabled for this job.
$sel:projectName:DescribeJobResponse'
, describeJobResponse_projectName
- The DataBrew project associated with this job.
$sel:maxRetries:DescribeJobResponse'
, describeJobResponse_maxRetries
- The maximum number of times to retry the job after a job run fails.
$sel:datasetName:DescribeJobResponse'
, describeJobResponse_datasetName
- The dataset that the job acts upon.
$sel:encryptionKeyArn:DescribeJobResponse'
, describeJobResponse_encryptionKeyArn
- The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
$sel:maxCapacity:DescribeJobResponse'
, describeJobResponse_maxCapacity
- The maximum number of compute nodes that DataBrew can consume when the
job processes data.
$sel:lastModifiedBy:DescribeJobResponse'
, describeJobResponse_lastModifiedBy
- The identifier (user name) of the user who last modified the job.
$sel:type':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.
$sel:timeout: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
.
$sel:tags:DescribeJobResponse'
, describeJobResponse_tags
- Metadata tags associated with this job.
$sel:roleArn:DescribeJobResponse'
, describeJobResponse_roleArn
- The ARN of the Identity and Access Management (IAM) role to be assumed
when DataBrew runs the job.
$sel:jobSample:DescribeJobResponse'
, describeJobResponse_jobSample
- Sample configuration for profile jobs only. Determines the number of
rows on which the profile job will be executed.
$sel:httpStatus:DescribeJobResponse'
, describeJobResponse_httpStatus
- The response's http status code.
$sel:name:DescribeJob'
, describeJobResponse_name
- The name of the job.
UpdateProfileJob
data UpdateProfileJob Source #
See: newUpdateProfileJob
smart constructor.
UpdateProfileJob' (Maybe EncryptionMode) (Maybe LogSubscription) (Maybe Natural) (Maybe Text) (Maybe Int) (Maybe ProfileConfiguration) (Maybe Natural) (Maybe JobSample) Text S3Location Text |
Instances
:: 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:encryptionMode: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.
$sel:logSubscription: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.
$sel:maxRetries:UpdateProfileJob'
, updateProfileJob_maxRetries
- The maximum number of times to retry the job after a job run fails.
$sel:encryptionKeyArn:UpdateProfileJob'
, updateProfileJob_encryptionKeyArn
- The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
$sel:maxCapacity:UpdateProfileJob'
, updateProfileJob_maxCapacity
- The maximum number of compute nodes that DataBrew can use when the job
processes data.
$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.
$sel:timeout: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
.
$sel:jobSample: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.
$sel:name:UpdateProfileJob'
, updateProfileJob_name
- The name of the job to be updated.
$sel:outputLocation:UpdateProfileJob'
, updateProfileJob_outputLocation
- Undocumented member.
$sel:roleArn: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.
Instances
newUpdateProfileJobResponse Source #
:: 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.
$sel:name:UpdateProfileJob'
, updateProfileJobResponse_name
- The name of the job that was updated.
DescribeRecipe
data DescribeRecipe Source #
See: newDescribeRecipe
smart constructor.
Instances
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:
$sel:recipeVersion:DescribeRecipe'
, describeRecipe_recipeVersion
- The recipe version identifier. If this parameter isn't specified, then
the latest published version is returned.
$sel:name:DescribeRecipe'
, describeRecipe_name
- The name of the recipe to be described.
data DescribeRecipeResponse Source #
See: newDescribeRecipeResponse
smart constructor.
DescribeRecipeResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int Text |
Instances
newDescribeRecipeResponse Source #
:: 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:
$sel:lastModifiedDate:DescribeRecipeResponse'
, describeRecipeResponse_lastModifiedDate
- The date and time that the recipe was last modified.
$sel:createDate:DescribeRecipeResponse'
, describeRecipeResponse_createDate
- The date and time that the recipe was created.
$sel:publishedBy:DescribeRecipeResponse'
, describeRecipeResponse_publishedBy
- The identifier (user name) of the user who last published the recipe.
$sel:createdBy:DescribeRecipeResponse'
, describeRecipeResponse_createdBy
- The identifier (user name) of the user who created the recipe.
$sel:steps: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.
$sel:publishedDate:DescribeRecipeResponse'
, describeRecipeResponse_publishedDate
- The date and time when the recipe was last published.
$sel:resourceArn:DescribeRecipeResponse'
, describeRecipeResponse_resourceArn
- The ARN of the recipe.
$sel:recipeVersion:DescribeRecipe'
, describeRecipeResponse_recipeVersion
- The recipe version identifier.
$sel:projectName:DescribeRecipeResponse'
, describeRecipeResponse_projectName
- The name of the project associated with this recipe.
$sel:lastModifiedBy:DescribeRecipeResponse'
, describeRecipeResponse_lastModifiedBy
- The identifier (user name) of the user who last modified the recipe.
$sel:description:DescribeRecipeResponse'
, describeRecipeResponse_description
- The description of the recipe.
$sel:tags:DescribeRecipeResponse'
, describeRecipeResponse_tags
- Metadata tags associated with this project.
$sel:httpStatus:DescribeRecipeResponse'
, describeRecipeResponse_httpStatus
- The response's http status code.
$sel:name:DescribeRecipe'
, describeRecipeResponse_name
- The name of the recipe.
CreateProfileJob
data CreateProfileJob Source #
See: newCreateProfileJob
smart constructor.
Instances
:: 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:encryptionMode: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.
$sel:logSubscription: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.
$sel:maxRetries:CreateProfileJob'
, createProfileJob_maxRetries
- The maximum number of times to retry the job after a job run fails.
$sel:encryptionKeyArn:CreateProfileJob'
, createProfileJob_encryptionKeyArn
- The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
$sel:maxCapacity:CreateProfileJob'
, createProfileJob_maxCapacity
- The maximum number of nodes that DataBrew can use when the job processes
data.
$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.
$sel:timeout: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
.
$sel:tags:CreateProfileJob'
, createProfileJob_tags
- Metadata tags to apply to this job.
$sel:jobSample: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.
$sel:datasetName:CreateProfileJob'
, createProfileJob_datasetName
- The name of the dataset that this job is to act upon.
$sel:name: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.
$sel:roleArn: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.
Instances
newCreateProfileJobResponse Source #
:: 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.
$sel:name:CreateProfileJob'
, createProfileJobResponse_name
- The name of the job that was created.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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:
$sel:resourceArn: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.
$sel:tags:TagResource'
, tagResource_tags
- One or more tags to be assigned to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
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.
DescribeSchedule
data DescribeSchedule Source #
See: newDescribeSchedule
smart constructor.
Instances
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:
$sel:name:DescribeSchedule'
, describeSchedule_name
- The name of the schedule to be described.
data DescribeScheduleResponse Source #
See: newDescribeScheduleResponse
smart constructor.
DescribeScheduleResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) Int Text |
Instances
newDescribeScheduleResponse Source #
:: 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:
$sel:lastModifiedDate:DescribeScheduleResponse'
, describeScheduleResponse_lastModifiedDate
- The date and time that the schedule was last modified.
$sel:createDate:DescribeScheduleResponse'
, describeScheduleResponse_createDate
- The date and time that the schedule was created.
$sel:createdBy:DescribeScheduleResponse'
, describeScheduleResponse_createdBy
- The identifier (user name) of the user who created the schedule.
$sel:resourceArn:DescribeScheduleResponse'
, describeScheduleResponse_resourceArn
- The Amazon Resource Name (ARN) of the schedule.
$sel:cronExpression: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.
$sel:lastModifiedBy:DescribeScheduleResponse'
, describeScheduleResponse_lastModifiedBy
- The identifier (user name) of the user who last modified the schedule.
$sel:jobNames:DescribeScheduleResponse'
, describeScheduleResponse_jobNames
- The name or names of one or more jobs to be run by using the schedule.
$sel:tags:DescribeScheduleResponse'
, describeScheduleResponse_tags
- Metadata tags associated with this schedule.
$sel:httpStatus:DescribeScheduleResponse'
, describeScheduleResponse_httpStatus
- The response's http status code.
$sel:name:DescribeSchedule'
, describeScheduleResponse_name
- The name of the schedule.
DescribeJobRun
data DescribeJobRun Source #
See: newDescribeJobRun
smart constructor.
Instances
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:
$sel:name:DescribeJobRun'
, describeJobRun_name
- The name of the job being processed during this run.
$sel:runId:DescribeJobRun'
, describeJobRun_runId
- The unique identifier of the job run.
data DescribeJobRunResponse Source #
See: newDescribeJobRunResponse
smart constructor.
DescribeJobRunResponse' (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty DataCatalogOutput)) (Maybe POSIX) (Maybe RecipeReference) (Maybe ProfileConfiguration) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe Int) (Maybe LogSubscription) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobSample) Int Text |
Instances
newDescribeJobRunResponse Source #
:: 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:
$sel:completedOn:DescribeJobRunResponse'
, describeJobRunResponse_completedOn
- The date and time when the job completed processing.
$sel:state:DescribeJobRunResponse'
, describeJobRunResponse_state
- The current state of the job run entity itself.
$sel:dataCatalogOutputs:DescribeJobRunResponse'
, describeJobRunResponse_dataCatalogOutputs
- One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:startedOn:DescribeJobRunResponse'
, describeJobRunResponse_startedOn
- The date and time when the job run began.
$sel:recipeReference:DescribeJobRunResponse'
, describeJobRunResponse_recipeReference
- Undocumented member.
$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.
$sel:databaseOutputs:DescribeJobRunResponse'
, describeJobRunResponse_databaseOutputs
- Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
$sel:logGroupName:DescribeJobRunResponse'
, describeJobRunResponse_logGroupName
- The name of an Amazon CloudWatch log group, where the job writes
diagnostic messages when it runs.
$sel:outputs:DescribeJobRunResponse'
, describeJobRunResponse_outputs
- One or more output artifacts from a job run.
$sel:runId:DescribeJobRun'
, describeJobRunResponse_runId
- The unique identifier of the job run.
$sel:executionTime:DescribeJobRunResponse'
, describeJobRunResponse_executionTime
- The amount of time, in seconds, during which the job run consumed
resources.
$sel:logSubscription:DescribeJobRunResponse'
, describeJobRunResponse_logSubscription
- The current status of Amazon CloudWatch logging for the job run.
$sel:startedBy:DescribeJobRunResponse'
, describeJobRunResponse_startedBy
- The Amazon Resource Name (ARN) of the user who started the job run.
$sel:datasetName:DescribeJobRunResponse'
, describeJobRunResponse_datasetName
- The name of the dataset for the job to process.
$sel:attempt:DescribeJobRunResponse'
, describeJobRunResponse_attempt
- The number of times that DataBrew has attempted to run the job.
$sel:errorMessage:DescribeJobRunResponse'
, describeJobRunResponse_errorMessage
- A message indicating an error (if any) that was encountered when the job
ran.
$sel:jobSample: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.
$sel:httpStatus:DescribeJobRunResponse'
, describeJobRunResponse_httpStatus
- The response's http status code.
$sel:jobName:DescribeJobRunResponse'
, describeJobRunResponse_jobName
- The name of the job being processed during this run.
StartProjectSession
data StartProjectSession Source #
See: newStartProjectSession
smart constructor.
Instances
newStartProjectSession Source #
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.
$sel:name:StartProjectSession'
, startProjectSession_name
- The name of the project to act upon.
data StartProjectSessionResponse Source #
See: newStartProjectSessionResponse
smart constructor.
Instances
newStartProjectSessionResponse Source #
:: 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.
$sel:name:StartProjectSession'
, startProjectSessionResponse_name
- The name of the project to be acted upon.
DeleteRecipeVersion
data DeleteRecipeVersion Source #
See: newDeleteRecipeVersion
smart constructor.
Instances
newDeleteRecipeVersion Source #
:: 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:
$sel:name:DeleteRecipeVersion'
, deleteRecipeVersion_name
- The name of the recipe.
$sel:recipeVersion: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.
Instances
newDeleteRecipeVersionResponse Source #
:: 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.
$sel:name:DeleteRecipeVersion'
, deleteRecipeVersionResponse_name
- The name of the recipe that was deleted.
$sel:recipeVersion:DeleteRecipeVersion'
, deleteRecipeVersionResponse_recipeVersion
- The version of the recipe that was deleted.
ListDatasets (Paginated)
data ListDatasets Source #
See: newListDatasets
smart constructor.
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:nextToken:ListDatasets'
, listDatasets_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:maxResults:ListDatasets'
, listDatasets_maxResults
- The maximum number of results to return in this request.
data ListDatasetsResponse Source #
See: newListDatasetsResponse
smart constructor.
Instances
newListDatasetsResponse Source #
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:
$sel:nextToken: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.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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:
$sel:resourceArn: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.
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.
StartJobRun
data StartJobRun Source #
See: newStartJobRun
smart constructor.
Instances
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:
$sel:name:StartJobRun'
, startJobRun_name
- The name of the job to be run.
data StartJobRunResponse Source #
See: newStartJobRunResponse
smart constructor.
Instances
newStartJobRunResponse Source #
:: Int | |
-> Text | |
-> StartJobRunResponse |
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.
$sel:runId:StartJobRunResponse'
, startJobRunResponse_runId
- A system-generated identifier for this particular job run.
UpdateRecipe
data UpdateRecipe Source #
See: newUpdateRecipe
smart constructor.
UpdateRecipe' (Maybe [RecipeStep]) (Maybe Text) Text |
Instances
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:
$sel:steps: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.
$sel:description:UpdateRecipe'
, updateRecipe_description
- A description of the recipe.
$sel:name:UpdateRecipe'
, updateRecipe_name
- The name of the recipe to be updated.
data UpdateRecipeResponse Source #
See: newUpdateRecipeResponse
smart constructor.
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.
$sel:name:UpdateRecipe'
, updateRecipeResponse_name
- The name of the recipe that was updated.
CreateSchedule
data CreateSchedule Source #
See: newCreateSchedule
smart constructor.
Instances
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:
$sel:jobNames:CreateSchedule'
, createSchedule_jobNames
- The name or names of one or more jobs to be run.
$sel:tags:CreateSchedule'
, createSchedule_tags
- Metadata tags to apply to this schedule.
$sel:cronExpression: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.
$sel:name: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.
Instances
newCreateScheduleResponse Source #
:: 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.
$sel:name:CreateSchedule'
, createScheduleResponse_name
- The name of the schedule that was created.
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:nextToken:ListRecipes'
, listRecipes_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:recipeVersion: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
$sel:maxResults:ListRecipes'
, listRecipes_maxResults
- The maximum number of results to return in this request.
data ListRecipesResponse Source #
See: newListRecipesResponse
smart constructor.
Instances
newListRecipesResponse Source #
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:
$sel:nextToken: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.
PublishRecipe
data PublishRecipe Source #
See: newPublishRecipe
smart constructor.
Instances
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:
$sel:description:PublishRecipe'
, publishRecipe_description
- A description of the recipe to be published, for this version of the
recipe.
$sel:name:PublishRecipe'
, publishRecipe_name
- The name of the recipe to be published.
data PublishRecipeResponse Source #
See: newPublishRecipeResponse
smart constructor.
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.
$sel:name:PublishRecipe'
, publishRecipeResponse_name
- The name of the recipe that you published.
CreateProject
data CreateProject Source #
See: newCreateProject
smart constructor.
Instances
:: 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:
$sel:sample:CreateProject'
, createProject_sample
- Undocumented member.
$sel:tags:CreateProject'
, createProject_tags
- Metadata tags to apply to this project.
$sel:datasetName:CreateProject'
, createProject_datasetName
- The name of an existing dataset to associate this project with.
$sel:name:CreateProject'
, createProject_name
- A unique name for the new project. Valid characters are alphanumeric
(A-Z, a-z, 0-9), hyphen (-), period (.), and space.
$sel:recipeName:CreateProject'
, createProject_recipeName
- The name of an existing recipe to associate with the project.
$sel:roleArn: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.
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.
$sel:name:CreateProject'
, createProjectResponse_name
- The name of the project that you created.
SendProjectSessionAction
data SendProjectSessionAction Source #
See: newSendProjectSessionAction
smart constructor.
SendProjectSessionAction' (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe RecipeStep) (Maybe ViewFrame) Text |
Instances
newSendProjectSessionAction Source #
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: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:preview:SendProjectSessionAction'
, sendProjectSessionAction_preview
- If true, the result of the recipe step will be returned, but not
applied.
$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:recipeStep:SendProjectSessionAction'
, sendProjectSessionAction_recipeStep
- Undocumented member.
$sel:viewFrame:SendProjectSessionAction'
, sendProjectSessionAction_viewFrame
- Undocumented member.
$sel:name:SendProjectSessionAction'
, sendProjectSessionAction_name
- The name of the project to apply the action to.
data SendProjectSessionActionResponse Source #
See: newSendProjectSessionActionResponse
smart constructor.
Instances
newSendProjectSessionActionResponse Source #
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.
$sel:name:SendProjectSessionAction'
, sendProjectSessionActionResponse_name
- The name of the project that was affected by the action.
Types
CompressionFormat
newtype CompressionFormat Source #
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 #
pattern DatabaseOutputMode_NEW_TABLE :: DatabaseOutputMode |
Instances
EncryptionMode
newtype EncryptionMode Source #
pattern EncryptionMode_SSE_KMS :: EncryptionMode | |
pattern EncryptionMode_SSE_S3 :: EncryptionMode |
Instances
InputFormat
newtype InputFormat Source #
pattern InputFormat_CSV :: InputFormat | |
pattern InputFormat_EXCEL :: InputFormat | |
pattern InputFormat_JSON :: InputFormat | |
pattern InputFormat_PARQUET :: InputFormat |
Instances
JobRunState
newtype JobRunState Source #
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
pattern JobType_PROFILE :: JobType | |
pattern JobType_RECIPE :: JobType |
Instances
LogSubscription
newtype LogSubscription Source #
pattern LogSubscription_DISABLE :: LogSubscription | |
pattern LogSubscription_ENABLE :: LogSubscription |
Instances
Order
pattern Order_ASCENDING :: Order | |
pattern Order_DESCENDING :: Order |
Instances
OrderedBy
pattern OrderedBy_LAST_MODIFIED_DATE :: OrderedBy |
Instances
OutputFormat
newtype OutputFormat Source #
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 #
pattern ParameterType_Datetime :: ParameterType | |
pattern ParameterType_Number :: ParameterType | |
pattern ParameterType_String :: ParameterType |
Instances
SampleMode
newtype SampleMode Source #
pattern SampleMode_CUSTOM_ROWS :: SampleMode | |
pattern SampleMode_FULL_DATASET :: SampleMode |
Instances
SampleType
newtype SampleType Source #
pattern SampleType_FIRST_N :: SampleType | |
pattern SampleType_LAST_N :: SampleType | |
pattern SampleType_RANDOM :: SampleType |
Instances
SessionStatus
newtype SessionStatus Source #
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
pattern Source_DATABASE :: Source | |
pattern Source_DATA_CATALOG :: Source | |
pattern Source_S3 :: Source |
Instances
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.
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:regex:ColumnSelector'
, columnSelector_regex
- A regular expression for selecting a column from a dataset.
$sel:name:ColumnSelector'
, columnSelector_name
- The name of 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.
Instances
newColumnStatisticsConfiguration Source #
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.
Instances
newConditionExpression Source #
:: 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.
CsvOptions' (Maybe Bool) (Maybe Text) |
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: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.
$sel:delimiter:CsvOptions'
, csvOptions_delimiter
- A single character that specifies the delimiter being used in the CSV
file.
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.
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.
Instances
newDataCatalogInputDefinition Source #
:: 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:tempDirectory:DataCatalogInputDefinition'
, dataCatalogInputDefinition_tempDirectory
- Represents an Amazon location where DataBrew can store intermediate
results.
$sel:catalogId:DataCatalogInputDefinition'
, dataCatalogInputDefinition_catalogId
- The unique identifier of the Amazon Web Services account that holds the
Data Catalog that stores the data.
$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.
DataCatalogOutput' (Maybe DatabaseTableOutputOptions) (Maybe S3TableOutputOptions) (Maybe Text) (Maybe Bool) Text Text |
Instances
:: Text | |
-> Text | |
-> DataCatalogOutput |
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:databaseOptions:DataCatalogOutput'
, dataCatalogOutput_databaseOptions
- Represents options that specify how and where DataBrew writes the
database output generated by recipe jobs.
$sel:s3Options:DataCatalogOutput'
, dataCatalogOutput_s3Options
- Represents options that specify how and where DataBrew writes the Amazon
S3 output generated by recipe jobs.
$sel:catalogId:DataCatalogOutput'
, dataCatalogOutput_catalogId
- The unique identifier of the Amazon Web Services account that holds the
Data Catalog that stores the data.
$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:databaseName:DataCatalogOutput'
, dataCatalogOutput_databaseName
- The name of a database in the Data Catalog.
$sel:tableName: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.
Instances
newDatabaseInputDefinition Source #
:: Text | |
-> Text | |
-> DatabaseInputDefinition |
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:tempDirectory:DatabaseInputDefinition'
, databaseInputDefinition_tempDirectory
- Undocumented member.
$sel:glueConnectionName:DatabaseInputDefinition'
, databaseInputDefinition_glueConnectionName
- The Glue Connection that stores the connection information for the
target database.
$sel:databaseTableName:DatabaseInputDefinition'
, databaseInputDefinition_databaseTableName
- The table within 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.
Instances
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.
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.
Dataset' (Maybe POSIX) (Maybe PathOptions) (Maybe POSIX) (Maybe FormatOptions) (Maybe InputFormat) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Source) (Maybe Text) (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: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:createDate:Dataset'
, dataset_createDate
- The date and time that the dataset was created.
$sel:formatOptions:Dataset'
, dataset_formatOptions
- A set of options that define how DataBrew interprets the data in the
dataset.
$sel:format:Dataset'
, dataset_format
- The file format of a dataset that is created from an Amazon S3 file or
folder.
$sel:createdBy:Dataset'
, dataset_createdBy
- The Amazon Resource Name (ARN) of the user who created the dataset.
$sel:accountId:Dataset'
, dataset_accountId
- The ID of the Amazon Web Services account that owns 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:lastModifiedBy:Dataset'
, dataset_lastModifiedBy
- The Amazon Resource Name (ARN) of the user who last modified the
dataset.
$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 paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
See: newDatasetParameter
smart constructor.
Instances
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:filter':DatasetParameter'
, datasetParameter_filter
- The optional filter expression structure to apply additional matching
criteria to the parameter.
$sel:datetimeOptions:DatasetParameter'
, datasetParameter_datetimeOptions
- Additional parameter options such as a format and a timezone. Required
for datetime parameters.
$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
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: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:localeCode:DatetimeOptions'
, datetimeOptions_localeCode
- Optional value for a non-US locale code, needed for correct
interpretation of some date formats.
$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".
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: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.
$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.
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
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: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: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. Anotherpossible value is ASCENDING.
$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.
Instances
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.
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:json:FormatOptions'
, formatOptions_json
- Options that define how JSON input is to be interpreted by DataBrew.
$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.
Input
Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.
See: newInput
smart constructor.
Instances
Eq Input Source # | |
Read Input Source # | |
Show Input Source # | |
Generic Input Source # | |
NFData Input Source # | |
Defined in Amazonka.DataBrew.Types.Input | |
Hashable Input Source # | |
Defined in Amazonka.DataBrew.Types.Input | |
ToJSON Input Source # | |
Defined in Amazonka.DataBrew.Types.Input | |
FromJSON Input Source # | |
type Rep Input Source # | |
Defined in Amazonka.DataBrew.Types.Input type Rep Input = D1 ('MetaData "Input" "Amazonka.DataBrew.Types.Input" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "Input'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataCatalogInputDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataCatalogInputDefinition)) :*: (S1 ('MetaSel ('Just "s3InputDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Location)) :*: S1 ('MetaSel ('Just "databaseInputDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatabaseInputDefinition))))) |
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:s3InputDefinition:Input'
, input_s3InputDefinition
- The Amazon S3 location where the data is stored.
$sel:databaseInputDefinition:Input'
, input_databaseInputDefinition
- Connection information for dataset input files stored in a database.
Job
Represents all of the attributes of a DataBrew job.
See: newJob
smart constructor.
Job' (Maybe (NonEmpty DataCatalogOutput)) (Maybe POSIX) (Maybe POSIX) (Maybe RecipeReference) (Maybe Text) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe EncryptionMode) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe LogSubscription) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobType) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe JobSample) 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:dataCatalogOutputs:Job'
, job_dataCatalogOutputs
- One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:lastModifiedDate:Job'
, job_lastModifiedDate
- The modification date and time of the job.
$sel:createDate:Job'
, job_createDate
- The date and time that the job was created.
$sel:recipeReference:Job'
, job_recipeReference
- A set of steps that the job runs.
$sel:createdBy:Job'
, job_createdBy
- The Amazon Resource Name (ARN) of the user who created 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:accountId:Job'
, job_accountId
- The ID of the Amazon Web Services account that owns the job.
$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:outputs:Job'
, job_outputs
- One or more artifacts that represent output from running the job.
$sel:resourceArn:Job'
, job_resourceArn
- The unique Amazon Resource Name (ARN) for the job.
$sel:logSubscription:Job'
, job_logSubscription
- The current status of Amazon CloudWatch logging for the job.
$sel:projectName:Job'
, job_projectName
- The name of the project that the job is associated with.
$sel:maxRetries:Job'
, job_maxRetries
- The maximum number of times to retry the job after a job run fails.
$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:maxCapacity:Job'
, job_maxCapacity
- The maximum number of nodes that can be consumed when the job processes
data.
$sel:lastModifiedBy:Job'
, job_lastModifiedBy
- The Amazon Resource Name (ARN) of the user who last modified the job.
$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: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:tags:Job'
, job_tags
- Metadata tags that have been applied to the job.
$sel:roleArn:Job'
, job_roleArn
- The Amazon Resource Name (ARN) of the role to be assumed for this job.
$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:name:Job'
, job_name
- The unique name of the job.
JobRun
Represents one run of a DataBrew job.
See: newJobRun
smart constructor.
JobRun' (Maybe POSIX) (Maybe JobRunState) (Maybe (NonEmpty DataCatalogOutput)) (Maybe Text) (Maybe POSIX) (Maybe RecipeReference) (Maybe (NonEmpty DatabaseOutput)) (Maybe Text) (Maybe (NonEmpty Output)) (Maybe Text) (Maybe Int) (Maybe LogSubscription) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobSample) |
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:completedOn:JobRun'
, jobRun_completedOn
- The date and time when the job completed processing.
$sel:state:JobRun'
, jobRun_state
- The current state of the job run entity itself.
$sel:dataCatalogOutputs:JobRun'
, jobRun_dataCatalogOutputs
- One or more artifacts that represent the Glue Data Catalog output from
running the job.
$sel:jobName:JobRun'
, jobRun_jobName
- The name of the job being processed during this run.
$sel:startedOn:JobRun'
, jobRun_startedOn
- The date and time when the job run began.
$sel:recipeReference:JobRun'
, jobRun_recipeReference
- The set of steps processed by 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:logGroupName:JobRun'
, jobRun_logGroupName
- The name of an Amazon CloudWatch log group, where the job writes
diagnostic messages when it runs.
$sel:outputs:JobRun'
, jobRun_outputs
- One or more output artifacts from a job run.
$sel:runId:JobRun'
, jobRun_runId
- The unique identifier of the job run.
$sel:executionTime:JobRun'
, jobRun_executionTime
- The amount of time, in seconds, during which a job run consumed
resources.
$sel:logSubscription:JobRun'
, jobRun_logSubscription
- The current status of Amazon CloudWatch logging for the job run.
$sel:startedBy:JobRun'
, jobRun_startedBy
- The Amazon Resource Name (ARN) of the user who initiated the job run.
$sel:datasetName:JobRun'
, jobRun_datasetName
- The name of the dataset for the job to process.
$sel:attempt:JobRun'
, jobRun_attempt
- The number of times that DataBrew has attempted to run the job.
$sel:errorMessage:JobRun'
, jobRun_errorMessage
- A message indicating an error (if any) that was encountered when the job
ran.
$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.
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.
Instances
Eq JobSample Source # | |
Read JobSample Source # | |
Show JobSample Source # | |
Generic JobSample Source # | |
NFData JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample | |
Hashable JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample | |
ToJSON JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample | |
FromJSON JobSample Source # | |
type Rep JobSample Source # | |
Defined in Amazonka.DataBrew.Types.JobSample type Rep JobSample = D1 ('MetaData "JobSample" "Amazonka.DataBrew.Types.JobSample" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "JobSample'" 'PrefixI 'True) (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SampleMode)))) |
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: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
$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
Size
parameter.
JsonOptions
data JsonOptions Source #
Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew.
See: newJsonOptions
smart constructor.
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.
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.
Output' (Maybe [Text]) (Maybe OutputFormatOptions) (Maybe OutputFormat) (Maybe CompressionFormat) (Maybe Bool) S3Location |
Instances
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:partitionColumns:Output'
, output_partitionColumns
- The names of one or more partition columns for the output of the job.
$sel:formatOptions:Output'
, output_formatOptions
- Represents options that define how DataBrew formats job output files.
$sel:format:Output'
, output_format
- The data format of the output of the job.
$sel:compressionFormat:Output'
, output_compressionFormat
- The compression algorithm used to compress the output text of the job.
$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: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.
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.
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: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.
$sel:filesLimit:PathOptions'
, pathOptions_filesLimit
- If provided, this structure imposes a limit on a number of files that
should be selected.
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.
ProfileConfiguration' (Maybe StatisticsConfiguration) (Maybe (NonEmpty ColumnStatisticsConfiguration)) (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: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: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: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.
Project' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Sample) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe 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: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: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:accountId:Project'
, project_accountId
- The ID of the Amazon Web Services account that owns the project.
$sel:resourceArn:Project'
, project_resourceArn
- The Amazon Resource Name (ARN) for 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: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:openedBy:Project'
, project_openedBy
- The Amazon Resource Name (ARN) of the user that opened the project for
use.
$sel:tags:Project'
, project_tags
- Metadata tags that have been applied to the project.
$sel:roleArn:Project'
, project_roleArn
- The Amazon Resource Name (ARN) of the role that will be assumed for this
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.
Recipe' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [RecipeStep]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (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:lastModifiedDate:Recipe'
, recipe_lastModifiedDate
- The last modification date and time of the recipe.
$sel:createDate:Recipe'
, recipe_createDate
- The date and time that the recipe was created.
$sel:publishedBy:Recipe'
, recipe_publishedBy
- The Amazon Resource Name (ARN) of the user who published the recipe.
$sel:createdBy:Recipe'
, recipe_createdBy
- The Amazon Resource Name (ARN) of the user who created the recipe.
$sel:steps:Recipe'
, recipe_steps
- A list of steps that are defined by the recipe.
$sel:publishedDate:Recipe'
, recipe_publishedDate
- The date and time when the recipe was published.
$sel:resourceArn:Recipe'
, recipe_resourceArn
- The Amazon Resource Name (ARN) for the recipe.
$sel:recipeVersion:Recipe'
, recipe_recipeVersion
- The identifier for the version for the recipe. Must be one of the
following:
- Numeric version (
X.Y
) -X
andY
stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. BothX
andY
are 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:projectName:Recipe'
, recipe_projectName
- The name of the project that the recipe is associated with.
$sel:lastModifiedBy:Recipe'
, recipe_lastModifiedBy
- The Amazon Resource Name (ARN) of the user who last modified the recipe.
$sel:description:Recipe'
, recipe_description
- The description of 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
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.
Instances
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.
Instances
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:recipeVersion:RecipeVersionErrorDetail'
, recipeVersionErrorDetail_recipeVersion
- The identifier for the recipe version associated with this error.
$sel:errorCode:RecipeVersionErrorDetail'
, recipeVersionErrorDetail_errorCode
- The HTTP status code for the error.
$sel:errorMessage:RecipeVersionErrorDetail'
, recipeVersionErrorDetail_errorMessage
- The text of the error message.
S3Location
data S3Location Source #
Represents an Amazon S3 location (bucket name and object key) where DataBrew can read input data, or write output from a job.
See: newS3Location
smart constructor.
Instances
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: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.
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.
Instances
Eq Sample Source # | |
Read Sample Source # | |
Show Sample Source # | |
Generic Sample Source # | |
NFData Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample | |
Hashable Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample | |
ToJSON Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample | |
FromJSON Sample Source # | |
type Rep Sample Source # | |
Defined in Amazonka.DataBrew.Types.Sample type Rep Sample = D1 ('MetaData "Sample" "Amazonka.DataBrew.Types.Sample" "libZSservicesZSamazonka-databrewZSamazonka-databrew" '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))) |
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.
Schedule' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (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:lastModifiedDate:Schedule'
, schedule_lastModifiedDate
- The date and time when the schedule was last modified.
$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:accountId:Schedule'
, schedule_accountId
- The ID of the Amazon Web Services account that owns the schedule.
$sel:resourceArn:Schedule'
, schedule_resourceArn
- The Amazon Resource Name (ARN) of 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:lastModifiedBy:Schedule'
, schedule_lastModifiedBy
- The Amazon Resource Name (ARN) of the user who last modified the
schedule.
$sel:jobNames:Schedule'
, schedule_jobNames
- A list of jobs to be run, according to 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.
Instances
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.
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:overrides:StatisticsConfiguration'
, statisticsConfiguration_overrides
- List of overrides for evaluations.
$sel:includedStatistics:StatisticsConfiguration'
, statisticsConfiguration_includedStatistics
- List of included evaluations. When the list is undefined, all supported
evaluations will be included.
ViewFrame
Represents the data being transformed during an action.
See: newViewFrame
smart constructor.
Instances
Eq ViewFrame Source # | |
Read ViewFrame Source # | |
Show ViewFrame Source # | |
Generic ViewFrame Source # | |
NFData ViewFrame Source # | |
Defined in Amazonka.DataBrew.Types.ViewFrame | |
Hashable ViewFrame Source # | |
Defined in Amazonka.DataBrew.Types.ViewFrame | |
ToJSON ViewFrame Source # | |
Defined in Amazonka.DataBrew.Types.ViewFrame | |
type Rep ViewFrame Source # | |
Defined in Amazonka.DataBrew.Types.ViewFrame type Rep ViewFrame = D1 ('MetaData "ViewFrame" "Amazonka.DataBrew.Types.ViewFrame" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "ViewFrame'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hiddenColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "columnRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "startColumnIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))) |
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:hiddenColumns:ViewFrame'
, viewFrame_hiddenColumns
- A list of columns to hide in the view frame.
$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:startColumnIndex:ViewFrame'
, viewFrame_startColumnIndex
- The starting index for the range of columns to return in the view frame.