libZSservicesZSamazonka-databrewZSamazonka-databrew
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataBrew.Lens

Description

 
Synopsis

Operations

ListProjects

listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #

The maximum number of results to return in this request.

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int Source #

The response's http status code.

listProjectsResponse_projects :: Lens' ListProjectsResponse [Project] Source #

A list of projects that are defined .

DeleteProject

deleteProject_name :: Lens' DeleteProject Text Source #

The name of the project to be deleted.

deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int Source #

The response's http status code.

deleteProjectResponse_name :: Lens' DeleteProjectResponse Text Source #

The name of the project that you deleted.

UpdateProject

updateProject_sample :: Lens' UpdateProject (Maybe Sample) Source #

Undocumented member.

updateProject_roleArn :: Lens' UpdateProject Text Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.

updateProject_name :: Lens' UpdateProject Text Source #

The name of the project to be updated.

updateProjectResponse_lastModifiedDate :: Lens' UpdateProjectResponse (Maybe UTCTime) Source #

The date and time that the project was last modified.

updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int Source #

The response's http status code.

updateProjectResponse_name :: Lens' UpdateProjectResponse Text Source #

The name of the project that you updated.

ListSchedules

listSchedules_jobName :: Lens' ListSchedules (Maybe Text) Source #

The name of the job that these schedules apply to.

listSchedules_nextToken :: Lens' ListSchedules (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listSchedules_maxResults :: Lens' ListSchedules (Maybe Natural) Source #

The maximum number of results to return in this request.

listSchedulesResponse_nextToken :: Lens' ListSchedulesResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listSchedulesResponse_httpStatus :: Lens' ListSchedulesResponse Int Source #

The response's http status code.

listSchedulesResponse_schedules :: Lens' ListSchedulesResponse [Schedule] Source #

A list of schedules that are defined.

DescribeDataset

describeDataset_name :: Lens' DescribeDataset Text Source #

The name of the dataset to be described.

describeDatasetResponse_lastModifiedDate :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #

The date and time that the dataset was last modified.

describeDatasetResponse_pathOptions :: Lens' DescribeDatasetResponse (Maybe PathOptions) Source #

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

describeDatasetResponse_createDate :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #

The date and time that the dataset was created.

describeDatasetResponse_formatOptions :: Lens' DescribeDatasetResponse (Maybe FormatOptions) Source #

Undocumented member.

describeDatasetResponse_format :: Lens' DescribeDatasetResponse (Maybe InputFormat) Source #

The file format of a dataset that is created from an Amazon S3 file or folder.

describeDatasetResponse_createdBy :: Lens' DescribeDatasetResponse (Maybe Text) Source #

The identifier (user name) of the user who created the dataset.

describeDatasetResponse_resourceArn :: Lens' DescribeDatasetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

describeDatasetResponse_source :: Lens' DescribeDatasetResponse (Maybe Source) Source #

The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.

describeDatasetResponse_lastModifiedBy :: Lens' DescribeDatasetResponse (Maybe Text) Source #

The identifier (user name) of the user who last modified the dataset.

describeDatasetResponse_tags :: Lens' DescribeDatasetResponse (Maybe (HashMap Text Text)) Source #

Metadata tags associated with this dataset.

describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int Source #

The response's http status code.

describeDatasetResponse_name :: Lens' DescribeDatasetResponse Text Source #

The name of the dataset.

describeDatasetResponse_input :: Lens' DescribeDatasetResponse Input Source #

Undocumented member.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

A list of tags associated with the DataBrew resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

DescribeProject

describeProject_name :: Lens' DescribeProject Text Source #

The name of the project to be described.

describeProjectResponse_lastModifiedDate :: Lens' DescribeProjectResponse (Maybe UTCTime) Source #

The date and time that the project was last modified.

describeProjectResponse_sessionStatus :: Lens' DescribeProjectResponse (Maybe SessionStatus) Source #

Describes the current state of the session:

  • PROVISIONING - allocating resources for the session.
  • INITIALIZING - getting the session ready for first use.
  • ASSIGNED - the session is ready for use.

describeProjectResponse_openDate :: Lens' DescribeProjectResponse (Maybe UTCTime) Source #

The date and time when the project was opened.

describeProjectResponse_createDate :: Lens' DescribeProjectResponse (Maybe UTCTime) Source #

The date and time that the project was created.

describeProjectResponse_createdBy :: Lens' DescribeProjectResponse (Maybe Text) Source #

The identifier (user name) of the user who created the project.

describeProjectResponse_resourceArn :: Lens' DescribeProjectResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project.

describeProjectResponse_recipeName :: Lens' DescribeProjectResponse (Maybe Text) Source #

The recipe associated with this job.

describeProjectResponse_datasetName :: Lens' DescribeProjectResponse (Maybe Text) Source #

The dataset associated with the project.

describeProjectResponse_lastModifiedBy :: Lens' DescribeProjectResponse (Maybe Text) Source #

The identifier (user name) of the user who last modified the project.

describeProjectResponse_sample :: Lens' DescribeProjectResponse (Maybe Sample) Source #

Undocumented member.

describeProjectResponse_openedBy :: Lens' DescribeProjectResponse (Maybe Text) Source #

The identifier (user name) of the user that opened the project for use.

describeProjectResponse_tags :: Lens' DescribeProjectResponse (Maybe (HashMap Text Text)) Source #

Metadata tags associated with this project.

describeProjectResponse_roleArn :: Lens' DescribeProjectResponse (Maybe Text) Source #

The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int Source #

The response's http status code.

describeProjectResponse_name :: Lens' DescribeProjectResponse Text Source #

The name of the project.

CreateRecipeJob

createRecipeJob_dataCatalogOutputs :: Lens' CreateRecipeJob (Maybe (NonEmpty DataCatalogOutput)) Source #

One or more artifacts that represent the Glue Data Catalog output from running the job.

createRecipeJob_recipeReference :: Lens' CreateRecipeJob (Maybe RecipeReference) Source #

Undocumented member.

createRecipeJob_databaseOutputs :: Lens' CreateRecipeJob (Maybe (NonEmpty DatabaseOutput)) Source #

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

createRecipeJob_encryptionMode :: Lens' CreateRecipeJob (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with keys managed by KMS.
  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

createRecipeJob_outputs :: Lens' CreateRecipeJob (Maybe (NonEmpty Output)) Source #

One or more artifacts that represent the output from running the job.

createRecipeJob_logSubscription :: Lens' CreateRecipeJob (Maybe LogSubscription) Source #

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

createRecipeJob_projectName :: Lens' CreateRecipeJob (Maybe Text) Source #

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

createRecipeJob_maxRetries :: Lens' CreateRecipeJob (Maybe Natural) Source #

The maximum number of times to retry the job after a job run fails.

createRecipeJob_datasetName :: Lens' CreateRecipeJob (Maybe Text) Source #

The name of the dataset that this job processes.

createRecipeJob_encryptionKeyArn :: Lens' CreateRecipeJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

createRecipeJob_maxCapacity :: Lens' CreateRecipeJob (Maybe Int) Source #

The maximum number of nodes that DataBrew can consume when the job processes data.

createRecipeJob_timeout :: Lens' CreateRecipeJob (Maybe Natural) Source #

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

createRecipeJob_tags :: Lens' CreateRecipeJob (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this job.

createRecipeJob_name :: Lens' CreateRecipeJob Text Source #

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createRecipeJob_roleArn :: Lens' CreateRecipeJob Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

createRecipeJobResponse_httpStatus :: Lens' CreateRecipeJobResponse Int Source #

The response's http status code.

createRecipeJobResponse_name :: Lens' CreateRecipeJobResponse Text Source #

The name of the job that you created.

ListRecipeVersions

listRecipeVersions_nextToken :: Lens' ListRecipeVersions (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listRecipeVersions_maxResults :: Lens' ListRecipeVersions (Maybe Natural) Source #

The maximum number of results to return in this request.

listRecipeVersions_name :: Lens' ListRecipeVersions Text Source #

The name of the recipe for which to return version information.

listRecipeVersionsResponse_nextToken :: Lens' ListRecipeVersionsResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listRecipeVersionsResponse_httpStatus :: Lens' ListRecipeVersionsResponse Int Source #

The response's http status code.

listRecipeVersionsResponse_recipes :: Lens' ListRecipeVersionsResponse [Recipe] Source #

A list of versions for the specified recipe.

DeleteDataset

deleteDataset_name :: Lens' DeleteDataset Text Source #

The name of the dataset to be deleted.

deleteDatasetResponse_httpStatus :: Lens' DeleteDatasetResponse Int Source #

The response's http status code.

deleteDatasetResponse_name :: Lens' DeleteDatasetResponse Text Source #

The name of the dataset that you deleted.

UpdateDataset

updateDataset_pathOptions :: Lens' UpdateDataset (Maybe PathOptions) Source #

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

updateDataset_formatOptions :: Lens' UpdateDataset (Maybe FormatOptions) Source #

Undocumented member.

updateDataset_format :: Lens' UpdateDataset (Maybe InputFormat) Source #

The file format of a dataset that is created from an Amazon S3 file or folder.

updateDataset_name :: Lens' UpdateDataset Text Source #

The name of the dataset to be updated.

updateDataset_input :: Lens' UpdateDataset Input Source #

Undocumented member.

updateDatasetResponse_httpStatus :: Lens' UpdateDatasetResponse Int Source #

The response's http status code.

updateDatasetResponse_name :: Lens' UpdateDatasetResponse Text Source #

The name of the dataset that you updated.

StopJobRun

stopJobRun_name :: Lens' StopJobRun Text Source #

The name of the job to be stopped.

stopJobRun_runId :: Lens' StopJobRun Text Source #

The ID of the job run to be stopped.

stopJobRunResponse_httpStatus :: Lens' StopJobRunResponse Int Source #

The response's http status code.

stopJobRunResponse_runId :: Lens' StopJobRunResponse Text Source #

The ID of the job run that you stopped.

UpdateRecipeJob

updateRecipeJob_dataCatalogOutputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty DataCatalogOutput)) Source #

One or more artifacts that represent the Glue Data Catalog output from running the job.

updateRecipeJob_databaseOutputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty DatabaseOutput)) Source #

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

updateRecipeJob_encryptionMode :: Lens' UpdateRecipeJob (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with keys managed by KMS.
  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

updateRecipeJob_outputs :: Lens' UpdateRecipeJob (Maybe (NonEmpty Output)) Source #

One or more artifacts that represent the output from running the job.

updateRecipeJob_logSubscription :: Lens' UpdateRecipeJob (Maybe LogSubscription) Source #

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

updateRecipeJob_maxRetries :: Lens' UpdateRecipeJob (Maybe Natural) Source #

The maximum number of times to retry the job after a job run fails.

updateRecipeJob_encryptionKeyArn :: Lens' UpdateRecipeJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

updateRecipeJob_maxCapacity :: Lens' UpdateRecipeJob (Maybe Int) Source #

The maximum number of nodes that DataBrew can consume when the job processes data.

updateRecipeJob_timeout :: Lens' UpdateRecipeJob (Maybe Natural) Source #

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

updateRecipeJob_name :: Lens' UpdateRecipeJob Text Source #

The name of the job to update.

updateRecipeJob_roleArn :: Lens' UpdateRecipeJob Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

updateRecipeJobResponse_httpStatus :: Lens' UpdateRecipeJobResponse Int Source #

The response's http status code.

updateRecipeJobResponse_name :: Lens' UpdateRecipeJobResponse Text Source #

The name of the job that you updated.

ListJobs

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

listJobs_projectName :: Lens' ListJobs (Maybe Text) Source #

The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

listJobs_datasetName :: Lens' ListJobs (Maybe Text) Source #

The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.

listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #

The maximum number of results to return in this request.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.

listJobsResponse_jobs :: Lens' ListJobsResponse [Job] Source #

A list of jobs that are defined.

CreateDataset

createDataset_pathOptions :: Lens' CreateDataset (Maybe PathOptions) Source #

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

createDataset_formatOptions :: Lens' CreateDataset (Maybe FormatOptions) Source #

Undocumented member.

createDataset_format :: Lens' CreateDataset (Maybe InputFormat) Source #

The file format of a dataset that is created from an Amazon S3 file or folder.

createDataset_tags :: Lens' CreateDataset (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this dataset.

createDataset_name :: Lens' CreateDataset Text Source #

The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createDataset_input :: Lens' CreateDataset Input Source #

Undocumented member.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #

The response's http status code.

createDatasetResponse_name :: Lens' CreateDatasetResponse Text Source #

The name of the dataset that you created.

DeleteJob

deleteJob_name :: Lens' DeleteJob Text Source #

The name of the job to be deleted.

deleteJobResponse_httpStatus :: Lens' DeleteJobResponse Int Source #

The response's http status code.

deleteJobResponse_name :: Lens' DeleteJobResponse Text Source #

The name of the job that you deleted.

CreateRecipe

createRecipe_description :: Lens' CreateRecipe (Maybe Text) Source #

A description for the recipe.

createRecipe_tags :: Lens' CreateRecipe (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this recipe.

createRecipe_name :: Lens' CreateRecipe Text Source #

A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createRecipe_steps :: Lens' CreateRecipe [RecipeStep] Source #

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.

createRecipeResponse_httpStatus :: Lens' CreateRecipeResponse Int Source #

The response's http status code.

createRecipeResponse_name :: Lens' CreateRecipeResponse Text Source #

The name of the recipe that you created.

UpdateSchedule

updateSchedule_jobNames :: Lens' UpdateSchedule (Maybe [Text]) Source #

The name or names of one or more jobs to be run for this schedule.

updateSchedule_cronExpression :: Lens' UpdateSchedule Text Source #

The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.

updateSchedule_name :: Lens' UpdateSchedule Text Source #

The name of the schedule to update.

updateScheduleResponse_httpStatus :: Lens' UpdateScheduleResponse Int Source #

The response's http status code.

updateScheduleResponse_name :: Lens' UpdateScheduleResponse Text Source #

The name of the schedule that was updated.

DeleteSchedule

deleteSchedule_name :: Lens' DeleteSchedule Text Source #

The name of the schedule to be deleted.

deleteScheduleResponse_httpStatus :: Lens' DeleteScheduleResponse Int Source #

The response's http status code.

deleteScheduleResponse_name :: Lens' DeleteScheduleResponse Text Source #

The name of the schedule that was deleted.

BatchDeleteRecipeVersion

batchDeleteRecipeVersion_name :: Lens' BatchDeleteRecipeVersion Text Source #

The name of the recipe whose versions are to be deleted.

batchDeleteRecipeVersion_recipeVersions :: Lens' BatchDeleteRecipeVersion (NonEmpty Text) Source #

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.

batchDeleteRecipeVersionResponse_errors :: Lens' BatchDeleteRecipeVersionResponse (Maybe [RecipeVersionErrorDetail]) Source #

Errors, if any, that occurred while attempting to delete the recipe versions.

batchDeleteRecipeVersionResponse_httpStatus :: Lens' BatchDeleteRecipeVersionResponse Int Source #

The response's http status code.

batchDeleteRecipeVersionResponse_name :: Lens' BatchDeleteRecipeVersionResponse Text Source #

The name of the recipe that was modified.

ListJobRuns

listJobRuns_nextToken :: Lens' ListJobRuns (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listJobRuns_maxResults :: Lens' ListJobRuns (Maybe Natural) Source #

The maximum number of results to return in this request.

listJobRuns_name :: Lens' ListJobRuns Text Source #

The name of the job.

listJobRunsResponse_nextToken :: Lens' ListJobRunsResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listJobRunsResponse_httpStatus :: Lens' ListJobRunsResponse Int Source #

The response's http status code.

listJobRunsResponse_jobRuns :: Lens' ListJobRunsResponse [JobRun] Source #

A list of job runs that have occurred for the specified job.

DescribeJob

describeJob_name :: Lens' DescribeJob Text Source #

The name of the job to be described.

describeJobResponse_dataCatalogOutputs :: Lens' DescribeJobResponse (Maybe (NonEmpty DataCatalogOutput)) Source #

One or more artifacts that represent the Glue Data Catalog output from running the job.

describeJobResponse_lastModifiedDate :: Lens' DescribeJobResponse (Maybe UTCTime) Source #

The date and time that the job was last modified.

describeJobResponse_createDate :: Lens' DescribeJobResponse (Maybe UTCTime) Source #

The date and time that the job was created.

describeJobResponse_recipeReference :: Lens' DescribeJobResponse (Maybe RecipeReference) Source #

Undocumented member.

describeJobResponse_profileConfiguration :: Lens' DescribeJobResponse (Maybe ProfileConfiguration) Source #

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

describeJobResponse_createdBy :: Lens' DescribeJobResponse (Maybe Text) Source #

The identifier (user name) of the user associated with the creation of the job.

describeJobResponse_databaseOutputs :: Lens' DescribeJobResponse (Maybe (NonEmpty DatabaseOutput)) Source #

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

describeJobResponse_encryptionMode :: Lens' DescribeJobResponse (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with keys managed by KMS.
  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

describeJobResponse_outputs :: Lens' DescribeJobResponse (Maybe (NonEmpty Output)) Source #

One or more artifacts that represent the output from running the job.

describeJobResponse_resourceArn :: Lens' DescribeJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the job.

describeJobResponse_logSubscription :: Lens' DescribeJobResponse (Maybe LogSubscription) Source #

Indicates whether Amazon CloudWatch logging is enabled for this job.

describeJobResponse_projectName :: Lens' DescribeJobResponse (Maybe Text) Source #

The DataBrew project associated with this job.

describeJobResponse_maxRetries :: Lens' DescribeJobResponse (Maybe Natural) Source #

The maximum number of times to retry the job after a job run fails.

describeJobResponse_datasetName :: Lens' DescribeJobResponse (Maybe Text) Source #

The dataset that the job acts upon.

describeJobResponse_encryptionKeyArn :: Lens' DescribeJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

describeJobResponse_maxCapacity :: Lens' DescribeJobResponse (Maybe Int) Source #

The maximum number of compute nodes that DataBrew can consume when the job processes data.

describeJobResponse_lastModifiedBy :: Lens' DescribeJobResponse (Maybe Text) Source #

The identifier (user name) of the user who last modified the job.

describeJobResponse_type :: Lens' DescribeJobResponse (Maybe JobType) Source #

The job type, which must be one of the following:

  • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.
  • RECIPE - The job applies one or more transformations to a dataset.

describeJobResponse_timeout :: Lens' DescribeJobResponse (Maybe Natural) Source #

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

describeJobResponse_tags :: Lens' DescribeJobResponse (Maybe (HashMap Text Text)) Source #

Metadata tags associated with this job.

describeJobResponse_roleArn :: Lens' DescribeJobResponse (Maybe Text) Source #

The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

describeJobResponse_jobSample :: Lens' DescribeJobResponse (Maybe JobSample) Source #

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

describeJobResponse_httpStatus :: Lens' DescribeJobResponse Int Source #

The response's http status code.

describeJobResponse_name :: Lens' DescribeJobResponse Text Source #

The name of the job.

UpdateProfileJob

updateProfileJob_encryptionMode :: Lens' UpdateProfileJob (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with keys managed by KMS.
  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

updateProfileJob_logSubscription :: Lens' UpdateProfileJob (Maybe LogSubscription) Source #

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

updateProfileJob_maxRetries :: Lens' UpdateProfileJob (Maybe Natural) Source #

The maximum number of times to retry the job after a job run fails.

updateProfileJob_encryptionKeyArn :: Lens' UpdateProfileJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

updateProfileJob_maxCapacity :: Lens' UpdateProfileJob (Maybe Int) Source #

The maximum number of compute nodes that DataBrew can use when the job processes data.

updateProfileJob_configuration :: Lens' UpdateProfileJob (Maybe ProfileConfiguration) Source #

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

updateProfileJob_timeout :: Lens' UpdateProfileJob (Maybe Natural) Source #

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

updateProfileJob_jobSample :: Lens' UpdateProfileJob (Maybe JobSample) Source #

Sample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

updateProfileJob_name :: Lens' UpdateProfileJob Text Source #

The name of the job to be updated.

updateProfileJob_outputLocation :: Lens' UpdateProfileJob S3Location Source #

Undocumented member.

updateProfileJob_roleArn :: Lens' UpdateProfileJob Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

updateProfileJobResponse_httpStatus :: Lens' UpdateProfileJobResponse Int Source #

The response's http status code.

updateProfileJobResponse_name :: Lens' UpdateProfileJobResponse Text Source #

The name of the job that was updated.

DescribeRecipe

describeRecipe_recipeVersion :: Lens' DescribeRecipe (Maybe Text) Source #

The recipe version identifier. If this parameter isn't specified, then the latest published version is returned.

describeRecipe_name :: Lens' DescribeRecipe Text Source #

The name of the recipe to be described.

describeRecipeResponse_lastModifiedDate :: Lens' DescribeRecipeResponse (Maybe UTCTime) Source #

The date and time that the recipe was last modified.

describeRecipeResponse_createDate :: Lens' DescribeRecipeResponse (Maybe UTCTime) Source #

The date and time that the recipe was created.

describeRecipeResponse_publishedBy :: Lens' DescribeRecipeResponse (Maybe Text) Source #

The identifier (user name) of the user who last published the recipe.

describeRecipeResponse_createdBy :: Lens' DescribeRecipeResponse (Maybe Text) Source #

The identifier (user name) of the user who created the recipe.

describeRecipeResponse_steps :: Lens' DescribeRecipeResponse (Maybe [RecipeStep]) Source #

One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.

describeRecipeResponse_publishedDate :: Lens' DescribeRecipeResponse (Maybe UTCTime) Source #

The date and time when the recipe was last published.

describeRecipeResponse_resourceArn :: Lens' DescribeRecipeResponse (Maybe Text) Source #

The ARN of the recipe.

describeRecipeResponse_recipeVersion :: Lens' DescribeRecipeResponse (Maybe Text) Source #

The recipe version identifier.

describeRecipeResponse_projectName :: Lens' DescribeRecipeResponse (Maybe Text) Source #

The name of the project associated with this recipe.

describeRecipeResponse_lastModifiedBy :: Lens' DescribeRecipeResponse (Maybe Text) Source #

The identifier (user name) of the user who last modified the recipe.

describeRecipeResponse_description :: Lens' DescribeRecipeResponse (Maybe Text) Source #

The description of the recipe.

describeRecipeResponse_tags :: Lens' DescribeRecipeResponse (Maybe (HashMap Text Text)) Source #

Metadata tags associated with this project.

describeRecipeResponse_httpStatus :: Lens' DescribeRecipeResponse Int Source #

The response's http status code.

describeRecipeResponse_name :: Lens' DescribeRecipeResponse Text Source #

The name of the recipe.

CreateProfileJob

createProfileJob_encryptionMode :: Lens' CreateProfileJob (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.
  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

createProfileJob_logSubscription :: Lens' CreateProfileJob (Maybe LogSubscription) Source #

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

createProfileJob_maxRetries :: Lens' CreateProfileJob (Maybe Natural) Source #

The maximum number of times to retry the job after a job run fails.

createProfileJob_encryptionKeyArn :: Lens' CreateProfileJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

createProfileJob_maxCapacity :: Lens' CreateProfileJob (Maybe Int) Source #

The maximum number of nodes that DataBrew can use when the job processes data.

createProfileJob_configuration :: Lens' CreateProfileJob (Maybe ProfileConfiguration) Source #

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

createProfileJob_timeout :: Lens' CreateProfileJob (Maybe Natural) Source #

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

createProfileJob_tags :: Lens' CreateProfileJob (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this job.

createProfileJob_jobSample :: Lens' CreateProfileJob (Maybe JobSample) Source #

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

createProfileJob_datasetName :: Lens' CreateProfileJob Text Source #

The name of the dataset that this job is to act upon.

createProfileJob_name :: Lens' CreateProfileJob Text Source #

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createProfileJob_outputLocation :: Lens' CreateProfileJob S3Location Source #

Undocumented member.

createProfileJob_roleArn :: Lens' CreateProfileJob Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

createProfileJobResponse_httpStatus :: Lens' CreateProfileJobResponse Int Source #

The response's http status code.

createProfileJobResponse_name :: Lens' CreateProfileJobResponse Text Source #

The name of the job that was created.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The DataBrew resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a recipe.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

One or more tags to be assigned to the resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

DescribeSchedule

describeSchedule_name :: Lens' DescribeSchedule Text Source #

The name of the schedule to be described.

describeScheduleResponse_lastModifiedDate :: Lens' DescribeScheduleResponse (Maybe UTCTime) Source #

The date and time that the schedule was last modified.

describeScheduleResponse_createDate :: Lens' DescribeScheduleResponse (Maybe UTCTime) Source #

The date and time that the schedule was created.

describeScheduleResponse_createdBy :: Lens' DescribeScheduleResponse (Maybe Text) Source #

The identifier (user name) of the user who created the schedule.

describeScheduleResponse_resourceArn :: Lens' DescribeScheduleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schedule.

describeScheduleResponse_cronExpression :: Lens' DescribeScheduleResponse (Maybe Text) Source #

The date or dates and time or times when the jobs are to be run for the schedule. For more information, see Cron expressions in the Glue DataBrew Developer Guide.

describeScheduleResponse_lastModifiedBy :: Lens' DescribeScheduleResponse (Maybe Text) Source #

The identifier (user name) of the user who last modified the schedule.

describeScheduleResponse_jobNames :: Lens' DescribeScheduleResponse (Maybe [Text]) Source #

The name or names of one or more jobs to be run by using the schedule.

describeScheduleResponse_tags :: Lens' DescribeScheduleResponse (Maybe (HashMap Text Text)) Source #

Metadata tags associated with this schedule.

describeScheduleResponse_httpStatus :: Lens' DescribeScheduleResponse Int Source #

The response's http status code.

describeScheduleResponse_name :: Lens' DescribeScheduleResponse Text Source #

The name of the schedule.

DescribeJobRun

describeJobRun_name :: Lens' DescribeJobRun Text Source #

The name of the job being processed during this run.

describeJobRun_runId :: Lens' DescribeJobRun Text Source #

The unique identifier of the job run.

describeJobRunResponse_completedOn :: Lens' DescribeJobRunResponse (Maybe UTCTime) Source #

The date and time when the job completed processing.

describeJobRunResponse_state :: Lens' DescribeJobRunResponse (Maybe JobRunState) Source #

The current state of the job run entity itself.

describeJobRunResponse_dataCatalogOutputs :: Lens' DescribeJobRunResponse (Maybe (NonEmpty DataCatalogOutput)) Source #

One or more artifacts that represent the Glue Data Catalog output from running the job.

describeJobRunResponse_startedOn :: Lens' DescribeJobRunResponse (Maybe UTCTime) Source #

The date and time when the job run began.

describeJobRunResponse_recipeReference :: Lens' DescribeJobRunResponse (Maybe RecipeReference) Source #

Undocumented member.

describeJobRunResponse_profileConfiguration :: Lens' DescribeJobRunResponse (Maybe ProfileConfiguration) Source #

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

describeJobRunResponse_databaseOutputs :: Lens' DescribeJobRunResponse (Maybe (NonEmpty DatabaseOutput)) Source #

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

describeJobRunResponse_logGroupName :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

describeJobRunResponse_outputs :: Lens' DescribeJobRunResponse (Maybe (NonEmpty Output)) Source #

One or more output artifacts from a job run.

describeJobRunResponse_runId :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The unique identifier of the job run.

describeJobRunResponse_executionTime :: Lens' DescribeJobRunResponse (Maybe Int) Source #

The amount of time, in seconds, during which the job run consumed resources.

describeJobRunResponse_logSubscription :: Lens' DescribeJobRunResponse (Maybe LogSubscription) Source #

The current status of Amazon CloudWatch logging for the job run.

describeJobRunResponse_startedBy :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who started the job run.

describeJobRunResponse_datasetName :: Lens' DescribeJobRunResponse (Maybe Text) Source #

The name of the dataset for the job to process.

describeJobRunResponse_attempt :: Lens' DescribeJobRunResponse (Maybe Int) Source #

The number of times that DataBrew has attempted to run the job.

describeJobRunResponse_errorMessage :: Lens' DescribeJobRunResponse (Maybe Text) Source #

A message indicating an error (if any) that was encountered when the job ran.

describeJobRunResponse_jobSample :: Lens' DescribeJobRunResponse (Maybe JobSample) Source #

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

describeJobRunResponse_httpStatus :: Lens' DescribeJobRunResponse Int Source #

The response's http status code.

describeJobRunResponse_jobName :: Lens' DescribeJobRunResponse Text Source #

The name of the job being processed during this run.

StartProjectSession

startProjectSession_assumeControl :: Lens' StartProjectSession (Maybe Bool) Source #

A value that, if true, enables you to take control of a session, even if a different client is currently accessing the project.

startProjectSession_name :: Lens' StartProjectSession Text Source #

The name of the project to act upon.

startProjectSessionResponse_clientSessionId :: Lens' StartProjectSessionResponse (Maybe Text) Source #

A system-generated identifier for the session.

startProjectSessionResponse_httpStatus :: Lens' StartProjectSessionResponse Int Source #

The response's http status code.

startProjectSessionResponse_name :: Lens' StartProjectSessionResponse Text Source #

The name of the project to be acted upon.

DeleteRecipeVersion

deleteRecipeVersion_name :: Lens' DeleteRecipeVersion Text Source #

The name of the recipe.

deleteRecipeVersion_recipeVersion :: Lens' DeleteRecipeVersion Text Source #

The version of the recipe to be deleted. You can specify a numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported.

deleteRecipeVersionResponse_httpStatus :: Lens' DeleteRecipeVersionResponse Int Source #

The response's http status code.

deleteRecipeVersionResponse_name :: Lens' DeleteRecipeVersionResponse Text Source #

The name of the recipe that was deleted.

deleteRecipeVersionResponse_recipeVersion :: Lens' DeleteRecipeVersionResponse Text Source #

The version of the recipe that was deleted.

ListDatasets

listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #

The maximum number of results to return in this request.

listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int Source #

The response's http status code.

listDatasetsResponse_datasets :: Lens' ListDatasetsResponse [Dataset] Source #

A list of datasets that are defined.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

A DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The tag keys (names) of one or more tags to be removed.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

StartJobRun

startJobRun_name :: Lens' StartJobRun Text Source #

The name of the job to be run.

startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int Source #

The response's http status code.

startJobRunResponse_runId :: Lens' StartJobRunResponse Text Source #

A system-generated identifier for this particular job run.

UpdateRecipe

updateRecipe_steps :: Lens' UpdateRecipe (Maybe [RecipeStep]) Source #

One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.

updateRecipe_description :: Lens' UpdateRecipe (Maybe Text) Source #

A description of the recipe.

updateRecipe_name :: Lens' UpdateRecipe Text Source #

The name of the recipe to be updated.

updateRecipeResponse_httpStatus :: Lens' UpdateRecipeResponse Int Source #

The response's http status code.

updateRecipeResponse_name :: Lens' UpdateRecipeResponse Text Source #

The name of the recipe that was updated.

CreateSchedule

createSchedule_jobNames :: Lens' CreateSchedule (Maybe [Text]) Source #

The name or names of one or more jobs to be run.

createSchedule_tags :: Lens' CreateSchedule (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this schedule.

createSchedule_cronExpression :: Lens' CreateSchedule Text Source #

The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.

createSchedule_name :: Lens' CreateSchedule Text Source #

A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createScheduleResponse_httpStatus :: Lens' CreateScheduleResponse Int Source #

The response's http status code.

createScheduleResponse_name :: Lens' CreateScheduleResponse Text Source #

The name of the schedule that was created.

ListRecipes

listRecipes_nextToken :: Lens' ListRecipes (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listRecipes_recipeVersion :: Lens' ListRecipes (Maybe Text) Source #

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

listRecipes_maxResults :: Lens' ListRecipes (Maybe Natural) Source #

The maximum number of results to return in this request.

listRecipesResponse_nextToken :: Lens' ListRecipesResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listRecipesResponse_httpStatus :: Lens' ListRecipesResponse Int Source #

The response's http status code.

listRecipesResponse_recipes :: Lens' ListRecipesResponse [Recipe] Source #

A list of recipes that are defined.

PublishRecipe

publishRecipe_description :: Lens' PublishRecipe (Maybe Text) Source #

A description of the recipe to be published, for this version of the recipe.

publishRecipe_name :: Lens' PublishRecipe Text Source #

The name of the recipe to be published.

publishRecipeResponse_httpStatus :: Lens' PublishRecipeResponse Int Source #

The response's http status code.

publishRecipeResponse_name :: Lens' PublishRecipeResponse Text Source #

The name of the recipe that you published.

CreateProject

createProject_sample :: Lens' CreateProject (Maybe Sample) Source #

Undocumented member.

createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this project.

createProject_datasetName :: Lens' CreateProject Text Source #

The name of an existing dataset to associate this project with.

createProject_name :: Lens' CreateProject Text Source #

A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createProject_recipeName :: Lens' CreateProject Text Source #

The name of an existing recipe to associate with the project.

createProject_roleArn :: Lens' CreateProject Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request.

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #

The response's http status code.

createProjectResponse_name :: Lens' CreateProjectResponse Text Source #

The name of the project that you created.

SendProjectSessionAction

sendProjectSessionAction_stepIndex :: Lens' SendProjectSessionAction (Maybe Natural) Source #

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.

sendProjectSessionAction_preview :: Lens' SendProjectSessionAction (Maybe Bool) Source #

If true, the result of the recipe step will be returned, but not applied.

sendProjectSessionAction_clientSessionId :: Lens' SendProjectSessionAction (Maybe Text) Source #

A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.

sendProjectSessionAction_recipeStep :: Lens' SendProjectSessionAction (Maybe RecipeStep) Source #

Undocumented member.

sendProjectSessionAction_viewFrame :: Lens' SendProjectSessionAction (Maybe ViewFrame) Source #

Undocumented member.

sendProjectSessionAction_name :: Lens' SendProjectSessionAction Text Source #

The name of the project to apply the action to.

sendProjectSessionActionResponse_actionId :: Lens' SendProjectSessionActionResponse (Maybe Int) Source #

A unique identifier for the action that was performed.

sendProjectSessionActionResponse_result :: Lens' SendProjectSessionActionResponse (Maybe Text) Source #

A message indicating the result of performing the action.

sendProjectSessionActionResponse_httpStatus :: Lens' SendProjectSessionActionResponse Int Source #

The response's http status code.

sendProjectSessionActionResponse_name :: Lens' SendProjectSessionActionResponse Text Source #

The name of the project that was affected by the action.

Types

ColumnSelector

columnSelector_regex :: Lens' ColumnSelector (Maybe Text) Source #

A regular expression for selecting a column from a dataset.

columnSelector_name :: Lens' ColumnSelector (Maybe Text) Source #

The name of a column from a dataset.

ColumnStatisticsConfiguration

columnStatisticsConfiguration_selectors :: Lens' ColumnStatisticsConfiguration (Maybe (NonEmpty ColumnSelector)) Source #

List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.

columnStatisticsConfiguration_statistics :: Lens' ColumnStatisticsConfiguration StatisticsConfiguration Source #

Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.

ConditionExpression

conditionExpression_value :: Lens' ConditionExpression (Maybe Text) Source #

A value that the condition must evaluate to for the condition to succeed.

conditionExpression_condition :: Lens' ConditionExpression Text Source #

A specific condition to apply to a recipe action. For more information, see Recipe structure in the Glue DataBrew Developer Guide.

conditionExpression_targetColumn :: Lens' ConditionExpression Text Source #

A column to apply this condition to.

CsvOptions

csvOptions_headerRow :: Lens' CsvOptions (Maybe Bool) Source #

A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.

csvOptions_delimiter :: Lens' CsvOptions (Maybe Text) Source #

A single character that specifies the delimiter being used in the CSV file.

CsvOutputOptions

csvOutputOptions_delimiter :: Lens' CsvOutputOptions (Maybe Text) Source #

A single character that specifies the delimiter used to create CSV job output.

DataCatalogInputDefinition

dataCatalogInputDefinition_tempDirectory :: Lens' DataCatalogInputDefinition (Maybe S3Location) Source #

Represents an Amazon location where DataBrew can store intermediate results.

dataCatalogInputDefinition_catalogId :: Lens' DataCatalogInputDefinition (Maybe Text) Source #

The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.

dataCatalogInputDefinition_databaseName :: Lens' DataCatalogInputDefinition Text Source #

The name of a database in the Data Catalog.

dataCatalogInputDefinition_tableName :: Lens' DataCatalogInputDefinition Text Source #

The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.

DataCatalogOutput

dataCatalogOutput_databaseOptions :: Lens' DataCatalogOutput (Maybe DatabaseTableOutputOptions) Source #

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

dataCatalogOutput_s3Options :: Lens' DataCatalogOutput (Maybe S3TableOutputOptions) Source #

Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

dataCatalogOutput_catalogId :: Lens' DataCatalogOutput (Maybe Text) Source #

The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.

dataCatalogOutput_overwrite :: Lens' DataCatalogOutput (Maybe Bool) Source #

A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.

dataCatalogOutput_databaseName :: Lens' DataCatalogOutput Text Source #

The name of a database in the Data Catalog.

dataCatalogOutput_tableName :: Lens' DataCatalogOutput Text Source #

The name of a table in the Data Catalog.

DatabaseInputDefinition

databaseInputDefinition_tempDirectory :: Lens' DatabaseInputDefinition (Maybe S3Location) Source #

Undocumented member.

databaseInputDefinition_glueConnectionName :: Lens' DatabaseInputDefinition Text Source #

The Glue Connection that stores the connection information for the target database.

databaseInputDefinition_databaseTableName :: Lens' DatabaseInputDefinition Text Source #

The table within the target database.

DatabaseOutput

databaseOutput_databaseOutputMode :: Lens' DatabaseOutput (Maybe DatabaseOutputMode) Source #

The output mode to write into the database. Currently supported option: NEW_TABLE.

databaseOutput_glueConnectionName :: Lens' DatabaseOutput Text Source #

The Glue connection that stores the connection information for the target database.

databaseOutput_databaseOptions :: Lens' DatabaseOutput DatabaseTableOutputOptions Source #

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

DatabaseTableOutputOptions

databaseTableOutputOptions_tempDirectory :: Lens' DatabaseTableOutputOptions (Maybe S3Location) Source #

Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

databaseTableOutputOptions_tableName :: Lens' DatabaseTableOutputOptions Text Source #

A prefix for the name of a table DataBrew will create in the database.

Dataset

dataset_lastModifiedDate :: Lens' Dataset (Maybe UTCTime) Source #

The last modification date and time of the dataset.

dataset_pathOptions :: Lens' Dataset (Maybe PathOptions) Source #

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

dataset_createDate :: Lens' Dataset (Maybe UTCTime) Source #

The date and time that the dataset was created.

dataset_formatOptions :: Lens' Dataset (Maybe FormatOptions) Source #

A set of options that define how DataBrew interprets the data in the dataset.

dataset_format :: Lens' Dataset (Maybe InputFormat) Source #

The file format of a dataset that is created from an Amazon S3 file or folder.

dataset_createdBy :: Lens' Dataset (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who created the dataset.

dataset_accountId :: Lens' Dataset (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the dataset.

dataset_resourceArn :: Lens' Dataset (Maybe Text) Source #

The unique Amazon Resource Name (ARN) for the dataset.

dataset_source :: Lens' Dataset (Maybe Source) Source #

The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.

dataset_lastModifiedBy :: Lens' Dataset (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who last modified the dataset.

dataset_tags :: Lens' Dataset (Maybe (HashMap Text Text)) Source #

Metadata tags that have been applied to the dataset.

dataset_name :: Lens' Dataset Text Source #

The unique name of the dataset.

dataset_input :: Lens' Dataset Input Source #

Information on how DataBrew can find the dataset, in either the Glue Data Catalog or Amazon S3.

DatasetParameter

datasetParameter_createColumn :: Lens' DatasetParameter (Maybe Bool) Source #

Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

datasetParameter_filter :: Lens' DatasetParameter (Maybe FilterExpression) Source #

The optional filter expression structure to apply additional matching criteria to the parameter.

datasetParameter_datetimeOptions :: Lens' DatasetParameter (Maybe DatetimeOptions) Source #

Additional parameter options such as a format and a timezone. Required for datetime parameters.

datasetParameter_name :: Lens' DatasetParameter Text Source #

The name of the parameter that is used in the dataset's Amazon S3 path.

datasetParameter_type :: Lens' DatasetParameter ParameterType Source #

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

DatetimeOptions

datetimeOptions_timezoneOffset :: Lens' DatetimeOptions (Maybe Text) Source #

Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed.

datetimeOptions_localeCode :: Lens' DatetimeOptions (Maybe Text) Source #

Optional value for a non-US locale code, needed for correct interpretation of some date formats.

datetimeOptions_format :: Lens' DatetimeOptions Text Source #

Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. Should use only supported datetime specifiers and separation characters, all literal a-z or A-Z characters should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm".

ExcelOptions

excelOptions_sheetIndexes :: Lens' ExcelOptions (Maybe (NonEmpty Natural)) Source #

One or more sheet numbers in the Excel file that will be included in the dataset.

excelOptions_sheetNames :: Lens' ExcelOptions (Maybe (NonEmpty Text)) Source #

One or more named sheets in the Excel file that will be included in the dataset.

excelOptions_headerRow :: Lens' ExcelOptions (Maybe Bool) Source #

A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.

FilesLimit

filesLimit_orderedBy :: Lens' FilesLimit (Maybe OrderedBy) Source #

A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed value.

filesLimit_order :: Lens' FilesLimit (Maybe Order) Source #

A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

filesLimit_maxFiles :: Lens' FilesLimit Natural Source #

The number of Amazon S3 files to select.

FilterExpression

filterExpression_expression :: Lens' FilterExpression Text Source #

The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, "(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)". Substitution variables should start with ':' symbol.

filterExpression_valuesMap :: Lens' FilterExpression (HashMap Text Text) Source #

The map of substitution variable names to their values used in this filter expression.

FormatOptions

formatOptions_json :: Lens' FormatOptions (Maybe JsonOptions) Source #

Options that define how JSON input is to be interpreted by DataBrew.

formatOptions_csv :: Lens' FormatOptions (Maybe CsvOptions) Source #

Options that define how CSV input is to be interpreted by DataBrew.

formatOptions_excel :: Lens' FormatOptions (Maybe ExcelOptions) Source #

Options that define how Excel input is to be interpreted by DataBrew.

Input

input_dataCatalogInputDefinition :: Lens' Input (Maybe DataCatalogInputDefinition) Source #

The Glue Data Catalog parameters for the data.

input_s3InputDefinition :: Lens' Input (Maybe S3Location) Source #

The Amazon S3 location where the data is stored.

input_databaseInputDefinition :: Lens' Input (Maybe DatabaseInputDefinition) Source #

Connection information for dataset input files stored in a database.

Job

job_dataCatalogOutputs :: Lens' Job (Maybe (NonEmpty DataCatalogOutput)) Source #

One or more artifacts that represent the Glue Data Catalog output from running the job.

job_lastModifiedDate :: Lens' Job (Maybe UTCTime) Source #

The modification date and time of the job.

job_createDate :: Lens' Job (Maybe UTCTime) Source #

The date and time that the job was created.

job_recipeReference :: Lens' Job (Maybe RecipeReference) Source #

A set of steps that the job runs.

job_createdBy :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who created the job.

job_databaseOutputs :: Lens' Job (Maybe (NonEmpty DatabaseOutput)) Source #

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

job_accountId :: Lens' Job (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the job.

job_encryptionMode :: Lens' Job (Maybe EncryptionMode) Source #

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with keys managed by KMS.
  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

job_outputs :: Lens' Job (Maybe (NonEmpty Output)) Source #

One or more artifacts that represent output from running the job.

job_resourceArn :: Lens' Job (Maybe Text) Source #

The unique Amazon Resource Name (ARN) for the job.

job_logSubscription :: Lens' Job (Maybe LogSubscription) Source #

The current status of Amazon CloudWatch logging for the job.

job_projectName :: Lens' Job (Maybe Text) Source #

The name of the project that the job is associated with.

job_maxRetries :: Lens' Job (Maybe Natural) Source #

The maximum number of times to retry the job after a job run fails.

job_datasetName :: Lens' Job (Maybe Text) Source #

A dataset that the job is to process.

job_encryptionKeyArn :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

job_maxCapacity :: Lens' Job (Maybe Int) Source #

The maximum number of nodes that can be consumed when the job processes data.

job_lastModifiedBy :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who last modified the job.

job_type :: Lens' Job (Maybe JobType) Source #

The job type of the job, which must be one of the following:

  • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
  • RECIPE - A job to apply one or more transformations to a dataset.

job_timeout :: Lens' Job (Maybe Natural) Source #

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

job_tags :: Lens' Job (Maybe (HashMap Text Text)) Source #

Metadata tags that have been applied to the job.

job_roleArn :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role to be assumed for this job.

job_jobSample :: Lens' Job (Maybe JobSample) Source #

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

job_name :: Lens' Job Text Source #

The unique name of the job.

JobRun

jobRun_completedOn :: Lens' JobRun (Maybe UTCTime) Source #

The date and time when the job completed processing.

jobRun_state :: Lens' JobRun (Maybe JobRunState) Source #

The current state of the job run entity itself.

jobRun_dataCatalogOutputs :: Lens' JobRun (Maybe (NonEmpty DataCatalogOutput)) Source #

One or more artifacts that represent the Glue Data Catalog output from running the job.

jobRun_jobName :: Lens' JobRun (Maybe Text) Source #

The name of the job being processed during this run.

jobRun_startedOn :: Lens' JobRun (Maybe UTCTime) Source #

The date and time when the job run began.

jobRun_recipeReference :: Lens' JobRun (Maybe RecipeReference) Source #

The set of steps processed by the job.

jobRun_databaseOutputs :: Lens' JobRun (Maybe (NonEmpty DatabaseOutput)) Source #

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

jobRun_logGroupName :: Lens' JobRun (Maybe Text) Source #

The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

jobRun_outputs :: Lens' JobRun (Maybe (NonEmpty Output)) Source #

One or more output artifacts from a job run.

jobRun_runId :: Lens' JobRun (Maybe Text) Source #

The unique identifier of the job run.

jobRun_executionTime :: Lens' JobRun (Maybe Int) Source #

The amount of time, in seconds, during which a job run consumed resources.

jobRun_logSubscription :: Lens' JobRun (Maybe LogSubscription) Source #

The current status of Amazon CloudWatch logging for the job run.

jobRun_startedBy :: Lens' JobRun (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who initiated the job run.

jobRun_datasetName :: Lens' JobRun (Maybe Text) Source #

The name of the dataset for the job to process.

jobRun_attempt :: Lens' JobRun (Maybe Int) Source #

The number of times that DataBrew has attempted to run the job.

jobRun_errorMessage :: Lens' JobRun (Maybe Text) Source #

A message indicating an error (if any) that was encountered when the job ran.

jobRun_jobSample :: Lens' JobRun (Maybe JobSample) Source #

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

JobSample

jobSample_size :: Lens' JobSample (Maybe Integer) Source #

The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

jobSample_mode :: Lens' JobSample (Maybe SampleMode) Source #

A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

  • FULL_DATASET - The profile job is run on the entire dataset.
  • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

JsonOptions

jsonOptions_multiLine :: Lens' JsonOptions (Maybe Bool) Source #

A value that specifies whether JSON input contains embedded new line characters.

Output

output_partitionColumns :: Lens' Output (Maybe [Text]) Source #

The names of one or more partition columns for the output of the job.

output_formatOptions :: Lens' Output (Maybe OutputFormatOptions) Source #

Represents options that define how DataBrew formats job output files.

output_format :: Lens' Output (Maybe OutputFormat) Source #

The data format of the output of the job.

output_compressionFormat :: Lens' Output (Maybe CompressionFormat) Source #

The compression algorithm used to compress the output text of the job.

output_overwrite :: Lens' Output (Maybe Bool) Source #

A value that, if true, means that any data in the location specified for output is overwritten with new output.

output_location :: Lens' Output S3Location Source #

The location in Amazon S3 where the job writes its output.

OutputFormatOptions

outputFormatOptions_csv :: Lens' OutputFormatOptions (Maybe CsvOutputOptions) Source #

Represents a set of options that define the structure of comma-separated value (CSV) job output.

PathOptions

pathOptions_lastModifiedDateCondition :: Lens' PathOptions (Maybe FilterExpression) Source #

If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.

pathOptions_parameters :: Lens' PathOptions (Maybe (HashMap Text DatasetParameter)) Source #

A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

pathOptions_filesLimit :: Lens' PathOptions (Maybe FilesLimit) Source #

If provided, this structure imposes a limit on a number of files that should be selected.

ProfileConfiguration

profileConfiguration_datasetStatisticsConfiguration :: Lens' ProfileConfiguration (Maybe StatisticsConfiguration) Source #

Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.

profileConfiguration_columnStatisticsConfigurations :: Lens' ProfileConfiguration (Maybe (NonEmpty ColumnStatisticsConfiguration)) Source #

List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.

profileConfiguration_profileColumns :: Lens' ProfileConfiguration (Maybe (NonEmpty ColumnSelector)) Source #

List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

Project

project_lastModifiedDate :: Lens' Project (Maybe UTCTime) Source #

The last modification date and time for the project.

project_openDate :: Lens' Project (Maybe UTCTime) Source #

The date and time when the project was opened.

project_createDate :: Lens' Project (Maybe UTCTime) Source #

The date and time that the project was created.

project_createdBy :: Lens' Project (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who crated the project.

project_accountId :: Lens' Project (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the project.

project_resourceArn :: Lens' Project (Maybe Text) Source #

The Amazon Resource Name (ARN) for the project.

project_datasetName :: Lens' Project (Maybe Text) Source #

The dataset that the project is to act upon.

project_lastModifiedBy :: Lens' Project (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who last modified the project.

project_sample :: Lens' Project (Maybe Sample) Source #

The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.

project_openedBy :: Lens' Project (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user that opened the project for use.

project_tags :: Lens' Project (Maybe (HashMap Text Text)) Source #

Metadata tags that have been applied to the project.

project_roleArn :: Lens' Project (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role that will be assumed for this project.

project_name :: Lens' Project Text Source #

The unique name of a project.

project_recipeName :: Lens' Project Text Source #

The name of a recipe that will be developed during a project session.

Recipe

recipe_lastModifiedDate :: Lens' Recipe (Maybe UTCTime) Source #

The last modification date and time of the recipe.

recipe_createDate :: Lens' Recipe (Maybe UTCTime) Source #

The date and time that the recipe was created.

recipe_publishedBy :: Lens' Recipe (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who published the recipe.

recipe_createdBy :: Lens' Recipe (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who created the recipe.

recipe_steps :: Lens' Recipe (Maybe [RecipeStep]) Source #

A list of steps that are defined by the recipe.

recipe_publishedDate :: Lens' Recipe (Maybe UTCTime) Source #

The date and time when the recipe was published.

recipe_resourceArn :: Lens' Recipe (Maybe Text) Source #

The Amazon Resource Name (ARN) for the recipe.

recipe_recipeVersion :: Lens' Recipe (Maybe Text) Source #

The identifier for the version for the recipe. Must be one of the following:

  • Numeric version (X.Y) - X and Y stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both X and Y 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.

recipe_projectName :: Lens' Recipe (Maybe Text) Source #

The name of the project that the recipe is associated with.

recipe_lastModifiedBy :: Lens' Recipe (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who last modified the recipe.

recipe_description :: Lens' Recipe (Maybe Text) Source #

The description of the recipe.

recipe_tags :: Lens' Recipe (Maybe (HashMap Text Text)) Source #

Metadata tags that have been applied to the recipe.

recipe_name :: Lens' Recipe Text Source #

The unique name for the recipe.

RecipeAction

recipeAction_parameters :: Lens' RecipeAction (Maybe (HashMap Text Text)) Source #

Contextual parameters for the transformation.

recipeAction_operation :: Lens' RecipeAction Text Source #

The name of a valid DataBrew transformation to be performed on the data.

RecipeReference

recipeReference_recipeVersion :: Lens' RecipeReference (Maybe Text) Source #

The identifier for the version for the recipe.

recipeReference_name :: Lens' RecipeReference Text Source #

The name of the recipe.

RecipeStep

recipeStep_conditionExpressions :: Lens' RecipeStep (Maybe [ConditionExpression]) Source #

One or more conditions that must be met for the recipe step to succeed.

All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.

recipeStep_action :: Lens' RecipeStep RecipeAction Source #

The particular action to be performed in the recipe step.

RecipeVersionErrorDetail

recipeVersionErrorDetail_recipeVersion :: Lens' RecipeVersionErrorDetail (Maybe Text) Source #

The identifier for the recipe version associated with this error.

recipeVersionErrorDetail_errorCode :: Lens' RecipeVersionErrorDetail (Maybe Text) Source #

The HTTP status code for the error.

recipeVersionErrorDetail_errorMessage :: Lens' RecipeVersionErrorDetail (Maybe Text) Source #

The text of the error message.

S3Location

s3Location_key :: Lens' S3Location (Maybe Text) Source #

The unique name of the object in the bucket.

s3Location_bucket :: Lens' S3Location Text Source #

The Amazon S3 bucket name.

S3TableOutputOptions

s3TableOutputOptions_location :: Lens' S3TableOutputOptions S3Location Source #

Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.

Sample

sample_size :: Lens' Sample (Maybe Natural) Source #

The number of rows in the sample.

sample_type :: Lens' Sample SampleType Source #

The way in which DataBrew obtains rows from a dataset.

Schedule

schedule_lastModifiedDate :: Lens' Schedule (Maybe UTCTime) Source #

The date and time when the schedule was last modified.

schedule_createDate :: Lens' Schedule (Maybe UTCTime) Source #

The date and time that the schedule was created.

schedule_createdBy :: Lens' Schedule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who created the schedule.

schedule_accountId :: Lens' Schedule (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the schedule.

schedule_resourceArn :: Lens' Schedule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schedule.

schedule_cronExpression :: Lens' Schedule (Maybe Text) Source #

The dates and times when the job is to run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.

schedule_lastModifiedBy :: Lens' Schedule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who last modified the schedule.

schedule_jobNames :: Lens' Schedule (Maybe [Text]) Source #

A list of jobs to be run, according to the schedule.

schedule_tags :: Lens' Schedule (Maybe (HashMap Text Text)) Source #

Metadata tags that have been applied to the schedule.

schedule_name :: Lens' Schedule Text Source #

The name of the schedule.

StatisticOverride

statisticOverride_statistic :: Lens' StatisticOverride Text Source #

The name of an evaluation

statisticOverride_parameters :: Lens' StatisticOverride (HashMap Text Text) Source #

A map that includes overrides of an evaluation’s parameters.

StatisticsConfiguration

statisticsConfiguration_overrides :: Lens' StatisticsConfiguration (Maybe (NonEmpty StatisticOverride)) Source #

List of overrides for evaluations.

statisticsConfiguration_includedStatistics :: Lens' StatisticsConfiguration (Maybe (NonEmpty Text)) Source #

List of included evaluations. When the list is undefined, all supported evaluations will be included.

ViewFrame

viewFrame_hiddenColumns :: Lens' ViewFrame (Maybe [Text]) Source #

A list of columns to hide in the view frame.

viewFrame_columnRange :: Lens' ViewFrame (Maybe Natural) Source #

The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.

viewFrame_startColumnIndex :: Lens' ViewFrame Natural Source #

The starting index for the range of columns to return in the view frame.