# API reference If you're a developer, you can write applications that access the DataBrew API (application programming interface). We recommend that you use one of the language-specific AWS SDKs for this. For more information, see [Tools to Build on AWS](https://aws.amazon.com/tools/). The AWS SDKs construct low-level DataBrew API requests on your behalf and process the responses from DataBrew. This lets you focus on your application logic, instead of low-level details. Following are the API actions, data types and exceptions for DataBrew. **Topics** + [ # Actions ](API_Operations.md) + [ # Data Types ](API_Types.md) + [ # Common Error Types ](CommonErrors.md) + [ # Common Parameters ](CommonParameters.md) # Actions The following actions are supported: + [BatchDeleteRecipeVersion](API_BatchDeleteRecipeVersion.md) + [CreateDataset](API_CreateDataset.md) + [CreateProfileJob](API_CreateProfileJob.md) + [CreateProject](API_CreateProject.md) + [CreateRecipe](API_CreateRecipe.md) + [CreateRecipeJob](API_CreateRecipeJob.md) + [CreateRuleset](API_CreateRuleset.md) + [CreateSchedule](API_CreateSchedule.md) + [DeleteDataset](API_DeleteDataset.md) + [DeleteJob](API_DeleteJob.md) + [DeleteProject](API_DeleteProject.md) + [DeleteRecipeVersion](API_DeleteRecipeVersion.md) + [DeleteRuleset](API_DeleteRuleset.md) + [DeleteSchedule](API_DeleteSchedule.md) + [DescribeDataset](API_DescribeDataset.md) + [DescribeJob](API_DescribeJob.md) + [DescribeJobRun](API_DescribeJobRun.md) + [DescribeProject](API_DescribeProject.md) + [DescribeRecipe](API_DescribeRecipe.md) + [DescribeRuleset](API_DescribeRuleset.md) + [DescribeSchedule](API_DescribeSchedule.md) + [ListDatasets](API_ListDatasets.md) + [ListJobRuns](API_ListJobRuns.md) + [ListJobs](API_ListJobs.md) + [ListProjects](API_ListProjects.md) + [ListRecipes](API_ListRecipes.md) + [ListRecipeVersions](API_ListRecipeVersions.md) + [ListRulesets](API_ListRulesets.md) + [ListSchedules](API_ListSchedules.md) + [ListTagsForResource](API_ListTagsForResource.md) + [PublishRecipe](API_PublishRecipe.md) + [SendProjectSessionAction](API_SendProjectSessionAction.md) + [StartJobRun](API_StartJobRun.md) + [StartProjectSession](API_StartProjectSession.md) + [StopJobRun](API_StopJobRun.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateDataset](API_UpdateDataset.md) + [UpdateProfileJob](API_UpdateProfileJob.md) + [UpdateProject](API_UpdateProject.md) + [UpdateRecipe](API_UpdateRecipe.md) + [UpdateRecipeJob](API_UpdateRecipeJob.md) + [UpdateRuleset](API_UpdateRuleset.md) + [UpdateSchedule](API_UpdateSchedule.md) # BatchDeleteRecipeVersion Deletes one or more versions of a recipe at a time. The entire request will be rejected if: + The recipe does not exist. + There is an invalid version identifier in the list of versions. + The version list is empty. + The version list size exceeds 50. + The version list contains duplicate entries. The request will complete successfully, but with partial failures, if: + A version does not exist. + A version is being used by a job. + You specify `LATEST_WORKING`, but it's being used by a project. + The version fails to be deleted. The `LATEST_WORKING` version will only be deleted if the recipe has no other versions. If you try to delete `LATEST_WORKING` while other versions exist (or if they can't be deleted), then `LATEST_WORKING` will be listed as partial failure in the response. ## Request Syntax ``` POST /recipes/name/batchDeleteRecipeVersion HTTP/1.1 Content-type: application/json { "RecipeVersions": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_BatchDeleteRecipeVersion_RequestSyntax) ** The name of the recipe whose versions are to be deleted. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [RecipeVersions](#API_BatchDeleteRecipeVersion_RequestSyntax) ** An array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (`X.Y`) or `LATEST_WORKING`. `LATEST_PUBLISHED` is not supported. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 16. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "RecipeVersion": "string" } ], "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_BatchDeleteRecipeVersion_ResponseSyntax) ** The name of the recipe that was modified. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [Errors](#API_BatchDeleteRecipeVersion_ResponseSyntax) ** Errors, if any, that occurred while attempting to delete the recipe versions. Type: Array of [RecipeVersionErrorDetail](API_RecipeVersionErrorDetail.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/BatchDeleteRecipeVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/BatchDeleteRecipeVersion) # CreateDataset Creates a new DataBrew dataset. ## Request Syntax ``` POST /datasets HTTP/1.1 Content-type: application/json { "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string", "HeaderRow": boolean }, "Excel": { "HeaderRow": boolean, "SheetIndexes": [ number ], "SheetNames": [ "string" ] }, "Json": { "MultiLine": boolean } }, "Input": { "DatabaseInputDefinition": { "DatabaseTableName": "string", "GlueConnectionName": "string", "QueryString": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DataCatalogInputDefinition": { "CatalogId": "string", "DatabaseName": "string", "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Metadata": { "SourceArn": "string" }, "S3InputDefinition": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Name": "string", "PathOptions": { "FilesLimit": { "MaxFiles": number, "Order": "string", "OrderedBy": "string" }, "LastModifiedDateCondition": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Parameters": { "string" : { "CreateColumn": boolean, "DatetimeOptions": { "Format": "string", "LocaleCode": "string", "TimezoneOffset": "string" }, "Filter": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Name": "string", "Type": "string" } } }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Input](#API_CreateDataset_RequestSyntax) ** Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3. Type: [Input](API_Input.md) object Required: Yes ** [Name](#API_CreateDataset_RequestSyntax) ** The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [Format](#API_CreateDataset_RequestSyntax) ** 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](#API_CreateDataset_RequestSyntax) ** Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. Type: [FormatOptions](API_FormatOptions.md) object Required: No ** [PathOptions](#API_CreateDataset_RequestSyntax) ** A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. Type: [PathOptions](API_PathOptions.md) object Required: No ** [Tags](#API_CreateDataset_RequestSyntax) ** Metadata tags to apply to this 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_CreateDataset_ResponseSyntax) ** The name of the dataset that you created. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access to the specified resource was denied. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateDataset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateDataset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateDataset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateDataset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateDataset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateDataset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateDataset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateDataset) # CreateProfileJob Creates a new job to analyze a dataset and create its data profile. ## Request Syntax ``` POST /profileJobs HTTP/1.1 Content-type: application/json { "Configuration": { "ColumnStatisticsConfigurations": [ { "Selectors": [ { "Name": "string", "Regex": "string" } ], "Statistics": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] } } ], "DatasetStatisticsConfiguration": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] }, "EntityDetectorConfiguration": { "AllowedStatistics": [ { "Statistics": [ "string" ] } ], "EntityTypes": [ "string" ] }, "ProfileColumns": [ { "Name": "string", "Regex": "string" } ] }, "DatasetName": "string", "EncryptionKeyArn": "string", "EncryptionMode": "string", "JobSample": { "Mode": "string", "Size": number }, "LogSubscription": "string", "MaxCapacity": number, "MaxRetries": number, "Name": "string", "OutputLocation": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "RoleArn": "string", "Tags": { "string" : "string" }, "Timeout": number, "ValidationConfigurations": [ { "RulesetArn": "string", "ValidationMode": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DatasetName](#API_CreateProfileJob_RequestSyntax) ** The name of the dataset that this job is to act upon. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [Name](#API_CreateProfileJob_RequestSyntax) ** The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ** [OutputLocation](#API_CreateProfileJob_RequestSyntax) ** 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: Yes ** [RoleArn](#API_CreateProfileJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ** [Configuration](#API_CreateProfileJob_RequestSyntax) ** 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. Type: [ProfileConfiguration](API_ProfileConfiguration.md) object Required: No ** [EncryptionKeyArn](#API_CreateProfileJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** [EncryptionMode](#API_CreateProfileJob_RequestSyntax) ** The encryption mode for the job, which can be one of the following: + `SSE-KMS` - `SSE-KMS` - Server-side encryption with AWS KMS-managed keys. + `SSE-S3` - Server-side encryption with keys managed by Amazon S3. Type: String Valid Values: `SSE-KMS | SSE-S3` Required: No ** [JobSample](#API_CreateProfileJob_RequestSyntax) ** 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\$1ROWS for the mode parameter and 20000 for the size parameter. Type: [JobSample](API_JobSample.md) object Required: No ** [LogSubscription](#API_CreateProfileJob_RequestSyntax) ** Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. Type: String Valid Values: `ENABLE | DISABLE` Required: No ** [MaxCapacity](#API_CreateProfileJob_RequestSyntax) ** The maximum number of nodes that DataBrew can use when the job processes data. Type: Integer Required: No ** [MaxRetries](#API_CreateProfileJob_RequestSyntax) ** The maximum number of times to retry the job after a job run fails. Type: Integer Valid Range: Minimum value of 0. Required: No ** [Tags](#API_CreateProfileJob_RequestSyntax) ** Metadata tags to apply to this 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](#API_CreateProfileJob_RequestSyntax) ** 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 ** [ValidationConfigurations](#API_CreateProfileJob_RequestSyntax) ** 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_CreateProfileJob_ResponseSyntax) ** The name of the job that was created. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access to the specified resource was denied. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateProfileJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateProfileJob) # CreateProject Creates a new DataBrew project. ## Request Syntax ``` POST /projects HTTP/1.1 Content-type: application/json { "DatasetName": "string", "Name": "string", "RecipeName": "string", "RoleArn": "string", "Sample": { "Size": number, "Type": "string" }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DatasetName](#API_CreateProject_RequestSyntax) ** The name of an existing dataset to associate this project with. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [Name](#API_CreateProject_RequestSyntax) ** A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [RecipeName](#API_CreateProject_RequestSyntax) ** The name of an existing recipe to associate with the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [RoleArn](#API_CreateProject_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ** [Sample](#API_CreateProject_RequestSyntax) ** Represents the sample size and sampling type for DataBrew to use for interactive data analysis. Type: [Sample](API_Sample.md) object Required: No ** [Tags](#API_CreateProject_RequestSyntax) ** Metadata tags to apply to this 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_CreateProject_ResponseSyntax) ** The name of the project that you created. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** InternalServerException ** An internal service failure occurred. HTTP Status Code: 500 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateProject) # CreateRecipe Creates a new DataBrew recipe. ## Request Syntax ``` POST /recipes HTTP/1.1 Content-type: application/json { "Description": "string", "Name": "string", "Steps": [ { "Action": { "Operation": "string", "Parameters": { "string" : "string" } }, "ConditionExpressions": [ { "Condition": "string", "TargetColumn": "string", "Value": "string" } ] } ], "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Name](#API_CreateRecipe_RequestSyntax) ** A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [Steps](#API_CreateRecipe_RequestSyntax) ** 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. Type: Array of [RecipeStep](API_RecipeStep.md) objects Required: Yes ** [Description](#API_CreateRecipe_RequestSyntax) ** A description for the recipe. Type: String Length Constraints: Maximum length of 1024. Required: No ** [Tags](#API_CreateRecipe_RequestSyntax) ** Metadata tags to apply to this 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_CreateRecipe_ResponseSyntax) ** The name of the recipe that you created. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateRecipe) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateRecipe) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateRecipe) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateRecipe) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateRecipe) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateRecipe) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateRecipe) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateRecipe) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateRecipe) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateRecipe) # CreateRecipeJob Creates a new job to transform input data, using steps defined in an existing AWS Glue DataBrew recipe ## Request Syntax ``` POST /recipeJobs HTTP/1.1 Content-type: application/json { "DatabaseOutputs": [ { "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DatabaseOutputMode": "string", "GlueConnectionName": "string" } ], "DataCatalogOutputs": [ { "CatalogId": "string", "DatabaseName": "string", "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Overwrite": boolean, "S3Options": { "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "TableName": "string" } ], "DatasetName": "string", "EncryptionKeyArn": "string", "EncryptionMode": "string", "LogSubscription": "string", "MaxCapacity": number, "MaxRetries": number, "Name": "string", "Outputs": [ { "CompressionFormat": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string" } }, "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "MaxOutputFiles": number, "Overwrite": boolean, "PartitionColumns": [ "string" ] } ], "ProjectName": "string", "RecipeReference": { "Name": "string", "RecipeVersion": "string" }, "RoleArn": "string", "Tags": { "string" : "string" }, "Timeout": number } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Name](#API_CreateRecipeJob_RequestSyntax) ** A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ** [RoleArn](#API_CreateRecipeJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ** [DatabaseOutputs](#API_CreateRecipeJob_RequestSyntax) ** Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to. Type: Array of [DatabaseOutput](API_DatabaseOutput.md) objects Array Members: Minimum number of 1 item. Required: No ** [DataCatalogOutputs](#API_CreateRecipeJob_RequestSyntax) ** One or more artifacts that represent the AWS 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](#API_CreateRecipeJob_RequestSyntax) ** The name of the dataset that this job processes. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [EncryptionKeyArn](#API_CreateRecipeJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** [EncryptionMode](#API_CreateRecipeJob_RequestSyntax) ** The encryption mode for the job, which can be one of the following: + `SSE-KMS` - Server-side encryption with keys managed by AWS KMS. + `SSE-S3` - Server-side encryption with keys managed by Amazon S3. Type: String Valid Values: `SSE-KMS | SSE-S3` Required: No ** [LogSubscription](#API_CreateRecipeJob_RequestSyntax) ** Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. Type: String Valid Values: `ENABLE | DISABLE` Required: No ** [MaxCapacity](#API_CreateRecipeJob_RequestSyntax) ** The maximum number of nodes that DataBrew can consume when the job processes data. Type: Integer Required: No ** [MaxRetries](#API_CreateRecipeJob_RequestSyntax) ** 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](#API_CreateRecipeJob_RequestSyntax) ** One or more artifacts that represent the output from running the job. Type: Array of [Output](API_Output.md) objects Array Members: Minimum number of 1 item. Required: No ** [ProjectName](#API_CreateRecipeJob_RequestSyntax) ** Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [RecipeReference](#API_CreateRecipeJob_RequestSyntax) ** Represents the name and version of a DataBrew recipe. Type: [RecipeReference](API_RecipeReference.md) object Required: No ** [Tags](#API_CreateRecipeJob_RequestSyntax) ** Metadata tags to apply to this 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](#API_CreateRecipeJob_RequestSyntax) ** 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_CreateRecipeJob_ResponseSyntax) ** The name of the job that you created. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access to the specified resource was denied. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateRecipeJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateRecipeJob) # CreateRuleset Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset. ## Request Syntax ``` POST /rulesets HTTP/1.1 Content-type: application/json { "Description": "string", "Name": "string", "Rules": [ { "CheckExpression": "string", "ColumnSelectors": [ { "Name": "string", "Regex": "string" } ], "Disabled": boolean, "Name": "string", "SubstitutionMap": { "string" : "string" }, "Threshold": { "Type": "string", "Unit": "string", "Value": number } } ], "Tags": { "string" : "string" }, "TargetArn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Name](#API_CreateRuleset_RequestSyntax) ** The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [Rules](#API_CreateRuleset_RequestSyntax) ** A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. Type: Array of [Rule](API_Rule.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [TargetArn](#API_CreateRuleset_RequestSyntax) ** 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 ** [Description](#API_CreateRuleset_RequestSyntax) ** The description of the ruleset. Type: String Length Constraints: Maximum length of 1024. Required: No ** [Tags](#API_CreateRuleset_RequestSyntax) ** Metadata tags to apply 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_CreateRuleset_ResponseSyntax) ** The unique name of the created ruleset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateRuleset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateRuleset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateRuleset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateRuleset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateRuleset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateRuleset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateRuleset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateRuleset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateRuleset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateRuleset) # CreateSchedule Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals. ## Request Syntax ``` POST /schedules HTTP/1.1 Content-type: application/json { "CronExpression": "string", "JobNames": [ "string" ], "Name": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [CronExpression](#API_CreateSchedule_RequestSyntax) ** The date or dates and time or times when the jobs are to be run. For more information, see [Cron expressions](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the * AWS Glue DataBrew Developer Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: Yes ** [Name](#API_CreateSchedule_RequestSyntax) ** A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [JobNames](#API_CreateSchedule_RequestSyntax) ** The name or names of one or more jobs to be run. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 240. Required: No ** [Tags](#API_CreateSchedule_RequestSyntax) ** Metadata tags to apply to this 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_CreateSchedule_ResponseSyntax) ** The name of the schedule that was created. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateSchedule) # DeleteDataset Deletes a dataset from DataBrew. ## Request Syntax ``` DELETE /datasets/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteDataset_RequestSyntax) ** The name of the dataset to be deleted. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DeleteDataset_ResponseSyntax) ** The name of the dataset that you deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteDataset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteDataset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteDataset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteDataset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteDataset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteDataset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteDataset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteDataset) # DeleteJob Deletes the specified DataBrew job. ## Request Syntax ``` DELETE /jobs/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteJob_RequestSyntax) ** The name of the job to be deleted. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DeleteJob_ResponseSyntax) ** The name of the job that you deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteJob) # DeleteProject Deletes an existing DataBrew project. ## Request Syntax ``` DELETE /projects/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteProject_RequestSyntax) ** The name of the project to be deleted. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DeleteProject_ResponseSyntax) ** The name of the project that you deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteProject) # DeleteRecipeVersion Deletes a single version of a DataBrew recipe. ## Request Syntax ``` DELETE /recipes/name/recipeVersion/recipeVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteRecipeVersion_RequestSyntax) ** The name of the recipe. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [recipeVersion](#API_DeleteRecipeVersion_RequestSyntax) ** The version of the recipe to be deleted. You can specify a numeric versions (`X.Y`) or `LATEST_WORKING`. `LATEST_PUBLISHED` is not supported. Length Constraints: Minimum length of 1. Maximum length of 16. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string", "RecipeVersion": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DeleteRecipeVersion_ResponseSyntax) ** The name of the recipe that was deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [RecipeVersion](#API_DeleteRecipeVersion_ResponseSyntax) ** The version of the recipe that was deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 16. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteRecipeVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteRecipeVersion) # DeleteRuleset Deletes a ruleset. ## Request Syntax ``` DELETE /rulesets/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteRuleset_RequestSyntax) ** The name of the ruleset to be deleted. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DeleteRuleset_ResponseSyntax) ** The name of the deleted ruleset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteRuleset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteRuleset) # DeleteSchedule Deletes the specified DataBrew schedule. ## Request Syntax ``` DELETE /schedules/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteSchedule_RequestSyntax) ** The name of the schedule to be deleted. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DeleteSchedule_ResponseSyntax) ** The name of the schedule that was deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteSchedule) # DescribeDataset Returns the definition of a specific DataBrew dataset. ## Request Syntax ``` GET /datasets/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeDataset_RequestSyntax) ** The name of the dataset to be described. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateDate": number, "CreatedBy": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string", "HeaderRow": boolean }, "Excel": { "HeaderRow": boolean, "SheetIndexes": [ number ], "SheetNames": [ "string" ] }, "Json": { "MultiLine": boolean } }, "Input": { "DatabaseInputDefinition": { "DatabaseTableName": "string", "GlueConnectionName": "string", "QueryString": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DataCatalogInputDefinition": { "CatalogId": "string", "DatabaseName": "string", "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Metadata": { "SourceArn": "string" }, "S3InputDefinition": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "PathOptions": { "FilesLimit": { "MaxFiles": number, "Order": "string", "OrderedBy": "string" }, "LastModifiedDateCondition": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Parameters": { "string" : { "CreateColumn": boolean, "DatetimeOptions": { "Format": "string", "LocaleCode": "string", "TimezoneOffset": "string" }, "Filter": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Name": "string", "Type": "string" } } }, "ResourceArn": "string", "Source": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Input](#API_DescribeDataset_ResponseSyntax) ** Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3. Type: [Input](API_Input.md) object ** [Name](#API_DescribeDataset_ResponseSyntax) ** The name of the dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [CreateDate](#API_DescribeDataset_ResponseSyntax) ** The date and time that the dataset was created. Type: Timestamp ** [CreatedBy](#API_DescribeDataset_ResponseSyntax) ** The identifier (user name) of the user who created the dataset. Type: String ** [Format](#API_DescribeDataset_ResponseSyntax) ** 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` ** [FormatOptions](#API_DescribeDataset_ResponseSyntax) ** Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. Type: [FormatOptions](API_FormatOptions.md) object ** [LastModifiedBy](#API_DescribeDataset_ResponseSyntax) ** The identifier (user name) of the user who last modified the dataset. Type: String ** [LastModifiedDate](#API_DescribeDataset_ResponseSyntax) ** The date and time that the dataset was last modified. Type: Timestamp ** [PathOptions](#API_DescribeDataset_ResponseSyntax) ** A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. Type: [PathOptions](API_PathOptions.md) object ** [ResourceArn](#API_DescribeDataset_ResponseSyntax) ** The Amazon Resource Name (ARN) of the dataset. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [Source](#API_DescribeDataset_ResponseSyntax) ** The location of the data for this dataset, Amazon S3 or the AWS Glue Data Catalog. Type: String Valid Values: `S3 | DATA-CATALOG | DATABASE` ** [Tags](#API_DescribeDataset_ResponseSyntax) ** Metadata tags associated with this 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeDataset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeDataset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeDataset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeDataset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeDataset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeDataset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeDataset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeDataset) # DescribeJob Returns the definition of a specific DataBrew job. ## Request Syntax ``` GET /jobs/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeJob_RequestSyntax) ** The name of the job to be described. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateDate": number, "CreatedBy": "string", "DatabaseOutputs": [ { "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DatabaseOutputMode": "string", "GlueConnectionName": "string" } ], "DataCatalogOutputs": [ { "CatalogId": "string", "DatabaseName": "string", "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Overwrite": boolean, "S3Options": { "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "TableName": "string" } ], "DatasetName": "string", "EncryptionKeyArn": "string", "EncryptionMode": "string", "JobSample": { "Mode": "string", "Size": number }, "LastModifiedBy": "string", "LastModifiedDate": number, "LogSubscription": "string", "MaxCapacity": number, "MaxRetries": number, "Name": "string", "Outputs": [ { "CompressionFormat": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string" } }, "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "MaxOutputFiles": number, "Overwrite": boolean, "PartitionColumns": [ "string" ] } ], "ProfileConfiguration": { "ColumnStatisticsConfigurations": [ { "Selectors": [ { "Name": "string", "Regex": "string" } ], "Statistics": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] } } ], "DatasetStatisticsConfiguration": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] }, "EntityDetectorConfiguration": { "AllowedStatistics": [ { "Statistics": [ "string" ] } ], "EntityTypes": [ "string" ] }, "ProfileColumns": [ { "Name": "string", "Regex": "string" } ] }, "ProjectName": "string", "RecipeReference": { "Name": "string", "RecipeVersion": "string" }, "ResourceArn": "string", "RoleArn": "string", "Tags": { "string" : "string" }, "Timeout": number, "Type": "string", "ValidationConfigurations": [ { "RulesetArn": "string", "ValidationMode": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DescribeJob_ResponseSyntax) ** The name of the job. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. ** [CreateDate](#API_DescribeJob_ResponseSyntax) ** The date and time that the job was created. Type: Timestamp ** [CreatedBy](#API_DescribeJob_ResponseSyntax) ** The identifier (user name) of the user associated with the creation of the job. Type: String ** [DatabaseOutputs](#API_DescribeJob_ResponseSyntax) ** 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. ** [DataCatalogOutputs](#API_DescribeJob_ResponseSyntax) ** One or more artifacts that represent the AWS Glue Data Catalog output from running the job. Type: Array of [DataCatalogOutput](API_DataCatalogOutput.md) objects Array Members: Minimum number of 1 item. ** [DatasetName](#API_DescribeJob_ResponseSyntax) ** The dataset that the job acts upon. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [EncryptionKeyArn](#API_DescribeJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [EncryptionMode](#API_DescribeJob_ResponseSyntax) ** The encryption mode for the job, which can be one of the following: + `SSE-KMS` - Server-side encryption with keys managed by AWS KMS. + `SSE-S3` - Server-side encryption with keys managed by Amazon S3. Type: String Valid Values: `SSE-KMS | SSE-S3` ** [JobSample](#API_DescribeJob_ResponseSyntax) ** Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. Type: [JobSample](API_JobSample.md) object ** [LastModifiedBy](#API_DescribeJob_ResponseSyntax) ** The identifier (user name) of the user who last modified the job. Type: String ** [LastModifiedDate](#API_DescribeJob_ResponseSyntax) ** The date and time that the job was last modified. Type: Timestamp ** [LogSubscription](#API_DescribeJob_ResponseSyntax) ** Indicates whether Amazon CloudWatch logging is enabled for this job. Type: String Valid Values: `ENABLE | DISABLE` ** [MaxCapacity](#API_DescribeJob_ResponseSyntax) ** The maximum number of compute nodes that DataBrew can consume when the job processes data. Type: Integer ** [MaxRetries](#API_DescribeJob_ResponseSyntax) ** The maximum number of times to retry the job after a job run fails. Type: Integer Valid Range: Minimum value of 0. ** [Outputs](#API_DescribeJob_ResponseSyntax) ** One or more artifacts that represent the output from running the job. Type: Array of [Output](API_Output.md) objects Array Members: Minimum number of 1 item. ** [ProfileConfiguration](#API_DescribeJob_ResponseSyntax) ** 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. Type: [ProfileConfiguration](API_ProfileConfiguration.md) object ** [ProjectName](#API_DescribeJob_ResponseSyntax) ** The DataBrew project associated with this job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [RecipeReference](#API_DescribeJob_ResponseSyntax) ** Represents the name and version of a DataBrew recipe. Type: [RecipeReference](API_RecipeReference.md) object ** [ResourceArn](#API_DescribeJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [RoleArn](#API_DescribeJob_ResponseSyntax) ** The ARN of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [Tags](#API_DescribeJob_ResponseSyntax) ** Metadata tags associated with this 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. ** [Timeout](#API_DescribeJob_ResponseSyntax) ** 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. ** [Type](#API_DescribeJob_ResponseSyntax) ** 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. Type: String Valid Values: `PROFILE | RECIPE` ** [ValidationConfigurations](#API_DescribeJob_ResponseSyntax) ** 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeJob) # DescribeJobRun Represents one run of a DataBrew job. ## Request Syntax ``` GET /jobs/name/jobRun/runId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeJobRun_RequestSyntax) ** The name of the job being processed during this run. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ** [runId](#API_DescribeJobRun_RequestSyntax) ** The unique identifier of the job run. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Attempt": number, "CompletedOn": number, "DatabaseOutputs": [ { "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DatabaseOutputMode": "string", "GlueConnectionName": "string" } ], "DataCatalogOutputs": [ { "CatalogId": "string", "DatabaseName": "string", "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Overwrite": boolean, "S3Options": { "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "TableName": "string" } ], "DatasetName": "string", "ErrorMessage": "string", "ExecutionTime": number, "JobName": "string", "JobSample": { "Mode": "string", "Size": number }, "LogGroupName": "string", "LogSubscription": "string", "Outputs": [ { "CompressionFormat": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string" } }, "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "MaxOutputFiles": number, "Overwrite": boolean, "PartitionColumns": [ "string" ] } ], "ProfileConfiguration": { "ColumnStatisticsConfigurations": [ { "Selectors": [ { "Name": "string", "Regex": "string" } ], "Statistics": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] } } ], "DatasetStatisticsConfiguration": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] }, "EntityDetectorConfiguration": { "AllowedStatistics": [ { "Statistics": [ "string" ] } ], "EntityTypes": [ "string" ] }, "ProfileColumns": [ { "Name": "string", "Regex": "string" } ] }, "RecipeReference": { "Name": "string", "RecipeVersion": "string" }, "RunId": "string", "StartedBy": "string", "StartedOn": number, "State": "string", "ValidationConfigurations": [ { "RulesetArn": "string", "ValidationMode": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobName](#API_DescribeJobRun_ResponseSyntax) ** The name of the job being processed during this run. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. ** [Attempt](#API_DescribeJobRun_ResponseSyntax) ** The number of times that DataBrew has attempted to run the job. Type: Integer ** [CompletedOn](#API_DescribeJobRun_ResponseSyntax) ** The date and time when the job completed processing. Type: Timestamp ** [DatabaseOutputs](#API_DescribeJobRun_ResponseSyntax) ** 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. ** [DataCatalogOutputs](#API_DescribeJobRun_ResponseSyntax) ** One or more artifacts that represent the AWS Glue Data Catalog output from running the job. Type: Array of [DataCatalogOutput](API_DataCatalogOutput.md) objects Array Members: Minimum number of 1 item. ** [DatasetName](#API_DescribeJobRun_ResponseSyntax) ** The name of the dataset for the job to process. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [ErrorMessage](#API_DescribeJobRun_ResponseSyntax) ** A message indicating an error (if any) that was encountered when the job ran. Type: String ** [ExecutionTime](#API_DescribeJobRun_ResponseSyntax) ** The amount of time, in seconds, during which the job run consumed resources. Type: Integer ** [JobSample](#API_DescribeJobRun_ResponseSyntax) ** 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\$1ROWS for the mode parameter and 20000 for the size parameter. Type: [JobSample](API_JobSample.md) object ** [LogGroupName](#API_DescribeJobRun_ResponseSyntax) ** 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. ** [LogSubscription](#API_DescribeJobRun_ResponseSyntax) ** The current status of Amazon CloudWatch logging for the job run. Type: String Valid Values: `ENABLE | DISABLE` ** [Outputs](#API_DescribeJobRun_ResponseSyntax) ** One or more output artifacts from a job run. Type: Array of [Output](API_Output.md) objects Array Members: Minimum number of 1 item. ** [ProfileConfiguration](#API_DescribeJobRun_ResponseSyntax) ** 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. Type: [ProfileConfiguration](API_ProfileConfiguration.md) object ** [RecipeReference](#API_DescribeJobRun_ResponseSyntax) ** Represents the name and version of a DataBrew recipe. Type: [RecipeReference](API_RecipeReference.md) object ** [RunId](#API_DescribeJobRun_ResponseSyntax) ** The unique identifier of the job run. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [StartedBy](#API_DescribeJobRun_ResponseSyntax) ** The Amazon Resource Name (ARN) of the user who started the job run. Type: String ** [StartedOn](#API_DescribeJobRun_ResponseSyntax) ** The date and time when the job run began. Type: Timestamp ** [State](#API_DescribeJobRun_ResponseSyntax) ** The current state of the job run entity itself. Type: String Valid Values: `STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT` ** [ValidationConfigurations](#API_DescribeJobRun_ResponseSyntax) ** 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeJobRun) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeJobRun) # DescribeProject Returns the definition of a specific DataBrew project. ## Request Syntax ``` GET /projects/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeProject_RequestSyntax) ** The name of the project to be described. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateDate": number, "CreatedBy": "string", "DatasetName": "string", "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "OpenDate": number, "OpenedBy": "string", "RecipeName": "string", "ResourceArn": "string", "RoleArn": "string", "Sample": { "Size": number, "Type": "string" }, "SessionStatus": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DescribeProject_ResponseSyntax) ** The name of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [CreateDate](#API_DescribeProject_ResponseSyntax) ** The date and time that the project was created. Type: Timestamp ** [CreatedBy](#API_DescribeProject_ResponseSyntax) ** The identifier (user name) of the user who created the project. Type: String ** [DatasetName](#API_DescribeProject_ResponseSyntax) ** The dataset associated with the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [LastModifiedBy](#API_DescribeProject_ResponseSyntax) ** The identifier (user name) of the user who last modified the project. Type: String ** [LastModifiedDate](#API_DescribeProject_ResponseSyntax) ** The date and time that the project was last modified. Type: Timestamp ** [OpenDate](#API_DescribeProject_ResponseSyntax) ** The date and time when the project was opened. Type: Timestamp ** [OpenedBy](#API_DescribeProject_ResponseSyntax) ** The identifier (user name) of the user that opened the project for use. Type: String ** [RecipeName](#API_DescribeProject_ResponseSyntax) ** The recipe associated with this job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [ResourceArn](#API_DescribeProject_ResponseSyntax) ** The Amazon Resource Name (ARN) of the project. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [RoleArn](#API_DescribeProject_ResponseSyntax) ** The ARN of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [Sample](#API_DescribeProject_ResponseSyntax) ** Represents the sample size and sampling type for DataBrew to use for interactive data analysis. Type: [Sample](API_Sample.md) object ** [SessionStatus](#API_DescribeProject_ResponseSyntax) ** 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. Type: String Valid Values: `ASSIGNED | FAILED | INITIALIZING | PROVISIONING | READY | RECYCLING | ROTATING | TERMINATED | TERMINATING | UPDATING` ** [Tags](#API_DescribeProject_ResponseSyntax) ** Metadata tags associated with this 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeProject) # DescribeRecipe Returns the definition of a specific DataBrew recipe corresponding to a particular version. ## Request Syntax ``` GET /recipes/name?recipeVersion=RecipeVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeRecipe_RequestSyntax) ** The name of the recipe to be described. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [RecipeVersion](#API_DescribeRecipe_RequestSyntax) ** The recipe version identifier. If this parameter isn't specified, then the latest published version is returned. Length Constraints: Minimum length of 1. Maximum length of 16. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateDate": number, "CreatedBy": "string", "Description": "string", "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "ProjectName": "string", "PublishedBy": "string", "PublishedDate": number, "RecipeVersion": "string", "ResourceArn": "string", "Steps": [ { "Action": { "Operation": "string", "Parameters": { "string" : "string" } }, "ConditionExpressions": [ { "Condition": "string", "TargetColumn": "string", "Value": "string" } ] } ], "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DescribeRecipe_ResponseSyntax) ** The name of the recipe. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [CreateDate](#API_DescribeRecipe_ResponseSyntax) ** The date and time that the recipe was created. Type: Timestamp ** [CreatedBy](#API_DescribeRecipe_ResponseSyntax) ** The identifier (user name) of the user who created the recipe. Type: String ** [Description](#API_DescribeRecipe_ResponseSyntax) ** The description of the recipe. Type: String Length Constraints: Maximum length of 1024. ** [LastModifiedBy](#API_DescribeRecipe_ResponseSyntax) ** The identifier (user name) of the user who last modified the recipe. Type: String ** [LastModifiedDate](#API_DescribeRecipe_ResponseSyntax) ** The date and time that the recipe was last modified. Type: Timestamp ** [ProjectName](#API_DescribeRecipe_ResponseSyntax) ** The name of the project associated with this recipe. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [PublishedBy](#API_DescribeRecipe_ResponseSyntax) ** The identifier (user name) of the user who last published the recipe. Type: String ** [PublishedDate](#API_DescribeRecipe_ResponseSyntax) ** The date and time when the recipe was last published. Type: Timestamp ** [RecipeVersion](#API_DescribeRecipe_ResponseSyntax) ** The recipe version identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 16. ** [ResourceArn](#API_DescribeRecipe_ResponseSyntax) ** The ARN of the recipe. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [Steps](#API_DescribeRecipe_ResponseSyntax) ** 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. Type: Array of [RecipeStep](API_RecipeStep.md) objects ** [Tags](#API_DescribeRecipe_ResponseSyntax) ** Metadata tags associated with this 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeRecipe) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeRecipe) # DescribeRuleset Retrieves detailed information about the ruleset. ## Request Syntax ``` GET /rulesets/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeRuleset_RequestSyntax) ** The name of the ruleset to be described. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateDate": number, "CreatedBy": "string", "Description": "string", "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "ResourceArn": "string", "Rules": [ { "CheckExpression": "string", "ColumnSelectors": [ { "Name": "string", "Regex": "string" } ], "Disabled": boolean, "Name": "string", "SubstitutionMap": { "string" : "string" }, "Threshold": { "Type": "string", "Unit": "string", "Value": number } } ], "Tags": { "string" : "string" }, "TargetArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DescribeRuleset_ResponseSyntax) ** The name of the ruleset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [CreateDate](#API_DescribeRuleset_ResponseSyntax) ** The date and time that the ruleset was created. Type: Timestamp ** [CreatedBy](#API_DescribeRuleset_ResponseSyntax) ** The Amazon Resource Name (ARN) of the user who created the ruleset. Type: String ** [Description](#API_DescribeRuleset_ResponseSyntax) ** The description of the ruleset. Type: String Length Constraints: Maximum length of 1024. ** [LastModifiedBy](#API_DescribeRuleset_ResponseSyntax) ** The Amazon Resource Name (ARN) of the user who last modified the ruleset. Type: String ** [LastModifiedDate](#API_DescribeRuleset_ResponseSyntax) ** The modification date and time of the ruleset. Type: Timestamp ** [ResourceArn](#API_DescribeRuleset_ResponseSyntax) ** The Amazon Resource Name (ARN) for the ruleset. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [Rules](#API_DescribeRuleset_ResponseSyntax) ** A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. Type: Array of [Rule](API_Rule.md) objects Array Members: Minimum number of 1 item. ** [Tags](#API_DescribeRuleset_ResponseSyntax) ** 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. ** [TargetArn](#API_DescribeRuleset_ResponseSyntax) ** 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeRuleset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeRuleset) # DescribeSchedule Returns the definition of a specific DataBrew schedule. ## Request Syntax ``` GET /schedules/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeSchedule_RequestSyntax) ** The name of the schedule to be described. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateDate": number, "CreatedBy": "string", "CronExpression": "string", "JobNames": [ "string" ], "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "ResourceArn": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_DescribeSchedule_ResponseSyntax) ** The name of the schedule. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [CreateDate](#API_DescribeSchedule_ResponseSyntax) ** The date and time that the schedule was created. Type: Timestamp ** [CreatedBy](#API_DescribeSchedule_ResponseSyntax) ** The identifier (user name) of the user who created the schedule. Type: String ** [CronExpression](#API_DescribeSchedule_ResponseSyntax) ** The date or dates and time or times when the jobs are to be run for the schedule. For more information, see [Cron expressions](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the * AWS Glue DataBrew Developer Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. ** [JobNames](#API_DescribeSchedule_ResponseSyntax) ** The name or names of one or more jobs to be run by using the schedule. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 240. ** [LastModifiedBy](#API_DescribeSchedule_ResponseSyntax) ** The identifier (user name) of the user who last modified the schedule. Type: String ** [LastModifiedDate](#API_DescribeSchedule_ResponseSyntax) ** The date and time that the schedule was last modified. Type: Timestamp ** [ResourceArn](#API_DescribeSchedule_ResponseSyntax) ** The Amazon Resource Name (ARN) of the schedule. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [Tags](#API_DescribeSchedule_ResponseSyntax) ** Metadata tags associated with this 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeSchedule) # ListDatasets Lists all of the DataBrew datasets. ## Request Syntax ``` GET /datasets?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListDatasets_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_ListDatasets_RequestSyntax) ** The token returned by a previous call to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2000. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Datasets": [ { "AccountId": "string", "CreateDate": number, "CreatedBy": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string", "HeaderRow": boolean }, "Excel": { "HeaderRow": boolean, "SheetIndexes": [ number ], "SheetNames": [ "string" ] }, "Json": { "MultiLine": boolean } }, "Input": { "DatabaseInputDefinition": { "DatabaseTableName": "string", "GlueConnectionName": "string", "QueryString": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DataCatalogInputDefinition": { "CatalogId": "string", "DatabaseName": "string", "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Metadata": { "SourceArn": "string" }, "S3InputDefinition": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "PathOptions": { "FilesLimit": { "MaxFiles": number, "Order": "string", "OrderedBy": "string" }, "LastModifiedDateCondition": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Parameters": { "string" : { "CreateColumn": boolean, "DatetimeOptions": { "Format": "string", "LocaleCode": "string", "TimezoneOffset": "string" }, "Filter": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Name": "string", "Type": "string" } } }, "ResourceArn": "string", "Source": "string", "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Datasets](#API_ListDatasets_ResponseSyntax) ** A list of datasets that are defined. Type: Array of [Dataset](API_Dataset.md) objects ** [NextToken](#API_ListDatasets_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListDatasets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListDatasets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListDatasets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListDatasets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListDatasets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListDatasets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListDatasets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListDatasets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListDatasets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListDatasets) # ListJobRuns Lists all of the previous runs of a particular DataBrew job. ## Request Syntax ``` GET /jobs/name/jobRuns?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListJobRuns_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [name](#API_ListJobRuns_RequestSyntax) ** The name of the job. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ** [NextToken](#API_ListJobRuns_RequestSyntax) ** The token returned by a previous call to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2000. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "JobRuns": [ { "Attempt": number, "CompletedOn": number, "DatabaseOutputs": [ { "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DatabaseOutputMode": "string", "GlueConnectionName": "string" } ], "DataCatalogOutputs": [ { "CatalogId": "string", "DatabaseName": "string", "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Overwrite": boolean, "S3Options": { "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "TableName": "string" } ], "DatasetName": "string", "ErrorMessage": "string", "ExecutionTime": number, "JobName": "string", "JobSample": { "Mode": "string", "Size": number }, "LogGroupName": "string", "LogSubscription": "string", "Outputs": [ { "CompressionFormat": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string" } }, "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "MaxOutputFiles": number, "Overwrite": boolean, "PartitionColumns": [ "string" ] } ], "RecipeReference": { "Name": "string", "RecipeVersion": "string" }, "RunId": "string", "StartedBy": "string", "StartedOn": number, "State": "string", "ValidationConfigurations": [ { "RulesetArn": "string", "ValidationMode": "string" } ] } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobRuns](#API_ListJobRuns_ResponseSyntax) ** A list of job runs that have occurred for the specified job. Type: Array of [JobRun](API_JobRun.md) objects ** [NextToken](#API_ListJobRuns_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListJobRuns) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListJobRuns) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListJobRuns) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListJobRuns) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListJobRuns) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListJobRuns) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListJobRuns) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListJobRuns) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListJobRuns) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListJobRuns) # ListJobs Lists all of the DataBrew jobs that are defined. ## Request Syntax ``` GET /jobs?datasetName=DatasetName&maxResults=MaxResults&nextToken=NextToken&projectName=ProjectName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DatasetName](#API_ListJobs_RequestSyntax) ** The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset. Length Constraints: Minimum length of 1. Maximum length of 255. ** [MaxResults](#API_ListJobs_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_ListJobs_RequestSyntax) ** 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. Length Constraints: Minimum length of 1. Maximum length of 2000. ** [ProjectName](#API_ListJobs_RequestSyntax) ** The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project. Length Constraints: Minimum length of 1. Maximum length of 255. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Jobs": [ { "AccountId": "string", "CreateDate": number, "CreatedBy": "string", "DatabaseOutputs": [ { "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DatabaseOutputMode": "string", "GlueConnectionName": "string" } ], "DataCatalogOutputs": [ { "CatalogId": "string", "DatabaseName": "string", "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Overwrite": boolean, "S3Options": { "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "TableName": "string" } ], "DatasetName": "string", "EncryptionKeyArn": "string", "EncryptionMode": "string", "JobSample": { "Mode": "string", "Size": number }, "LastModifiedBy": "string", "LastModifiedDate": number, "LogSubscription": "string", "MaxCapacity": number, "MaxRetries": number, "Name": "string", "Outputs": [ { "CompressionFormat": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string" } }, "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "MaxOutputFiles": number, "Overwrite": boolean, "PartitionColumns": [ "string" ] } ], "ProjectName": "string", "RecipeReference": { "Name": "string", "RecipeVersion": "string" }, "ResourceArn": "string", "RoleArn": "string", "Tags": { "string" : "string" }, "Timeout": number, "Type": "string", "ValidationConfigurations": [ { "RulesetArn": "string", "ValidationMode": "string" } ] } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Jobs](#API_ListJobs_ResponseSyntax) ** A list of jobs that are defined. Type: Array of [Job](API_Job.md) objects ** [NextToken](#API_ListJobs_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListJobs) # ListProjects Lists all of the DataBrew projects that are defined. ## Request Syntax ``` GET /projects?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListProjects_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_ListProjects_RequestSyntax) ** The token returned by a previous call to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2000. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Projects": [ { "AccountId": "string", "CreateDate": number, "CreatedBy": "string", "DatasetName": "string", "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "OpenDate": number, "OpenedBy": "string", "RecipeName": "string", "ResourceArn": "string", "RoleArn": "string", "Sample": { "Size": number, "Type": "string" }, "Tags": { "string" : "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Projects](#API_ListProjects_ResponseSyntax) ** A list of projects that are defined . Type: Array of [Project](API_Project.md) objects ** [NextToken](#API_ListProjects_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListProjects) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListProjects) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListProjects) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListProjects) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListProjects) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListProjects) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListProjects) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListProjects) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListProjects) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListProjects) # ListRecipes Lists all of the DataBrew recipes that are defined. ## Request Syntax ``` GET /recipes?maxResults=MaxResults&nextToken=NextToken&recipeVersion=RecipeVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListRecipes_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_ListRecipes_RequestSyntax) ** The token returned by a previous call to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2000. ** [RecipeVersion](#API_ListRecipes_RequestSyntax) ** 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` \$1 `LATEST_PUBLISHED` Length Constraints: Minimum length of 1. Maximum length of 16. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Recipes": [ { "CreateDate": number, "CreatedBy": "string", "Description": "string", "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "ProjectName": "string", "PublishedBy": "string", "PublishedDate": number, "RecipeVersion": "string", "ResourceArn": "string", "Steps": [ { "Action": { "Operation": "string", "Parameters": { "string" : "string" } }, "ConditionExpressions": [ { "Condition": "string", "TargetColumn": "string", "Value": "string" } ] } ], "Tags": { "string" : "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Recipes](#API_ListRecipes_ResponseSyntax) ** A list of recipes that are defined. Type: Array of [Recipe](API_Recipe.md) objects ** [NextToken](#API_ListRecipes_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListRecipes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListRecipes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListRecipes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListRecipes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListRecipes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListRecipes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListRecipes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListRecipes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListRecipes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListRecipes) # ListRecipeVersions Lists the versions of a particular DataBrew recipe, except for `LATEST_WORKING`. ## Request Syntax ``` GET /recipeVersions?maxResults=MaxResults&name=Name&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListRecipeVersions_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [Name](#API_ListRecipeVersions_RequestSyntax) ** The name of the recipe for which to return version information. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [NextToken](#API_ListRecipeVersions_RequestSyntax) ** The token returned by a previous call to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2000. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Recipes": [ { "CreateDate": number, "CreatedBy": "string", "Description": "string", "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "ProjectName": "string", "PublishedBy": "string", "PublishedDate": number, "RecipeVersion": "string", "ResourceArn": "string", "Steps": [ { "Action": { "Operation": "string", "Parameters": { "string" : "string" } }, "ConditionExpressions": [ { "Condition": "string", "TargetColumn": "string", "Value": "string" } ] } ], "Tags": { "string" : "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Recipes](#API_ListRecipeVersions_ResponseSyntax) ** A list of versions for the specified recipe. Type: Array of [Recipe](API_Recipe.md) objects ** [NextToken](#API_ListRecipeVersions_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListRecipeVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListRecipeVersions) # ListRulesets List all rulesets available in the current account or rulesets associated with a specific resource (dataset). ## Request Syntax ``` GET /rulesets?maxResults=MaxResults&nextToken=NextToken&targetArn=TargetArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListRulesets_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_ListRulesets_RequestSyntax) ** 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. Length Constraints: Minimum length of 1. Maximum length of 2000. ** [TargetArn](#API_ListRulesets_RequestSyntax) ** 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. Length Constraints: Minimum length of 20. Maximum length of 2048. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Rulesets": [ { "AccountId": "string", "CreateDate": number, "CreatedBy": "string", "Description": "string", "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "ResourceArn": "string", "RuleCount": number, "Tags": { "string" : "string" }, "TargetArn": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Rulesets](#API_ListRulesets_ResponseSyntax) ** A list of RulesetItem. RulesetItem contains meta data of a ruleset. Type: Array of [RulesetItem](API_RulesetItem.md) objects ** [NextToken](#API_ListRulesets_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListRulesets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListRulesets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListRulesets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListRulesets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListRulesets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListRulesets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListRulesets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListRulesets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListRulesets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListRulesets) # ListSchedules Lists the DataBrew schedules that are defined. ## Request Syntax ``` GET /schedules?jobName=JobName&maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [JobName](#API_ListSchedules_RequestSyntax) ** The name of the job that these schedules apply to. Length Constraints: Minimum length of 1. Maximum length of 240. ** [MaxResults](#API_ListSchedules_RequestSyntax) ** The maximum number of results to return in this request. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_ListSchedules_RequestSyntax) ** The token returned by a previous call to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2000. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Schedules": [ { "AccountId": "string", "CreateDate": number, "CreatedBy": "string", "CronExpression": "string", "JobNames": [ "string" ], "LastModifiedBy": "string", "LastModifiedDate": number, "Name": "string", "ResourceArn": "string", "Tags": { "string" : "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Schedules](#API_ListSchedules_ResponseSyntax) ** A list of schedules that are defined. Type: Array of [Schedule](API_Schedule.md) objects ** [NextToken](#API_ListSchedules_ResponseSyntax) ** A token that you can use in a subsequent call to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListSchedules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListSchedules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListSchedules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListSchedules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListSchedules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListSchedules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListSchedules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListSchedules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListSchedules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListSchedules) # ListTagsForResource Lists all the tags for a DataBrew resource. ## Request Syntax ``` GET /tags/ResourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** A list of tags associated with the DataBrew resource. 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. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal service failure occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListTagsForResource) # PublishRecipe Publishes a new version of a DataBrew recipe. ## Request Syntax ``` POST /recipes/name/publishRecipe HTTP/1.1 Content-type: application/json { "Description": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_PublishRecipe_RequestSyntax) ** The name of the recipe to be published. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_PublishRecipe_RequestSyntax) ** A description of the recipe to be published, for this version of the recipe. Type: String Length Constraints: Maximum length of 1024. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_PublishRecipe_ResponseSyntax) ** The name of the recipe that you published. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/PublishRecipe) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/PublishRecipe) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/PublishRecipe) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/PublishRecipe) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/PublishRecipe) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/PublishRecipe) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/PublishRecipe) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/PublishRecipe) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/PublishRecipe) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/PublishRecipe) # SendProjectSessionAction Performs a recipe step within an interactive DataBrew session that's currently open. ## Request Syntax ``` PUT /projects/name/sendProjectSessionAction HTTP/1.1 Content-type: application/json { "ClientSessionId": "string", "Preview": boolean, "RecipeStep": { "Action": { "Operation": "string", "Parameters": { "string" : "string" } }, "ConditionExpressions": [ { "Condition": "string", "TargetColumn": "string", "Value": "string" } ] }, "StepIndex": number, "ViewFrame": { "Analytics": "string", "ColumnRange": number, "HiddenColumns": [ "string" ], "RowRange": number, "StartColumnIndex": number, "StartRowIndex": number } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_SendProjectSessionAction_RequestSyntax) ** The name of the project to apply the action to. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ClientSessionId](#API_SendProjectSessionAction_RequestSyntax) ** A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z0-9][a-zA-Z0-9-]*$` Required: No ** [Preview](#API_SendProjectSessionAction_RequestSyntax) ** If true, the result of the recipe step will be returned, but not applied. Type: Boolean Required: No ** [RecipeStep](#API_SendProjectSessionAction_RequestSyntax) ** Represents a single step from a DataBrew recipe to be performed. Type: [RecipeStep](API_RecipeStep.md) object Required: No ** [StepIndex](#API_SendProjectSessionAction_RequestSyntax) ** 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. Type: Integer Valid Range: Minimum value of 0. Required: No ** [ViewFrame](#API_SendProjectSessionAction_RequestSyntax) ** Represents the data being transformed during an action. Type: [ViewFrame](API_ViewFrame.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ActionId": number, "Name": "string", "Result": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_SendProjectSessionAction_ResponseSyntax) ** The name of the project that was affected by the action. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [ActionId](#API_SendProjectSessionAction_ResponseSyntax) ** A unique identifier for the action that was performed. Type: Integer ** [Result](#API_SendProjectSessionAction_ResponseSyntax) ** A message indicating the result of performing the action. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/SendProjectSessionAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/SendProjectSessionAction) # StartJobRun Runs a DataBrew job. ## Request Syntax ``` POST /jobs/name/startJobRun HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_StartJobRun_RequestSyntax) ** The name of the job to be run. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "RunId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [RunId](#API_StartJobRun_ResponseSyntax) ** A system-generated identifier for this particular job run. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/StartJobRun) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/StartJobRun) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StartJobRun) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/StartJobRun) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StartJobRun) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/StartJobRun) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/StartJobRun) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/StartJobRun) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/StartJobRun) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/StartJobRun) # StartProjectSession Creates an interactive session, enabling you to manipulate data in a DataBrew project. ## Request Syntax ``` PUT /projects/name/startProjectSession HTTP/1.1 Content-type: application/json { "AssumeControl": boolean } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_StartProjectSession_RequestSyntax) ** The name of the project to act upon. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [AssumeControl](#API_StartProjectSession_RequestSyntax) ** A value that, if true, enables you to take control of a session, even if a different client is currently accessing the project. Type: Boolean Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ClientSessionId": "string", "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_StartProjectSession_ResponseSyntax) ** The name of the project to be acted upon. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [ClientSessionId](#API_StartProjectSession_ResponseSyntax) ** A system-generated identifier for the session. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z0-9][a-zA-Z0-9-]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/StartProjectSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/StartProjectSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StartProjectSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/StartProjectSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StartProjectSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/StartProjectSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/StartProjectSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/StartProjectSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/StartProjectSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/StartProjectSession) # StopJobRun Stops a particular run of a job. ## Request Syntax ``` POST /jobs/name/jobRun/runId/stopJobRun HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_StopJobRun_RequestSyntax) ** The name of the job to be stopped. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ** [runId](#API_StopJobRun_RequestSyntax) ** The ID of the job run to be stopped. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "RunId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [RunId](#API_StopJobRun_ResponseSyntax) ** The ID of the job run that you stopped. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/StopJobRun) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/StopJobRun) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StopJobRun) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/StopJobRun) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StopJobRun) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/StopJobRun) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/StopJobRun) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/StopJobRun) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/StopJobRun) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/StopJobRun) # TagResource Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule. ## Request Syntax ``` POST /tags/ResourceArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_TagResource_RequestSyntax) ** The DataBrew resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a recipe. Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Tags](#API_TagResource_RequestSyntax) ** One or more tags to be assigned to the resource. 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: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal service failure occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/TagResource) # UntagResource Removes metadata tags from a DataBrew resource. ## Request Syntax ``` DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_UntagResource_RequestSyntax) ** A DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** The tag keys (names) of one or more tags to be removed. Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal service failure occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UntagResource) # UpdateDataset Modifies the definition of an existing DataBrew dataset. ## Request Syntax ``` PUT /datasets/name HTTP/1.1 Content-type: application/json { "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string", "HeaderRow": boolean }, "Excel": { "HeaderRow": boolean, "SheetIndexes": [ number ], "SheetNames": [ "string" ] }, "Json": { "MultiLine": boolean } }, "Input": { "DatabaseInputDefinition": { "DatabaseTableName": "string", "GlueConnectionName": "string", "QueryString": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DataCatalogInputDefinition": { "CatalogId": "string", "DatabaseName": "string", "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Metadata": { "SourceArn": "string" }, "S3InputDefinition": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "PathOptions": { "FilesLimit": { "MaxFiles": number, "Order": "string", "OrderedBy": "string" }, "LastModifiedDateCondition": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Parameters": { "string" : { "CreateColumn": boolean, "DatetimeOptions": { "Format": "string", "LocaleCode": "string", "TimezoneOffset": "string" }, "Filter": { "Expression": "string", "ValuesMap": { "string" : "string" } }, "Name": "string", "Type": "string" } } } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateDataset_RequestSyntax) ** The name of the dataset to be updated. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Input](#API_UpdateDataset_RequestSyntax) ** Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3. Type: [Input](API_Input.md) object Required: Yes ** [Format](#API_UpdateDataset_RequestSyntax) ** 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](#API_UpdateDataset_RequestSyntax) ** Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. Type: [FormatOptions](API_FormatOptions.md) object Required: No ** [PathOptions](#API_UpdateDataset_RequestSyntax) ** A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. Type: [PathOptions](API_PathOptions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_UpdateDataset_ResponseSyntax) ** The name of the dataset that you updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access to the specified resource was denied. HTTP Status Code: 403 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateDataset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateDataset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateDataset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateDataset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateDataset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateDataset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateDataset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateDataset) # UpdateProfileJob Modifies the definition of an existing profile job. ## Request Syntax ``` PUT /profileJobs/name HTTP/1.1 Content-type: application/json { "Configuration": { "ColumnStatisticsConfigurations": [ { "Selectors": [ { "Name": "string", "Regex": "string" } ], "Statistics": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] } } ], "DatasetStatisticsConfiguration": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] }, "EntityDetectorConfiguration": { "AllowedStatistics": [ { "Statistics": [ "string" ] } ], "EntityTypes": [ "string" ] }, "ProfileColumns": [ { "Name": "string", "Regex": "string" } ] }, "EncryptionKeyArn": "string", "EncryptionMode": "string", "JobSample": { "Mode": "string", "Size": number }, "LogSubscription": "string", "MaxCapacity": number, "MaxRetries": number, "OutputLocation": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "RoleArn": "string", "Timeout": number, "ValidationConfigurations": [ { "RulesetArn": "string", "ValidationMode": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateProfileJob_RequestSyntax) ** The name of the job to be updated. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [OutputLocation](#API_UpdateProfileJob_RequestSyntax) ** 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: Yes ** [RoleArn](#API_UpdateProfileJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ** [Configuration](#API_UpdateProfileJob_RequestSyntax) ** 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. Type: [ProfileConfiguration](API_ProfileConfiguration.md) object Required: No ** [EncryptionKeyArn](#API_UpdateProfileJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** [EncryptionMode](#API_UpdateProfileJob_RequestSyntax) ** The encryption mode for the job, which can be one of the following: + `SSE-KMS` - Server-side encryption with keys managed by AWS KMS. + `SSE-S3` - Server-side encryption with keys managed by Amazon S3. Type: String Valid Values: `SSE-KMS | SSE-S3` Required: No ** [JobSample](#API_UpdateProfileJob_RequestSyntax) ** 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\$1ROWS for the mode parameter and 20000 for the size parameter. Type: [JobSample](API_JobSample.md) object Required: No ** [LogSubscription](#API_UpdateProfileJob_RequestSyntax) ** Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. Type: String Valid Values: `ENABLE | DISABLE` Required: No ** [MaxCapacity](#API_UpdateProfileJob_RequestSyntax) ** The maximum number of compute nodes that DataBrew can use when the job processes data. Type: Integer Required: No ** [MaxRetries](#API_UpdateProfileJob_RequestSyntax) ** The maximum number of times to retry the job after a job run fails. Type: Integer Valid Range: Minimum value of 0. Required: No ** [Timeout](#API_UpdateProfileJob_RequestSyntax) ** 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 ** [ValidationConfigurations](#API_UpdateProfileJob_RequestSyntax) ** 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_UpdateProfileJob_ResponseSyntax) ** The name of the job that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access to the specified resource was denied. HTTP Status Code: 403 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateProfileJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateProfileJob) # UpdateProject Modifies the definition of an existing DataBrew project. ## Request Syntax ``` PUT /projects/name HTTP/1.1 Content-type: application/json { "RoleArn": "string", "Sample": { "Size": number, "Type": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateProject_RequestSyntax) ** The name of the project to be updated. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [RoleArn](#API_UpdateProject_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role to be assumed for this request. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ** [Sample](#API_UpdateProject_RequestSyntax) ** Represents the sample size and sampling type for DataBrew to use for interactive data analysis. Type: [Sample](API_Sample.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "LastModifiedDate": number, "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_UpdateProject_ResponseSyntax) ** The name of the project that you updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [LastModifiedDate](#API_UpdateProject_ResponseSyntax) ** The date and time that the project was last modified. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateProject) # UpdateRecipe Modifies the definition of the `LATEST_WORKING` version of a DataBrew recipe. ## Request Syntax ``` PUT /recipes/name HTTP/1.1 Content-type: application/json { "Description": "string", "Steps": [ { "Action": { "Operation": "string", "Parameters": { "string" : "string" } }, "ConditionExpressions": [ { "Condition": "string", "TargetColumn": "string", "Value": "string" } ] } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateRecipe_RequestSyntax) ** The name of the recipe to be updated. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_UpdateRecipe_RequestSyntax) ** A description of the recipe. Type: String Length Constraints: Maximum length of 1024. Required: No ** [Steps](#API_UpdateRecipe_RequestSyntax) ** 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. Type: Array of [RecipeStep](API_RecipeStep.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_UpdateRecipe_ResponseSyntax) ** The name of the recipe that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateRecipe) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateRecipe) # UpdateRecipeJob Modifies the definition of an existing DataBrew recipe job. ## Request Syntax ``` PUT /recipeJobs/name HTTP/1.1 Content-type: application/json { "DatabaseOutputs": [ { "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "DatabaseOutputMode": "string", "GlueConnectionName": "string" } ], "DataCatalogOutputs": [ { "CatalogId": "string", "DatabaseName": "string", "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "Overwrite": boolean, "S3Options": { "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" } }, "TableName": "string" } ], "EncryptionKeyArn": "string", "EncryptionMode": "string", "LogSubscription": "string", "MaxCapacity": number, "MaxRetries": number, "Outputs": [ { "CompressionFormat": "string", "Format": "string", "FormatOptions": { "Csv": { "Delimiter": "string" } }, "Location": { "Bucket": "string", "BucketOwner": "string", "Key": "string" }, "MaxOutputFiles": number, "Overwrite": boolean, "PartitionColumns": [ "string" ] } ], "RoleArn": "string", "Timeout": number } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateRecipeJob_RequestSyntax) ** The name of the job to update. Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [RoleArn](#API_UpdateRecipeJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes ** [DatabaseOutputs](#API_UpdateRecipeJob_RequestSyntax) ** 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](#API_UpdateRecipeJob_RequestSyntax) ** One or more artifacts that represent the AWS 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 ** [EncryptionKeyArn](#API_UpdateRecipeJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** [EncryptionMode](#API_UpdateRecipeJob_RequestSyntax) ** The encryption mode for the job, which can be one of the following: + `SSE-KMS` - Server-side encryption with keys managed by AWS KMS. + `SSE-S3` - Server-side encryption with keys managed by Amazon S3. Type: String Valid Values: `SSE-KMS | SSE-S3` Required: No ** [LogSubscription](#API_UpdateRecipeJob_RequestSyntax) ** Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. Type: String Valid Values: `ENABLE | DISABLE` Required: No ** [MaxCapacity](#API_UpdateRecipeJob_RequestSyntax) ** The maximum number of nodes that DataBrew can consume when the job processes data. Type: Integer Required: No ** [MaxRetries](#API_UpdateRecipeJob_RequestSyntax) ** 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](#API_UpdateRecipeJob_RequestSyntax) ** One or more artifacts that represent the output from running the job. Type: Array of [Output](API_Output.md) objects Array Members: Minimum number of 1 item. Required: No ** [Timeout](#API_UpdateRecipeJob_RequestSyntax) ** 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_UpdateRecipeJob_ResponseSyntax) ** The name of the job that you updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access to the specified resource was denied. HTTP Status Code: 403 ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateRecipeJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateRecipeJob) # UpdateRuleset Updates specified ruleset. ## Request Syntax ``` PUT /rulesets/name HTTP/1.1 Content-type: application/json { "Description": "string", "Rules": [ { "CheckExpression": "string", "ColumnSelectors": [ { "Name": "string", "Regex": "string" } ], "Disabled": boolean, "Name": "string", "SubstitutionMap": { "string" : "string" }, "Threshold": { "Type": "string", "Unit": "string", "Value": number } } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateRuleset_RequestSyntax) ** The name of the ruleset to be updated. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Rules](#API_UpdateRuleset_RequestSyntax) ** A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. Type: Array of [Rule](API_Rule.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [Description](#API_UpdateRuleset_RequestSyntax) ** The description of the ruleset. Type: String Length Constraints: Maximum length of 1024. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_UpdateRuleset_ResponseSyntax) ** The name of the updated ruleset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateRuleset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateRuleset) # UpdateSchedule Modifies the definition of an existing DataBrew schedule. ## Request Syntax ``` PUT /schedules/name HTTP/1.1 Content-type: application/json { "CronExpression": "string", "JobNames": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateSchedule_RequestSyntax) ** The name of the schedule to update. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [CronExpression](#API_UpdateSchedule_RequestSyntax) ** The date or dates and time or times when the jobs are to be run. For more information, see [Cron expressions](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the * AWS Glue DataBrew Developer Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: Yes ** [JobNames](#API_UpdateSchedule_RequestSyntax) ** The name or names of one or more jobs to be run for this schedule. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 240. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Name](#API_UpdateSchedule_ResponseSyntax) ** The name of the schedule that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** One or more resources can't be found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** A service quota is exceeded. HTTP Status Code: 402 ** ValidationException ** The input parameters for this request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateSchedule) # 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/AllowedStatistics) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/AllowedStatistics) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The name of a column from a dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** Regex ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ColumnSelector) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ColumnSelector) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations. Type: [StatisticsConfiguration](API_StatisticsConfiguration.md) object Required: Yes ** 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. 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ColumnStatisticsConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ColumnStatisticsConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 specific condition to apply to a recipe action. For more information, see [Recipe structure](https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure) in the * AWS Glue DataBrew Developer Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[A-Z\_]+$` Required: Yes ** TargetColumn ** A column to apply this condition to. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes ** Value ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ConditionExpression) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ConditionExpression) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 single character that specifies the delimiter being used in the CSV file. Type: String Length Constraints: Fixed length of 1. Required: No ** 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. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CsvOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CsvOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CsvOutputOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CsvOutputOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The AWS 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 ** The table within the target database. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** QueryString ** Custom SQL to run against the provided AWS 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DatabaseInputDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DatabaseInputDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** The AWS 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DatabaseOutput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DatabaseOutput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DatabaseTableOutputOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DatabaseTableOutputOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DatabaseTableOutputOptions) # DataCatalogInputDefinition Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset. ## Contents **Note** In the following list, the required parameters are described first. ** DatabaseName ** The name of a database in the Data Catalog. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** TableName ** 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 ** The unique identifier of the AWS 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DataCatalogInputDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DataCatalogInputDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DataCatalogInputDefinition) # DataCatalogOutput Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs. ## Contents **Note** In the following list, the required parameters are described first. ** DatabaseName ** The name of a database in the Data Catalog. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** TableName ** The name of a table in the Data Catalog. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** CatalogId ** The unique identifier of the AWS 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 ** 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 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DataCatalogOutput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DataCatalogOutput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3. Type: [Input](API_Input.md) object Required: Yes ** Name ** The unique name of the dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** AccountId ** The ID of the AWS account that owns the dataset. Type: String Length Constraints: Maximum length of 255. Required: No ** CreateDate ** The date and time that the dataset was created. Type: Timestamp Required: No ** CreatedBy ** The Amazon Resource Name (ARN) of the user who created the dataset. Type: String Required: No ** Format ** 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 set of options that define how DataBrew interprets the data in the dataset. Type: [FormatOptions](API_FormatOptions.md) object Required: No ** LastModifiedBy ** The Amazon Resource Name (ARN) of the user who last modified the dataset. Type: String Required: No ** LastModifiedDate ** The last modification date and time of the dataset. Type: Timestamp Required: No ** PathOptions ** 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 ** The unique Amazon Resource Name (ARN) for the dataset. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** Source ** The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog. Type: String Valid Values: `S3 | DATA-CATALOG | DATABASE` Required: No ** Tags ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Dataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Dataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** 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 ** 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 ** Additional parameter options such as a format and a timezone. Required for datetime parameters. Type: [DatetimeOptions](API_DatetimeOptions.md) object Required: No ** Filter ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DatasetParameter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DatasetParameter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DatetimeOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DatetimeOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/EntityDetectorConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/EntityDetectorConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 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 ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ExcelOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ExcelOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The number of Amazon S3 files to select. Type: Integer Valid Range: Minimum value of 1. Required: Yes ** 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. Type: String Valid Values: `DESCENDING | ASCENDING` Required: No ** OrderedBy ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/FilesLimit) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/FilesLimit) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets) in the * AWS Glue DataBrew Developer Guide*. ## Contents **Note** In the following list, the required parameters are described first. ** Expression ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/FilterExpression) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/FilterExpression) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** Options that define how CSV input is to be interpreted by DataBrew. Type: [CsvOptions](API_CsvOptions.md) object Required: No ** Excel ** Options that define how Excel input is to be interpreted by DataBrew. Type: [ExcelOptions](API_ExcelOptions.md) object Required: No ** Json ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/FormatOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/FormatOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/FormatOptions) # Input Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3. ## Contents **Note** In the following list, the required parameters are described first. ** DatabaseInputDefinition ** Connection information for dataset input files stored in a database. Type: [DatabaseInputDefinition](API_DatabaseInputDefinition.md) object Required: No ** DataCatalogInputDefinition ** The AWS Glue Data Catalog parameters for the data. Type: [DataCatalogInputDefinition](API_DataCatalogInputDefinition.md) object Required: No ** Metadata ** Contains additional resource information needed for specific datasets. Type: [Metadata](API_Metadata.md) object Required: No ** S3InputDefinition ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Input) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Input) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The unique name of the job. Type: String Length Constraints: Minimum length of 1. Maximum length of 240. Required: Yes ** AccountId ** The ID of the AWS account that owns the job. Type: String Length Constraints: Maximum length of 255. Required: No ** CreateDate ** The date and time that the job was created. Type: Timestamp Required: No ** CreatedBy ** The Amazon Resource Name (ARN) of the user who created the job. Type: String Required: No ** DatabaseOutputs ** 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 ** One or more artifacts that represent the AWS 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 dataset that the job is to process. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** 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](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** EncryptionMode ** The encryption mode for the job, which can be one of the following: + `SSE-KMS` - Server-side encryption with keys managed by AWS KMS. + `SSE-S3` - Server-side encryption with keys managed by Amazon S3. Type: String Valid Values: `SSE-KMS | SSE-S3` Required: No ** 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\$1ROWS for the mode parameter and 20,000 for the size parameter. Type: [JobSample](API_JobSample.md) object Required: No ** LastModifiedBy ** The Amazon Resource Name (ARN) of the user who last modified the job. Type: String Required: No ** LastModifiedDate ** The modification date and time of the job. Type: Timestamp Required: No ** LogSubscription ** The current status of Amazon CloudWatch logging for the job. Type: String Valid Values: `ENABLE | DISABLE` Required: No ** MaxCapacity ** The maximum number of nodes that can be consumed when the job processes data. Type: Integer Required: No ** MaxRetries ** 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 ** 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 ** 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 set of steps that the job runs. Type: [RecipeReference](API_RecipeReference.md) object Required: No ** ResourceArn ** The unique Amazon Resource Name (ARN) for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** RoleArn ** 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 ** 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 ** 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 ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Job) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Job) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The number of times that DataBrew has attempted to run the job. Type: Integer Required: No ** CompletedOn ** The date and time when the job completed processing. Type: Timestamp Required: No ** DatabaseOutputs ** 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 ** One or more artifacts that represent the AWS 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 ** 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 message indicating an error (if any) that was encountered when the job ran. Type: String Required: No ** ExecutionTime ** The amount of time, in seconds, during which a job run consumed resources. Type: Integer Required: No ** JobName ** 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 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 ** 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 ** The current status of Amazon CloudWatch logging for the job run. Type: String Valid Values: `ENABLE | DISABLE` Required: No ** Outputs ** 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 ** The set of steps processed by the job. Type: [RecipeReference](API_RecipeReference.md) object Required: No ** RunId ** The unique identifier of the job run. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** StartedBy ** The Amazon Resource Name (ARN) of the user who initiated the job run. Type: String Required: No ** StartedOn ** The date and time when the job run began. Type: Timestamp Required: No ** State ** The current state of the job run entity itself. Type: String Valid Values: `STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT` Required: No ** ValidationConfigurations ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/JobRun) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/JobRun) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/JobSample) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/JobSample) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/JobSample) # JsonOptions Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew. ## Contents **Note** In the following list, the required parameters are described first. ** MultiLine ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/JsonOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/JsonOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Metadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Metadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The location in Amazon S3 where the job writes its output. Type: [S3Location](API_S3Location.md) object Required: Yes ** CompressionFormat ** 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 ** The data format of the output of the job. Type: String Valid Values: `CSV | JSON | PARQUET | GLUEPARQUET | AVRO | ORC | XML | TABLEAUHYPER` Required: No ** FormatOptions ** Represents options that define how DataBrew formats job output files. Type: [OutputFormatOptions](API_OutputFormatOptions.md) object Required: No ** 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 999. Required: No ** Overwrite ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Output) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Output) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/OutputFormatOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/OutputFormatOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** 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 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/PathOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/PathOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** 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 ** Configuration of entity detection for a profile job. When undefined, entity detection is disabled. Type: [EntityDetectorConfiguration](API_EntityDetectorConfiguration.md) object Required: No ** 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. 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ProfileConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ProfileConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The unique name of a project. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** RecipeName ** 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 ** The ID of the AWS account that owns the project. Type: String Length Constraints: Maximum length of 255. Required: No ** CreateDate ** The date and time that the project was created. Type: Timestamp Required: No ** CreatedBy ** The Amazon Resource Name (ARN) of the user who crated the project. Type: String Required: No ** DatasetName ** The dataset that the project is to act upon. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** LastModifiedBy ** The Amazon Resource Name (ARN) of the user who last modified the project. Type: String Required: No ** LastModifiedDate ** The last modification date and time for the project. Type: Timestamp Required: No ** OpenDate ** The date and time when the project was opened. Type: Timestamp Required: No ** OpenedBy ** The Amazon Resource Name (ARN) of the user that opened the project for use. Type: String Required: No ** ResourceArn ** The Amazon Resource Name (ARN) for the project. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** RoleArn ** 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 ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Project) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Project) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The unique name for the recipe. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** CreateDate ** The date and time that the recipe was created. Type: Timestamp Required: No ** CreatedBy ** The Amazon Resource Name (ARN) of the user who created the recipe. Type: String Required: No ** Description ** The description of the recipe. Type: String Length Constraints: Maximum length of 1024. Required: No ** LastModifiedBy ** The Amazon Resource Name (ARN) of the user who last modified the recipe. Type: String Required: No ** LastModifiedDate ** The last modification date and time of the recipe. Type: Timestamp Required: No ** ProjectName ** 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 ** The Amazon Resource Name (ARN) of the user who published the recipe. Type: String Required: No ** PublishedDate ** The date and time when the recipe was published. Type: Timestamp Required: No ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 16. Required: No ** ResourceArn ** The Amazon Resource Name (ARN) for the recipe. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** Steps ** A list of steps that are defined by the recipe. Type: Array of [RecipeStep](API_RecipeStep.md) objects Required: No ** Tags ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Recipe) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Recipe) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html). ## Contents **Note** In the following list, the required parameters are described first. ** Operation ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/RecipeAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/RecipeAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The name of the recipe. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** RecipeVersion ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/RecipeReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/RecipeReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The particular action to be performed in the recipe step. Type: [RecipeAction](API_RecipeAction.md) object Required: Yes ** 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. 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/RecipeStep) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/RecipeStep) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The HTTP status code for the error. Type: String Pattern: `^[1-5][0-9][0-9]$` Required: No ** ErrorMessage ** The text of the error message. Type: String Required: No ** RecipeVersion ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/RecipeVersionErrorDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/RecipeVersionErrorDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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.aws.amazon.com/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 ** The name of the rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ** 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. Type: Array of [ColumnSelector](API_ColumnSelector.md) objects Array Members: Minimum number of 1 item. Required: No ** 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. Type: Boolean Required: No ** 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`".` 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Rule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Rule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The name of the ruleset. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** TargetArn ** 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 ** The ID of the AWS account that owns the ruleset. Type: String Length Constraints: Maximum length of 255. Required: No ** CreateDate ** The date and time that the ruleset was created. Type: Timestamp Required: No ** CreatedBy ** The Amazon Resource Name (ARN) of the user who created the ruleset. Type: String Required: No ** Description ** The description of the ruleset. Type: String Length Constraints: Maximum length of 1024. Required: No ** LastModifiedBy ** The Amazon Resource Name (ARN) of the user who last modified the ruleset. Type: String Required: No ** LastModifiedDate ** The modification date and time of the ruleset. Type: Timestamp Required: No ** ResourceArn ** The Amazon Resource Name (ARN) for the ruleset. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** RuleCount ** The number of rules that are defined in the ruleset. Type: Integer Valid Range: Minimum value of 0. Required: No ** Tags ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/RulesetItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/RulesetItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The Amazon S3 bucket name. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: Yes ** BucketOwner ** The AWS account ID of the bucket owner. Type: String Length Constraints: Fixed length of 12. Pattern: `^[0-9]{12}$` Required: No ** Key ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/S3Location) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/S3Location) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/S3TableOutputOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/S3TableOutputOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The way in which DataBrew obtains rows from a dataset. Type: String Valid Values: `FIRST_N | LAST_N | RANDOM` Required: Yes ** Size ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Sample) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Sample) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The name of the schedule. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** AccountId ** The ID of the AWS account that owns the schedule. Type: String Length Constraints: Maximum length of 255. Required: No ** CreateDate ** The date and time that the schedule was created. Type: Timestamp Required: No ** CreatedBy ** The Amazon Resource Name (ARN) of the user who created the schedule. Type: String Required: No ** CronExpression ** The dates and times when the job is to run. For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the * AWS Glue DataBrew Developer Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No ** JobNames ** 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 ** The Amazon Resource Name (ARN) of the user who last modified the schedule. Type: String Required: No ** LastModifiedDate ** The date and time when the schedule was last modified. Type: Timestamp Required: No ** ResourceArn ** The Amazon Resource Name (ARN) of the schedule. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** Tags ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Schedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Schedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StatisticOverride) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StatisticOverride) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StatisticsConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StatisticsConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** The value of a threshold. Type: Double Valid Range: Minimum value of 0. Required: Yes ** Type ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/Threshold) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/Threshold) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ValidationConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ValidationConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/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 ** 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 ** Controls if analytics computation is enabled or disabled. Enabled by default. Type: String Valid Values: `ENABLE | DISABLE` Required: No ** ColumnRange ** 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 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 ** The number of rows to include in the view frame, beginning with the `StartRowIndex` value. Type: Integer Required: No ** StartRowIndex ** 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 AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ViewFrame) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ViewFrame) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ViewFrame) # Common Error Types This section lists common error types that this AWS service may return. Not all services return all error types listed here. For errors specific to an API action for this service, see the topic for that API action. **AccessDeniedException** You don't have permission to perform this action. Verify that your IAM policy includes the required permissions. HTTP Status Code: 403 **ExpiredTokenException** The security token included in the request has expired. Request a new security token and try again. HTTP Status Code: 403 **IncompleteSignature** The request signature doesn't conform to AWS standards. Verify that you're using valid AWS credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to date. HTTP Status Code: 403 **InternalFailure** The request can't be processed right now because of an internal server issue. Try again later. If the problem persists, contact AWS Support. HTTP Status Code: 500 **MalformedHttpRequestException** The request body can't be processed. This typically happens when the request body can't be decompressed using the specified content encoding algorithm. Verify that the content encoding header matches the compression format used. HTTP Status Code: 400 **NotAuthorized** You don't have permissions to perform this action. Verify that your IAM policy includes the required permissions. HTTP Status Code: 401 **OptInRequired** Your AWS account needs a subscription for this service. Verify that you've enabled the service in your account. HTTP Status Code: 403 **RequestAbortedException** The request was aborted before a response could be returned. This typically happens when the client closes the connection. HTTP Status Code: 400 **RequestEntityTooLargeException** The request entity is too large. Reduce the size of the request body and try again. HTTP Status Code: 413 **RequestTimeoutException** The request timed out. The server didn't receive the complete request within the expected time frame. Try again. HTTP Status Code: 408 **ServiceUnavailable** The service is temporarily unavailable. Try again later. HTTP Status Code: 503 **ThrottlingException** Your request rate is too high. The AWS SDKs automatically retry requests that receive this exception. Reduce the frequency of requests. HTTP Status Code: 400 **UnknownOperationException** The action or operation isn't recognized. Verify that the action name is spelled correctly and that it's supported by the API version you're using. HTTP Status Code: 404 **UnrecognizedClientException** The X.509 certificate or AWS access key ID you provided doesn't exist in our records. Verify that you're using valid credentials and that they haven't expired. HTTP Status Code: 403 **ValidationError** The input doesn't meet the required format or constraints. Check that all required parameters are included and that values are valid. HTTP Status Code: 400 # Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see [Signing AWS API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) in the *IAM User Guide*. **X-Amz-Algorithm** The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: `AWS4-HMAC-SHA256` Required: Conditional **X-Amz-Credential** The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4\$1request"). The value is expressed in the following format: *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request. For more information, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional **X-Amz-Date** The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: `20120325T120000Z`. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see [Elements of an AWS API request signature](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) in the *IAM User Guide*. Type: string Required: Conditional **X-Amz-Security-Token** The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional **X-Amz-Signature** Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional **X-Amz-SignedHeaders** Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional