# Actions
<a name="API_Operations"></a>

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
<a name="API_BatchDeleteRecipeVersion"></a>

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
<a name="API_BatchDeleteRecipeVersion_RequestSyntax"></a>

```
POST /recipes/name/batchDeleteRecipeVersion HTTP/1.1
Content-type: application/json

{
   "RecipeVersions": [ "string" ]
}
```

## URI Request Parameters
<a name="API_BatchDeleteRecipeVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_BatchDeleteRecipeVersion_RequestSyntax) **   <a name="databrew-BatchDeleteRecipeVersion-request-uri-Name"></a>
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
<a name="API_BatchDeleteRecipeVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [RecipeVersions](#API_BatchDeleteRecipeVersion_RequestSyntax) **   <a name="databrew-BatchDeleteRecipeVersion-request-RecipeVersions"></a>
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
<a name="API_BatchDeleteRecipeVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "RecipeVersion": "string"
      }
   ],
   "Name": "string"
}
```

## Response Elements
<a name="API_BatchDeleteRecipeVersion_ResponseElements"></a>

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) **   <a name="databrew-BatchDeleteRecipeVersion-response-Name"></a>
The name of the recipe that was modified.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Errors](#API_BatchDeleteRecipeVersion_ResponseSyntax) **   <a name="databrew-BatchDeleteRecipeVersion-response-Errors"></a>
Errors, if any, that occurred while attempting to delete the recipe versions.  
Type: Array of [RecipeVersionErrorDetail](API_RecipeVersionErrorDetail.md) objects

## Errors
<a name="API_BatchDeleteRecipeVersion_Errors"></a>

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
<a name="API_BatchDeleteRecipeVersion_SeeAlso"></a>

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
<a name="API_CreateDataset"></a>

Creates a new DataBrew dataset.

## Request Syntax
<a name="API_CreateDataset_RequestSyntax"></a>

```
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
<a name="API_CreateDataset_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDataset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Input](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-Input"></a>
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) **   <a name="databrew-CreateDataset-request-Name"></a>
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) **   <a name="databrew-CreateDataset-request-Format"></a>
The file format of a dataset that is created from an Amazon S3 file or folder.  
Type: String  
Valid Values: `CSV | JSON | PARQUET | EXCEL | ORC`   
Required: No

 ** [FormatOptions](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-FormatOptions"></a>
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 name="databrew-CreateDataset-request-PathOptions"></a>
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.  
Type: [PathOptions](API_PathOptions.md) object  
Required: No

 ** [Tags](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-Tags"></a>
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
<a name="API_CreateDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateDataset_ResponseElements"></a>

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) **   <a name="databrew-CreateDataset-response-Name"></a>
The name of the dataset that you created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_CreateDataset_Errors"></a>

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
<a name="API_CreateDataset_SeeAlso"></a>

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
<a name="API_CreateProfileJob"></a>

Creates a new job to analyze a dataset and create its data profile.

## Request Syntax
<a name="API_CreateProfileJob_RequestSyntax"></a>

```
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
<a name="API_CreateProfileJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateProfileJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DatasetName](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-DatasetName"></a>
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) **   <a name="databrew-CreateProfileJob-request-Name"></a>
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) **   <a name="databrew-CreateProfileJob-request-OutputLocation"></a>
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.  
Type: [S3Location](API_S3Location.md) object  
Required: Yes

 ** [RoleArn](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-RoleArn"></a>
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) **   <a name="databrew-CreateProfileJob-request-Configuration"></a>
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) **   <a name="databrew-CreateProfileJob-request-EncryptionKeyArn"></a>
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) **   <a name="databrew-CreateProfileJob-request-EncryptionMode"></a>
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) **   <a name="databrew-CreateProfileJob-request-JobSample"></a>
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) **   <a name="databrew-CreateProfileJob-request-LogSubscription"></a>
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) **   <a name="databrew-CreateProfileJob-request-MaxCapacity"></a>
The maximum number of nodes that DataBrew can use when the job processes data.  
Type: Integer  
Required: No

 ** [MaxRetries](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-MaxRetries"></a>
The maximum number of times to retry the job after a job run fails.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [Tags](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-Tags"></a>
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) **   <a name="databrew-CreateProfileJob-request-Timeout"></a>
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

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

## Response Syntax
<a name="API_CreateProfileJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateProfileJob_ResponseElements"></a>

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) **   <a name="databrew-CreateProfileJob-response-Name"></a>
The name of the job that was created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.

## Errors
<a name="API_CreateProfileJob_Errors"></a>

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
<a name="API_CreateProfileJob_SeeAlso"></a>

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
<a name="API_CreateProject"></a>

Creates a new DataBrew project.

## Request Syntax
<a name="API_CreateProject_RequestSyntax"></a>

```
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
<a name="API_CreateProject_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DatasetName](#API_CreateProject_RequestSyntax) **   <a name="databrew-CreateProject-request-DatasetName"></a>
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 name="databrew-CreateProject-request-Name"></a>
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) **   <a name="databrew-CreateProject-request-RecipeName"></a>
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) **   <a name="databrew-CreateProject-request-RoleArn"></a>
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) **   <a name="databrew-CreateProject-request-Sample"></a>
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) **   <a name="databrew-CreateProject-request-Tags"></a>
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
<a name="API_CreateProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateProject_ResponseElements"></a>

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) **   <a name="databrew-CreateProject-response-Name"></a>
The name of the project that you created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_CreateProject_Errors"></a>

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
<a name="API_CreateProject_SeeAlso"></a>

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
<a name="API_CreateRecipe"></a>

Creates a new DataBrew recipe.

## Request Syntax
<a name="API_CreateRecipe_RequestSyntax"></a>

```
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
<a name="API_CreateRecipe_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateRecipe_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_CreateRecipe_RequestSyntax) **   <a name="databrew-CreateRecipe-request-Name"></a>
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) **   <a name="databrew-CreateRecipe-request-Steps"></a>
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 name="databrew-CreateRecipe-request-Description"></a>
A description for the recipe.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [Tags](#API_CreateRecipe_RequestSyntax) **   <a name="databrew-CreateRecipe-request-Tags"></a>
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
<a name="API_CreateRecipe_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateRecipe_ResponseElements"></a>

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) **   <a name="databrew-CreateRecipe-response-Name"></a>
The name of the recipe that you created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_CreateRecipe_Errors"></a>

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
<a name="API_CreateRecipe_SeeAlso"></a>

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
<a name="API_CreateRecipeJob"></a>

Creates a new job to transform input data, using steps defined in an existing AWS Glue DataBrew recipe

## Request Syntax
<a name="API_CreateRecipeJob_RequestSyntax"></a>

```
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
<a name="API_CreateRecipeJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateRecipeJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-Name"></a>
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) **   <a name="databrew-CreateRecipeJob-request-RoleArn"></a>
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) **   <a name="databrew-CreateRecipeJob-request-DatabaseOutputs"></a>
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) **   <a name="databrew-CreateRecipeJob-request-DataCatalogOutputs"></a>
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) **   <a name="databrew-CreateRecipeJob-request-DatasetName"></a>
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) **   <a name="databrew-CreateRecipeJob-request-EncryptionKeyArn"></a>
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) **   <a name="databrew-CreateRecipeJob-request-EncryptionMode"></a>
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) **   <a name="databrew-CreateRecipeJob-request-LogSubscription"></a>
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) **   <a name="databrew-CreateRecipeJob-request-MaxCapacity"></a>
The maximum number of nodes that DataBrew can consume when the job processes data.  
Type: Integer  
Required: No

 ** [MaxRetries](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-MaxRetries"></a>
The maximum number of times to retry the job after a job run fails.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [Outputs](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-Outputs"></a>
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) **   <a name="databrew-CreateRecipeJob-request-ProjectName"></a>
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) **   <a name="databrew-CreateRecipeJob-request-RecipeReference"></a>
Represents the name and version of a DataBrew recipe.  
Type: [RecipeReference](API_RecipeReference.md) object  
Required: No

 ** [Tags](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-Tags"></a>
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) **   <a name="databrew-CreateRecipeJob-request-Timeout"></a>
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## Response Syntax
<a name="API_CreateRecipeJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateRecipeJob_ResponseElements"></a>

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) **   <a name="databrew-CreateRecipeJob-response-Name"></a>
The name of the job that you created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.

## Errors
<a name="API_CreateRecipeJob_Errors"></a>

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
<a name="API_CreateRecipeJob_SeeAlso"></a>

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
<a name="API_CreateRuleset"></a>

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

## Request Syntax
<a name="API_CreateRuleset_RequestSyntax"></a>

```
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
<a name="API_CreateRuleset_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateRuleset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-Name"></a>
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 name="databrew-CreateRuleset-request-Rules"></a>
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) **   <a name="databrew-CreateRuleset-request-TargetArn"></a>
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

 ** [Description](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-Description"></a>
The description of the ruleset.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [Tags](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-Tags"></a>
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
<a name="API_CreateRuleset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateRuleset_ResponseElements"></a>

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) **   <a name="databrew-CreateRuleset-response-Name"></a>
The unique name of the created ruleset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_CreateRuleset_Errors"></a>

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
<a name="API_CreateRuleset_SeeAlso"></a>

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
<a name="API_CreateSchedule"></a>

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
<a name="API_CreateSchedule_RequestSyntax"></a>

```
POST /schedules HTTP/1.1
Content-type: application/json

{
   "CronExpression": "string",
   "JobNames": [ "string" ],
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateSchedule_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateSchedule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CronExpression](#API_CreateSchedule_RequestSyntax) **   <a name="databrew-CreateSchedule-request-CronExpression"></a>
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 name="databrew-CreateSchedule-request-Name"></a>
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) **   <a name="databrew-CreateSchedule-request-JobNames"></a>
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) **   <a name="databrew-CreateSchedule-request-Tags"></a>
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
<a name="API_CreateSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateSchedule_ResponseElements"></a>

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) **   <a name="databrew-CreateSchedule-response-Name"></a>
The name of the schedule that was created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_CreateSchedule_Errors"></a>

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
<a name="API_CreateSchedule_SeeAlso"></a>

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
<a name="API_DeleteDataset"></a>

Deletes a dataset from DataBrew.

## Request Syntax
<a name="API_DeleteDataset_RequestSyntax"></a>

```
DELETE /datasets/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteDataset_RequestSyntax) **   <a name="databrew-DeleteDataset-request-uri-Name"></a>
The name of the dataset to be deleted.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DeleteDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_DeleteDataset_ResponseElements"></a>

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) **   <a name="databrew-DeleteDataset-response-Name"></a>
The name of the dataset that you deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_DeleteDataset_Errors"></a>

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
<a name="API_DeleteDataset_SeeAlso"></a>

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
<a name="API_DeleteJob"></a>

Deletes the specified DataBrew job.

## Request Syntax
<a name="API_DeleteJob_RequestSyntax"></a>

```
DELETE /jobs/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteJob_RequestSyntax) **   <a name="databrew-DeleteJob-request-uri-Name"></a>
The name of the job to be deleted.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

## Request Body
<a name="API_DeleteJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_DeleteJob_ResponseElements"></a>

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) **   <a name="databrew-DeleteJob-response-Name"></a>
The name of the job that you deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.

## Errors
<a name="API_DeleteJob_Errors"></a>

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
<a name="API_DeleteJob_SeeAlso"></a>

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
<a name="API_DeleteProject"></a>

Deletes an existing DataBrew project.

## Request Syntax
<a name="API_DeleteProject_RequestSyntax"></a>

```
DELETE /projects/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteProject_RequestSyntax) **   <a name="databrew-DeleteProject-request-uri-Name"></a>
The name of the project to be deleted.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DeleteProject_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_DeleteProject_ResponseElements"></a>

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) **   <a name="databrew-DeleteProject-response-Name"></a>
The name of the project that you deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_DeleteProject_Errors"></a>

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
<a name="API_DeleteProject_SeeAlso"></a>

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
<a name="API_DeleteRecipeVersion"></a>

Deletes a single version of a DataBrew recipe.

## Request Syntax
<a name="API_DeleteRecipeVersion_RequestSyntax"></a>

```
DELETE /recipes/name/recipeVersion/recipeVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRecipeVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteRecipeVersion_RequestSyntax) **   <a name="databrew-DeleteRecipeVersion-request-uri-Name"></a>
The name of the recipe.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [recipeVersion](#API_DeleteRecipeVersion_RequestSyntax) **   <a name="databrew-DeleteRecipeVersion-request-uri-RecipeVersion"></a>
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
<a name="API_DeleteRecipeVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRecipeVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string",
   "RecipeVersion": "string"
}
```

## Response Elements
<a name="API_DeleteRecipeVersion_ResponseElements"></a>

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) **   <a name="databrew-DeleteRecipeVersion-response-Name"></a>
The name of the recipe that was deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [RecipeVersion](#API_DeleteRecipeVersion_ResponseSyntax) **   <a name="databrew-DeleteRecipeVersion-response-RecipeVersion"></a>
The version of the recipe that was deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.

## Errors
<a name="API_DeleteRecipeVersion_Errors"></a>

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
<a name="API_DeleteRecipeVersion_SeeAlso"></a>

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
<a name="API_DeleteRuleset"></a>

Deletes a ruleset.

## Request Syntax
<a name="API_DeleteRuleset_RequestSyntax"></a>

```
DELETE /rulesets/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRuleset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteRuleset_RequestSyntax) **   <a name="databrew-DeleteRuleset-request-uri-Name"></a>
The name of the ruleset to be deleted.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DeleteRuleset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRuleset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_DeleteRuleset_ResponseElements"></a>

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) **   <a name="databrew-DeleteRuleset-response-Name"></a>
The name of the deleted ruleset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_DeleteRuleset_Errors"></a>

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
<a name="API_DeleteRuleset_SeeAlso"></a>

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
<a name="API_DeleteSchedule"></a>

Deletes the specified DataBrew schedule.

## Request Syntax
<a name="API_DeleteSchedule_RequestSyntax"></a>

```
DELETE /schedules/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteSchedule_RequestSyntax) **   <a name="databrew-DeleteSchedule-request-uri-Name"></a>
The name of the schedule to be deleted.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DeleteSchedule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_DeleteSchedule_ResponseElements"></a>

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) **   <a name="databrew-DeleteSchedule-response-Name"></a>
The name of the schedule that was deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_DeleteSchedule_Errors"></a>

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
<a name="API_DeleteSchedule_SeeAlso"></a>

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
<a name="API_DescribeDataset"></a>

Returns the definition of a specific DataBrew dataset.

## Request Syntax
<a name="API_DescribeDataset_RequestSyntax"></a>

```
GET /datasets/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeDataset_RequestSyntax) **   <a name="databrew-DescribeDataset-request-uri-Name"></a>
The name of the dataset to be described.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DescribeDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDataset_ResponseSyntax"></a>

```
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
<a name="API_DescribeDataset_ResponseElements"></a>

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) **   <a name="databrew-DescribeDataset-response-Input"></a>
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) **   <a name="databrew-DescribeDataset-response-Name"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [CreateDate](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-CreateDate"></a>
The date and time that the dataset was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-CreatedBy"></a>
The identifier (user name) of the user who created the dataset.  
Type: String

 ** [Format](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Format"></a>
The file format of a dataset that is created from an Amazon S3 file or folder.  
Type: String  
Valid Values: `CSV | JSON | PARQUET | EXCEL | ORC` 

 ** [FormatOptions](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-FormatOptions"></a>
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) **   <a name="databrew-DescribeDataset-response-LastModifiedBy"></a>
The identifier (user name) of the user who last modified the dataset.  
Type: String

 ** [LastModifiedDate](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-LastModifiedDate"></a>
The date and time that the dataset was last modified.  
Type: Timestamp

 ** [PathOptions](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-PathOptions"></a>
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) **   <a name="databrew-DescribeDataset-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the dataset.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [Source](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Source"></a>
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) **   <a name="databrew-DescribeDataset-response-Tags"></a>
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
<a name="API_DescribeDataset_Errors"></a>

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
<a name="API_DescribeDataset_SeeAlso"></a>

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
<a name="API_DescribeJob"></a>

Returns the definition of a specific DataBrew job.

## Request Syntax
<a name="API_DescribeJob_RequestSyntax"></a>

```
GET /jobs/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeJob_RequestSyntax) **   <a name="databrew-DescribeJob-request-uri-Name"></a>
The name of the job to be described.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

## Request Body
<a name="API_DescribeJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeJob_ResponseSyntax"></a>

```
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
<a name="API_DescribeJob_ResponseElements"></a>

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) **   <a name="databrew-DescribeJob-response-Name"></a>
The name of the job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.

 ** [CreateDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreateDate"></a>
The date and time that the job was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreatedBy"></a>
The identifier (user name) of the user associated with the creation of the job.  
Type: String

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

 ** [DataCatalogOutputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DataCatalogOutputs"></a>
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) **   <a name="databrew-DescribeJob-response-DatasetName"></a>
The dataset that the job acts upon.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [EncryptionKeyArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-EncryptionKeyArn"></a>
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) **   <a name="databrew-DescribeJob-response-EncryptionMode"></a>
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) **   <a name="databrew-DescribeJob-response-JobSample"></a>
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) **   <a name="databrew-DescribeJob-response-LastModifiedBy"></a>
The identifier (user name) of the user who last modified the job.  
Type: String

 ** [LastModifiedDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LastModifiedDate"></a>
The date and time that the job was last modified.  
Type: Timestamp

 ** [LogSubscription](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LogSubscription"></a>
Indicates whether Amazon CloudWatch logging is enabled for this job.  
Type: String  
Valid Values: `ENABLE | DISABLE` 

 ** [MaxCapacity](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxCapacity"></a>
The maximum number of compute nodes that DataBrew can consume when the job processes data.  
Type: Integer

 ** [MaxRetries](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxRetries"></a>
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) **   <a name="databrew-DescribeJob-response-Outputs"></a>
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) **   <a name="databrew-DescribeJob-response-ProfileConfiguration"></a>
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) **   <a name="databrew-DescribeJob-response-ProjectName"></a>
The DataBrew project associated with this job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [RecipeReference](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RecipeReference"></a>
Represents the name and version of a DataBrew recipe.  
Type: [RecipeReference](API_RecipeReference.md) object

 ** [ResourceArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [RoleArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RoleArn"></a>
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) **   <a name="databrew-DescribeJob-response-Tags"></a>
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) **   <a name="databrew-DescribeJob-response-Timeout"></a>
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT`.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [Type](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Type"></a>
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) **   <a name="databrew-DescribeJob-response-ValidationConfigurations"></a>
List of validation configurations that are applied to the profile job.  
Type: Array of [ValidationConfiguration](API_ValidationConfiguration.md) objects  
Array Members: Minimum number of 1 item.

## Errors
<a name="API_DescribeJob_Errors"></a>

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
<a name="API_DescribeJob_SeeAlso"></a>

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
<a name="API_DescribeJobRun"></a>

Represents one run of a DataBrew job.

## Request Syntax
<a name="API_DescribeJobRun_RequestSyntax"></a>

```
GET /jobs/name/jobRun/runId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeJobRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeJobRun_RequestSyntax) **   <a name="databrew-DescribeJobRun-request-uri-Name"></a>
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) **   <a name="databrew-DescribeJobRun-request-uri-RunId"></a>
The unique identifier of the job run.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DescribeJobRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeJobRun_ResponseSyntax"></a>

```
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
<a name="API_DescribeJobRun_ResponseElements"></a>

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) **   <a name="databrew-DescribeJobRun-response-JobName"></a>
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) **   <a name="databrew-DescribeJobRun-response-Attempt"></a>
The number of times that DataBrew has attempted to run the job.  
Type: Integer

 ** [CompletedOn](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-CompletedOn"></a>
The date and time when the job completed processing.  
Type: Timestamp

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

 ** [DataCatalogOutputs](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-DataCatalogOutputs"></a>
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) **   <a name="databrew-DescribeJobRun-response-DatasetName"></a>
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 name="databrew-DescribeJobRun-response-ErrorMessage"></a>
A message indicating an error (if any) that was encountered when the job ran.  
Type: String

 ** [ExecutionTime](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-ExecutionTime"></a>
The amount of time, in seconds, during which the job run consumed resources.  
Type: Integer

 ** [JobSample](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-JobSample"></a>
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) **   <a name="databrew-DescribeJobRun-response-LogGroupName"></a>
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.

 ** [LogSubscription](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-LogSubscription"></a>
The current status of Amazon CloudWatch logging for the job run.  
Type: String  
Valid Values: `ENABLE | DISABLE` 

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

 ** [ProfileConfiguration](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-ProfileConfiguration"></a>
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) **   <a name="databrew-DescribeJobRun-response-RecipeReference"></a>
Represents the name and version of a DataBrew recipe.  
Type: [RecipeReference](API_RecipeReference.md) object

 ** [RunId](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-RunId"></a>
The unique identifier of the job run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [StartedBy](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-StartedBy"></a>
The Amazon Resource Name (ARN) of the user who started the job run.  
Type: String

 ** [StartedOn](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-StartedOn"></a>
The date and time when the job run began.  
Type: Timestamp

 ** [State](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-State"></a>
The current state of the job run entity itself.  
Type: String  
Valid Values: `STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT` 

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

## Errors
<a name="API_DescribeJobRun_Errors"></a>

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
<a name="API_DescribeJobRun_SeeAlso"></a>

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
<a name="API_DescribeProject"></a>

Returns the definition of a specific DataBrew project.

## Request Syntax
<a name="API_DescribeProject_RequestSyntax"></a>

```
GET /projects/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeProject_RequestSyntax) **   <a name="databrew-DescribeProject-request-uri-Name"></a>
The name of the project to be described.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DescribeProject_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeProject_ResponseSyntax"></a>

```
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
<a name="API_DescribeProject_ResponseElements"></a>

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) **   <a name="databrew-DescribeProject-response-Name"></a>
The name of the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [CreateDate](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-CreateDate"></a>
The date and time that the project was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-CreatedBy"></a>
The identifier (user name) of the user who created the project.  
Type: String

 ** [DatasetName](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-DatasetName"></a>
The dataset associated with the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [LastModifiedBy](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-LastModifiedBy"></a>
The identifier (user name) of the user who last modified the project.  
Type: String

 ** [LastModifiedDate](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-LastModifiedDate"></a>
The date and time that the project was last modified.  
Type: Timestamp

 ** [OpenDate](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-OpenDate"></a>
The date and time when the project was opened.   
Type: Timestamp

 ** [OpenedBy](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-OpenedBy"></a>
The identifier (user name) of the user that opened the project for use.   
Type: String

 ** [RecipeName](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-RecipeName"></a>
The recipe associated with this job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [ResourceArn](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the project.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [RoleArn](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-RoleArn"></a>
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) **   <a name="databrew-DescribeProject-response-Sample"></a>
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) **   <a name="databrew-DescribeProject-response-SessionStatus"></a>
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) **   <a name="databrew-DescribeProject-response-Tags"></a>
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
<a name="API_DescribeProject_Errors"></a>

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
<a name="API_DescribeProject_SeeAlso"></a>

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
<a name="API_DescribeRecipe"></a>

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

## Request Syntax
<a name="API_DescribeRecipe_RequestSyntax"></a>

```
GET /recipes/name?recipeVersion=RecipeVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeRecipe_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeRecipe_RequestSyntax) **   <a name="databrew-DescribeRecipe-request-uri-Name"></a>
The name of the recipe to be described.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [RecipeVersion](#API_DescribeRecipe_RequestSyntax) **   <a name="databrew-DescribeRecipe-request-uri-RecipeVersion"></a>
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
<a name="API_DescribeRecipe_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeRecipe_ResponseSyntax"></a>

```
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
<a name="API_DescribeRecipe_ResponseElements"></a>

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) **   <a name="databrew-DescribeRecipe-response-Name"></a>
The name of the recipe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [CreateDate](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-CreateDate"></a>
The date and time that the recipe was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-CreatedBy"></a>
The identifier (user name) of the user who created the recipe.  
Type: String

 ** [Description](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-Description"></a>
The description of the recipe.  
Type: String  
Length Constraints: Maximum length of 1024.

 ** [LastModifiedBy](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-LastModifiedBy"></a>
The identifier (user name) of the user who last modified the recipe.  
Type: String

 ** [LastModifiedDate](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-LastModifiedDate"></a>
The date and time that the recipe was last modified.  
Type: Timestamp

 ** [ProjectName](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-ProjectName"></a>
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) **   <a name="databrew-DescribeRecipe-response-PublishedBy"></a>
The identifier (user name) of the user who last published the recipe.  
Type: String

 ** [PublishedDate](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-PublishedDate"></a>
The date and time when the recipe was last published.  
Type: Timestamp

 ** [RecipeVersion](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-RecipeVersion"></a>
The recipe version identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.

 ** [ResourceArn](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-ResourceArn"></a>
The ARN of the recipe.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [Steps](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-Steps"></a>
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) **   <a name="databrew-DescribeRecipe-response-Tags"></a>
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
<a name="API_DescribeRecipe_Errors"></a>

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
<a name="API_DescribeRecipe_SeeAlso"></a>

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
<a name="API_DescribeRuleset"></a>

Retrieves detailed information about the ruleset.

## Request Syntax
<a name="API_DescribeRuleset_RequestSyntax"></a>

```
GET /rulesets/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeRuleset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeRuleset_RequestSyntax) **   <a name="databrew-DescribeRuleset-request-uri-Name"></a>
The name of the ruleset to be described.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DescribeRuleset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeRuleset_ResponseSyntax"></a>

```
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
<a name="API_DescribeRuleset_ResponseElements"></a>

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) **   <a name="databrew-DescribeRuleset-response-Name"></a>
The name of the ruleset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [CreateDate](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-CreateDate"></a>
The date and time that the ruleset was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-CreatedBy"></a>
The Amazon Resource Name (ARN) of the user who created the ruleset.  
Type: String

 ** [Description](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-Description"></a>
The description of the ruleset.  
Type: String  
Length Constraints: Maximum length of 1024.

 ** [LastModifiedBy](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-LastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last modified the ruleset.  
Type: String

 ** [LastModifiedDate](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-LastModifiedDate"></a>
The modification date and time of the ruleset.  
Type: Timestamp

 ** [ResourceArn](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-ResourceArn"></a>
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 name="databrew-DescribeRuleset-response-Rules"></a>
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) **   <a name="databrew-DescribeRuleset-response-Tags"></a>
Metadata tags that have been applied to the ruleset.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.

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

## Errors
<a name="API_DescribeRuleset_Errors"></a>

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
<a name="API_DescribeRuleset_SeeAlso"></a>

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
<a name="API_DescribeSchedule"></a>

Returns the definition of a specific DataBrew schedule.

## Request Syntax
<a name="API_DescribeSchedule_RequestSyntax"></a>

```
GET /schedules/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeSchedule_RequestSyntax) **   <a name="databrew-DescribeSchedule-request-uri-Name"></a>
The name of the schedule to be described.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_DescribeSchedule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeSchedule_ResponseSyntax"></a>

```
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
<a name="API_DescribeSchedule_ResponseElements"></a>

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) **   <a name="databrew-DescribeSchedule-response-Name"></a>
The name of the schedule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [CreateDate](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-CreateDate"></a>
The date and time that the schedule was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-CreatedBy"></a>
The identifier (user name) of the user who created the schedule.   
Type: String

 ** [CronExpression](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-CronExpression"></a>
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) **   <a name="databrew-DescribeSchedule-response-JobNames"></a>
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) **   <a name="databrew-DescribeSchedule-response-LastModifiedBy"></a>
The identifier (user name) of the user who last modified the schedule.  
Type: String

 ** [LastModifiedDate](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-LastModifiedDate"></a>
The date and time that the schedule was last modified.  
Type: Timestamp

 ** [ResourceArn](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the schedule.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [Tags](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-Tags"></a>
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
<a name="API_DescribeSchedule_Errors"></a>

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
<a name="API_DescribeSchedule_SeeAlso"></a>

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
<a name="API_ListDatasets"></a>

Lists all of the DataBrew datasets.

## Request Syntax
<a name="API_ListDatasets_RequestSyntax"></a>

```
GET /datasets?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDatasets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListDatasets_RequestSyntax) **   <a name="databrew-ListDatasets-request-uri-MaxResults"></a>
The maximum number of results to return in this request.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListDatasets_RequestSyntax) **   <a name="databrew-ListDatasets-request-uri-NextToken"></a>
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
<a name="API_ListDatasets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDatasets_ResponseSyntax"></a>

```
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
<a name="API_ListDatasets_ResponseElements"></a>

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 name="databrew-ListDatasets-response-Datasets"></a>
A list of datasets that are defined.  
Type: Array of [Dataset](API_Dataset.md) objects

 ** [NextToken](#API_ListDatasets_ResponseSyntax) **   <a name="databrew-ListDatasets-response-NextToken"></a>
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
<a name="API_ListDatasets_Errors"></a>

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
<a name="API_ListDatasets_SeeAlso"></a>

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
<a name="API_ListJobRuns"></a>

Lists all of the previous runs of a particular DataBrew job.

## Request Syntax
<a name="API_ListJobRuns_RequestSyntax"></a>

```
GET /jobs/name/jobRuns?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListJobRuns_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListJobRuns_RequestSyntax) **   <a name="databrew-ListJobRuns-request-uri-MaxResults"></a>
The maximum number of results to return in this request.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [name](#API_ListJobRuns_RequestSyntax) **   <a name="databrew-ListJobRuns-request-uri-Name"></a>
The name of the job.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

 ** [NextToken](#API_ListJobRuns_RequestSyntax) **   <a name="databrew-ListJobRuns-request-uri-NextToken"></a>
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
<a name="API_ListJobRuns_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListJobRuns_ResponseSyntax"></a>

```
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
<a name="API_ListJobRuns_ResponseElements"></a>

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 name="databrew-ListJobRuns-response-JobRuns"></a>
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 name="databrew-ListJobRuns-response-NextToken"></a>
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
<a name="API_ListJobRuns_Errors"></a>

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
<a name="API_ListJobRuns_SeeAlso"></a>

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
<a name="API_ListJobs"></a>

Lists all of the DataBrew jobs that are defined.

## Request Syntax
<a name="API_ListJobs_RequestSyntax"></a>

```
GET /jobs?datasetName=DatasetName&maxResults=MaxResults&nextToken=NextToken&projectName=ProjectName HTTP/1.1
```

## URI Request Parameters
<a name="API_ListJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DatasetName](#API_ListJobs_RequestSyntax) **   <a name="databrew-ListJobs-request-uri-DatasetName"></a>
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) **   <a name="databrew-ListJobs-request-uri-MaxResults"></a>
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 name="databrew-ListJobs-request-uri-NextToken"></a>
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) **   <a name="databrew-ListJobs-request-uri-ProjectName"></a>
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
<a name="API_ListJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListJobs_ResponseSyntax"></a>

```
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
<a name="API_ListJobs_ResponseElements"></a>

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 name="databrew-ListJobs-response-Jobs"></a>
A list of jobs that are defined.  
Type: Array of [Job](API_Job.md) objects

 ** [NextToken](#API_ListJobs_ResponseSyntax) **   <a name="databrew-ListJobs-response-NextToken"></a>
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
<a name="API_ListJobs_Errors"></a>

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
<a name="API_ListJobs_SeeAlso"></a>

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
<a name="API_ListProjects"></a>

Lists all of the DataBrew projects that are defined.

## Request Syntax
<a name="API_ListProjects_RequestSyntax"></a>

```
GET /projects?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListProjects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListProjects_RequestSyntax) **   <a name="databrew-ListProjects-request-uri-MaxResults"></a>
The maximum number of results to return in this request.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListProjects_RequestSyntax) **   <a name="databrew-ListProjects-request-uri-NextToken"></a>
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
<a name="API_ListProjects_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProjects_ResponseSyntax"></a>

```
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
<a name="API_ListProjects_ResponseElements"></a>

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 name="databrew-ListProjects-response-Projects"></a>
A list of projects that are defined .  
Type: Array of [Project](API_Project.md) objects

 ** [NextToken](#API_ListProjects_ResponseSyntax) **   <a name="databrew-ListProjects-response-NextToken"></a>
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
<a name="API_ListProjects_Errors"></a>

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
<a name="API_ListProjects_SeeAlso"></a>

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
<a name="API_ListRecipes"></a>

Lists all of the DataBrew recipes that are defined.

## Request Syntax
<a name="API_ListRecipes_RequestSyntax"></a>

```
GET /recipes?maxResults=MaxResults&nextToken=NextToken&recipeVersion=RecipeVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRecipes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListRecipes_RequestSyntax) **   <a name="databrew-ListRecipes-request-uri-MaxResults"></a>
The maximum number of results to return in this request.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListRecipes_RequestSyntax) **   <a name="databrew-ListRecipes-request-uri-NextToken"></a>
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) **   <a name="databrew-ListRecipes-request-uri-RecipeVersion"></a>
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
<a name="API_ListRecipes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRecipes_ResponseSyntax"></a>

```
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
<a name="API_ListRecipes_ResponseElements"></a>

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 name="databrew-ListRecipes-response-Recipes"></a>
A list of recipes that are defined.  
Type: Array of [Recipe](API_Recipe.md) objects

 ** [NextToken](#API_ListRecipes_ResponseSyntax) **   <a name="databrew-ListRecipes-response-NextToken"></a>
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
<a name="API_ListRecipes_Errors"></a>

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
<a name="API_ListRecipes_SeeAlso"></a>

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
<a name="API_ListRecipeVersions"></a>

Lists the versions of a particular DataBrew recipe, except for `LATEST_WORKING`.

## Request Syntax
<a name="API_ListRecipeVersions_RequestSyntax"></a>

```
GET /recipeVersions?maxResults=MaxResults&name=Name&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRecipeVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListRecipeVersions_RequestSyntax) **   <a name="databrew-ListRecipeVersions-request-uri-MaxResults"></a>
The maximum number of results to return in this request.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [Name](#API_ListRecipeVersions_RequestSyntax) **   <a name="databrew-ListRecipeVersions-request-uri-Name"></a>
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) **   <a name="databrew-ListRecipeVersions-request-uri-NextToken"></a>
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
<a name="API_ListRecipeVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRecipeVersions_ResponseSyntax"></a>

```
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
<a name="API_ListRecipeVersions_ResponseElements"></a>

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 name="databrew-ListRecipeVersions-response-Recipes"></a>
A list of versions for the specified recipe.  
Type: Array of [Recipe](API_Recipe.md) objects

 ** [NextToken](#API_ListRecipeVersions_ResponseSyntax) **   <a name="databrew-ListRecipeVersions-response-NextToken"></a>
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
<a name="API_ListRecipeVersions_Errors"></a>

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
<a name="API_ListRecipeVersions_SeeAlso"></a>

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
<a name="API_ListRulesets"></a>

List all rulesets available in the current account or rulesets associated with a specific resource (dataset).

## Request Syntax
<a name="API_ListRulesets_RequestSyntax"></a>

```
GET /rulesets?maxResults=MaxResults&nextToken=NextToken&targetArn=TargetArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRulesets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListRulesets_RequestSyntax) **   <a name="databrew-ListRulesets-request-uri-MaxResults"></a>
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 name="databrew-ListRulesets-request-uri-NextToken"></a>
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) **   <a name="databrew-ListRulesets-request-uri-TargetArn"></a>
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
<a name="API_ListRulesets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRulesets_ResponseSyntax"></a>

```
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
<a name="API_ListRulesets_ResponseElements"></a>

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 name="databrew-ListRulesets-response-Rulesets"></a>
A list of RulesetItem. RulesetItem contains meta data of a ruleset.  
Type: Array of [RulesetItem](API_RulesetItem.md) objects

 ** [NextToken](#API_ListRulesets_ResponseSyntax) **   <a name="databrew-ListRulesets-response-NextToken"></a>
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
<a name="API_ListRulesets_Errors"></a>

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
<a name="API_ListRulesets_SeeAlso"></a>

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
<a name="API_ListSchedules"></a>

Lists the DataBrew schedules that are defined.

## Request Syntax
<a name="API_ListSchedules_RequestSyntax"></a>

```
GET /schedules?jobName=JobName&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSchedules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [JobName](#API_ListSchedules_RequestSyntax) **   <a name="databrew-ListSchedules-request-uri-JobName"></a>
The name of the job that these schedules apply to.  
Length Constraints: Minimum length of 1. Maximum length of 240.

 ** [MaxResults](#API_ListSchedules_RequestSyntax) **   <a name="databrew-ListSchedules-request-uri-MaxResults"></a>
The maximum number of results to return in this request.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListSchedules_RequestSyntax) **   <a name="databrew-ListSchedules-request-uri-NextToken"></a>
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
<a name="API_ListSchedules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSchedules_ResponseSyntax"></a>

```
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
<a name="API_ListSchedules_ResponseElements"></a>

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 name="databrew-ListSchedules-response-Schedules"></a>
A list of schedules that are defined.  
Type: Array of [Schedule](API_Schedule.md) objects

 ** [NextToken](#API_ListSchedules_ResponseSyntax) **   <a name="databrew-ListSchedules-response-NextToken"></a>
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
<a name="API_ListSchedules_Errors"></a>

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
<a name="API_ListSchedules_SeeAlso"></a>

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
<a name="API_ListTagsForResource"></a>

Lists all the tags for a DataBrew resource. 

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/ResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="databrew-ListTagsForResource-request-uri-ResourceArn"></a>
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
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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 name="databrew-ListTagsForResource-response-Tags"></a>
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
<a name="API_ListTagsForResource_Errors"></a>

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
<a name="API_ListTagsForResource_SeeAlso"></a>

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
<a name="API_PublishRecipe"></a>

Publishes a new version of a DataBrew recipe.

## Request Syntax
<a name="API_PublishRecipe_RequestSyntax"></a>

```
POST /recipes/name/publishRecipe HTTP/1.1
Content-type: application/json

{
   "Description": "string"
}
```

## URI Request Parameters
<a name="API_PublishRecipe_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_PublishRecipe_RequestSyntax) **   <a name="databrew-PublishRecipe-request-uri-Name"></a>
The name of the recipe to be published.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_PublishRecipe_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_PublishRecipe_RequestSyntax) **   <a name="databrew-PublishRecipe-request-Description"></a>
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
<a name="API_PublishRecipe_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_PublishRecipe_ResponseElements"></a>

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) **   <a name="databrew-PublishRecipe-response-Name"></a>
The name of the recipe that you published.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_PublishRecipe_Errors"></a>

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
<a name="API_PublishRecipe_SeeAlso"></a>

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
<a name="API_SendProjectSessionAction"></a>

Performs a recipe step within an interactive DataBrew session that's currently open.

## Request Syntax
<a name="API_SendProjectSessionAction_RequestSyntax"></a>

```
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
<a name="API_SendProjectSessionAction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-uri-Name"></a>
The name of the project to apply the action to.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_SendProjectSessionAction_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientSessionId](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-ClientSessionId"></a>
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) **   <a name="databrew-SendProjectSessionAction-request-Preview"></a>
If true, the result of the recipe step will be returned, but not applied.  
Type: Boolean  
Required: No

 ** [RecipeStep](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-RecipeStep"></a>
Represents a single step from a DataBrew recipe to be performed.  
Type: [RecipeStep](API_RecipeStep.md) object  
Required: No

 ** [StepIndex](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-StepIndex"></a>
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) **   <a name="databrew-SendProjectSessionAction-request-ViewFrame"></a>
Represents the data being transformed during an action.  
Type: [ViewFrame](API_ViewFrame.md) object  
Required: No

## Response Syntax
<a name="API_SendProjectSessionAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ActionId": number,
   "Name": "string",
   "Result": "string"
}
```

## Response Elements
<a name="API_SendProjectSessionAction_ResponseElements"></a>

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) **   <a name="databrew-SendProjectSessionAction-response-Name"></a>
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 name="databrew-SendProjectSessionAction-response-ActionId"></a>
A unique identifier for the action that was performed.  
Type: Integer

 ** [Result](#API_SendProjectSessionAction_ResponseSyntax) **   <a name="databrew-SendProjectSessionAction-response-Result"></a>
A message indicating the result of performing the action.  
Type: String

## Errors
<a name="API_SendProjectSessionAction_Errors"></a>

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
<a name="API_SendProjectSessionAction_SeeAlso"></a>

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
<a name="API_StartJobRun"></a>

Runs a DataBrew job.

## Request Syntax
<a name="API_StartJobRun_RequestSyntax"></a>

```
POST /jobs/name/startJobRun HTTP/1.1
```

## URI Request Parameters
<a name="API_StartJobRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_StartJobRun_RequestSyntax) **   <a name="databrew-StartJobRun-request-uri-Name"></a>
The name of the job to be run.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

## Request Body
<a name="API_StartJobRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StartJobRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RunId": "string"
}
```

## Response Elements
<a name="API_StartJobRun_ResponseElements"></a>

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 name="databrew-StartJobRun-response-RunId"></a>
A system-generated identifier for this particular job run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_StartJobRun_Errors"></a>

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
<a name="API_StartJobRun_SeeAlso"></a>

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
<a name="API_StartProjectSession"></a>

Creates an interactive session, enabling you to manipulate data in a DataBrew project.

## Request Syntax
<a name="API_StartProjectSession_RequestSyntax"></a>

```
PUT /projects/name/startProjectSession HTTP/1.1
Content-type: application/json

{
   "AssumeControl": boolean
}
```

## URI Request Parameters
<a name="API_StartProjectSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_StartProjectSession_RequestSyntax) **   <a name="databrew-StartProjectSession-request-uri-Name"></a>
The name of the project to act upon.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_StartProjectSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AssumeControl](#API_StartProjectSession_RequestSyntax) **   <a name="databrew-StartProjectSession-request-AssumeControl"></a>
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
<a name="API_StartProjectSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ClientSessionId": "string",
   "Name": "string"
}
```

## Response Elements
<a name="API_StartProjectSession_ResponseElements"></a>

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) **   <a name="databrew-StartProjectSession-response-Name"></a>
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 name="databrew-StartProjectSession-response-ClientSessionId"></a>
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
<a name="API_StartProjectSession_Errors"></a>

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
<a name="API_StartProjectSession_SeeAlso"></a>

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
<a name="API_StopJobRun"></a>

Stops a particular run of a job.

## Request Syntax
<a name="API_StopJobRun_RequestSyntax"></a>

```
POST /jobs/name/jobRun/runId/stopJobRun HTTP/1.1
```

## URI Request Parameters
<a name="API_StopJobRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_StopJobRun_RequestSyntax) **   <a name="databrew-StopJobRun-request-uri-Name"></a>
The name of the job to be stopped.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

 ** [runId](#API_StopJobRun_RequestSyntax) **   <a name="databrew-StopJobRun-request-uri-RunId"></a>
The ID of the job run to be stopped.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_StopJobRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StopJobRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RunId": "string"
}
```

## Response Elements
<a name="API_StopJobRun_ResponseElements"></a>

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) **   <a name="databrew-StopJobRun-response-RunId"></a>
The ID of the job run that you stopped.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_StopJobRun_Errors"></a>

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
<a name="API_StopJobRun_SeeAlso"></a>

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
<a name="API_TagResource"></a>

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="databrew-TagResource-request-uri-ResourceArn"></a>
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
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="databrew-TagResource-request-Tags"></a>
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
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

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
<a name="API_TagResource_SeeAlso"></a>

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
<a name="API_UntagResource"></a>

Removes metadata tags from a DataBrew resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="databrew-UntagResource-request-uri-ResourceArn"></a>
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) **   <a name="databrew-UntagResource-request-uri-TagKeys"></a>
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
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

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
<a name="API_UntagResource_SeeAlso"></a>

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
<a name="API_UpdateDataset"></a>

Modifies the definition of an existing DataBrew dataset.

## Request Syntax
<a name="API_UpdateDataset_RequestSyntax"></a>

```
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
<a name="API_UpdateDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-uri-Name"></a>
The name of the dataset to be updated.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_UpdateDataset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Input](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-Input"></a>
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) **   <a name="databrew-UpdateDataset-request-Format"></a>
The file format of a dataset that is created from an Amazon S3 file or folder.  
Type: String  
Valid Values: `CSV | JSON | PARQUET | EXCEL | ORC`   
Required: No

 ** [FormatOptions](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-FormatOptions"></a>
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 name="databrew-UpdateDataset-request-PathOptions"></a>
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.  
Type: [PathOptions](API_PathOptions.md) object  
Required: No

## Response Syntax
<a name="API_UpdateDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateDataset_ResponseElements"></a>

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) **   <a name="databrew-UpdateDataset-response-Name"></a>
The name of the dataset that you updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_UpdateDataset_Errors"></a>

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
<a name="API_UpdateDataset_SeeAlso"></a>

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
<a name="API_UpdateProfileJob"></a>

Modifies the definition of an existing profile job.

## Request Syntax
<a name="API_UpdateProfileJob_RequestSyntax"></a>

```
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
<a name="API_UpdateProfileJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-uri-Name"></a>
The name of the job to be updated.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

## Request Body
<a name="API_UpdateProfileJob_RequestBody"></a>

The request accepts the following data in JSON format.

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

 ** [RoleArn](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-RoleArn"></a>
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) **   <a name="databrew-UpdateProfileJob-request-Configuration"></a>
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) **   <a name="databrew-UpdateProfileJob-request-EncryptionKeyArn"></a>
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) **   <a name="databrew-UpdateProfileJob-request-EncryptionMode"></a>
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) **   <a name="databrew-UpdateProfileJob-request-JobSample"></a>
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) **   <a name="databrew-UpdateProfileJob-request-LogSubscription"></a>
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) **   <a name="databrew-UpdateProfileJob-request-MaxCapacity"></a>
The maximum number of compute nodes that DataBrew can use when the job processes data.  
Type: Integer  
Required: No

 ** [MaxRetries](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-MaxRetries"></a>
The maximum number of times to retry the job after a job run fails.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

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

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

## Response Syntax
<a name="API_UpdateProfileJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateProfileJob_ResponseElements"></a>

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) **   <a name="databrew-UpdateProfileJob-response-Name"></a>
The name of the job that was updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.

## Errors
<a name="API_UpdateProfileJob_Errors"></a>

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
<a name="API_UpdateProfileJob_SeeAlso"></a>

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
<a name="API_UpdateProject"></a>

Modifies the definition of an existing DataBrew project.

## Request Syntax
<a name="API_UpdateProject_RequestSyntax"></a>

```
PUT /projects/name HTTP/1.1
Content-type: application/json

{
   "RoleArn": "string",
   "Sample": { 
      "Size": number,
      "Type": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateProject_RequestSyntax) **   <a name="databrew-UpdateProject-request-uri-Name"></a>
The name of the project to be updated.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_UpdateProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [RoleArn](#API_UpdateProject_RequestSyntax) **   <a name="databrew-UpdateProject-request-RoleArn"></a>
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) **   <a name="databrew-UpdateProject-request-Sample"></a>
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
<a name="API_UpdateProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedDate": number,
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateProject_ResponseElements"></a>

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) **   <a name="databrew-UpdateProject-response-Name"></a>
The name of the project that you updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [LastModifiedDate](#API_UpdateProject_ResponseSyntax) **   <a name="databrew-UpdateProject-response-LastModifiedDate"></a>
The date and time that the project was last modified.  
Type: Timestamp

## Errors
<a name="API_UpdateProject_Errors"></a>

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
<a name="API_UpdateProject_SeeAlso"></a>

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
<a name="API_UpdateRecipe"></a>

Modifies the definition of the `LATEST_WORKING` version of a DataBrew recipe.

## Request Syntax
<a name="API_UpdateRecipe_RequestSyntax"></a>

```
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
<a name="API_UpdateRecipe_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateRecipe_RequestSyntax) **   <a name="databrew-UpdateRecipe-request-uri-Name"></a>
The name of the recipe to be updated.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_UpdateRecipe_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateRecipe_RequestSyntax) **   <a name="databrew-UpdateRecipe-request-Description"></a>
A description of the recipe.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [Steps](#API_UpdateRecipe_RequestSyntax) **   <a name="databrew-UpdateRecipe-request-Steps"></a>
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
<a name="API_UpdateRecipe_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateRecipe_ResponseElements"></a>

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) **   <a name="databrew-UpdateRecipe-response-Name"></a>
The name of the recipe that was updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_UpdateRecipe_Errors"></a>

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
<a name="API_UpdateRecipe_SeeAlso"></a>

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
<a name="API_UpdateRecipeJob"></a>

Modifies the definition of an existing DataBrew recipe job.

## Request Syntax
<a name="API_UpdateRecipeJob_RequestSyntax"></a>

```
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
<a name="API_UpdateRecipeJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-uri-Name"></a>
The name of the job to update.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

## Request Body
<a name="API_UpdateRecipeJob_RequestBody"></a>

The request accepts the following data in JSON format.

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

 ** [DataCatalogOutputs](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-DataCatalogOutputs"></a>
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) **   <a name="databrew-UpdateRecipeJob-request-EncryptionKeyArn"></a>
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) **   <a name="databrew-UpdateRecipeJob-request-EncryptionMode"></a>
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) **   <a name="databrew-UpdateRecipeJob-request-LogSubscription"></a>
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) **   <a name="databrew-UpdateRecipeJob-request-MaxCapacity"></a>
The maximum number of nodes that DataBrew can consume when the job processes data.  
Type: Integer  
Required: No

 ** [MaxRetries](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-MaxRetries"></a>
The maximum number of times to retry the job after a job run fails.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [Outputs](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-Outputs"></a>
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) **   <a name="databrew-UpdateRecipeJob-request-Timeout"></a>
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## Response Syntax
<a name="API_UpdateRecipeJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateRecipeJob_ResponseElements"></a>

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) **   <a name="databrew-UpdateRecipeJob-response-Name"></a>
The name of the job that you updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.

## Errors
<a name="API_UpdateRecipeJob_Errors"></a>

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
<a name="API_UpdateRecipeJob_SeeAlso"></a>

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
<a name="API_UpdateRuleset"></a>

Updates specified ruleset.

## Request Syntax
<a name="API_UpdateRuleset_RequestSyntax"></a>

```
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
<a name="API_UpdateRuleset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateRuleset_RequestSyntax) **   <a name="databrew-UpdateRuleset-request-uri-Name"></a>
The name of the ruleset to be updated.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_UpdateRuleset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Rules](#API_UpdateRuleset_RequestSyntax) **   <a name="databrew-UpdateRuleset-request-Rules"></a>
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) **   <a name="databrew-UpdateRuleset-request-Description"></a>
The description of the ruleset.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_UpdateRuleset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateRuleset_ResponseElements"></a>

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) **   <a name="databrew-UpdateRuleset-response-Name"></a>
The name of the updated ruleset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_UpdateRuleset_Errors"></a>

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
<a name="API_UpdateRuleset_SeeAlso"></a>

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
<a name="API_UpdateSchedule"></a>

Modifies the definition of an existing DataBrew schedule.

## Request Syntax
<a name="API_UpdateSchedule_RequestSyntax"></a>

```
PUT /schedules/name HTTP/1.1
Content-type: application/json

{
   "CronExpression": "string",
   "JobNames": [ "string" ]
}
```

## URI Request Parameters
<a name="API_UpdateSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateSchedule_RequestSyntax) **   <a name="databrew-UpdateSchedule-request-uri-Name"></a>
The name of the schedule to update.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_UpdateSchedule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CronExpression](#API_UpdateSchedule_RequestSyntax) **   <a name="databrew-UpdateSchedule-request-CronExpression"></a>
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) **   <a name="databrew-UpdateSchedule-request-JobNames"></a>
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
<a name="API_UpdateSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateSchedule_ResponseElements"></a>

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) **   <a name="databrew-UpdateSchedule-response-Name"></a>
The name of the schedule that was updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_UpdateSchedule_Errors"></a>

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
<a name="API_UpdateSchedule_SeeAlso"></a>

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)