List<E> 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.
StatisticsConfiguration statistics
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
String condition
A specific condition to apply to a recipe action. For more information, see Recipe structure in the Glue DataBrew Developer Guide.
String value
A value that the condition must evaluate to for the condition to succeed.
String targetColumn
A column to apply this condition to.
String name
The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
String format
The file format of a dataset that is created from an Amazon S3 file or folder.
FormatOptions formatOptions
Input input
PathOptions pathOptions
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
Map<K,V> tags
Metadata tags to apply to this dataset.
String name
The name of the dataset that you created.
String datasetName
The name of the dataset that this job is to act upon.
String encryptionKeyArn
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
String 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.
String name
The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
String logSubscription
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
Integer maxCapacity
The maximum number of nodes that DataBrew can use when the job processes data.
Integer maxRetries
The maximum number of times to retry the job after a job run fails.
S3Location outputLocation
ProfileConfiguration 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.
List<E> validationConfigurations
List of validation configurations that are applied to the profile job.
String roleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Map<K,V> tags
Metadata tags to apply to this job.
Integer timeout
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT.
JobSample 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.
String name
The name of the job that was created.
String datasetName
The name of an existing dataset to associate this project with.
String name
A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
String recipeName
The name of an existing recipe to associate with the project.
Sample sample
String roleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request.
Map<K,V> tags
Metadata tags to apply to this project.
String name
The name of the project that you created.
String datasetName
The name of the dataset that this job processes.
String encryptionKeyArn
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
String 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.
String name
A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
String logSubscription
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
Integer maxCapacity
The maximum number of nodes that DataBrew can consume when the job processes data.
Integer maxRetries
The maximum number of times to retry the job after a job run fails.
List<E> outputs
One or more artifacts that represent the output from running the job.
List<E> dataCatalogOutputs
One or more artifacts that represent the Glue Data Catalog output from running the job.
List<E> databaseOutputs
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
String projectName
Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
RecipeReference recipeReference
String roleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Map<K,V> tags
Metadata tags to apply to this job.
Integer timeout
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT.
String name
The name of the job that you created.
String description
A description for the recipe.
String name
A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
List<E> 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.
Map<K,V> tags
Metadata tags to apply to this recipe.
String name
The name of the recipe that you created.
String name
The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
String description
The description of the ruleset.
String targetArn
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
List<E> rules
A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.
Map<K,V> tags
Metadata tags to apply to the ruleset.
String name
The unique name of the created ruleset.
List<E> jobNames
The name or names of one or more jobs to be run.
String 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.
Map<K,V> tags
Metadata tags to apply to this schedule.
String name
A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
String name
The name of the schedule that was created.
String delimiter
A single character that specifies the delimiter used to create CSV job output.
String glueConnectionName
The Glue Connection that stores the connection information for the target database.
String databaseTableName
The table within the target database.
S3Location tempDirectory
String queryString
Custom SQL to run against the provided Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
String glueConnectionName
The Glue connection that stores the connection information for the target database.
DatabaseTableOutputOptions databaseOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
String databaseOutputMode
The output mode to write into the database. Currently supported option: NEW_TABLE.
S3Location tempDirectory
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
String tableName
A prefix for the name of a table DataBrew will create in the database.
String catalogId
The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
String databaseName
The name of a database in the Data Catalog.
String tableName
The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.
S3Location tempDirectory
Represents an Amazon location where DataBrew can store intermediate results.
String catalogId
The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
String databaseName
The name of a database in the Data Catalog.
String tableName
The name of a table in the Data Catalog.
S3TableOutputOptions s3Options
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
DatabaseTableOutputOptions databaseOptions
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
Boolean 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.
String accountId
The ID of the Amazon Web Services account that owns the dataset.
String createdBy
The Amazon Resource Name (ARN) of the user who created the dataset.
Date createDate
The date and time that the dataset was created.
String name
The unique name of the dataset.
String format
The file format of a dataset that is created from an Amazon S3 file or folder.
FormatOptions formatOptions
A set of options that define how DataBrew interprets the data in the dataset.
Input input
Information on how DataBrew can find the dataset, in either the Glue Data Catalog or Amazon S3.
Date lastModifiedDate
The last modification date and time of the dataset.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last modified the dataset.
String source
The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.
PathOptions pathOptions
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
Map<K,V> tags
Metadata tags that have been applied to the dataset.
String resourceArn
The unique Amazon Resource Name (ARN) for the dataset.
String name
The name of the parameter that is used in the dataset's Amazon S3 path.
String type
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
DatetimeOptions datetimeOptions
Additional parameter options such as a format and a timezone. Required for datetime parameters.
Boolean createColumn
Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
FilterExpression filter
The optional filter expression structure to apply additional matching criteria to the parameter.
String 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".
String 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.
String localeCode
Optional value for a non-US locale code, needed for correct interpretation of some date formats.
String name
The name of the dataset to be deleted.
String name
The name of the dataset that you deleted.
String name
The name of the job to be deleted.
String name
The name of the job that you deleted.
String name
The name of the project to be deleted.
String name
The name of the project that you deleted.
String name
The name of the ruleset to be deleted.
String name
The name of the deleted ruleset.
String name
The name of the schedule to be deleted.
String name
The name of the schedule that was deleted.
String name
The name of the dataset to be described.
String createdBy
The identifier (user name) of the user who created the dataset.
Date createDate
The date and time that the dataset was created.
String name
The name of the dataset.
String format
The file format of a dataset that is created from an Amazon S3 file or folder.
FormatOptions formatOptions
Input input
Date lastModifiedDate
The date and time that the dataset was last modified.
String lastModifiedBy
The identifier (user name) of the user who last modified the dataset.
String source
The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.
PathOptions pathOptions
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
Map<K,V> tags
Metadata tags associated with this dataset.
String resourceArn
The Amazon Resource Name (ARN) of the dataset.
String name
The name of the job to be described.
Date createDate
The date and time that the job was created.
String createdBy
The identifier (user name) of the user associated with the creation of the job.
String datasetName
The dataset that the job acts upon.
String encryptionKeyArn
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
String 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.
String name
The name of the job.
String 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.
String lastModifiedBy
The identifier (user name) of the user who last modified the job.
Date lastModifiedDate
The date and time that the job was last modified.
String logSubscription
Indicates whether Amazon CloudWatch logging is enabled for this job.
Integer maxCapacity
The maximum number of compute nodes that DataBrew can consume when the job processes data.
Integer maxRetries
The maximum number of times to retry the job after a job run fails.
List<E> outputs
One or more artifacts that represent the output from running the job.
List<E> dataCatalogOutputs
One or more artifacts that represent the Glue Data Catalog output from running the job.
List<E> databaseOutputs
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
String projectName
The DataBrew project associated with this job.
ProfileConfiguration 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.
List<E> validationConfigurations
List of validation configurations that are applied to the profile job.
RecipeReference recipeReference
String resourceArn
The Amazon Resource Name (ARN) of the job.
String roleArn
The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Map<K,V> tags
Metadata tags associated with this job.
Integer timeout
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT.
JobSample jobSample
Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.
Integer attempt
The number of times that DataBrew has attempted to run the job.
Date completedOn
The date and time when the job completed processing.
String datasetName
The name of the dataset for the job to process.
String errorMessage
A message indicating an error (if any) that was encountered when the job ran.
Integer executionTime
The amount of time, in seconds, during which the job run consumed resources.
String jobName
The name of the job being processed during this run.
ProfileConfiguration 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.
List<E> validationConfigurations
List of validation configurations that are applied to the profile job.
String runId
The unique identifier of the job run.
String state
The current state of the job run entity itself.
String logSubscription
The current status of Amazon CloudWatch logging for the job run.
String logGroupName
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
List<E> outputs
One or more output artifacts from a job run.
List<E> dataCatalogOutputs
One or more artifacts that represent the Glue Data Catalog output from running the job.
List<E> databaseOutputs
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
RecipeReference recipeReference
String startedBy
The Amazon Resource Name (ARN) of the user who started the job run.
Date startedOn
The date and time when the job run began.
JobSample 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.
String name
The name of the project to be described.
Date createDate
The date and time that the project was created.
String createdBy
The identifier (user name) of the user who created the project.
String datasetName
The dataset associated with the project.
Date lastModifiedDate
The date and time that the project was last modified.
String lastModifiedBy
The identifier (user name) of the user who last modified the project.
String name
The name of the project.
String recipeName
The recipe associated with this job.
String resourceArn
The Amazon Resource Name (ARN) of the project.
Sample sample
String roleArn
The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Map<K,V> tags
Metadata tags associated with this project.
String 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.
String openedBy
The identifier (user name) of the user that opened the project for use.
Date openDate
The date and time when the project was opened.
String createdBy
The identifier (user name) of the user who created the recipe.
Date createDate
The date and time that the recipe was created.
String lastModifiedBy
The identifier (user name) of the user who last modified the recipe.
Date lastModifiedDate
The date and time that the recipe was last modified.
String projectName
The name of the project associated with this recipe.
String publishedBy
The identifier (user name) of the user who last published the recipe.
Date publishedDate
The date and time when the recipe was last published.
String description
The description of the recipe.
String name
The name of the recipe.
List<E> 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.
Map<K,V> tags
Metadata tags associated with this project.
String resourceArn
The ARN of the recipe.
String recipeVersion
The recipe version identifier.
String name
The name of the ruleset to be described.
String name
The name of the ruleset.
String description
The description of the ruleset.
String targetArn
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
List<E> rules
A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.
Date createDate
The date and time that the ruleset was created.
String createdBy
The Amazon Resource Name (ARN) of the user who created the ruleset.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last modified the ruleset.
Date lastModifiedDate
The modification date and time of the ruleset.
String resourceArn
The Amazon Resource Name (ARN) for the ruleset.
Map<K,V> tags
Metadata tags that have been applied to the ruleset.
String name
The name of the schedule to be described.
Date createDate
The date and time that the schedule was created.
String createdBy
The identifier (user name) of the user who created the schedule.
List<E> jobNames
The name or names of one or more jobs to be run by using the schedule.
String lastModifiedBy
The identifier (user name) of the user who last modified the schedule.
Date lastModifiedDate
The date and time that the schedule was last modified.
String resourceArn
The Amazon Resource Name (ARN) of the schedule.
String 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.
Map<K,V> tags
Metadata tags associated with this schedule.
String name
The name of the schedule.
List<E> entityTypes
Entity types to detect. Can be any of the following:
USA_SSN
USA_ITIN
USA_PASSPORT_NUMBER
PHONE_NUMBER
USA_DRIVING_LICENSE
BANK_ACCOUNT
CREDIT_CARD
IP_ADDRESS
MAC_ADDRESS
USA_DEA_NUMBER
USA_HCPCS_CODE
USA_NATIONAL_PROVIDER_IDENTIFIER
USA_NATIONAL_DRUG_CODE
USA_HEALTH_INSURANCE_CLAIM_NUMBER
USA_MEDICARE_BENEFICIARY_IDENTIFIER
USA_CPT_CODE
PERSON_NAME
DATE
The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.
List<E> allowedStatistics
Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
List<E> sheetNames
One or more named sheets in the Excel file that will be included in the dataset.
List<E> sheetIndexes
One or more sheet numbers in the Excel file that will be included in the dataset.
Boolean 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.
Integer maxFiles
The number of Amazon S3 files to select.
String 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.
String order
A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Another possible value is ASCENDING.
String 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.
Map<K,V> valuesMap
The map of substitution variable names to their values used in this filter expression.
JsonOptions json
Options that define how JSON input is to be interpreted by DataBrew.
ExcelOptions excel
Options that define how Excel input is to be interpreted by DataBrew.
CsvOptions csv
Options that define how CSV input is to be interpreted by DataBrew.
S3Location s3InputDefinition
The Amazon S3 location where the data is stored.
DataCatalogInputDefinition dataCatalogInputDefinition
The Glue Data Catalog parameters for the data.
DatabaseInputDefinition databaseInputDefinition
Connection information for dataset input files stored in a database.
Metadata metadata
Contains additional resource information needed for specific datasets.
String accountId
The ID of the Amazon Web Services account that owns the job.
String createdBy
The Amazon Resource Name (ARN) of the user who created the job.
Date createDate
The date and time that the job was created.
String datasetName
A dataset that the job is to process.
String 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
String 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.
String name
The unique name of the job.
String 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.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last modified the job.
Date lastModifiedDate
The modification date and time of the job.
String logSubscription
The current status of Amazon CloudWatch logging for the job.
Integer maxCapacity
The maximum number of nodes that can be consumed when the job processes data.
Integer maxRetries
The maximum number of times to retry the job after a job run fails.
List<E> outputs
One or more artifacts that represent output from running the job.
List<E> dataCatalogOutputs
One or more artifacts that represent the Glue Data Catalog output from running the job.
List<E> databaseOutputs
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
String projectName
The name of the project that the job is associated with.
RecipeReference recipeReference
A set of steps that the job runs.
String resourceArn
The unique Amazon Resource Name (ARN) for the job.
String roleArn
The Amazon Resource Name (ARN) of the role to be assumed for this job.
Integer timeout
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT.
Map<K,V> tags
Metadata tags that have been applied to the job.
JobSample 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.
List<E> validationConfigurations
List of validation configurations that are applied to the profile job.
Integer attempt
The number of times that DataBrew has attempted to run the job.
Date completedOn
The date and time when the job completed processing.
String datasetName
The name of the dataset for the job to process.
String errorMessage
A message indicating an error (if any) that was encountered when the job ran.
Integer executionTime
The amount of time, in seconds, during which a job run consumed resources.
String jobName
The name of the job being processed during this run.
String runId
The unique identifier of the job run.
String state
The current state of the job run entity itself.
String logSubscription
The current status of Amazon CloudWatch logging for the job run.
String logGroupName
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
List<E> outputs
One or more output artifacts from a job run.
List<E> dataCatalogOutputs
One or more artifacts that represent the Glue Data Catalog output from running the job.
List<E> databaseOutputs
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
RecipeReference recipeReference
The set of steps processed by the job.
String startedBy
The Amazon Resource Name (ARN) of the user who initiated the job run.
Date startedOn
The date and time when the job run began.
JobSample 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.
List<E> validationConfigurations
List of validation configurations that are applied to the profile job run.
String 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.
Long 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
Boolean multiLine
A value that specifies whether JSON input contains embedded new line characters.
String datasetName
The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.
Integer maxResults
The maximum number of results to return in this request.
String 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.
String projectName
The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.
Integer maxResults
The maximum number of results to return in this request.
String nextToken
The token returned by a previous call to retrieve the next set of results.
String 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
String targetArn
The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.
Integer maxResults
The maximum number of results to return in this request.
String 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.
String resourceArn
The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.
String sourceArn
The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow.
String compressionFormat
The compression algorithm used to compress the output text of the job.
String format
The data format of the output of the job.
List<E> partitionColumns
The names of one or more partition columns for the output of the job.
S3Location location
The location in Amazon S3 where the job writes its output.
Boolean overwrite
A value that, if true, means that any data in the location specified for output is overwritten with new output.
OutputFormatOptions formatOptions
Represents options that define how DataBrew formats job output files.
Integer maxOutputFiles
Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.
CsvOutputOptions csv
Represents a set of options that define the structure of comma-separated value (CSV) job output.
FilterExpression lastModifiedDateCondition
If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.
FilesLimit filesLimit
If provided, this structure imposes a limit on a number of files that should be selected.
Map<K,V> parameters
A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
StatisticsConfiguration 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.
List<E> 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.
List<E> 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.
EntityDetectorConfiguration entityDetectorConfiguration
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
String accountId
The ID of the Amazon Web Services account that owns the project.
Date createDate
The date and time that the project was created.
String createdBy
The Amazon Resource Name (ARN) of the user who crated the project.
String datasetName
The dataset that the project is to act upon.
Date lastModifiedDate
The last modification date and time for the project.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last modified the project.
String name
The unique name of a project.
String recipeName
The name of a recipe that will be developed during a project session.
String resourceArn
The Amazon Resource Name (ARN) for the project.
Sample 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.
Map<K,V> tags
Metadata tags that have been applied to the project.
String roleArn
The Amazon Resource Name (ARN) of the role that will be assumed for this project.
String openedBy
The Amazon Resource Name (ARN) of the user that opened the project for use.
Date openDate
The date and time when the project was opened.
String name
The name of the recipe that you published.
String createdBy
The Amazon Resource Name (ARN) of the user who created the recipe.
Date createDate
The date and time that the recipe was created.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last modified the recipe.
Date lastModifiedDate
The last modification date and time of the recipe.
String projectName
The name of the project that the recipe is associated with.
String publishedBy
The Amazon Resource Name (ARN) of the user who published the recipe.
Date publishedDate
The date and time when the recipe was published.
String description
The description of the recipe.
String name
The unique name for the recipe.
String resourceArn
The Amazon Resource Name (ARN) for the recipe.
List<E> steps
A list of steps that are defined by the recipe.
Map<K,V> tags
Metadata tags that have been applied to the recipe.
String recipeVersion
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.
RecipeAction action
The particular action to be performed in the recipe step.
List<E> 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.
String name
The name of the rule.
Boolean disabled
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
String checkExpression
The expression which includes column references, condition names followed by variable references, possibly
grouped and combined with other conditions. For example,
(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)
. Column and value references are substitution variables that should start with the ':' symbol. Depending on the
context, substitution variables' values can be either an actual value or a column name. These values are defined
in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule
should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of
a condition, for example, is_between :val1 and :val2.
For more information, see Available checks
Map<K,V> substitutionMap
The map of substitution variable names to their values used in a check expression. Variable names should start
with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the
two, column names should be enclosed in backticks, for example, ":col1": "`Column A`".
Threshold threshold
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
List<E> columnSelectors
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
String accountId
The ID of the Amazon Web Services account that owns the ruleset.
String createdBy
The Amazon Resource Name (ARN) of the user who created the ruleset.
Date createDate
The date and time that the ruleset was created.
String description
The description of the ruleset.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last modified the ruleset.
Date lastModifiedDate
The modification date and time of the ruleset.
String name
The name of the ruleset.
String resourceArn
The Amazon Resource Name (ARN) for the ruleset.
Integer ruleCount
The number of rules that are defined in the ruleset.
Map<K,V> tags
Metadata tags that have been applied to the ruleset.
String targetArn
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
S3Location location
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
String accountId
The ID of the Amazon Web Services account that owns the schedule.
String createdBy
The Amazon Resource Name (ARN) of the user who created the schedule.
Date createDate
The date and time that the schedule was created.
List<E> jobNames
A list of jobs to be run, according to the schedule.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last modified the schedule.
Date lastModifiedDate
The date and time when the schedule was last modified.
String resourceArn
The Amazon Resource Name (ARN) of the schedule.
String cronExpression
The dates and times when the job is to run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
Map<K,V> tags
Metadata tags that have been applied to the schedule.
String name
The name of the schedule.
Boolean preview
If true, the result of the recipe step will be returned, but not applied.
String name
The name of the project to apply the action to.
RecipeStep recipeStep
Integer 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.
String clientSessionId
A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.
ViewFrame viewFrame
String name
The name of the job to be run.
String runId
A system-generated identifier for this particular job run.
String runId
The ID of the job run that you stopped.
Double value
The value of a threshold.
String type
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
String unit
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
String name
The name of the dataset to be updated.
String format
The file format of a dataset that is created from an Amazon S3 file or folder.
FormatOptions formatOptions
Input input
PathOptions pathOptions
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
String name
The name of the dataset that you updated.
ProfileConfiguration 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.
String encryptionKeyArn
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
String 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.
String name
The name of the job to be updated.
String logSubscription
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
Integer maxCapacity
The maximum number of compute nodes that DataBrew can use when the job processes data.
Integer maxRetries
The maximum number of times to retry the job after a job run fails.
S3Location outputLocation
List<E> validationConfigurations
List of validation configurations that are applied to the profile job.
String roleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Integer timeout
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT.
JobSample 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.
String name
The name of the job that was updated.
String encryptionKeyArn
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
String 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.
String name
The name of the job to update.
String logSubscription
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
Integer maxCapacity
The maximum number of nodes that DataBrew can consume when the job processes data.
Integer maxRetries
The maximum number of times to retry the job after a job run fails.
List<E> outputs
One or more artifacts that represent the output from running the job.
List<E> dataCatalogOutputs
One or more artifacts that represent the Glue Data Catalog output from running the job.
List<E> databaseOutputs
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
String roleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Integer timeout
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT.
String name
The name of the job that you updated.
String name
The name of the recipe that was updated.
String name
The name of the updated ruleset.
List<E> jobNames
The name or names of one or more jobs to be run for this schedule.
String 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.
String name
The name of the schedule to update.
String name
The name of the schedule that was updated.
String rulesetArn
The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.
String validationMode
Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.
Integer startColumnIndex
The starting index for the range of columns to return in the view frame.
Integer columnRange
The number of columns to include in the view frame, beginning with the StartColumnIndex value and
ignoring any columns in the HiddenColumns list.
List<E> hiddenColumns
A list of columns to hide in the view frame.
Integer startRowIndex
The starting index for the range of rows to return in the view frame.
Integer rowRange
The number of rows to include in the view frame, beginning with the StartRowIndex value.
String analytics
Controls if analytics computation is enabled or disabled. Enabled by default.
Copyright © 2022. All rights reserved.