# Data Types


The following data types are supported:
+  [AllowedStatistics](API_AllowedStatistics.md) 
+  [ColumnSelector](API_ColumnSelector.md) 
+  [ColumnStatisticsConfiguration](API_ColumnStatisticsConfiguration.md) 
+  [ConditionExpression](API_ConditionExpression.md) 
+  [CsvOptions](API_CsvOptions.md) 
+  [CsvOutputOptions](API_CsvOutputOptions.md) 
+  [DatabaseInputDefinition](API_DatabaseInputDefinition.md) 
+  [DatabaseOutput](API_DatabaseOutput.md) 
+  [DatabaseTableOutputOptions](API_DatabaseTableOutputOptions.md) 
+  [DataCatalogInputDefinition](API_DataCatalogInputDefinition.md) 
+  [DataCatalogOutput](API_DataCatalogOutput.md) 
+  [Dataset](API_Dataset.md) 
+  [DatasetParameter](API_DatasetParameter.md) 
+  [DatetimeOptions](API_DatetimeOptions.md) 
+  [EntityDetectorConfiguration](API_EntityDetectorConfiguration.md) 
+  [ExcelOptions](API_ExcelOptions.md) 
+  [FilesLimit](API_FilesLimit.md) 
+  [FilterExpression](API_FilterExpression.md) 
+  [FormatOptions](API_FormatOptions.md) 
+  [Input](API_Input.md) 
+  [Job](API_Job.md) 
+  [JobRun](API_JobRun.md) 
+  [JobSample](API_JobSample.md) 
+  [JsonOptions](API_JsonOptions.md) 
+  [Metadata](API_Metadata.md) 
+  [Output](API_Output.md) 
+  [OutputFormatOptions](API_OutputFormatOptions.md) 
+  [PathOptions](API_PathOptions.md) 
+  [ProfileConfiguration](API_ProfileConfiguration.md) 
+  [Project](API_Project.md) 
+  [Recipe](API_Recipe.md) 
+  [RecipeAction](API_RecipeAction.md) 
+  [RecipeReference](API_RecipeReference.md) 
+  [RecipeStep](API_RecipeStep.md) 
+  [RecipeVersionErrorDetail](API_RecipeVersionErrorDetail.md) 
+  [Rule](API_Rule.md) 
+  [RulesetItem](API_RulesetItem.md) 
+  [S3Location](API_S3Location.md) 
+  [S3TableOutputOptions](API_S3TableOutputOptions.md) 
+  [Sample](API_Sample.md) 
+  [Schedule](API_Schedule.md) 
+  [StatisticOverride](API_StatisticOverride.md) 
+  [StatisticsConfiguration](API_StatisticsConfiguration.md) 
+  [Threshold](API_Threshold.md) 
+  [ValidationConfiguration](API_ValidationConfiguration.md) 
+  [ViewFrame](API_ViewFrame.md) 

# 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.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Statistics **   <a name="databrew-Type-AllowedStatistics-Statistics"></a>
One or more column statistics to allow for columns that contain detected entities.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[A-Z\_]+$`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/AllowedStatistics) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/AllowedStatistics) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/AllowedStatistics) 

# ColumnSelector


Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-ColumnSelector-Name"></a>
The name of a column from a dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Regex **   <a name="databrew-Type-ColumnSelector-Regex"></a>
A regular expression for selecting a column from a dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/ColumnSelector) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/ColumnSelector) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/ColumnSelector) 

# ColumnStatisticsConfiguration


Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns. 

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Statistics **   <a name="databrew-Type-ColumnStatisticsConfiguration-Statistics"></a>
Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.   
Type: [StatisticsConfiguration](API_StatisticsConfiguration.md) object  
Required: Yes

 ** Selectors **   <a name="databrew-Type-ColumnStatisticsConfiguration-Selectors"></a>
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.   
Type: Array of [ColumnSelector](API_ColumnSelector.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/ColumnStatisticsConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/ColumnStatisticsConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/ColumnStatisticsConfiguration) 

# ConditionExpression


Represents an individual condition that evaluates to true or false.

Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.

If a recipe requires more than one condition, then the recipe must specify multiple `ConditionExpression` elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Condition **   <a name="databrew-Type-ConditionExpression-Condition"></a>
A specific condition to apply to a recipe action. For more information, see [Recipe structure](https://docs.amazonaws.cn/databrew/latest/dg/recipes.html#recipes.structure) in the * Amazon Glue DataBrew Developer Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[A-Z\_]+$`   
Required: Yes

 ** TargetColumn **   <a name="databrew-Type-ConditionExpression-TargetColumn"></a>
A column to apply this condition to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** Value **   <a name="databrew-Type-ConditionExpression-Value"></a>
A value that the condition must evaluate to for the condition to succeed.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/ConditionExpression) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/ConditionExpression) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/ConditionExpression) 

# CsvOptions


Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Delimiter **   <a name="databrew-Type-CsvOptions-Delimiter"></a>
A single character that specifies the delimiter being used in the CSV file.  
Type: String  
Length Constraints: Fixed length of 1.  
Required: No

 ** HeaderRow **   <a name="databrew-Type-CsvOptions-HeaderRow"></a>
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.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/CsvOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/CsvOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/CsvOptions) 

# CsvOutputOptions


Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Delimiter **   <a name="databrew-Type-CsvOutputOptions-Delimiter"></a>
A single character that specifies the delimiter used to create CSV job output.  
Type: String  
Length Constraints: Fixed length of 1.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/CsvOutputOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/CsvOutputOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/CsvOutputOptions) 

# DatabaseInputDefinition


Connection information for dataset input files stored in a database.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** GlueConnectionName **   <a name="databrew-Type-DatabaseInputDefinition-GlueConnectionName"></a>
The Amazon Glue Connection that stores the connection information for the target database.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** DatabaseTableName **   <a name="databrew-Type-DatabaseInputDefinition-DatabaseTableName"></a>
The table within the target database.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** QueryString **   <a name="databrew-Type-DatabaseInputDefinition-QueryString"></a>
Custom SQL to run against the provided Amazon Glue connection. This SQL will be used as the input for DataBrew projects and jobs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.  
Required: No

 ** TempDirectory **   <a name="databrew-Type-DatabaseInputDefinition-TempDirectory"></a>
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.  
Type: [S3Location](API_S3Location.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/DatabaseInputDefinition) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/DatabaseInputDefinition) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/DatabaseInputDefinition) 

# DatabaseOutput


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

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** DatabaseOptions **   <a name="databrew-Type-DatabaseOutput-DatabaseOptions"></a>
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.  
Type: [DatabaseTableOutputOptions](API_DatabaseTableOutputOptions.md) object  
Required: Yes

 ** GlueConnectionName **   <a name="databrew-Type-DatabaseOutput-GlueConnectionName"></a>
The Amazon Glue connection that stores the connection information for the target database.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** DatabaseOutputMode **   <a name="databrew-Type-DatabaseOutput-DatabaseOutputMode"></a>
The output mode to write into the database. Currently supported option: NEW\$1TABLE.  
Type: String  
Valid Values: `NEW_TABLE`   
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/DatabaseOutput) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/DatabaseOutput) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/DatabaseOutput) 

# DatabaseTableOutputOptions


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

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** TableName **   <a name="databrew-Type-DatabaseTableOutputOptions-TableName"></a>
A prefix for the name of a table DataBrew will create in the database.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** TempDirectory **   <a name="databrew-Type-DatabaseTableOutputOptions-TempDirectory"></a>
Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.  
Type: [S3Location](API_S3Location.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/DatabaseTableOutputOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/DatabaseTableOutputOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/DatabaseTableOutputOptions) 

# DataCatalogInputDefinition


Represents how metadata stored in the Amazon Glue Data Catalog is defined in a DataBrew dataset. 

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** DatabaseName **   <a name="databrew-Type-DataCatalogInputDefinition-DatabaseName"></a>
The name of a database in the Data Catalog.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** TableName **   <a name="databrew-Type-DataCatalogInputDefinition-TableName"></a>
The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** CatalogId **   <a name="databrew-Type-DataCatalogInputDefinition-CatalogId"></a>
The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** TempDirectory **   <a name="databrew-Type-DataCatalogInputDefinition-TempDirectory"></a>
Represents an Amazon location where DataBrew can store intermediate results.  
Type: [S3Location](API_S3Location.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/DataCatalogInputDefinition) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/DataCatalogInputDefinition) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/DataCatalogInputDefinition) 

# DataCatalogOutput


Represents options that specify how and where in the Amazon Glue Data Catalog DataBrew writes the output generated by recipe jobs.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** DatabaseName **   <a name="databrew-Type-DataCatalogOutput-DatabaseName"></a>
The name of a database in the Data Catalog.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** TableName **   <a name="databrew-Type-DataCatalogOutput-TableName"></a>
The name of a table in the Data Catalog.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** CatalogId **   <a name="databrew-Type-DataCatalogOutput-CatalogId"></a>
The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** DatabaseOptions **   <a name="databrew-Type-DataCatalogOutput-DatabaseOptions"></a>
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.  
Type: [DatabaseTableOutputOptions](API_DatabaseTableOutputOptions.md) object  
Required: No

 ** Overwrite **   <a name="databrew-Type-DataCatalogOutput-Overwrite"></a>
A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.  
Type: Boolean  
Required: No

 ** S3Options **   <a name="databrew-Type-DataCatalogOutput-S3Options"></a>
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.  
Type: [S3TableOutputOptions](API_S3TableOutputOptions.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/DataCatalogOutput) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/DataCatalogOutput) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/DataCatalogOutput) 

# Dataset


Represents a dataset that can be processed by DataBrew.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Input **   <a name="databrew-Type-Dataset-Input"></a>
Information on how DataBrew can find the dataset, in either the Amazon Glue Data Catalog or Amazon S3.  
Type: [Input](API_Input.md) object  
Required: Yes

 ** Name **   <a name="databrew-Type-Dataset-Name"></a>
The unique name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** AccountId **   <a name="databrew-Type-Dataset-AccountId"></a>
The ID of the Amazon account that owns the dataset.  
Type: String  
Length Constraints: Maximum length of 255.  
Required: No

 ** CreateDate **   <a name="databrew-Type-Dataset-CreateDate"></a>
The date and time that the dataset was created.  
Type: Timestamp  
Required: No

 ** CreatedBy **   <a name="databrew-Type-Dataset-CreatedBy"></a>
The Amazon Resource Name (ARN) of the user who created the dataset.  
Type: String  
Required: No

 ** Format **   <a name="databrew-Type-Dataset-Format"></a>
The file format of a dataset that is created from an Amazon S3 file or folder.  
Type: String  
Valid Values: `CSV | JSON | PARQUET | EXCEL | ORC`   
Required: No

 ** FormatOptions **   <a name="databrew-Type-Dataset-FormatOptions"></a>
A set of options that define how DataBrew interprets the data in the dataset.  
Type: [FormatOptions](API_FormatOptions.md) object  
Required: No

 ** LastModifiedBy **   <a name="databrew-Type-Dataset-LastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last modified the dataset.  
Type: String  
Required: No

 ** LastModifiedDate **   <a name="databrew-Type-Dataset-LastModifiedDate"></a>
The last modification date and time of the dataset.  
Type: Timestamp  
Required: No

 ** PathOptions **   <a name="databrew-Type-Dataset-PathOptions"></a>
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.  
Type: [PathOptions](API_PathOptions.md) object  
Required: No

 ** ResourceArn **   <a name="databrew-Type-Dataset-ResourceArn"></a>
The unique Amazon Resource Name (ARN) for the dataset.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** Source **   <a name="databrew-Type-Dataset-Source"></a>
The location of the data for the dataset, either Amazon S3 or the Amazon Glue Data Catalog.  
Type: String  
Valid Values: `S3 | DATA-CATALOG | DATABASE`   
Required: No

 ** Tags **   <a name="databrew-Type-Dataset-Tags"></a>
Metadata tags that have been applied to the dataset.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Dataset) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Dataset) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Dataset) 

# DatasetParameter


Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-DatasetParameter-Name"></a>
The name of the parameter that is used in the dataset's Amazon S3 path.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** Type **   <a name="databrew-Type-DatasetParameter-Type"></a>
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.  
Type: String  
Valid Values: `Datetime | Number | String`   
Required: Yes

 ** CreateColumn **   <a name="databrew-Type-DatasetParameter-CreateColumn"></a>
Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.  
Type: Boolean  
Required: No

 ** DatetimeOptions **   <a name="databrew-Type-DatasetParameter-DatetimeOptions"></a>
Additional parameter options such as a format and a timezone. Required for datetime parameters.  
Type: [DatetimeOptions](API_DatetimeOptions.md) object  
Required: No

 ** Filter **   <a name="databrew-Type-DatasetParameter-Filter"></a>
The optional filter expression structure to apply additional matching criteria to the parameter.  
Type: [FilterExpression](API_FilterExpression.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/DatasetParameter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/DatasetParameter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/DatasetParameter) 

# DatetimeOptions


Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Format **   <a name="databrew-Type-DatetimeOptions-Format"></a>
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".  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Required: Yes

 ** LocaleCode **   <a name="databrew-Type-DatetimeOptions-LocaleCode"></a>
Optional value for a non-US locale code, needed for correct interpretation of some date formats.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `^[A-Za-z0-9_\.#@\-]+$`   
Required: No

 ** TimezoneOffset **   <a name="databrew-Type-DatetimeOptions-TimezoneOffset"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6.  
Pattern: `^(Z|[-+](\d|\d{2}|\d{2}:?\d{2}))$`   
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/DatetimeOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/DatetimeOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/DatetimeOptions) 

# EntityDetectorConfiguration


Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** EntityTypes **   <a name="databrew-Type-EntityDetectorConfiguration-EntityTypes"></a>
Entity types to detect. Can be any of the following:  
+ USA\$1SSN
+ EMAIL
+ USA\$1ITIN
+ USA\$1PASSPORT\$1NUMBER
+ PHONE\$1NUMBER
+ USA\$1DRIVING\$1LICENSE
+ BANK\$1ACCOUNT
+ CREDIT\$1CARD
+ IP\$1ADDRESS
+ MAC\$1ADDRESS
+ USA\$1DEA\$1NUMBER
+ USA\$1HCPCS\$1CODE
+ USA\$1NATIONAL\$1PROVIDER\$1IDENTIFIER
+ USA\$1NATIONAL\$1DRUG\$1CODE
+ USA\$1HEALTH\$1INSURANCE\$1CLAIM\$1NUMBER
+ USA\$1MEDICARE\$1BENEFICIARY\$1IDENTIFIER
+ USA\$1CPT\$1CODE
+ PERSON\$1NAME
+ DATE
The Entity type group USA\$1ALL is also supported, and includes all of the above entity types except PERSON\$1NAME and DATE.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[A-Z_][A-Z\\d_]*$`   
Required: Yes

 ** AllowedStatistics **   <a name="databrew-Type-EntityDetectorConfiguration-AllowedStatistics"></a>
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.  
Type: Array of [AllowedStatistics](API_AllowedStatistics.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/EntityDetectorConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/EntityDetectorConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/EntityDetectorConfiguration) 

# ExcelOptions


Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** HeaderRow **   <a name="databrew-Type-ExcelOptions-HeaderRow"></a>
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.  
Type: Boolean  
Required: No

 ** SheetIndexes **   <a name="databrew-Type-ExcelOptions-SheetIndexes"></a>
One or more sheet numbers in the Excel file that will be included in the dataset.  
Type: Array of integers  
Array Members: Fixed number of 1 item.  
Valid Range: Minimum value of 0. Maximum value of 200.  
Required: No

 ** SheetNames **   <a name="databrew-Type-ExcelOptions-SheetNames"></a>
One or more named sheets in the Excel file that will be included in the dataset.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 31.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/ExcelOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/ExcelOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/ExcelOptions) 

# FilesLimit


Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** MaxFiles **   <a name="databrew-Type-FilesLimit-MaxFiles"></a>
The number of Amazon S3 files to select.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: Yes

 ** Order **   <a name="databrew-Type-FilesLimit-Order"></a>
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.  
Type: String  
Valid Values: `DESCENDING | ASCENDING`   
Required: No

 ** OrderedBy **   <a name="databrew-Type-FilesLimit-OrderedBy"></a>
A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST\$1MODIFIED\$1DATE as a sorting criteria. Currently it's the only allowed value.  
Type: String  
Valid Values: `LAST_MODIFIED_DATE`   
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/FilesLimit) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/FilesLimit) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/FilesLimit) 

# FilterExpression


Represents a structure for defining parameter conditions. Supported conditions are described here: [Supported conditions for dynamic datasets](https://docs.amazonaws.cn/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets) in the * Amazon Glue DataBrew Developer Guide*.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Expression **   <a name="databrew-Type-FilterExpression-Expression"></a>
The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, "(starts\$1with :prefix1 or starts\$1with :prefix2) and (ends\$1with :suffix1 or ends\$1with :suffix2)". Substitution variables should start with ':' symbol.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Pattern: `^[<>0-9A-Za-z_.,:)(!= ]+$`   
Required: Yes

 ** ValuesMap **   <a name="databrew-Type-FilterExpression-ValuesMap"></a>
The map of substitution variable names to their values used in this filter expression.  
Type: String to string map  
Key Length Constraints: Minimum length of 2. Maximum length of 128.  
Key Pattern: `^:[A-Za-z0-9_]+$`   
Value Length Constraints: Maximum length of 1024.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/FilterExpression) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/FilterExpression) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/FilterExpression) 

# FormatOptions


Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Csv **   <a name="databrew-Type-FormatOptions-Csv"></a>
Options that define how CSV input is to be interpreted by DataBrew.  
Type: [CsvOptions](API_CsvOptions.md) object  
Required: No

 ** Excel **   <a name="databrew-Type-FormatOptions-Excel"></a>
Options that define how Excel input is to be interpreted by DataBrew.  
Type: [ExcelOptions](API_ExcelOptions.md) object  
Required: No

 ** Json **   <a name="databrew-Type-FormatOptions-Json"></a>
Options that define how JSON input is to be interpreted by DataBrew.  
Type: [JsonOptions](API_JsonOptions.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/FormatOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/FormatOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/FormatOptions) 

# Input


Represents information on how DataBrew can find data, in either the Amazon Glue Data Catalog or Amazon S3.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** DatabaseInputDefinition **   <a name="databrew-Type-Input-DatabaseInputDefinition"></a>
Connection information for dataset input files stored in a database.  
Type: [DatabaseInputDefinition](API_DatabaseInputDefinition.md) object  
Required: No

 ** DataCatalogInputDefinition **   <a name="databrew-Type-Input-DataCatalogInputDefinition"></a>
The Amazon Glue Data Catalog parameters for the data.  
Type: [DataCatalogInputDefinition](API_DataCatalogInputDefinition.md) object  
Required: No

 ** Metadata **   <a name="databrew-Type-Input-Metadata"></a>
Contains additional resource information needed for specific datasets.  
Type: [Metadata](API_Metadata.md) object  
Required: No

 ** S3InputDefinition **   <a name="databrew-Type-Input-S3InputDefinition"></a>
The Amazon S3 location where the data is stored.  
Type: [S3Location](API_S3Location.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Input) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Input) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Input) 

# Job


Represents all of the attributes of a DataBrew job.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-Job-Name"></a>
The unique name of the job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

 ** AccountId **   <a name="databrew-Type-Job-AccountId"></a>
The ID of the Amazon account that owns the job.  
Type: String  
Length Constraints: Maximum length of 255.  
Required: No

 ** CreateDate **   <a name="databrew-Type-Job-CreateDate"></a>
The date and time that the job was created.  
Type: Timestamp  
Required: No

 ** CreatedBy **   <a name="databrew-Type-Job-CreatedBy"></a>
The Amazon Resource Name (ARN) of the user who created the job.  
Type: String  
Required: No

 ** DatabaseOutputs **   <a name="databrew-Type-Job-DatabaseOutputs"></a>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.  
Type: Array of [DatabaseOutput](API_DatabaseOutput.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** DataCatalogOutputs **   <a name="databrew-Type-Job-DataCatalogOutputs"></a>
One or more artifacts that represent the Amazon Glue Data Catalog output from running the job.  
Type: Array of [DataCatalogOutput](API_DataCatalogOutput.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** DatasetName **   <a name="databrew-Type-Job-DatasetName"></a>
A dataset that the job is to process.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** EncryptionKeyArn **   <a name="databrew-Type-Job-EncryptionKeyArn"></a>
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](https://docs.amazonaws.cn/databrew/latest/dg/encryption-security-configuration.html)   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** EncryptionMode **   <a name="databrew-Type-Job-EncryptionMode"></a>
The encryption mode for the job, which can be one of the following:  
+  `SSE-KMS` - Server-side encryption with keys managed by Amazon KMS.
+  `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
Type: String  
Valid Values: `SSE-KMS | SSE-S3`   
Required: No

 ** JobSample **   <a name="databrew-Type-Job-JobSample"></a>
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\$1ROWS for the mode parameter and 20,000 for the size parameter.  
Type: [JobSample](API_JobSample.md) object  
Required: No

 ** LastModifiedBy **   <a name="databrew-Type-Job-LastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last modified the job.  
Type: String  
Required: No

 ** LastModifiedDate **   <a name="databrew-Type-Job-LastModifiedDate"></a>
The modification date and time of the job.  
Type: Timestamp  
Required: No

 ** LogSubscription **   <a name="databrew-Type-Job-LogSubscription"></a>
The current status of Amazon CloudWatch logging for the job.  
Type: String  
Valid Values: `ENABLE | DISABLE`   
Required: No

 ** MaxCapacity **   <a name="databrew-Type-Job-MaxCapacity"></a>
The maximum number of nodes that can be consumed when the job processes data.  
Type: Integer  
Required: No

 ** MaxRetries **   <a name="databrew-Type-Job-MaxRetries"></a>
The maximum number of times to retry the job after a job run fails.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Outputs **   <a name="databrew-Type-Job-Outputs"></a>
One or more artifacts that represent output from running the job.  
Type: Array of [Output](API_Output.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** ProjectName **   <a name="databrew-Type-Job-ProjectName"></a>
The name of the project that the job is associated with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** RecipeReference **   <a name="databrew-Type-Job-RecipeReference"></a>
A set of steps that the job runs.  
Type: [RecipeReference](API_RecipeReference.md) object  
Required: No

 ** ResourceArn **   <a name="databrew-Type-Job-ResourceArn"></a>
The unique Amazon Resource Name (ARN) for the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** RoleArn **   <a name="databrew-Type-Job-RoleArn"></a>
The Amazon Resource Name (ARN) of the role to be assumed for this job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** Tags **   <a name="databrew-Type-Job-Tags"></a>
Metadata tags that have been applied to the job.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

 ** Timeout **   <a name="databrew-Type-Job-Timeout"></a>
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Type **   <a name="databrew-Type-Job-Type"></a>
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.
Type: String  
Valid Values: `PROFILE | RECIPE`   
Required: No

 ** ValidationConfigurations **   <a name="databrew-Type-Job-ValidationConfigurations"></a>
List of validation configurations that are applied to the profile job.  
Type: Array of [ValidationConfiguration](API_ValidationConfiguration.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Job) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Job) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Job) 

# JobRun


Represents one run of a DataBrew job.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Attempt **   <a name="databrew-Type-JobRun-Attempt"></a>
The number of times that DataBrew has attempted to run the job.  
Type: Integer  
Required: No

 ** CompletedOn **   <a name="databrew-Type-JobRun-CompletedOn"></a>
The date and time when the job completed processing.  
Type: Timestamp  
Required: No

 ** DatabaseOutputs **   <a name="databrew-Type-JobRun-DatabaseOutputs"></a>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.  
Type: Array of [DatabaseOutput](API_DatabaseOutput.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** DataCatalogOutputs **   <a name="databrew-Type-JobRun-DataCatalogOutputs"></a>
One or more artifacts that represent the Amazon Glue Data Catalog output from running the job.  
Type: Array of [DataCatalogOutput](API_DataCatalogOutput.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** DatasetName **   <a name="databrew-Type-JobRun-DatasetName"></a>
The name of the dataset for the job to process.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** ErrorMessage **   <a name="databrew-Type-JobRun-ErrorMessage"></a>
A message indicating an error (if any) that was encountered when the job ran.  
Type: String  
Required: No

 ** ExecutionTime **   <a name="databrew-Type-JobRun-ExecutionTime"></a>
The amount of time, in seconds, during which a job run consumed resources.  
Type: Integer  
Required: No

 ** JobName **   <a name="databrew-Type-JobRun-JobName"></a>
The name of the job being processed during this run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: No

 ** JobSample **   <a name="databrew-Type-JobRun-JobSample"></a>
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\$1ROWS for the mode parameter and 20,000 for the size parameter.  
Type: [JobSample](API_JobSample.md) object  
Required: No

 ** LogGroupName **   <a name="databrew-Type-JobRun-LogGroupName"></a>
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** LogSubscription **   <a name="databrew-Type-JobRun-LogSubscription"></a>
The current status of Amazon CloudWatch logging for the job run.  
Type: String  
Valid Values: `ENABLE | DISABLE`   
Required: No

 ** Outputs **   <a name="databrew-Type-JobRun-Outputs"></a>
One or more output artifacts from a job run.  
Type: Array of [Output](API_Output.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** RecipeReference **   <a name="databrew-Type-JobRun-RecipeReference"></a>
The set of steps processed by the job.  
Type: [RecipeReference](API_RecipeReference.md) object  
Required: No

 ** RunId **   <a name="databrew-Type-JobRun-RunId"></a>
The unique identifier of the job run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** StartedBy **   <a name="databrew-Type-JobRun-StartedBy"></a>
The Amazon Resource Name (ARN) of the user who initiated the job run.   
Type: String  
Required: No

 ** StartedOn **   <a name="databrew-Type-JobRun-StartedOn"></a>
The date and time when the job run began.   
Type: Timestamp  
Required: No

 ** State **   <a name="databrew-Type-JobRun-State"></a>
The current state of the job run entity itself.  
Type: String  
Valid Values: `STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT`   
Required: No

 ** ValidationConfigurations **   <a name="databrew-Type-JobRun-ValidationConfigurations"></a>
List of validation configurations that are applied to the profile job run.  
Type: Array of [ValidationConfiguration](API_ValidationConfiguration.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/JobRun) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/JobRun) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/JobRun) 

# JobSample


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

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Mode **   <a name="databrew-Type-JobSample-Mode"></a>
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\$1DATASET - The profile job is run on the entire dataset.
+ CUSTOM\$1ROWS - The profile job is run on the number of rows specified in the `Size` parameter.
Type: String  
Valid Values: `FULL_DATASET | CUSTOM_ROWS`   
Required: No

 ** Size **   <a name="databrew-Type-JobSample-Size"></a>
The `Size` parameter is only required when the mode is CUSTOM\$1ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX\$1VALUE.  
Long.MAX\$1VALUE = 9223372036854775807  
Type: Long  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/JobSample) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/JobSample) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/JobSample) 

# JsonOptions


Represents the JSON-specific options that define how input is to be interpreted by Amazon Glue DataBrew.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** MultiLine **   <a name="databrew-Type-JsonOptions-MultiLine"></a>
A value that specifies whether JSON input contains embedded new line characters.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/JsonOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/JsonOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/JsonOptions) 

# Metadata


Contains additional resource information needed for specific datasets.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** SourceArn **   <a name="databrew-Type-Metadata-SourceArn"></a>
The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Metadata) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Metadata) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Metadata) 

# Output


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

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Location **   <a name="databrew-Type-Output-Location"></a>
The location in Amazon S3 where the job writes its output.  
Type: [S3Location](API_S3Location.md) object  
Required: Yes

 ** CompressionFormat **   <a name="databrew-Type-Output-CompressionFormat"></a>
The compression algorithm used to compress the output text of the job.  
Type: String  
Valid Values: `GZIP | LZ4 | SNAPPY | BZIP2 | DEFLATE | LZO | BROTLI | ZSTD | ZLIB`   
Required: No

 ** Format **   <a name="databrew-Type-Output-Format"></a>
The data format of the output of the job.  
Type: String  
Valid Values: `CSV | JSON | PARQUET | GLUEPARQUET | AVRO | ORC | XML | TABLEAUHYPER`   
Required: No

 ** FormatOptions **   <a name="databrew-Type-Output-FormatOptions"></a>
Represents options that define how DataBrew formats job output files.  
Type: [OutputFormatOptions](API_OutputFormatOptions.md) object  
Required: No

 ** MaxOutputFiles **   <a name="databrew-Type-Output-MaxOutputFiles"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 999.  
Required: No

 ** Overwrite **   <a name="databrew-Type-Output-Overwrite"></a>
A value that, if true, means that any data in the location specified for output is overwritten with new output.  
Type: Boolean  
Required: No

 ** PartitionColumns **   <a name="databrew-Type-Output-PartitionColumns"></a>
The names of one or more partition columns for the output of the job.  
Type: Array of strings  
Array Members: Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Output) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Output) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Output) 

# OutputFormatOptions


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

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Csv **   <a name="databrew-Type-OutputFormatOptions-Csv"></a>
Represents a set of options that define the structure of comma-separated value (CSV) job output.  
Type: [CsvOutputOptions](API_CsvOutputOptions.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/OutputFormatOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/OutputFormatOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/OutputFormatOptions) 

# PathOptions


Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** FilesLimit **   <a name="databrew-Type-PathOptions-FilesLimit"></a>
If provided, this structure imposes a limit on a number of files that should be selected.  
Type: [FilesLimit](API_FilesLimit.md) object  
Required: No

 ** LastModifiedDateCondition **   <a name="databrew-Type-PathOptions-LastModifiedDateCondition"></a>
If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.  
Type: [FilterExpression](API_FilterExpression.md) object  
Required: No

 ** Parameters **   <a name="databrew-Type-PathOptions-Parameters"></a>
A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.  
Type: String to [DatasetParameter](API_DatasetParameter.md) object map  
Map Entries: Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/PathOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/PathOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/PathOptions) 

# ProfileConfiguration


Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. 

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** ColumnStatisticsConfigurations **   <a name="databrew-Type-ProfileConfiguration-ColumnStatisticsConfigurations"></a>
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.   
Type: Array of [ColumnStatisticsConfiguration](API_ColumnStatisticsConfiguration.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** DatasetStatisticsConfiguration **   <a name="databrew-Type-ProfileConfiguration-DatasetStatisticsConfiguration"></a>
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.   
Type: [StatisticsConfiguration](API_StatisticsConfiguration.md) object  
Required: No

 ** EntityDetectorConfiguration **   <a name="databrew-Type-ProfileConfiguration-EntityDetectorConfiguration"></a>
Configuration of entity detection for a profile job. When undefined, entity detection is disabled.  
Type: [EntityDetectorConfiguration](API_EntityDetectorConfiguration.md) object  
Required: No

 ** ProfileColumns **   <a name="databrew-Type-ProfileConfiguration-ProfileColumns"></a>
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.   
Type: Array of [ColumnSelector](API_ColumnSelector.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/ProfileConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/ProfileConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/ProfileConfiguration) 

# Project


Represents all of the attributes of a DataBrew project.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-Project-Name"></a>
The unique name of a project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** RecipeName **   <a name="databrew-Type-Project-RecipeName"></a>
The name of a recipe that will be developed during a project session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** AccountId **   <a name="databrew-Type-Project-AccountId"></a>
The ID of the Amazon account that owns the project.  
Type: String  
Length Constraints: Maximum length of 255.  
Required: No

 ** CreateDate **   <a name="databrew-Type-Project-CreateDate"></a>
The date and time that the project was created.  
Type: Timestamp  
Required: No

 ** CreatedBy **   <a name="databrew-Type-Project-CreatedBy"></a>
The Amazon Resource Name (ARN) of the user who crated the project.  
Type: String  
Required: No

 ** DatasetName **   <a name="databrew-Type-Project-DatasetName"></a>
The dataset that the project is to act upon.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** LastModifiedBy **   <a name="databrew-Type-Project-LastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last modified the project.  
Type: String  
Required: No

 ** LastModifiedDate **   <a name="databrew-Type-Project-LastModifiedDate"></a>
The last modification date and time for the project.  
Type: Timestamp  
Required: No

 ** OpenDate **   <a name="databrew-Type-Project-OpenDate"></a>
The date and time when the project was opened.  
Type: Timestamp  
Required: No

 ** OpenedBy **   <a name="databrew-Type-Project-OpenedBy"></a>
The Amazon Resource Name (ARN) of the user that opened the project for use.  
Type: String  
Required: No

 ** ResourceArn **   <a name="databrew-Type-Project-ResourceArn"></a>
The Amazon Resource Name (ARN) for the project.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** RoleArn **   <a name="databrew-Type-Project-RoleArn"></a>
The Amazon Resource Name (ARN) of the role that will be assumed for this project.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** Sample **   <a name="databrew-Type-Project-Sample"></a>
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.  
Type: [Sample](API_Sample.md) object  
Required: No

 ** Tags **   <a name="databrew-Type-Project-Tags"></a>
Metadata tags that have been applied to the project.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Project) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Project) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Project) 

# Recipe


Represents one or more actions to be performed on a DataBrew dataset.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-Recipe-Name"></a>
The unique name for the recipe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** CreateDate **   <a name="databrew-Type-Recipe-CreateDate"></a>
The date and time that the recipe was created.  
Type: Timestamp  
Required: No

 ** CreatedBy **   <a name="databrew-Type-Recipe-CreatedBy"></a>
The Amazon Resource Name (ARN) of the user who created the recipe.  
Type: String  
Required: No

 ** Description **   <a name="databrew-Type-Recipe-Description"></a>
The description of the recipe.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** LastModifiedBy **   <a name="databrew-Type-Recipe-LastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last modified the recipe.  
Type: String  
Required: No

 ** LastModifiedDate **   <a name="databrew-Type-Recipe-LastModifiedDate"></a>
The last modification date and time of the recipe.  
Type: Timestamp  
Required: No

 ** ProjectName **   <a name="databrew-Type-Recipe-ProjectName"></a>
The name of the project that the recipe is associated with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** PublishedBy **   <a name="databrew-Type-Recipe-PublishedBy"></a>
The Amazon Resource Name (ARN) of the user who published the recipe.  
Type: String  
Required: No

 ** PublishedDate **   <a name="databrew-Type-Recipe-PublishedDate"></a>
The date and time when the recipe was published.  
Type: Timestamp  
Required: No

 ** RecipeVersion **   <a name="databrew-Type-Recipe-RecipeVersion"></a>
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.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.  
Required: No

 ** ResourceArn **   <a name="databrew-Type-Recipe-ResourceArn"></a>
The Amazon Resource Name (ARN) for the recipe.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** Steps **   <a name="databrew-Type-Recipe-Steps"></a>
A list of steps that are defined by the recipe.  
Type: Array of [RecipeStep](API_RecipeStep.md) objects  
Required: No

 ** Tags **   <a name="databrew-Type-Recipe-Tags"></a>
Metadata tags that have been applied to the recipe.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Recipe) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Recipe) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Recipe) 

# RecipeAction


Represents a transformation and associated parameters that are used to apply a change to a DataBrew dataset. For more information, see [Recipe actions reference](https://docs.amazonaws.cn/databrew/latest/dg/recipe-actions-reference.html).

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Operation **   <a name="databrew-Type-RecipeAction-Operation"></a>
The name of a valid DataBrew transformation to be performed on the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[A-Z\_]+$`   
Required: Yes

 ** Parameters **   <a name="databrew-Type-RecipeAction-Parameters"></a>
Contextual parameters for the transformation.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^[A-Za-z0-9]+$`   
Value Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/RecipeAction) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/RecipeAction) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/RecipeAction) 

# RecipeReference


Represents the name and version of a DataBrew recipe.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-RecipeReference-Name"></a>
The name of the recipe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** RecipeVersion **   <a name="databrew-Type-RecipeReference-RecipeVersion"></a>
The identifier for the version for the recipe.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/RecipeReference) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/RecipeReference) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/RecipeReference) 

# RecipeStep


Represents a single step from a DataBrew recipe to be performed.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Action **   <a name="databrew-Type-RecipeStep-Action"></a>
The particular action to be performed in the recipe step.  
Type: [RecipeAction](API_RecipeAction.md) object  
Required: Yes

 ** ConditionExpressions **   <a name="databrew-Type-RecipeStep-ConditionExpressions"></a>
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.
Type: Array of [ConditionExpression](API_ConditionExpression.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/RecipeStep) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/RecipeStep) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/RecipeStep) 

# RecipeVersionErrorDetail


Represents any errors encountered when attempting to delete multiple recipe versions.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** ErrorCode **   <a name="databrew-Type-RecipeVersionErrorDetail-ErrorCode"></a>
The HTTP status code for the error.  
Type: String  
Pattern: `^[1-5][0-9][0-9]$`   
Required: No

 ** ErrorMessage **   <a name="databrew-Type-RecipeVersionErrorDetail-ErrorMessage"></a>
The text of the error message.  
Type: String  
Required: No

 ** RecipeVersion **   <a name="databrew-Type-RecipeVersionErrorDetail-RecipeVersion"></a>
The identifier for the recipe version associated with this error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/RecipeVersionErrorDetail) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/RecipeVersionErrorDetail) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/RecipeVersionErrorDetail) 

# Rule


Represents a single data quality requirement that should be validated in the scope of this dataset.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** CheckExpression **   <a name="databrew-Type-Rule-CheckExpression"></a>
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](https://docs.amazonaws.cn/databrew/latest/dg/profile.data-quality-available-checks.html)   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Pattern: `^[<>0-9A-Za-z_.,:)(!= ]+$`   
Required: Yes

 ** Name **   <a name="databrew-Type-Rule-Name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** ColumnSelectors **   <a name="databrew-Type-Rule-ColumnSelectors"></a>
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.  
Type: Array of [ColumnSelector](API_ColumnSelector.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** Disabled **   <a name="databrew-Type-Rule-Disabled"></a>
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.  
Type: Boolean  
Required: No

 ** SubstitutionMap **   <a name="databrew-Type-Rule-SubstitutionMap"></a>
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`".`   
Type: String to string map  
Key Length Constraints: Minimum length of 2. Maximum length of 128.  
Key Pattern: `^:[A-Za-z0-9_]+$`   
Value Length Constraints: Maximum length of 1024.  
Required: No

 ** Threshold **   <a name="databrew-Type-Rule-Threshold"></a>
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.  
Type: [Threshold](API_Threshold.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Rule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Rule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Rule) 

# RulesetItem


Contains metadata about the ruleset.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-RulesetItem-Name"></a>
The name of the ruleset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** TargetArn **   <a name="databrew-Type-RulesetItem-TargetArn"></a>
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

 ** AccountId **   <a name="databrew-Type-RulesetItem-AccountId"></a>
The ID of the Amazon account that owns the ruleset.  
Type: String  
Length Constraints: Maximum length of 255.  
Required: No

 ** CreateDate **   <a name="databrew-Type-RulesetItem-CreateDate"></a>
The date and time that the ruleset was created.  
Type: Timestamp  
Required: No

 ** CreatedBy **   <a name="databrew-Type-RulesetItem-CreatedBy"></a>
The Amazon Resource Name (ARN) of the user who created the ruleset.  
Type: String  
Required: No

 ** Description **   <a name="databrew-Type-RulesetItem-Description"></a>
The description of the ruleset.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** LastModifiedBy **   <a name="databrew-Type-RulesetItem-LastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last modified the ruleset.  
Type: String  
Required: No

 ** LastModifiedDate **   <a name="databrew-Type-RulesetItem-LastModifiedDate"></a>
The modification date and time of the ruleset.  
Type: Timestamp  
Required: No

 ** ResourceArn **   <a name="databrew-Type-RulesetItem-ResourceArn"></a>
The Amazon Resource Name (ARN) for the ruleset.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** RuleCount **   <a name="databrew-Type-RulesetItem-RuleCount"></a>
The number of rules that are defined in the ruleset.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Tags **   <a name="databrew-Type-RulesetItem-Tags"></a>
Metadata tags that have been applied to the ruleset.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/RulesetItem) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/RulesetItem) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/RulesetItem) 

# S3Location


Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Bucket **   <a name="databrew-Type-S3Location-Bucket"></a>
The Amazon S3 bucket name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

 ** BucketOwner **   <a name="databrew-Type-S3Location-BucketOwner"></a>
The Amazon account ID of the bucket owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `^[0-9]{12}$`   
Required: No

 ** Key **   <a name="databrew-Type-S3Location-Key"></a>
The unique name of the object in the bucket.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1280.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/S3Location) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/S3Location) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/S3Location) 

# S3TableOutputOptions


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

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Location **   <a name="databrew-Type-S3TableOutputOptions-Location"></a>
Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.  
Type: [S3Location](API_S3Location.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/S3TableOutputOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/S3TableOutputOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/S3TableOutputOptions) 

# Sample


Represents the sample size and sampling type for DataBrew to use for interactive data analysis.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Type **   <a name="databrew-Type-Sample-Type"></a>
The way in which DataBrew obtains rows from a dataset.  
Type: String  
Valid Values: `FIRST_N | LAST_N | RANDOM`   
Required: Yes

 ** Size **   <a name="databrew-Type-Sample-Size"></a>
The number of rows in the sample.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5000.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Sample) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Sample) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Sample) 

# Schedule


Represents one or more dates and times when a job is to run.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Name **   <a name="databrew-Type-Schedule-Name"></a>
The name of the schedule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** AccountId **   <a name="databrew-Type-Schedule-AccountId"></a>
The ID of the Amazon account that owns the schedule.  
Type: String  
Length Constraints: Maximum length of 255.  
Required: No

 ** CreateDate **   <a name="databrew-Type-Schedule-CreateDate"></a>
The date and time that the schedule was created.  
Type: Timestamp  
Required: No

 ** CreatedBy **   <a name="databrew-Type-Schedule-CreatedBy"></a>
The Amazon Resource Name (ARN) of the user who created the schedule.  
Type: String  
Required: No

 ** CronExpression **   <a name="databrew-Type-Schedule-CronExpression"></a>
The dates and times when the job is to run. For more information, see [Working with cron expressions for recipe jobs](https://docs.amazonaws.cn/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the * Amazon Glue DataBrew Developer Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** JobNames **   <a name="databrew-Type-Schedule-JobNames"></a>
A list of jobs to be run, according to the schedule.  
Type: Array of strings  
Array Members: Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: No

 ** LastModifiedBy **   <a name="databrew-Type-Schedule-LastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last modified the schedule.  
Type: String  
Required: No

 ** LastModifiedDate **   <a name="databrew-Type-Schedule-LastModifiedDate"></a>
The date and time when the schedule was last modified.  
Type: Timestamp  
Required: No

 ** ResourceArn **   <a name="databrew-Type-Schedule-ResourceArn"></a>
The Amazon Resource Name (ARN) of the schedule.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** Tags **   <a name="databrew-Type-Schedule-Tags"></a>
Metadata tags that have been applied to the schedule.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Schedule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Schedule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Schedule) 

# StatisticOverride


Override of a particular evaluation for a profile job. 

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Parameters **   <a name="databrew-Type-StatisticOverride-Parameters"></a>
A map that includes overrides of an evaluation’s parameters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^[A-Za-z0-9]+$`   
Value Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: Yes

 ** Statistic **   <a name="databrew-Type-StatisticOverride-Statistic"></a>
The name of an evaluation  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[A-Z\_]+$`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/StatisticOverride) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/StatisticOverride) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/StatisticOverride) 

# StatisticsConfiguration


Configuration of evaluations for a profile job. This configuration can be used to select evaluations and override the parameters of selected evaluations. 

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** IncludedStatistics **   <a name="databrew-Type-StatisticsConfiguration-IncludedStatistics"></a>
List of included evaluations. When the list is undefined, all supported evaluations will be included.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[A-Z\_]+$`   
Required: No

 ** Overrides **   <a name="databrew-Type-StatisticsConfiguration-Overrides"></a>
List of overrides for evaluations.  
Type: Array of [StatisticOverride](API_StatisticOverride.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/StatisticsConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/StatisticsConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/StatisticsConfiguration) 

# Threshold


The threshold used with a non-aggregate check expression. The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Value **   <a name="databrew-Type-Threshold-Value"></a>
The value of a threshold.  
Type: Double  
Valid Range: Minimum value of 0.  
Required: Yes

 ** Type **   <a name="databrew-Type-Threshold-Type"></a>
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.  
Type: String  
Valid Values: `GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | GREATER_THAN | LESS_THAN`   
Required: No

 ** Unit **   <a name="databrew-Type-Threshold-Unit"></a>
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.  
Type: String  
Valid Values: `COUNT | PERCENTAGE`   
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/Threshold) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/Threshold) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/Threshold) 

# ValidationConfiguration


Configuration for data quality validation. Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** RulesetArn **   <a name="databrew-Type-ValidationConfiguration-RulesetArn"></a>
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.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

 ** ValidationMode **   <a name="databrew-Type-ValidationConfiguration-ValidationMode"></a>
Mode of data quality validation. Default mode is “CHECK\$1ALL” which verifies all rules defined in the selected ruleset.  
Type: String  
Valid Values: `CHECK_ALL`   
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/ValidationConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/ValidationConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/ValidationConfiguration) 

# ViewFrame


Represents the data being transformed during an action.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** StartColumnIndex **   <a name="databrew-Type-ViewFrame-StartColumnIndex"></a>
The starting index for the range of columns to return in the view frame.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** Analytics **   <a name="databrew-Type-ViewFrame-Analytics"></a>
Controls if analytics computation is enabled or disabled. Enabled by default.  
Type: String  
Valid Values: `ENABLE | DISABLE`   
Required: No

 ** ColumnRange **   <a name="databrew-Type-ViewFrame-ColumnRange"></a>
The number of columns to include in the view frame, beginning with the `StartColumnIndex` value and ignoring any columns in the `HiddenColumns` list.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** HiddenColumns **   <a name="databrew-Type-ViewFrame-HiddenColumns"></a>
A list of columns to hide in the view frame.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** RowRange **   <a name="databrew-Type-ViewFrame-RowRange"></a>
The number of rows to include in the view frame, beginning with the `StartRowIndex` value.  
Type: Integer  
Required: No

 ** StartRowIndex **   <a name="databrew-Type-ViewFrame-StartRowIndex"></a>
The starting index for the range of rows to return in the view frame.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/databrew-2017-07-25/ViewFrame) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/databrew-2017-07-25/ViewFrame) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/databrew-2017-07-25/ViewFrame)