

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 操作
<a name="API_Operations"></a>

支持以下操作：
+  [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>

一次删除配方的一个或多个版本。

在以下情况下，整个请求将被拒绝：
+ 配方不存在。
+ 在版本列表中存在无效版本标识符。
+ 版本列表为空。
+ 版本列表大小超过 50。
+ 版本列表包含重复条目。

如果出现以下情况，请求将成功完成，但部分失败：
+ 某个版本不存在。
+ 某个作业正在使用某个版本。
+ 您指定 `LATEST_WORKING`，但它正在被一个项目使用。
+ 版本删除失败。

仅当配方没有其他版本时，才会删除 `LATEST_WORKING` 版本。如果您在其他版本存在时尝试删除 `LATEST_WORKING`（或者如果无法删除这些版本），则 `LATEST_WORKING` 将在响应中列为部分失败。

## 请求语法
<a name="API_BatchDeleteRecipeVersion_RequestSyntax"></a>

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

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

## URI 请求参数
<a name="API_BatchDeleteRecipeVersion_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_BatchDeleteRecipeVersion_RequestSyntax) **   <a name="databrew-BatchDeleteRecipeVersion-request-uri-Name"></a>
要删除其版本的配方的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_BatchDeleteRecipeVersion_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [RecipeVersions](#API_BatchDeleteRecipeVersion_RequestSyntax) **   <a name="databrew-BatchDeleteRecipeVersion-request-RecipeVersions"></a>
要删除的配方版本的版本标识符数组。您可以指定数字版本（`X.Y`）或 `LATEST_WORKING`。`LATEST_PUBLISHED` 不受支持。  
类型：字符串数组  
数组成员：最少 1 个物品。最多 50 项。  
长度限制：最小长度为 1。最大长度为 16。  
是否必需：是

## 响应语法
<a name="API_BatchDeleteRecipeVersion_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_BatchDeleteRecipeVersion_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_BatchDeleteRecipeVersion_ResponseSyntax) **   <a name="databrew-BatchDeleteRecipeVersion-response-Name"></a>
已修改的配方的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [Errors](#API_BatchDeleteRecipeVersion_ResponseSyntax) **   <a name="databrew-BatchDeleteRecipeVersion-response-Errors"></a>
尝试删除配方版本时出现的错误（如果有）。  
类型：[RecipeVersionErrorDetail](API_RecipeVersionErrorDetail.md) 对象数组

## 错误
<a name="API_BatchDeleteRecipeVersion_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_BatchDeleteRecipeVersion_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/BatchDeleteRecipeVersion) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/BatchDeleteRecipeVersion) 

# CreateDataset
<a name="API_CreateDataset"></a>

创建新的 DataBrew 数据集。

## 请求语法
<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 请求参数
<a name="API_CreateDataset_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_CreateDataset_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Input](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-Input"></a>
表示有关 DataBrew 如何在 Amazon S3 AWS Glue Data Catalog 或 Amazon S3 中查找数据的信息。  
类型：[Input](API_Input.md) 对象  
是否必需：是

 ** [Name](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-Name"></a>
要创建的数据集的名称。有效字符包括字母数字（A-Z、a-z、0-9）、连字符（-）、句点（.）和空格。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [Format](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-Format"></a>
从 Amazon S3 文件或文件夹创建的数据集的文件格式。  
类型：字符串  
有效值：`CSV | JSON | PARQUET | EXCEL | ORC`  
必需：否

 ** [FormatOptions](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-FormatOptions"></a>
表示一组选项，这些选项用于定义逗号分隔值（CSV）、Excel 或 JSON 输入的结构。  
类型：[FormatOptions](API_FormatOptions.md) 对象  
必需：否

 ** [PathOptions](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-PathOptions"></a>
一组选项，用于定义如何 DataBrew 解释数据集的 Amazon S3 路径。  
类型：[PathOptions](API_PathOptions.md) 对象  
必需：否

 ** [Tags](#API_CreateDataset_RequestSyntax) **   <a name="databrew-CreateDataset-request-Tags"></a>
要应用于此数据集的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
必需：否

## 响应语法
<a name="API_CreateDataset_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_CreateDataset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_CreateDataset_ResponseSyntax) **   <a name="databrew-CreateDataset-response-Name"></a>
您创建的数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_CreateDataset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
对指定资源的访问被拒绝。  
HTTP 状态代码：403

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateDataset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateDataset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateDataset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateDataset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateDataset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateDataset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateDataset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateDataset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateDataset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateDataset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateDataset) 

# CreateProfileJob
<a name="API_CreateProfileJob"></a>

创建一个新作业以分析数据集并创建其数据配置文件。

## 请求语法
<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 请求参数
<a name="API_CreateProfileJob_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_CreateProfileJob_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [DatasetName](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-DatasetName"></a>
此作业要执行操作的数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [Name](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-Name"></a>
要创建的作业的名称。有效字符包括字母数字（A-Z、a-z、0-9）、连字符（-）、句点（.）和空格。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

 ** [OutputLocation](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-OutputLocation"></a>
表示 Amazon S3 位置（存储桶名称、存储桶拥有者和对象密钥）， DataBrew 可以在其中读取输入数据或写入任务的输出。  
类型：[S3Location](API_S3Location.md) 对象  
是否必需：是

 ** [RoleArn](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-RoleArn"></a>
 DataBrew 运行任务时要假设的 AWS Identity and Access Management (IAM) 角色的亚马逊资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [Configuration](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-Configuration"></a>
配置文件作业的配置。用于选择列、进行评估并覆盖评估的默认参数。配置为 null 时，配置文件作业将使用默认设置运行。  
类型：[ProfileConfiguration](API_ProfileConfiguration.md) 对象  
必需：否

 ** [EncryptionKeyArn](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-EncryptionKeyArn"></a>
用于保护作业的加密密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
必需：否

 ** [EncryptionMode](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-EncryptionMode"></a>
作业的加密模式包括以下几种：  
+  `SSE-KMS` - `SSE-KMS`：使用 AWS KMS托管密钥的服务器端加密。
+  `SSE-S3` - 使用 Amazon S3 托管密钥进行服务器端加密。
类型：字符串  
有效值：`SSE-KMS | SSE-S3`  
必需：否

 ** [JobSample](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-JobSample"></a>
仅配置文件作业的样本配置。确定要执行配置文件作业的行数。如果未提供 JobSample 值，则将使用默认值。模式参数的默认值为 CUSTOM\$1ROWS，大小参数的默认值为 20000。  
类型：[JobSample](API_JobSample.md) 对象  
必需：否

 ** [LogSubscription](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-LogSubscription"></a>
为任务启用或禁用 Amazon CloudWatch 日志记录。如果启用了日志记录，则为每个作业运行 CloudWatch 写入一个日志流。  
类型：字符串  
有效值：`ENABLE | DISABLE`  
必需：否

 ** [MaxCapacity](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-MaxCapacity"></a>
作业处理数据时 DataBrew 可使用的最大节点数。  
类型：整数  
必需：否

 ** [MaxRetries](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-MaxRetries"></a>
作业运行失败后重试此作业的最大次数。  
类型：整数  
有效范围：最小值为 0。  
必需：否

 ** [Tags](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-Tags"></a>
要应用于此作业的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
必需：否

 ** [Timeout](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-Timeout"></a>
作业的超时（以分钟为单位）。如果作业的运行时间超出此超时时间，作业将以 `TIMEOUT` 状态结束。  
类型：整数  
有效范围：最小值为 0。  
必需：否

 ** [ValidationConfigurations](#API_CreateProfileJob_RequestSyntax) **   <a name="databrew-CreateProfileJob-request-ValidationConfigurations"></a>
应用于配置文件作业的验证配置列表。  
类型：[ValidationConfiguration](API_ValidationConfiguration.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

## 响应语法
<a name="API_CreateProfileJob_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_CreateProfileJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_CreateProfileJob_ResponseSyntax) **   <a name="databrew-CreateProfileJob-response-Name"></a>
已创建的作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

## 错误
<a name="API_CreateProfileJob_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
对指定资源的访问被拒绝。  
HTTP 状态代码：403

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateProfileJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateProfileJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateProfileJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateProfileJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateProfileJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateProfileJob) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateProfileJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateProfileJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateProfileJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateProfileJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateProfileJob) 

# CreateProject
<a name="API_CreateProject"></a>

创建新 DataBrew 项目。

## 请求语法
<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 请求参数
<a name="API_CreateProject_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_CreateProject_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [DatasetName](#API_CreateProject_RequestSyntax) **   <a name="databrew-CreateProject-request-DatasetName"></a>
要与该项目关联的现有数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [Name](#API_CreateProject_RequestSyntax) **   <a name="databrew-CreateProject-request-Name"></a>
新项目的唯一名称。有效字符包括字母数字（A-Z、a-z、0-9）、连字符（-）、句点（.）和空格。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [RecipeName](#API_CreateProject_RequestSyntax) **   <a name="databrew-CreateProject-request-RecipeName"></a>
要与项目关联的现有配方的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [RoleArn](#API_CreateProject_RequestSyntax) **   <a name="databrew-CreateProject-request-RoleArn"></a>
为该请求承担的 (IAM) 角色的亚马逊资源名称 AWS Identity and Access Management (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [Sample](#API_CreateProject_RequestSyntax) **   <a name="databrew-CreateProject-request-Sample"></a>
表示用于交互式数据分析 DataBrew 的样本数量和采样类型。  
类型：[Sample](API_Sample.md) 对象  
必需：否

 ** [Tags](#API_CreateProject_RequestSyntax) **   <a name="databrew-CreateProject-request-Tags"></a>
要应用于此项目的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
必需：否

## 响应语法
<a name="API_CreateProject_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_CreateProject_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_CreateProject_ResponseSyntax) **   <a name="databrew-CreateProject-response-Name"></a>
已创建的项目的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_CreateProject_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** InternalServerException **   
出现内部服务故障。  
HTTP 状态代码：500

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateProject_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateProject) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateProject) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateProject) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateProject) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateProject) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateProject) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateProject) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateProject) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateProject) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateProject) 

# CreateRecipe
<a name="API_CreateRecipe"></a>

创建新 DataBrew 配方。

## 请求语法
<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 请求参数
<a name="API_CreateRecipe_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_CreateRecipe_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Name](#API_CreateRecipe_RequestSyntax) **   <a name="databrew-CreateRecipe-request-Name"></a>
配方的唯一名称。有效字符包括字母数字（A-Z、a-z、0-9）、连字符（-）、句点（.）和空格。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [Steps](#API_CreateRecipe_RequestSyntax) **   <a name="databrew-CreateRecipe-request-Steps"></a>
包含配方要执行的步骤的数组。每个配方步骤都由一个配方操作和（可选）一个条件表达式数组组成。  
类型：[RecipeStep](API_RecipeStep.md) 对象数组  
是否必需：是

 ** [Description](#API_CreateRecipe_RequestSyntax) **   <a name="databrew-CreateRecipe-request-Description"></a>
配方的描述。  
类型：字符串  
长度限制：最大长度为 1024。  
必需：否

 ** [Tags](#API_CreateRecipe_RequestSyntax) **   <a name="databrew-CreateRecipe-request-Tags"></a>
要应用于此配方的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
必需：否

## 响应语法
<a name="API_CreateRecipe_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_CreateRecipe_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_CreateRecipe_ResponseSyntax) **   <a name="databrew-CreateRecipe-response-Name"></a>
已创建的配方的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_CreateRecipe_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateRecipe_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateRecipe) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateRecipe) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateRecipe) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateRecipe) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateRecipe) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateRecipe) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateRecipe) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateRecipe) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateRecipe) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateRecipe) 

# CreateRecipeJob
<a name="API_CreateRecipeJob"></a>

使用现有 AWS Glue DataBrew 配方中定义的步骤创建用于转换输入数据的新作业

## 请求语法
<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 请求参数
<a name="API_CreateRecipeJob_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_CreateRecipeJob_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Name](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-Name"></a>
作业的唯一名称。有效字符包括字母数字（A-Z、a-z、0-9）、连字符（-）、句点（.）和空格。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

 ** [RoleArn](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-RoleArn"></a>
 DataBrew 运行任务时要假设的 AWS Identity and Access Management (IAM) 角色的亚马逊资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [DatabaseOutputs](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-DatabaseOutputs"></a>
表示 JDBC 数据库输出对象的列表，该对象定义了要写入的 DataBrew 配方作业的输出目标。  
类型：[DatabaseOutput](API_DatabaseOutput.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** [DataCatalogOutputs](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-DataCatalogOutputs"></a>
一个或多个工件，用于表示运行作业的 AWS Glue Data Catalog 输出。  
类型：[DataCatalogOutput](API_DataCatalogOutput.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** [DatasetName](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-DatasetName"></a>
此作业处理的数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
必需：否

 ** [EncryptionKeyArn](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-EncryptionKeyArn"></a>
用于保护作业的加密密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
必需：否

 ** [EncryptionMode](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-EncryptionMode"></a>
作业的加密模式包括以下几种：  
+  `SSE-KMS`-使用由 AWS KMS管理的密钥进行服务器端加密。
+  `SSE-S3` - 使用 Amazon S3 托管密钥进行服务器端加密。
类型：字符串  
有效值：`SSE-KMS | SSE-S3`  
必需：否

 ** [LogSubscription](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-LogSubscription"></a>
为任务启用或禁用 Amazon CloudWatch 日志记录。如果启用了日志记录，则为每个作业运行 CloudWatch 写入一个日志流。  
类型：字符串  
有效值：`ENABLE | DISABLE`  
必需：否

 ** [MaxCapacity](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-MaxCapacity"></a>
任务处理数据时 DataBrew 可以消耗的最大节点数。  
类型：整数  
必需：否

 ** [MaxRetries](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-MaxRetries"></a>
作业运行失败后重试此作业的最大次数。  
类型：整数  
有效范围：最小值为 0。  
必需：否

 ** [Outputs](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-Outputs"></a>
代表作业运行时 输出的一个或多个构件。  
类型：[Output](API_Output.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** [ProjectName](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-ProjectName"></a>
要么是现有项目的名称，要么是配方和要与配方关联的数据集的组合。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
必需：否

 ** [RecipeReference](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-RecipeReference"></a>
表示 DataBrew 食谱的名称和版本。  
类型：[RecipeReference](API_RecipeReference.md) 对象  
必需：否

 ** [Tags](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-Tags"></a>
要应用于此作业的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
必需：否

 ** [Timeout](#API_CreateRecipeJob_RequestSyntax) **   <a name="databrew-CreateRecipeJob-request-Timeout"></a>
作业的超时（以分钟为单位）。如果作业的运行时间超出此超时时间，作业将以 `TIMEOUT` 状态结束。  
类型：整数  
有效范围：最小值为 0。  
必需：否

## 响应语法
<a name="API_CreateRecipeJob_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_CreateRecipeJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_CreateRecipeJob_ResponseSyntax) **   <a name="databrew-CreateRecipeJob-response-Name"></a>
您创建的作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

## 错误
<a name="API_CreateRecipeJob_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
对指定资源的访问被拒绝。  
HTTP 状态代码：403

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateRecipeJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateRecipeJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateRecipeJob) 

# CreateRuleset
<a name="API_CreateRuleset"></a>

创建可在配置文件作业中用于验证数据集数据质量的新规则集。

## 请求语法
<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 请求参数
<a name="API_CreateRuleset_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_CreateRuleset_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Name](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-Name"></a>
要创建的规则集的名称。有效字符包括字母数字（A-Z、a-z、0-9）、连字符（-）、句点（.）和空格。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [Rules](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-Rules"></a>
使用规则集定义的规则列表。规则包括一项或多项要对 DataBrew 数据集进行验证的校验。  
类型：[Rule](API_Rule.md) 对象数组  
数组成员：最少 1 个物品。  
是否必需：是

 ** [TargetArn](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-TargetArn"></a>
与规则集关联的资源（数据集）的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [Description](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-Description"></a>
规则集的描述。  
类型：字符串  
长度限制：最大长度为 1024。  
必需：否

 ** [Tags](#API_CreateRuleset_RequestSyntax) **   <a name="databrew-CreateRuleset-request-Tags"></a>
要应用于规则集的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
必需：否

## 响应语法
<a name="API_CreateRuleset_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_CreateRuleset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_CreateRuleset_ResponseSyntax) **   <a name="databrew-CreateRuleset-response-Name"></a>
创建的规则集的唯一名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_CreateRuleset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateRuleset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateRuleset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateRuleset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateRuleset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateRuleset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateRuleset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateRuleset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateRuleset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateRuleset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateRuleset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateRuleset) 

# CreateSchedule
<a name="API_CreateSchedule"></a>

为一个或多个 DataBrew 作业创建新的时间表。作业可以在特定的日期和时间运行，也可以定期运行。

## 请求语法
<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 请求参数
<a name="API_CreateSchedule_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_CreateSchedule_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [CronExpression](#API_CreateSchedule_RequestSyntax) **   <a name="databrew-CreateSchedule-request-CronExpression"></a>
将要运行作业的日期或者日期和时间。有关更多信息，请参阅《* AWS Glue DataBrew 开发人员指南*[》中的 Cron 表达式](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html)。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 512。  
是否必需：是

 ** [Name](#API_CreateSchedule_RequestSyntax) **   <a name="databrew-CreateSchedule-request-Name"></a>
计划的唯一名称。有效字符包括字母数字（A-Z、a-z、0-9）、连字符（-）、句点（.）和空格。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [JobNames](#API_CreateSchedule_RequestSyntax) **   <a name="databrew-CreateSchedule-request-JobNames"></a>
要运行的一个或多个作业的名称。  
类型：字符串数组  
数组成员：最多 50 项。  
长度限制：最小长度为 1。最大长度为 240。  
必需：否

 ** [Tags](#API_CreateSchedule_RequestSyntax) **   <a name="databrew-CreateSchedule-request-Tags"></a>
要应用于此计划的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
必需：否

## 响应语法
<a name="API_CreateSchedule_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_CreateSchedule_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_CreateSchedule_ResponseSyntax) **   <a name="databrew-CreateSchedule-response-Name"></a>
已创建的计划的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_CreateSchedule_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateSchedule_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/CreateSchedule) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/CreateSchedule) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/CreateSchedule) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/CreateSchedule) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/CreateSchedule) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/CreateSchedule) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/CreateSchedule) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/CreateSchedule) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/CreateSchedule) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/CreateSchedule) 

# DeleteDataset
<a name="API_DeleteDataset"></a>

从中删除数据集 DataBrew。

## 请求语法
<a name="API_DeleteDataset_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DeleteDataset_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DeleteDataset_RequestSyntax) **   <a name="databrew-DeleteDataset-request-uri-Name"></a>
要删除的数据集的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DeleteDataset_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DeleteDataset_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_DeleteDataset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DeleteDataset_ResponseSyntax) **   <a name="databrew-DeleteDataset-response-Name"></a>
您删除的数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_DeleteDataset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteDataset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteDataset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteDataset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteDataset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteDataset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteDataset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteDataset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteDataset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteDataset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteDataset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteDataset) 

# DeleteJob
<a name="API_DeleteJob"></a>

删除指定的 DataBrew 作业。

## 请求语法
<a name="API_DeleteJob_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DeleteJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DeleteJob_RequestSyntax) **   <a name="databrew-DeleteJob-request-uri-Name"></a>
要删除的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

## 请求体
<a name="API_DeleteJob_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DeleteJob_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_DeleteJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DeleteJob_ResponseSyntax) **   <a name="databrew-DeleteJob-response-Name"></a>
您删除的作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

## 错误
<a name="API_DeleteJob_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteJob) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteJob) 

# DeleteProject
<a name="API_DeleteProject"></a>

删除现有 DataBrew 项目。

## 请求语法
<a name="API_DeleteProject_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DeleteProject_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DeleteProject_RequestSyntax) **   <a name="databrew-DeleteProject-request-uri-Name"></a>
要删除的项目的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DeleteProject_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DeleteProject_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_DeleteProject_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DeleteProject_ResponseSyntax) **   <a name="databrew-DeleteProject-response-Name"></a>
您删除的项目的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_DeleteProject_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteProject_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteProject) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteProject) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteProject) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteProject) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteProject) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteProject) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteProject) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteProject) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteProject) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteProject) 

# DeleteRecipeVersion
<a name="API_DeleteRecipeVersion"></a>

删除食 DataBrew 谱的单个版本。

## 请求语法
<a name="API_DeleteRecipeVersion_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DeleteRecipeVersion_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DeleteRecipeVersion_RequestSyntax) **   <a name="databrew-DeleteRecipeVersion-request-uri-Name"></a>
食谱的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [recipeVersion](#API_DeleteRecipeVersion_RequestSyntax) **   <a name="databrew-DeleteRecipeVersion-request-uri-RecipeVersion"></a>
要删除的配方的版本。您可以指定数字版本（`X.Y`）或 `LATEST_WORKING`。`LATEST_PUBLISHED` 不受支持。  
长度限制：最小长度为 1。最大长度为 16。  
是否必需：是

## 请求体
<a name="API_DeleteRecipeVersion_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DeleteRecipeVersion_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_DeleteRecipeVersion_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DeleteRecipeVersion_ResponseSyntax) **   <a name="databrew-DeleteRecipeVersion-response-Name"></a>
已删除的配方的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [RecipeVersion](#API_DeleteRecipeVersion_ResponseSyntax) **   <a name="databrew-DeleteRecipeVersion-response-RecipeVersion"></a>
已删除的配方的版本。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 16。

## 错误
<a name="API_DeleteRecipeVersion_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteRecipeVersion_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteRecipeVersion) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteRecipeVersion) 

# DeleteRuleset
<a name="API_DeleteRuleset"></a>

删除规则集。

## 请求语法
<a name="API_DeleteRuleset_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DeleteRuleset_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DeleteRuleset_RequestSyntax) **   <a name="databrew-DeleteRuleset-request-uri-Name"></a>
要删除的规则集的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DeleteRuleset_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DeleteRuleset_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_DeleteRuleset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DeleteRuleset_ResponseSyntax) **   <a name="databrew-DeleteRuleset-response-Name"></a>
删除的规则集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_DeleteRuleset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteRuleset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteRuleset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteRuleset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteRuleset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteRuleset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteRuleset) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteRuleset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteRuleset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteRuleset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteRuleset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteRuleset) 

# DeleteSchedule
<a name="API_DeleteSchedule"></a>

删除指定的 DataBrew 时间表。

## 请求语法
<a name="API_DeleteSchedule_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DeleteSchedule_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DeleteSchedule_RequestSyntax) **   <a name="databrew-DeleteSchedule-request-uri-Name"></a>
要删除的计划的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DeleteSchedule_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DeleteSchedule_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_DeleteSchedule_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DeleteSchedule_ResponseSyntax) **   <a name="databrew-DeleteSchedule-response-Name"></a>
已删除的计划的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_DeleteSchedule_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteSchedule_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DeleteSchedule) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DeleteSchedule) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DeleteSchedule) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DeleteSchedule) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DeleteSchedule) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DeleteSchedule) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DeleteSchedule) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DeleteSchedule) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DeleteSchedule) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DeleteSchedule) 

# DescribeDataset
<a name="API_DescribeDataset"></a>

返回特定 DataBrew 数据集的定义。

## 请求语法
<a name="API_DescribeDataset_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DescribeDataset_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeDataset_RequestSyntax) **   <a name="databrew-DescribeDataset-request-uri-Name"></a>
要描述的数据集的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DescribeDataset_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
   }
}
```

## 响应元素
<a name="API_DescribeDataset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Input](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Input"></a>
表示有关 DataBrew 如何在 Amazon S3 AWS Glue Data Catalog 或 Amazon S3 中查找数据的信息。  
类型：[Input](API_Input.md) 对象

 ** [Name](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Name"></a>
数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [CreateDate](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-CreateDate"></a>
数据集的创建日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-CreatedBy"></a>
创建数据集的用户的标识符（用户名）。  
类型：字符串

 ** [Format](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Format"></a>
从 Amazon S3 文件或文件夹创建的数据集的文件格式。  
类型：字符串  
有效值：`CSV | JSON | PARQUET | EXCEL | ORC`

 ** [FormatOptions](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-FormatOptions"></a>
表示一组选项，这些选项用于定义逗号分隔值（CSV）、Excel 或 JSON 输入的结构。  
类型：[FormatOptions](API_FormatOptions.md) 对象

 ** [LastModifiedBy](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-LastModifiedBy"></a>
上次修改数据集的用户的标识符（用户名）。  
类型：字符串

 ** [LastModifiedDate](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-LastModifiedDate"></a>
上次修改数据集的日期和时间。  
类型：时间戳

 ** [PathOptions](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-PathOptions"></a>
一组选项，用于定义如何 DataBrew 解释数据集的 Amazon S3 路径。  
类型：[PathOptions](API_PathOptions.md) 对象

 ** [ResourceArn](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-ResourceArn"></a>
数据集的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [Source](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Source"></a>
此数据集的数据位置：Amazon S3 或 AWS Glue Data Catalog。  
类型：字符串  
有效值：`S3 | DATA-CATALOG | DATABASE`

 ** [Tags](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Tags"></a>
与此数据集关联的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

## 错误
<a name="API_DescribeDataset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeDataset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeDataset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeDataset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeDataset) 

# DescribeJob
<a name="API_DescribeJob"></a>

返回特定 DataBrew 作业的定义。

## 请求语法
<a name="API_DescribeJob_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DescribeJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeJob_RequestSyntax) **   <a name="databrew-DescribeJob-request-uri-Name"></a>
要描述的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

## 请求体
<a name="API_DescribeJob_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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"
      }
   ]
}
```

## 响应元素
<a name="API_DescribeJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Name"></a>
 作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

 ** [CreateDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreateDate"></a>
创建作业的日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreatedBy"></a>
与创建作业关联的用户的标识符（用户名）。  
类型：字符串

 ** [DatabaseOutputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DatabaseOutputs"></a>
表示 JDBC 数据库输出对象的列表，该对象定义了要写入的 DataBrew 配方作业的输出目标。  
类型：[DatabaseOutput](API_DatabaseOutput.md) 对象数组  
数组成员：最少 1 个物品。

 ** [DataCatalogOutputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DataCatalogOutputs"></a>
一个或多个工件，用于表示运行作业的 AWS Glue Data Catalog 输出。  
类型：[DataCatalogOutput](API_DataCatalogOutput.md) 对象数组  
数组成员：最少 1 个物品。

 ** [DatasetName](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DatasetName"></a>
作业执行操作的数据集。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [EncryptionKeyArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-EncryptionKeyArn"></a>
用于保护作业的加密密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [EncryptionMode](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-EncryptionMode"></a>
作业的加密模式包括以下几种：  
+  `SSE-KMS`-使用由 AWS KMS管理的密钥进行服务器端加密。
+  `SSE-S3` - 使用 Amazon S3 托管密钥进行服务器端加密。
类型：字符串  
有效值：`SSE-KMS | SSE-S3`

 ** [JobSample](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-JobSample"></a>
仅配置文件作业的样本配置。确定要执行配置文件作业的行数。  
类型：[JobSample](API_JobSample.md) 对象

 ** [LastModifiedBy](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LastModifiedBy"></a>
上次修改作业的用户的标识符（用户名）。  
类型：字符串

 ** [LastModifiedDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LastModifiedDate"></a>
上次修改作业的日期和时间。  
类型：时间戳

 ** [LogSubscription](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LogSubscription"></a>
表示此任务是否启用了 Amazon CloudWatch 日志记录。  
类型：字符串  
有效值：`ENABLE | DISABLE`

 ** [MaxCapacity](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxCapacity"></a>
作业处理数据时 DataBrew 可以消耗的最大计算节点数。  
类型：整数

 ** [MaxRetries](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxRetries"></a>
作业运行失败后重试此作业的最大次数。  
类型：整数  
有效范围：最小值为 0。

 ** [Outputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Outputs"></a>
代表作业运行时 输出的一个或多个构件。  
类型：[Output](API_Output.md) 对象数组  
数组成员：最少 1 个物品。

 ** [ProfileConfiguration](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ProfileConfiguration"></a>
配置文件作业的配置。用于选择列、进行评估并覆盖评估的默认参数。配置为 null 时，配置文件作业将使用默认设置运行。  
类型：[ProfileConfiguration](API_ProfileConfiguration.md) 对象

 ** [ProjectName](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ProjectName"></a>
与此工作相关的 DataBrew 项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [RecipeReference](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RecipeReference"></a>
表示 DataBrew 食谱的名称和版本。  
类型：[RecipeReference](API_RecipeReference.md) 对象

 ** [ResourceArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ResourceArn"></a>
作业的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [RoleArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RoleArn"></a>
 DataBrew 运行任务时要扮演的 AWS Identity and Access Management (IAM) 角色的 ARN。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [Tags](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Tags"></a>
与此作业关联的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

 ** [Timeout](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Timeout"></a>
作业的超时（以分钟为单位）。如果作业的运行时间超出此超时时间，作业将以 `TIMEOUT` 状态结束。  
类型：整数  
有效范围：最小值为 0。

 ** [Type](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Type"></a>
作业类型，必须为以下类型之一：  
+  `PROFILE`：作业分析数据集，以确定其大小、数据类型、数据分布等。
+  `RECIPE`：作业将一个或多个转换应用于数据集。
类型：字符串  
有效值：`PROFILE | RECIPE`

 ** [ValidationConfigurations](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ValidationConfigurations"></a>
应用于配置文件作业的验证配置列表。  
类型：[ValidationConfiguration](API_ValidationConfiguration.md) 对象数组  
数组成员：最少 1 个物品。

## 错误
<a name="API_DescribeJob_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeJob) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeJob) 

# DescribeJobRun
<a name="API_DescribeJobRun"></a>

表示 DataBrew 作业的一次运行。

## 请求语法
<a name="API_DescribeJobRun_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DescribeJobRun_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeJobRun_RequestSyntax) **   <a name="databrew-DescribeJobRun-request-uri-Name"></a>
在此运行期间正在处理的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

 ** [runId](#API_DescribeJobRun_RequestSyntax) **   <a name="databrew-DescribeJobRun-request-uri-RunId"></a>
作业运行的唯一标识符。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DescribeJobRun_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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"
      }
   ]
}
```

## 响应元素
<a name="API_DescribeJobRun_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [JobName](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-JobName"></a>
在此运行期间正在处理的作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

 ** [Attempt](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-Attempt"></a>
尝试运行作业 DataBrew 的次数。  
类型：整数

 ** [CompletedOn](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-CompletedOn"></a>
作业完成处理的日期和时间。  
类型：时间戳

 ** [DatabaseOutputs](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-DatabaseOutputs"></a>
表示 JDBC 数据库输出对象的列表，该对象定义了要写入的 DataBrew 配方作业的输出目标。  
类型：[DatabaseOutput](API_DatabaseOutput.md) 对象数组  
数组成员：最少 1 个物品。

 ** [DataCatalogOutputs](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-DataCatalogOutputs"></a>
一个或多个工件，表示运行作业的 AWS Glue Data Catalog 输出。  
类型：[DataCatalogOutput](API_DataCatalogOutput.md) 对象数组  
数组成员：最少 1 个物品。

 ** [DatasetName](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-DatasetName"></a>
作业处理的数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [ErrorMessage](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-ErrorMessage"></a>
一条消息，指示作业运行时遇到的错误（如果有）。  
类型：字符串

 ** [ExecutionTime](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-ExecutionTime"></a>
作业运行使用资源的时间长度（以秒为单位）。  
类型：整数

 ** [JobSample](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-JobSample"></a>
仅配置文件作业的样本配置。确定要执行配置文件作业的行数。如果未提供 JobSample 值，则将使用默认值。模式参数的默认值为 CUSTOM\$1ROWS，大小参数的默认值为 20000。  
类型：[JobSample](API_JobSample.md) 对象

 ** [LogGroupName](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-LogGroupName"></a>
Amazon CloudWatch 日志组的名称，作业在运行时写入诊断消息。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 512。

 ** [LogSubscription](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-LogSubscription"></a>
Amazon CloudWatch 记录任务运行的当前状态。  
类型：字符串  
有效值：`ENABLE | DISABLE`

 ** [Outputs](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-Outputs"></a>
作业运行的一个或多个输出构件。  
类型：[Output](API_Output.md) 对象数组  
数组成员：最少 1 个物品。

 ** [ProfileConfiguration](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-ProfileConfiguration"></a>
配置文件作业的配置。用于选择列、进行评估并覆盖评估的默认参数。配置为 null 时，配置文件作业将使用默认设置运行。  
类型：[ProfileConfiguration](API_ProfileConfiguration.md) 对象

 ** [RecipeReference](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-RecipeReference"></a>
表示 DataBrew 配方的名称和版本。  
类型：[RecipeReference](API_RecipeReference.md) 对象

 ** [RunId](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-RunId"></a>
作业运行的唯一标识符。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [StartedBy](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-StartedBy"></a>
启动作业运行的用户的 Amazon 资源名称（ARN）。  
类型：字符串

 ** [StartedOn](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-StartedOn"></a>
作业运行的开始日期和时间。  
类型：时间戳

 ** [State](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-State"></a>
作业运行实体本身的当前状态。  
类型：字符串  
有效值：`STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT`

 ** [ValidationConfigurations](#API_DescribeJobRun_ResponseSyntax) **   <a name="databrew-DescribeJobRun-response-ValidationConfigurations"></a>
应用于配置文件作业的验证配置列表。  
类型：[ValidationConfiguration](API_ValidationConfiguration.md) 对象数组  
数组成员：最少 1 个物品。

## 错误
<a name="API_DescribeJobRun_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeJobRun_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeJobRun) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeJobRun) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeJobRun) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeJobRun) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeJobRun) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeJobRun) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeJobRun) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeJobRun) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeJobRun) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeJobRun) 

# DescribeProject
<a name="API_DescribeProject"></a>

返回特定 DataBrew 项目的定义。

## 请求语法
<a name="API_DescribeProject_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DescribeProject_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeProject_RequestSyntax) **   <a name="databrew-DescribeProject-request-uri-Name"></a>
要描述的项目的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DescribeProject_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
   }
}
```

## 响应元素
<a name="API_DescribeProject_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-Name"></a>
项目的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [CreateDate](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-CreateDate"></a>
项目的创建日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-CreatedBy"></a>
创建项目的用户的标识符（用户名）。  
类型：字符串

 ** [DatasetName](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-DatasetName"></a>
与项目关联的数据集。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [LastModifiedBy](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-LastModifiedBy"></a>
上次修改项目的用户的标识符（用户名）。  
类型：字符串

 ** [LastModifiedDate](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-LastModifiedDate"></a>
上次修改项目的日期和时间。  
类型：时间戳

 ** [OpenDate](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-OpenDate"></a>
打开项目的日期和时间。  
类型：时间戳

 ** [OpenedBy](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-OpenedBy"></a>
打开项目以供使用的用户的标识符（用户名）。  
类型：字符串

 ** [RecipeName](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-RecipeName"></a>
与此作业关联的配方。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [ResourceArn](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-ResourceArn"></a>
 项目的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [RoleArn](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-RoleArn"></a>
 DataBrew 运行任务时要扮演的 AWS Identity and Access Management (IAM) 角色的 ARN。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [Sample](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-Sample"></a>
表示用于交互式数据分析 DataBrew 的样本数量和采样类型。  
类型：[Sample](API_Sample.md) 对象

 ** [SessionStatus](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-SessionStatus"></a>
描述会话的当前状态：  
+  `PROVISIONING`：为会话分配资源。
+  `INITIALIZING`：让会话为首次使用做好准备。
+  `ASSIGNED`：会话已准备好使用。
类型：字符串  
有效值：`ASSIGNED | FAILED | INITIALIZING | PROVISIONING | READY | RECYCLING | ROTATING | TERMINATED | TERMINATING | UPDATING`

 ** [Tags](#API_DescribeProject_ResponseSyntax) **   <a name="databrew-DescribeProject-response-Tags"></a>
与此项目关联的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

## 错误
<a name="API_DescribeProject_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeProject_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeProject) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeProject) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeProject) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeProject) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeProject) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeProject) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeProject) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeProject) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeProject) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeProject) 

# DescribeRecipe
<a name="API_DescribeRecipe"></a>

返回与特定版本对应的特定 DataBrew 配方的定义。

## 请求语法
<a name="API_DescribeRecipe_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DescribeRecipe_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeRecipe_RequestSyntax) **   <a name="databrew-DescribeRecipe-request-uri-Name"></a>
要描述的配方的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [RecipeVersion](#API_DescribeRecipe_RequestSyntax) **   <a name="databrew-DescribeRecipe-request-uri-RecipeVersion"></a>
配方版本标识符。如果未指定此参数，则会返回最新发布的版本。  
长度限制：最小长度为 1。最大长度为 16。

## 请求正文
<a name="API_DescribeRecipe_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
   }
}
```

## 响应元素
<a name="API_DescribeRecipe_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-Name"></a>
食谱的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [CreateDate](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-CreateDate"></a>
创建配方的日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-CreatedBy"></a>
创建配方的用户的标识符（用户名）。  
类型：字符串

 ** [Description](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-Description"></a>
对食谱的描述。  
类型：字符串  
长度限制：最大长度为 1024。

 ** [LastModifiedBy](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-LastModifiedBy"></a>
上次修改配方的用户的标识符（用户名）。  
类型：字符串

 ** [LastModifiedDate](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-LastModifiedDate"></a>
上次修改配方的日期和时间。  
类型：时间戳

 ** [ProjectName](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-ProjectName"></a>
与此配方关联的项目的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [PublishedBy](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-PublishedBy"></a>
上次发布配置的用户的标识符（用户名）。  
类型：字符串

 ** [PublishedDate](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-PublishedDate"></a>
上次发布配方的日期和时间。  
类型：时间戳

 ** [RecipeVersion](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-RecipeVersion"></a>
配方版本标识符。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 16。

 ** [ResourceArn](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-ResourceArn"></a>
 脚本的 ARN。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [Steps](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-Steps"></a>
配方要执行的一个或多个步骤。每个步骤都由一个操作以及该操作的成功条件组成。  
类型：[RecipeStep](API_RecipeStep.md) 对象数组

 ** [Tags](#API_DescribeRecipe_ResponseSyntax) **   <a name="databrew-DescribeRecipe-response-Tags"></a>
与此项目关联的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

## 错误
<a name="API_DescribeRecipe_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeRecipe_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeRecipe) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeRecipe) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeRecipe) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeRecipe) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeRecipe) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeRecipe) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeRecipe) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeRecipe) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeRecipe) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeRecipe) 

# DescribeRuleset
<a name="API_DescribeRuleset"></a>

检索有关规则集的详细信息。

## 请求语法
<a name="API_DescribeRuleset_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DescribeRuleset_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeRuleset_RequestSyntax) **   <a name="databrew-DescribeRuleset-request-uri-Name"></a>
要描述的规则集的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DescribeRuleset_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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"
}
```

## 响应元素
<a name="API_DescribeRuleset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-Name"></a>
规则集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [CreateDate](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-CreateDate"></a>
规则集的创建日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-CreatedBy"></a>
创建规则集的用户的 Amazon 资源名称（ARN）。  
类型：字符串

 ** [Description](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-Description"></a>
规则集的描述。  
类型：字符串  
长度限制：最大长度为 1024。

 ** [LastModifiedBy](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-LastModifiedBy"></a>
上次修改规则集的用户的 Amazon 资源名称（ARN）。  
类型：字符串

 ** [LastModifiedDate](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-LastModifiedDate"></a>
规则集的修改日期和时间。  
类型：时间戳

 ** [ResourceArn](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-ResourceArn"></a>
规则集的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [Rules](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-Rules"></a>
使用规则集定义的规则列表。规则包括一项或多项要对 DataBrew 数据集进行验证的校验。  
类型：[Rule](API_Rule.md) 对象数组  
数组成员：最少 1 个物品。

 ** [Tags](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-Tags"></a>
已应用于规则集的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

 ** [TargetArn](#API_DescribeRuleset_ResponseSyntax) **   <a name="databrew-DescribeRuleset-response-TargetArn"></a>
与规则集关联的资源（数据集）的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

## 错误
<a name="API_DescribeRuleset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeRuleset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeRuleset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeRuleset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeRuleset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeRuleset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeRuleset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeRuleset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeRuleset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeRuleset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeRuleset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeRuleset) 

# DescribeSchedule
<a name="API_DescribeSchedule"></a>

返回特定 DataBrew 时间表的定义。

## 请求语法
<a name="API_DescribeSchedule_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_DescribeSchedule_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeSchedule_RequestSyntax) **   <a name="databrew-DescribeSchedule-request-uri-Name"></a>
要描述的计划的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DescribeSchedule_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
   }
}
```

## 响应元素
<a name="API_DescribeSchedule_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-Name"></a>
计划的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [CreateDate](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-CreateDate"></a>
计划的创建日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-CreatedBy"></a>
创建计划的用户的标识符（用户名）。  
类型：字符串

 ** [CronExpression](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-CronExpression"></a>
将要按计划运行作业的日期或者日期和时间。有关更多信息，请参阅《* AWS Glue DataBrew 开发人员指南*[》中的 Cron 表达式](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html)。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 512。

 ** [JobNames](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-JobNames"></a>
要使用计划运行的一个或多个作业的名称。  
类型：字符串数组  
数组成员：最多 50 项。  
长度限制：最小长度为 1。最大长度为 240。

 ** [LastModifiedBy](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-LastModifiedBy"></a>
上次修改计划的用户的标识符（用户名）。  
类型：字符串

 ** [LastModifiedDate](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-LastModifiedDate"></a>
上次修改计划的日期和时间。  
类型：时间戳

 ** [ResourceArn](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-ResourceArn"></a>
计划的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [Tags](#API_DescribeSchedule_ResponseSyntax) **   <a name="databrew-DescribeSchedule-response-Tags"></a>
与此计划关联的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

## 错误
<a name="API_DescribeSchedule_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeSchedule_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeSchedule) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeSchedule) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeSchedule) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeSchedule) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeSchedule) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeSchedule) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeSchedule) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeSchedule) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeSchedule) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeSchedule) 

# ListDatasets
<a name="API_ListDatasets"></a>

列出所有 DataBrew 数据集。

## 请求语法
<a name="API_ListDatasets_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListDatasets_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_ListDatasets_RequestSyntax) **   <a name="databrew-ListDatasets-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [NextToken](#API_ListDatasets_RequestSyntax) **   <a name="databrew-ListDatasets-request-uri-NextToken"></a>
先前调用返回的用于检索下一组结果的令牌。  
长度限制：最小长度为 1。最大长度为 2000。

## 请求正文
<a name="API_ListDatasets_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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"
}
```

## 响应元素
<a name="API_ListDatasets_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Datasets](#API_ListDatasets_ResponseSyntax) **   <a name="databrew-ListDatasets-response-Datasets"></a>
已定义的数据集列表。  
类型：[Dataset](API_Dataset.md) 对象数组

 ** [NextToken](#API_ListDatasets_ResponseSyntax) **   <a name="databrew-ListDatasets-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListDatasets_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListDatasets_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListDatasets) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListDatasets) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListDatasets) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListDatasets) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListDatasets) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListDatasets) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListDatasets) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListDatasets) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListDatasets) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListDatasets) 

# ListJobRuns
<a name="API_ListJobRuns"></a>

列出特定 DataBrew 作业之前的所有运行情况。

## 请求语法
<a name="API_ListJobRuns_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListJobRuns_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_ListJobRuns_RequestSyntax) **   <a name="databrew-ListJobRuns-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [name](#API_ListJobRuns_RequestSyntax) **   <a name="databrew-ListJobRuns-request-uri-Name"></a>
 作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

 ** [NextToken](#API_ListJobRuns_RequestSyntax) **   <a name="databrew-ListJobRuns-request-uri-NextToken"></a>
先前调用返回的用于检索下一组结果的令牌。  
长度限制：最小长度为 1。最大长度为 2000。

## 请求正文
<a name="API_ListJobRuns_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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"
}
```

## 响应元素
<a name="API_ListJobRuns_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [JobRuns](#API_ListJobRuns_ResponseSyntax) **   <a name="databrew-ListJobRuns-response-JobRuns"></a>
针对指定作业发生的作业运行列表。  
类型：[JobRun](API_JobRun.md) 对象数组

 ** [NextToken](#API_ListJobRuns_ResponseSyntax) **   <a name="databrew-ListJobRuns-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListJobRuns_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListJobRuns_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListJobRuns) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListJobRuns) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListJobRuns) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListJobRuns) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListJobRuns) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListJobRuns) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListJobRuns) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListJobRuns) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListJobRuns) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListJobRuns) 

# ListJobs
<a name="API_ListJobs"></a>

列出所有已定义的 DataBrew 作业。

## 请求语法
<a name="API_ListJobs_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListJobs_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [DatasetName](#API_ListJobs_RequestSyntax) **   <a name="databrew-ListJobs-request-uri-DatasetName"></a>
数据集的名称。使用此参数指示仅返回那些作用于指定数据集的作业。  
长度约束：最小长度为 1。最大长度为 255。

 ** [MaxResults](#API_ListJobs_RequestSyntax) **   <a name="databrew-ListJobs-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [NextToken](#API_ListJobs_RequestSyntax) **   <a name="databrew-ListJobs-request-uri-NextToken"></a>
由生成的令牌 DataBrew ，用于指定在之前的请求被截断时在哪里继续分页。要获取下一组页面，请传入上一页调用的响应对象中的 NextToken值。  
长度限制：最小长度为 1。最大长度为 2000。

 ** [ProjectName](#API_ListJobs_RequestSyntax) **   <a name="databrew-ListJobs-request-uri-ProjectName"></a>
项目的名称。使用此参数指示仅返回那些与指定项目关联的作业。  
长度约束：最小长度为 1。最大长度为 255。

## 请求正文
<a name="API_ListJobs_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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"
}
```

## 响应元素
<a name="API_ListJobs_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Jobs](#API_ListJobs_ResponseSyntax) **   <a name="databrew-ListJobs-response-Jobs"></a>
已定义的作业列表。  
类型：[Job](API_Job.md) 对象数组

 ** [NextToken](#API_ListJobs_ResponseSyntax) **   <a name="databrew-ListJobs-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListJobs_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListJobs_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListJobs) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListJobs) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListJobs) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListJobs) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListJobs) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListJobs) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListJobs) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListJobs) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListJobs) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListJobs) 

# ListProjects
<a name="API_ListProjects"></a>

列出所有已定义的 DataBrew 项目。

## 请求语法
<a name="API_ListProjects_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListProjects_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_ListProjects_RequestSyntax) **   <a name="databrew-ListProjects-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [NextToken](#API_ListProjects_RequestSyntax) **   <a name="databrew-ListProjects-request-uri-NextToken"></a>
先前调用返回的用于检索下一组结果的令牌。  
长度限制：最小长度为 1。最大长度为 2000。

## 请求正文
<a name="API_ListProjects_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
         }
      }
   ]
}
```

## 响应元素
<a name="API_ListProjects_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Projects](#API_ListProjects_ResponseSyntax) **   <a name="databrew-ListProjects-response-Projects"></a>
已定义的项目列表。  
类型：[Project](API_Project.md) 对象数组

 ** [NextToken](#API_ListProjects_ResponseSyntax) **   <a name="databrew-ListProjects-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListProjects_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListProjects_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListProjects) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListProjects) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListProjects) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListProjects) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListProjects) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListProjects) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListProjects) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListProjects) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListProjects) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListProjects) 

# ListRecipes
<a name="API_ListRecipes"></a>

列出所有已定义的 DataBrew 配方。

## 请求语法
<a name="API_ListRecipes_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListRecipes_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_ListRecipes_RequestSyntax) **   <a name="databrew-ListRecipes-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [NextToken](#API_ListRecipes_RequestSyntax) **   <a name="databrew-ListRecipes-request-uri-NextToken"></a>
先前调用返回的用于检索下一组结果的令牌。  
长度限制：最小长度为 1。最大长度为 2000。

 ** [RecipeVersion](#API_ListRecipes_RequestSyntax) **   <a name="databrew-ListRecipes-request-uri-RecipeVersion"></a>
仅返回版本标识符为 `LATEST_WORKING` 或 `LATEST_PUBLISHED` 的配方。如果忽略 `RecipeVersion`，`ListRecipes` 将返回所有 `LATEST_PUBLISHED` 配方版本。  
有效值：`LATEST_WORKING` \$1 `LATEST_PUBLISHED`   
长度限制：最小长度为 1。最大长度为 16。

## 请求正文
<a name="API_ListRecipes_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
         }
      }
   ]
}
```

## 响应元素
<a name="API_ListRecipes_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Recipes](#API_ListRecipes_ResponseSyntax) **   <a name="databrew-ListRecipes-response-Recipes"></a>
已定义的配方列表。  
类型：[Recipe](API_Recipe.md) 对象数组

 ** [NextToken](#API_ListRecipes_ResponseSyntax) **   <a name="databrew-ListRecipes-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListRecipes_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListRecipes_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListRecipes) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListRecipes) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListRecipes) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListRecipes) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListRecipes) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListRecipes) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListRecipes) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListRecipes) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListRecipes) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListRecipes) 

# ListRecipeVersions
<a name="API_ListRecipeVersions"></a>

列出特定 DataBrew 配方的版本，但以下版本除外`LATEST_WORKING`。

## 请求语法
<a name="API_ListRecipeVersions_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListRecipeVersions_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_ListRecipeVersions_RequestSyntax) **   <a name="databrew-ListRecipeVersions-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [Name](#API_ListRecipeVersions_RequestSyntax) **   <a name="databrew-ListRecipeVersions-request-uri-Name"></a>
要返回其版本信息的配方的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

 ** [NextToken](#API_ListRecipeVersions_RequestSyntax) **   <a name="databrew-ListRecipeVersions-request-uri-NextToken"></a>
先前调用返回的用于检索下一组结果的令牌。  
长度限制：最小长度为 1。最大长度为 2000。

## 请求正文
<a name="API_ListRecipeVersions_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
         }
      }
   ]
}
```

## 响应元素
<a name="API_ListRecipeVersions_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Recipes](#API_ListRecipeVersions_ResponseSyntax) **   <a name="databrew-ListRecipeVersions-response-Recipes"></a>
指定配方的版本列表。  
类型：[Recipe](API_Recipe.md) 对象数组

 ** [NextToken](#API_ListRecipeVersions_ResponseSyntax) **   <a name="databrew-ListRecipeVersions-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListRecipeVersions_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListRecipeVersions_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListRecipeVersions) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListRecipeVersions) 

# ListRulesets
<a name="API_ListRulesets"></a>

列出当前账户中可用的所有规则集或与特定资源（数据集）关联的规则集。

## 请求语法
<a name="API_ListRulesets_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListRulesets_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_ListRulesets_RequestSyntax) **   <a name="databrew-ListRulesets-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [NextToken](#API_ListRulesets_RequestSyntax) **   <a name="databrew-ListRulesets-request-uri-NextToken"></a>
由生成的令牌 DataBrew ，用于指定在之前的请求被截断时在哪里继续分页。要获取下一组页面，请传入上一页调用的响应对象中的 NextToken 值。  
长度限制：最小长度为 1。最大长度为 2000。

 ** [TargetArn](#API_ListRulesets_RequestSyntax) **   <a name="databrew-ListRulesets-request-uri-TargetArn"></a>
资源（数据集）的 Amazon 资源名称（ARN）。使用此参数指示仅返回那些与指定资源关联的规则集。  
长度约束：最小长度为 20。最大长度为 2048。

## 请求正文
<a name="API_ListRulesets_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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"
      }
   ]
}
```

## 响应元素
<a name="API_ListRulesets_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Rulesets](#API_ListRulesets_ResponseSyntax) **   <a name="databrew-ListRulesets-response-Rulesets"></a>
清单 RulesetItem. RulesetItem 包含规则集的元数据。  
类型：[RulesetItem](API_RulesetItem.md) 对象数组

 ** [NextToken](#API_ListRulesets_ResponseSyntax) **   <a name="databrew-ListRulesets-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListRulesets_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListRulesets_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListRulesets) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListRulesets) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListRulesets) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListRulesets) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListRulesets) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListRulesets) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListRulesets) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListRulesets) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListRulesets) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListRulesets) 

# ListSchedules
<a name="API_ListSchedules"></a>

列出已定义的 DataBrew 计划。

## 请求语法
<a name="API_ListSchedules_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListSchedules_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [JobName](#API_ListSchedules_RequestSyntax) **   <a name="databrew-ListSchedules-request-uri-JobName"></a>
这些计划应用于的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。

 ** [MaxResults](#API_ListSchedules_RequestSyntax) **   <a name="databrew-ListSchedules-request-uri-MaxResults"></a>
此请求中要返回的最大结果数。  
有效范围：最小值为 1。最大值为 100。

 ** [NextToken](#API_ListSchedules_RequestSyntax) **   <a name="databrew-ListSchedules-request-uri-NextToken"></a>
先前调用返回的用于检索下一组结果的令牌。  
长度限制：最小长度为 1。最大长度为 2000。

## 请求正文
<a name="API_ListSchedules_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<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" 
         }
      }
   ]
}
```

## 响应元素
<a name="API_ListSchedules_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Schedules](#API_ListSchedules_ResponseSyntax) **   <a name="databrew-ListSchedules-response-Schedules"></a>
已定义的计划列表。  
类型：[Schedule](API_Schedule.md) 对象数组

 ** [NextToken](#API_ListSchedules_ResponseSyntax) **   <a name="databrew-ListSchedules-response-NextToken"></a>
可在后续调用中用于检索下一组结果的令牌。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2000。

## 错误
<a name="API_ListSchedules_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListSchedules_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListSchedules) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListSchedules) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListSchedules) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListSchedules) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListSchedules) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListSchedules) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListSchedules) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListSchedules) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListSchedules) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListSchedules) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

列出 DataBrew 资源的所有标签。

## 请求语法
<a name="API_ListTagsForResource_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_ListTagsForResource_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="databrew-ListTagsForResource-request-uri-ResourceArn"></a>
唯一标识资源的亚马逊资源名称 (ARN) 字符串。 DataBrew   
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

## 请求体
<a name="API_ListTagsForResource_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_ListTagsForResource_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_ListTagsForResource_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="databrew-ListTagsForResource-response-Tags"></a>
与 DataBrew 资源关联的标签列表。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

## 错误
<a name="API_ListTagsForResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InternalServerException **   
出现内部服务故障。  
HTTP 状态代码：500

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListTagsForResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/ListTagsForResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/ListTagsForResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/ListTagsForResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/ListTagsForResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/ListTagsForResource) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/ListTagsForResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/ListTagsForResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/ListTagsForResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/ListTagsForResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/ListTagsForResource) 

# PublishRecipe
<a name="API_PublishRecipe"></a>

发布 DataBrew 食谱的新版本。

## 请求语法
<a name="API_PublishRecipe_RequestSyntax"></a>

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

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

## URI 请求参数
<a name="API_PublishRecipe_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_PublishRecipe_RequestSyntax) **   <a name="databrew-PublishRecipe-request-uri-Name"></a>
要发布的配方的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_PublishRecipe_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Description](#API_PublishRecipe_RequestSyntax) **   <a name="databrew-PublishRecipe-request-Description"></a>
要为此版本配方发布的配方的描述。  
类型：字符串  
长度限制：最大长度为 1024。  
必需：否

## 响应语法
<a name="API_PublishRecipe_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_PublishRecipe_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_PublishRecipe_ResponseSyntax) **   <a name="databrew-PublishRecipe-response-Name"></a>
您发布的配方的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_PublishRecipe_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_PublishRecipe_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/PublishRecipe) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/PublishRecipe) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/PublishRecipe) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/PublishRecipe) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/PublishRecipe) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/PublishRecipe) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/PublishRecipe) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/PublishRecipe) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/PublishRecipe) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/PublishRecipe) 

# SendProjectSessionAction
<a name="API_SendProjectSessionAction"></a>

在当前打开的交互式 DataBrew 会话中执行配方步骤。

## 请求语法
<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 请求参数
<a name="API_SendProjectSessionAction_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-uri-Name"></a>
要将操作应用到的项目的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_SendProjectSessionAction_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [ClientSessionId](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-ClientSessionId"></a>
当前已打开并可供使用的交互式会话的唯一标识符。将在此会话中执行操作。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9-]*$`  
必需：否

 ** [Preview](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-Preview"></a>
如果为 true，才会返回配方步骤的结果，但不会应用。  
类型：布尔值  
必需：否

 ** [RecipeStep](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-RecipeStep"></a>
表示要执行的 DataBrew 配方中的一个步骤。  
类型：[RecipeStep](API_RecipeStep.md) 对象  
必需：否

 ** [StepIndex](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-StepIndex"></a>
用于预览步骤的索引。此索引用于预览已经应用的步骤的结果，因此生成的视图帧来自视图帧堆栈中更早的位置。  
类型：整数  
有效范围：最小值为 0。  
必需：否

 ** [ViewFrame](#API_SendProjectSessionAction_RequestSyntax) **   <a name="databrew-SendProjectSessionAction-request-ViewFrame"></a>
表示操作期间正在转换的数据。  
类型：[ViewFrame](API_ViewFrame.md) 对象  
必需：否

## 响应语法
<a name="API_SendProjectSessionAction_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_SendProjectSessionAction_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_SendProjectSessionAction_ResponseSyntax) **   <a name="databrew-SendProjectSessionAction-response-Name"></a>
受操作影响的项目的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [ActionId](#API_SendProjectSessionAction_ResponseSyntax) **   <a name="databrew-SendProjectSessionAction-response-ActionId"></a>
所执行操作的唯一标识符。  
类型：整数

 ** [Result](#API_SendProjectSessionAction_ResponseSyntax) **   <a name="databrew-SendProjectSessionAction-response-Result"></a>
一条消息，指示执行操作的结果。  
类型：字符串

## 错误
<a name="API_SendProjectSessionAction_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_SendProjectSessionAction_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/SendProjectSessionAction) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/SendProjectSessionAction) 

# StartJobRun
<a name="API_StartJobRun"></a>

运行作 DataBrew 业。

## 请求语法
<a name="API_StartJobRun_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_StartJobRun_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_StartJobRun_RequestSyntax) **   <a name="databrew-StartJobRun-request-uri-Name"></a>
要运行的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

## 请求体
<a name="API_StartJobRun_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_StartJobRun_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_StartJobRun_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [RunId](#API_StartJobRun_ResponseSyntax) **   <a name="databrew-StartJobRun-response-RunId"></a>
系统针对此特定作业运行生成的标识符。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_StartJobRun_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_StartJobRun_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/StartJobRun) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/StartJobRun) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StartJobRun) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/StartJobRun) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StartJobRun) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/StartJobRun) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/StartJobRun) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/StartJobRun) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/StartJobRun) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/StartJobRun) 

# StartProjectSession
<a name="API_StartProjectSession"></a>

创建交互式会话，使您能够操作 DataBrew项目中的数据。

## 请求语法
<a name="API_StartProjectSession_RequestSyntax"></a>

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

{
   "AssumeControl": boolean
}
```

## URI 请求参数
<a name="API_StartProjectSession_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_StartProjectSession_RequestSyntax) **   <a name="databrew-StartProjectSession-request-uri-Name"></a>
要执行操作的项目的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_StartProjectSession_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [AssumeControl](#API_StartProjectSession_RequestSyntax) **   <a name="databrew-StartProjectSession-request-AssumeControl"></a>
此值如果为 true，则使您可以控制会话，即使当前有其他客户端正在访问该项目。  
类型：布尔值  
必需：否

## 响应语法
<a name="API_StartProjectSession_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_StartProjectSession_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_StartProjectSession_ResponseSyntax) **   <a name="databrew-StartProjectSession-response-Name"></a>
要执行操作的项目的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [ClientSessionId](#API_StartProjectSession_ResponseSyntax) **   <a name="databrew-StartProjectSession-response-ClientSessionId"></a>
系统为会话生成的标识符。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9-]*$`

## 错误
<a name="API_StartProjectSession_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_StartProjectSession_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/StartProjectSession) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/StartProjectSession) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StartProjectSession) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/StartProjectSession) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StartProjectSession) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/StartProjectSession) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/StartProjectSession) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/StartProjectSession) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/StartProjectSession) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/StartProjectSession) 

# StopJobRun
<a name="API_StopJobRun"></a>

停止作业的特定运行。

## 请求语法
<a name="API_StopJobRun_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_StopJobRun_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_StopJobRun_RequestSyntax) **   <a name="databrew-StopJobRun-request-uri-Name"></a>
要停止的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

 ** [runId](#API_StopJobRun_RequestSyntax) **   <a name="databrew-StopJobRun-request-uri-RunId"></a>
要停止的作业运行的 ID。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_StopJobRun_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_StopJobRun_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_StopJobRun_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [RunId](#API_StopJobRun_ResponseSyntax) **   <a name="databrew-StopJobRun-response-RunId"></a>
您停止的作业运行的 ID。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_StopJobRun_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_StopJobRun_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/StopJobRun) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/StopJobRun) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/StopJobRun) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/StopJobRun) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/StopJobRun) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/StopJobRun) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/StopJobRun) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/StopJobRun) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/StopJobRun) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/StopJobRun) 

# TagResource
<a name="API_TagResource"></a>

向 DataBrew 资源添加元数据标签，例如数据集、项目、配方、作业或计划。

## 请求语法
<a name="API_TagResource_RequestSyntax"></a>

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

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

## URI 请求参数
<a name="API_TagResource_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="databrew-TagResource-request-uri-ResourceArn"></a>
应向其添加标签的 DataBrew 资源。此参数的值是 Amazon 资源名称（ARN）。对于 DataBrew，您可以为数据集、作业、项目或配方添加标签。  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

## 请求体
<a name="API_TagResource_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="databrew-TagResource-request-Tags"></a>
要分配给资源的一个或多个标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。  
是否必需：是

## 响应语法
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 响应元素
<a name="API_TagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_TagResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InternalServerException **   
出现内部服务故障。  
HTTP 状态代码：500

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_TagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/TagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/TagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/TagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/TagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/TagResource) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/TagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/TagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/TagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/TagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

从 DataBrew 资源中移除元数据标签。

## 请求语法
<a name="API_UntagResource_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_UntagResource_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="databrew-UntagResource-request-uri-ResourceArn"></a>
要从中移除一个或多个标签的 DataBrew 资源。此参数的值是 Amazon 资源名称（ARN）。  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="databrew-UntagResource-request-uri-TagKeys"></a>
要删除的一个或多个标签的标签键（名称）。  
数组成员：最少 1 个物品。最多 200 项。  
长度限制：最小长度为 1。最大长度为 128。  
是否必需：是

## 请求体
<a name="API_UntagResource_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 响应元素
<a name="API_UntagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_UntagResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InternalServerException **   
出现内部服务故障。  
HTTP 状态代码：500

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UntagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UntagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UntagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UntagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UntagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UntagResource) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UntagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UntagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UntagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UntagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UntagResource) 

# UpdateDataset
<a name="API_UpdateDataset"></a>

修改现有 DataBrew 数据集的定义。

## 请求语法
<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 请求参数
<a name="API_UpdateDataset_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-uri-Name"></a>
要更新的数据集的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_UpdateDataset_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Input](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-Input"></a>
表示有关 DataBrew 如何在 Amazon S3 AWS Glue Data Catalog 或 Amazon S3 中查找数据的信息。  
类型：[Input](API_Input.md) 对象  
是否必需：是

 ** [Format](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-Format"></a>
从 Amazon S3 文件或文件夹创建的数据集的文件格式。  
类型：字符串  
有效值：`CSV | JSON | PARQUET | EXCEL | ORC`  
必需：否

 ** [FormatOptions](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-FormatOptions"></a>
表示一组选项，这些选项用于定义逗号分隔值（CSV）、Excel 或 JSON 输入的结构。  
类型：[FormatOptions](API_FormatOptions.md) 对象  
必需：否

 ** [PathOptions](#API_UpdateDataset_RequestSyntax) **   <a name="databrew-UpdateDataset-request-PathOptions"></a>
一组选项，用于定义如何 DataBrew 解释数据集的 Amazon S3 路径。  
类型：[PathOptions](API_PathOptions.md) 对象  
必需：否

## 响应语法
<a name="API_UpdateDataset_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_UpdateDataset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_UpdateDataset_ResponseSyntax) **   <a name="databrew-UpdateDataset-response-Name"></a>
您更新的数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_UpdateDataset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
对指定资源的访问被拒绝。  
HTTP 状态代码：403

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateDataset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateDataset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateDataset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateDataset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateDataset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateDataset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateDataset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateDataset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateDataset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateDataset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateDataset) 

# UpdateProfileJob
<a name="API_UpdateProfileJob"></a>

修改现有配置文件作业的定义。

## 请求语法
<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 请求参数
<a name="API_UpdateProfileJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-uri-Name"></a>
要更新的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

## 请求体
<a name="API_UpdateProfileJob_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [OutputLocation](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-OutputLocation"></a>
表示 Amazon S3 位置（存储桶名称、存储桶拥有者和对象密钥）， DataBrew 可以在其中读取输入数据或写入任务的输出。  
类型：[S3Location](API_S3Location.md) 对象  
是否必需：是

 ** [RoleArn](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-RoleArn"></a>
 DataBrew 运行任务时要假设的 AWS Identity and Access Management (IAM) 角色的亚马逊资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [Configuration](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-Configuration"></a>
配置文件作业的配置。用于选择列、进行评估并覆盖评估的默认参数。配置为 null 时，配置文件作业将使用默认设置运行。  
类型：[ProfileConfiguration](API_ProfileConfiguration.md) 对象  
必需：否

 ** [EncryptionKeyArn](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-EncryptionKeyArn"></a>
用于保护作业的加密密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
必需：否

 ** [EncryptionMode](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-EncryptionMode"></a>
作业的加密模式包括以下几种：  
+  `SSE-KMS`-使用由 AWS KMS管理的密钥进行服务器端加密。
+  `SSE-S3` - 使用 Amazon S3 托管密钥进行服务器端加密。
类型：字符串  
有效值：`SSE-KMS | SSE-S3`  
必需：否

 ** [JobSample](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-JobSample"></a>
仅配置文件作业的样本配置。确定要执行配置文件作业的行数。如果没有为分析作业提供 JobSample 值，则将使用默认值。模式参数的默认值为 CUSTOM\$1ROWS，大小参数的默认值为 20000。  
类型：[JobSample](API_JobSample.md) 对象  
必需：否

 ** [LogSubscription](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-LogSubscription"></a>
为任务启用或禁用 Amazon CloudWatch 日志记录。如果启用了日志记录，则为每个作业运行 CloudWatch 写入一个日志流。  
类型：字符串  
有效值：`ENABLE | DISABLE`  
必需：否

 ** [MaxCapacity](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-MaxCapacity"></a>
作业处理数据时 DataBrew 可使用的最大计算节点数。  
类型：整数  
必需：否

 ** [MaxRetries](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-MaxRetries"></a>
作业运行失败后重试此作业的最大次数。  
类型：整数  
有效范围：最小值为 0。  
必需：否

 ** [Timeout](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-Timeout"></a>
作业的超时（以分钟为单位）。如果作业的运行时间超出此超时时间，作业将以 `TIMEOUT` 状态结束。  
类型：整数  
有效范围：最小值为 0。  
必需：否

 ** [ValidationConfigurations](#API_UpdateProfileJob_RequestSyntax) **   <a name="databrew-UpdateProfileJob-request-ValidationConfigurations"></a>
应用于配置文件作业的验证配置列表。  
类型：[ValidationConfiguration](API_ValidationConfiguration.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

## 响应语法
<a name="API_UpdateProfileJob_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_UpdateProfileJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_UpdateProfileJob_ResponseSyntax) **   <a name="databrew-UpdateProfileJob-response-Name"></a>
已更新的作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

## 错误
<a name="API_UpdateProfileJob_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
对指定资源的访问被拒绝。  
HTTP 状态代码：403

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateProfileJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateProfileJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateProfileJob) 

# UpdateProject
<a name="API_UpdateProject"></a>

修改现有 DataBrew 项目的定义。

## 请求语法
<a name="API_UpdateProject_RequestSyntax"></a>

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

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

## URI 请求参数
<a name="API_UpdateProject_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_UpdateProject_RequestSyntax) **   <a name="databrew-UpdateProject-request-uri-Name"></a>
要更新的项目的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_UpdateProject_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [RoleArn](#API_UpdateProject_RequestSyntax) **   <a name="databrew-UpdateProject-request-RoleArn"></a>
要为此请求担任的 IAM 角色的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [Sample](#API_UpdateProject_RequestSyntax) **   <a name="databrew-UpdateProject-request-Sample"></a>
表示用于交互式数据分析 DataBrew 的样本数量和采样类型。  
类型：[Sample](API_Sample.md) 对象  
必需：否

## 响应语法
<a name="API_UpdateProject_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_UpdateProject_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_UpdateProject_ResponseSyntax) **   <a name="databrew-UpdateProject-response-Name"></a>
您更新的项目的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [LastModifiedDate](#API_UpdateProject_ResponseSyntax) **   <a name="databrew-UpdateProject-response-LastModifiedDate"></a>
上次修改项目的日期和时间。  
类型：时间戳

## 错误
<a name="API_UpdateProject_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateProject_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateProject) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateProject) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateProject) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateProject) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateProject) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateProject) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateProject) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateProject) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateProject) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateProject) 

# UpdateRecipe
<a name="API_UpdateRecipe"></a>

修改 DataBrew配方`LATEST_WORKING`版本的定义。

## 请求语法
<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 请求参数
<a name="API_UpdateRecipe_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_UpdateRecipe_RequestSyntax) **   <a name="databrew-UpdateRecipe-request-uri-Name"></a>
要更新的配方的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_UpdateRecipe_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Description](#API_UpdateRecipe_RequestSyntax) **   <a name="databrew-UpdateRecipe-request-Description"></a>
配方的描述。  
类型：字符串  
长度限制：最大长度为 1024。  
必需：否

 ** [Steps](#API_UpdateRecipe_RequestSyntax) **   <a name="databrew-UpdateRecipe-request-Steps"></a>
配方要执行的一个或多个步骤。每个步骤都由一个操作以及该操作的成功条件组成。  
类型：[RecipeStep](API_RecipeStep.md) 对象数组  
必需：否

## 响应语法
<a name="API_UpdateRecipe_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_UpdateRecipe_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_UpdateRecipe_ResponseSyntax) **   <a name="databrew-UpdateRecipe-response-Name"></a>
已更新的配方的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_UpdateRecipe_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateRecipe_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateRecipe) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateRecipe) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateRecipe) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateRecipe) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateRecipe) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateRecipe) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateRecipe) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateRecipe) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateRecipe) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateRecipe) 

# UpdateRecipeJob
<a name="API_UpdateRecipeJob"></a>

修改现有 DataBrew 配方任务的定义。

## 请求语法
<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 请求参数
<a name="API_UpdateRecipeJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-uri-Name"></a>
要更新的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

## 请求体
<a name="API_UpdateRecipeJob_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [RoleArn](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-RoleArn"></a>
 DataBrew 运行任务时要假设的 AWS Identity and Access Management (IAM) 角色的亚马逊资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
是否必需：是

 ** [DatabaseOutputs](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-DatabaseOutputs"></a>
表示 JDBC 数据库输出对象的列表，该对象定义了要写入的 DataBrew 配方作业的输出目标。  
类型：[DatabaseOutput](API_DatabaseOutput.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** [DataCatalogOutputs](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-DataCatalogOutputs"></a>
一个或多个工件，表示运行作业的 AWS Glue Data Catalog 输出。  
类型：[DataCatalogOutput](API_DataCatalogOutput.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** [EncryptionKeyArn](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-EncryptionKeyArn"></a>
用于保护作业的加密密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
必需：否

 ** [EncryptionMode](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-EncryptionMode"></a>
作业的加密模式包括以下几种：  
+  `SSE-KMS`-使用由 AWS KMS管理的密钥进行服务器端加密。
+  `SSE-S3` - 使用 Amazon S3 托管密钥进行服务器端加密。
类型：字符串  
有效值：`SSE-KMS | SSE-S3`  
必需：否

 ** [LogSubscription](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-LogSubscription"></a>
为任务启用或禁用 Amazon CloudWatch 日志记录。如果启用了日志记录，则为每个作业运行 CloudWatch 写入一个日志流。  
类型：字符串  
有效值：`ENABLE | DISABLE`  
必需：否

 ** [MaxCapacity](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-MaxCapacity"></a>
任务处理数据时 DataBrew 可以消耗的最大节点数。  
类型：整数  
必需：否

 ** [MaxRetries](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-MaxRetries"></a>
作业运行失败后重试此作业的最大次数。  
类型：整数  
有效范围：最小值为 0。  
必需：否

 ** [Outputs](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-Outputs"></a>
代表作业运行时 输出的一个或多个构件。  
类型：[Output](API_Output.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** [Timeout](#API_UpdateRecipeJob_RequestSyntax) **   <a name="databrew-UpdateRecipeJob-request-Timeout"></a>
作业的超时（以分钟为单位）。如果作业的运行时间超出此超时时间，作业将以 `TIMEOUT` 状态结束。  
类型：整数  
有效范围：最小值为 0。  
必需：否

## 响应语法
<a name="API_UpdateRecipeJob_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_UpdateRecipeJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_UpdateRecipeJob_ResponseSyntax) **   <a name="databrew-UpdateRecipeJob-response-Name"></a>
您更新的作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

## 错误
<a name="API_UpdateRecipeJob_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
对指定资源的访问被拒绝。  
HTTP 状态代码：403

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateRecipeJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateRecipeJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateRecipeJob) 

# UpdateRuleset
<a name="API_UpdateRuleset"></a>

更新指定的规则集。

## 请求语法
<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 请求参数
<a name="API_UpdateRuleset_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_UpdateRuleset_RequestSyntax) **   <a name="databrew-UpdateRuleset-request-uri-Name"></a>
要更新的规则集的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_UpdateRuleset_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Rules](#API_UpdateRuleset_RequestSyntax) **   <a name="databrew-UpdateRuleset-request-Rules"></a>
使用规则集定义的规则列表。规则包括一项或多项要对 DataBrew 数据集进行验证的校验。  
类型：[Rule](API_Rule.md) 对象数组  
数组成员：最少 1 个物品。  
是否必需：是

 ** [Description](#API_UpdateRuleset_RequestSyntax) **   <a name="databrew-UpdateRuleset-request-Description"></a>
规则集的描述。  
类型：字符串  
长度限制：最大长度为 1024。  
必需：否

## 响应语法
<a name="API_UpdateRuleset_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_UpdateRuleset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_UpdateRuleset_ResponseSyntax) **   <a name="databrew-UpdateRuleset-response-Name"></a>
更新的规则集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_UpdateRuleset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateRuleset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateRuleset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateRuleset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateRuleset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateRuleset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateRuleset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateRuleset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateRuleset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateRuleset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateRuleset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateRuleset) 

# UpdateSchedule
<a name="API_UpdateSchedule"></a>

修改现有 DataBrew 计划的定义。

## 请求语法
<a name="API_UpdateSchedule_RequestSyntax"></a>

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

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

## URI 请求参数
<a name="API_UpdateSchedule_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_UpdateSchedule_RequestSyntax) **   <a name="databrew-UpdateSchedule-request-uri-Name"></a>
要更新的计划的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_UpdateSchedule_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [CronExpression](#API_UpdateSchedule_RequestSyntax) **   <a name="databrew-UpdateSchedule-request-CronExpression"></a>
将要运行作业的日期或者日期和时间。有关更多信息，请参阅《* AWS Glue DataBrew 开发人员指南*[》中的 Cron 表达式](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html)。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 512。  
是否必需：是

 ** [JobNames](#API_UpdateSchedule_RequestSyntax) **   <a name="databrew-UpdateSchedule-request-JobNames"></a>
要为此计划运行的一个或多个作业的名称。  
类型：字符串数组  
数组成员：最多 50 项。  
长度限制：最小长度为 1。最大长度为 240。  
必需：否

## 响应语法
<a name="API_UpdateSchedule_ResponseSyntax"></a>

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

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

## 响应元素
<a name="API_UpdateSchedule_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Name](#API_UpdateSchedule_ResponseSyntax) **   <a name="databrew-UpdateSchedule-response-Name"></a>
已更新的计划的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

## 错误
<a name="API_UpdateSchedule_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
超出服务配额。  
HTTP 状态代码：402

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateSchedule_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/UpdateSchedule) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/UpdateSchedule) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/UpdateSchedule) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/UpdateSchedule) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/UpdateSchedule) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/UpdateSchedule) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/UpdateSchedule) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/UpdateSchedule) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/UpdateSchedule) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/UpdateSchedule) 