本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Data Quality API
<a name="aws-glue-api-data-quality-api"></a>

Data Quality API 描述資料品質類型，包含建立、刪除或更新資料品質規則集、執行和評估的 API。

## 資料類型
<a name="aws-glue-api-data-quality-api-objects"></a>
+ [DataSource 結構](#aws-glue-api-data-quality-api-DataSource)
+ [DataQualityRulesetListDetails 結構](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails)
+ [DataQualityTargetTable 結構](#aws-glue-api-data-quality-api-DataQualityTargetTable)
+ [DataQualityRulesetEvaluationRunDescription 結構](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription)
+ [DataQualityRulesetEvaluationRunFilter 結構](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter)
+ [DataQualityEvaluationRunAdditionalRunOptions 結構](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions)
+ [DataQualityRuleRecommendationRunDescription 結構](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription)
+ [DataQualityRuleRecommendationRunFilter 結構](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter)
+ [DataQualityResult 結構](#aws-glue-api-data-quality-api-DataQualityResult)
+ [DataQualityAnalyzerResult 結構](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult)
+ [DataQualityObservation 結構](#aws-glue-api-data-quality-api-DataQualityObservation)
+ [MetricBasedObservation 結構](#aws-glue-api-data-quality-api-MetricBasedObservation)
+ [DataQualityMetricValues 結構](#aws-glue-api-data-quality-api-DataQualityMetricValues)
+ [DataQualityRuleResult 結構](#aws-glue-api-data-quality-api-DataQualityRuleResult)
+ [DataQualityResultDescription 結構](#aws-glue-api-data-quality-api-DataQualityResultDescription)
+ [DataQualityResultFilterCriteria 結構](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria)
+ [DataQualityRulesetFilterCriteria 結構](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria)
+ [DataQualityAggregatedMetrics 結構](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics)
+ [StatisticAnnotation 結構](#aws-glue-api-data-quality-api-StatisticAnnotation)
+ [TimestampedInclusionAnnotation 結構](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation)
+ [AnnotationError 結構](#aws-glue-api-data-quality-api-AnnotationError)
+ [DatapointInclusionAnnotation 結構](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation)
+ [StatisticSummaryList 清單](#aws-glue-api-data-quality-api-StatisticSummaryList)
+ [StatisticSummary 結構](#aws-glue-api-data-quality-api-StatisticSummary)
+ [RunIdentifier 結構](#aws-glue-api-data-quality-api-RunIdentifier)
+ [StatisticModelResult 結構](#aws-glue-api-data-quality-api-StatisticModelResult)
+ [DataQualityGlueTable 結構](#aws-glue-api-data-quality-api-DataQualityGlueTable)

## DataSource 結構
<a name="aws-glue-api-data-quality-api-DataSource"></a>

您想要資料品質結果的資料來源 ( AWS Glue 資料表）。

**欄位**
+ `GlueTable` – [GlueTable](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GlueTable) 物件。

   AWS Glue 資料表。
+ `DataQualityGlueTable` – [DataQualityGlueTable](#aws-glue-api-data-quality-api-DataQualityGlueTable) 物件。

  Data Quality Operations 的 AWS Glue 資料表。

## DataQualityRulesetListDetails 結構
<a name="aws-glue-api-data-quality-api-DataQualityRulesetListDetails"></a>

描述 `GetDataQualityRuleset` 傳回的資料品質規則集。

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則集的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  資料品質規則集的描述。
+ `CreatedOn` – 時間戳記。

  建立資料品質規則集的日期和時間。
+ `LastModifiedOn` – 時間戳記。

  上次修改資料品質規則集的日期和時間。
+ `TargetTable` – [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 物件。

  代表 AWS Glue 資料表的物件。
+ `RecommendationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  從建議執行建立規則集時，會產生此執行 ID 以將兩者連結在一起。
+ `RuleCount` – 數字 (整數)。

  規則集中的規則數目。

## DataQualityTargetTable 結構
<a name="aws-glue-api-data-quality-api-DataQualityTargetTable"></a>

代表 AWS Glue 資料表的物件。

**欄位**
+ `TableName` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

   AWS Glue 資料表的名稱。
+ `DatabaseName` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

   AWS Glue 資料表存在的資料庫名稱。
+ `CatalogId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

   AWS Glue 資料表所在的目錄 ID。

## DataQualityRulesetEvaluationRunDescription 結構
<a name="aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription"></a>

描述資料品質規則集評估執行的結果。

**欄位**
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。
+ `Status` – UTF-8 字串 (有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`)。

  此回合的狀態。
+ `StartedOn` – 時間戳記。

  執行開始的日期和時間。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與執行相關聯的資料來源 ( AWS Glue 資料表）。

## DataQualityRulesetEvaluationRunFilter 結構
<a name="aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter"></a>

篩選條件。

**欄位**
+ `DataSource` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  根據與執行相關聯的資料來源 ( AWS Glue 資料表） 進行篩選。
+ `StartedBefore` – 時間戳記。

  依在此時間之前開始的執行篩選結果。
+ `StartedAfter` – 時間戳記。

  依在此時間之後開始的執行篩選結果。

## DataQualityEvaluationRunAdditionalRunOptions 結構
<a name="aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions"></a>

您可以為評估執行指定的其他執行選項。

**欄位**
+ `CloudWatchMetricsEnabled` – 布林值。

  是否要啟用 CloudWatch 指標。
+ `ResultsS3Prefix` – UTF-8 字串。

  用於存放結果的 Amazon S3 的字首。
+ `CompositeRuleEvaluationMethod` – UTF-8 字串 (有效值：`COLUMN` \$1 `ROW`)。

  將規則集中複合規則的評估方法設定為 ROW/COLUMN

## DataQualityRuleRecommendationRunDescription 結構
<a name="aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription"></a>

描述資料品質規則建議執行的結果。

**欄位**
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。
+ `Status` – UTF-8 字串 (有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`)。

  此回合的狀態。
+ `StartedOn` – 時間戳記。

  此執行開始時的日期和時間。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與建議執行相關聯的資料來源 (AWS Glue 資料表）。

## DataQualityRuleRecommendationRunFilter 結構
<a name="aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter"></a>

列出資料品質建議執行的篩選條件。

**欄位**
+ `DataSource` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  根據指定的資料來源 (AWS Glue 資料表） 進行篩選。
+ `StartedBefore` – 時間戳記。

  根據在提供時間之前開始的結果進行篩選。
+ `StartedAfter` – 時間戳記。

  根據在提供時間之後開始的結果進行篩選。

## DataQualityResult 結構
<a name="aws-glue-api-data-quality-api-DataQualityResult"></a>

描述資料品質結果。

**欄位**
+ `ResultId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質結果的唯一結果 ID。
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質結果的設定檔 ID。
+ `Score` – 數字 (double)，不可大於 1.0。

  彙總資料品質分數。表示通過的規則數目與規則總數的比率。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與資料品質結果相關聯的資料表 (若有)。
+ `RulesetName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的規則集名稱。
+ `EvaluationContext` – UTF-8 字串。

  在 AWS Glue Studio 中任務的內容中，畫布中的每個節點通常會被指派某種名稱，而資料品質節點將具有名稱。如果存在多個節點，`evaluationContext` 可以區分節點。
+ `StartedOn` – 時間戳記。

  此資料品質執行開始的日期和時間。
+ `CompletedOn` – 時間戳記。

  此資料品質執行完成的日期和時間。
+ `JobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務名稱 (若有)。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務執行 ID (若有)。
+ `RulesetEvaluationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  此資料品質結果的規則集評估的唯一執行 ID。
+ `RuleResults` – 一個 [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult) 物件陣列，不可超過 2000 個結構。

  代表每個規則結果的 `DataQualityRuleResult` 物件清單。
+ `AnalyzerResults` – 一個 [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult) 物件陣列，不可超過 2000 個結構。

  代表每個分析器結果的 `DataQualityAnalyzerResult` 物件清單。
+ `Observations` – [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) 物件陣列，不可超過 50 個結構。

  代表評估規則和分析器後產生的觀測值的 `DataQualityObservation` 物件清單。
+ `AggregatedMetrics` – [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics) 物件。

   `DataQualityAggregatedMetrics` 物件的摘要，顯示已處理的資料列和規則的總計數，包括根據資料列層級結果的通過/失敗統計資料。

## DataQualityAnalyzerResult 結構
<a name="aws-glue-api-data-quality-api-DataQualityAnalyzerResult"></a>

描述資料品質分析器的評估結果。

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質分析器的名稱。
+ `Description` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  資料品質分析器的描述。
+ `EvaluationMessage` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  評估訊息。
+ `EvaluatedMetrics` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是一個數字 (double)。

  與分析器評估關聯的指標映射。

## DataQualityObservation 結構
<a name="aws-glue-api-data-quality-api-DataQualityObservation"></a>

描述評估規則和分析器後產生的觀察。

**欄位**
+ `Description` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  資料品質觀察的描述。
+ `MetricBasedObservation` – [MetricBasedObservation](#aws-glue-api-data-quality-api-MetricBasedObservation) 物件。

  `MetricBasedObservation` 類型的物件，代表基於評估的資料品質指標的觀察。

## MetricBasedObservation 結構
<a name="aws-glue-api-data-quality-api-MetricBasedObservation"></a>

描述根據所評估資料品質指標產生的以指標為基礎的觀察。

**欄位**
+ `MetricName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於產生觀察的資料品質指標名稱。
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `MetricValues` – [DataQualityMetricValues](#aws-glue-api-data-quality-api-DataQualityMetricValues) 物件。

  `DataQualityMetricValues` 類型的物件，代表資料品質指標值的分析。
+ `NewRules` – UTF-8 字串陣列。

  根據資料品質指標值，在觀察中產生的新資料品質規則清單。

## DataQualityMetricValues 結構
<a name="aws-glue-api-data-quality-api-DataQualityMetricValues"></a>

根據歷史資料的分析，描述資料品質指標值。

**欄位**
+ `ActualValue` – 數字 (雙位數)。

  資料品質指標的實際值。
+ `ExpectedValue` – 數字 (雙位數)。

  根據歷史資料分析的資料品質指標的預期值。
+ `LowerLimit` – 數字 (雙位數)。

  根據歷史資料分析的資料品質指標值下限。
+ `UpperLimit` – 數字 (雙位數)。

  根據歷史資料分析的資料品質指標值上限。

## DataQualityRuleResult 結構
<a name="aws-glue-api-data-quality-api-DataQualityRuleResult"></a>

描述資料品質規則評估的結果。

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則的名稱。
+ `Description` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  資料品質規則的描述。
+ `EvaluationMessage` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  評估訊息。
+ `Result` – UTF-8 字串 (有效值：`PASS` \$1 `FAIL` \$1 `ERROR`)。

  規則的通過或失敗狀態。
+ `EvaluatedMetrics` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是一個數字 (double)。

  與規則評估相關聯的指標映射。
+ `EvaluatedRule` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  評估的規則。
+ `RuleMetrics` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是一個數字 (double)。

  包含與根據資料列層級結果評估規則關聯的指標的映射。

## DataQualityResultDescription 結構
<a name="aws-glue-api-data-quality-api-DataQualityResultDescription"></a>

描述資料品質結果。

**欄位**
+ `ResultId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  此資料品質結果的唯一結果 ID。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與資料品質結果相關聯的資料表名稱。
+ `JobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務名稱。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務執行 ID。
+ `StartedOn` – 時間戳記。

  此資料品質結果的執行開始時間。

## DataQualityResultFilterCriteria 結構
<a name="aws-glue-api-data-quality-api-DataQualityResultFilterCriteria"></a>

用於傳回資料品質結果的條件。

**欄位**
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  依指定的資料來源篩選結果。例如，擷取 AWS Glue 資料表的所有結果。
+ `JobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  依指定的任務名稱篩選結果。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  依指定的任務執行 ID 篩選結果。
+ `StartedAfter` – 時間戳記。

  依在此時間之後開始的執行篩選結果。
+ `StartedBefore` – 時間戳記。

  依在此時間之前開始的執行篩選結果。

## DataQualityRulesetFilterCriteria 結構
<a name="aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria"></a>

用於篩選資料品質規則集的條件。

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  規則集篩選條件的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  規則集篩選條件的描述。
+ `CreatedBefore` – 時間戳記。

  篩選在此日期之前建立的規則集。
+ `CreatedAfter` – 時間戳記。

  篩選在此日期之後建立的規則集。
+ `LastModifiedBefore` – 時間戳記。

  篩選在此日期之前最後一次修改的規則集。
+ `LastModifiedAfter` – 時間戳記。

  篩選在此日期之後最後一次修改的規則集。
+ `TargetTable` – [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 物件。

  目標資料表的名稱和資料庫名稱。

## DataQualityAggregatedMetrics 結構
<a name="aws-glue-api-data-quality-api-DataQualityAggregatedMetrics"></a>

指標的摘要，顯示已處理的資料列和規則的總計數，包括根據資料列層級結果的通過/失敗統計資料。

**欄位**
+ `TotalRowsProcessed` – 數字 (雙位數)。

  在資料品質評估期間處理的資料列總數。
+ `TotalRowsPassed` – 數字 (雙位數)。

  傳遞所有適用資料品質規則的資料列總數。
+ `TotalRowsFailed` – 數字 (雙位數)。

  使一個或多個資料品質規則失敗的資料列總數。
+ `TotalRulesProcessed` – 數字 (雙位數)。

  已評估的資料品質規則總數。
+ `TotalRulesPassed` – 數字 (雙位數)。

  通過評估條件的資料品質規則總數。
+ `TotalRulesFailed` – 數字 (雙位數)。

  未通過評估條件的資料品質規則總數。

## StatisticAnnotation 結構
<a name="aws-glue-api-data-quality-api-StatisticAnnotation"></a>

統計資料註釋。

**欄位**
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  設定檔 ID。
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `StatisticRecordedOn` – 時間戳記。

  記錄註釋統計資料時的時間戳記。
+ `InclusionAnnotation` – [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation) 物件。

  套用至統計資料的包含註釋。

## TimestampedInclusionAnnotation 結構
<a name="aws-glue-api-data-quality-api-TimestampedInclusionAnnotation"></a>

有時間戳記的包含註釋。

**欄位**
+ `Value` – UTF-8 字串 (有效值：`INCLUDE` \$1 `EXCLUDE`)。

  包含註釋值。
+ `LastModifiedOn` – 時間戳記。

  上次修改包含註釋時的時間戳記。

## AnnotationError 結構
<a name="aws-glue-api-data-quality-api-AnnotationError"></a>

失敗的註釋。

**欄位**
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  失敗註釋的設定檔 ID。
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  失敗註釋的統計資料 ID。
+ `FailureReason` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  註釋失敗的原因。

## DatapointInclusionAnnotation 結構
<a name="aws-glue-api-data-quality-api-DatapointInclusionAnnotation"></a>

包含註釋。

**欄位**
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料所屬的資料品質設定檔 ID。
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `InclusionAnnotation` – UTF-8 字串 (有效值：`INCLUDE` \$1 `EXCLUDE`)。

  要套用至統計資料的包含註釋值。

## StatisticSummaryList 清單
<a name="aws-glue-api-data-quality-api-StatisticSummaryList"></a>

`StatisticSummary` 的清單。

[StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary) 物件的陣列。

`StatisticSummary` 的清單。

## StatisticSummary 結構
<a name="aws-glue-api-data-quality-api-StatisticSummary"></a>

有關統計資料的摘要資訊。

**欄位**
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  設定檔 ID。
+ `RunIdentifier` – [RunIdentifier](#aws-glue-api-data-quality-api-RunIdentifier) 物件。

  執行識別碼
+ `StatisticName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Custom string pattern #16](aws-glue-api-common.md#regex_16)。

  統計資料的名稱。
+ `DoubleValue` – 數字 (雙位數)。

  統計資料的值。
+ `EvaluationLevel` – UTF-8 字串 (有效值：`Dataset="DATASET"` \$1 `Column="COLUMN"` \$1 `Multicolumn="MULTICOLUMN"`)。

  統計資料的評估層級。可能的值：`Dataset`、`Column`、`Multicolumn`。
+ `ColumnsReferenced` – UTF-8 字串陣列。

  統計資料參考的資料欄清單。
+ `ReferencedDatasets` – UTF-8 字串陣列。

  統計資料參考的資料集清單。
+ `StatisticProperties` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是描述字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  `StatisticPropertiesMap`，其中包含 `NameString` 和 `DescriptionString`
+ `RecordedOn` – 時間戳記。

  記錄統計資料時的時間戳記。
+ `InclusionAnnotation` – [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation) 物件。

  統計資料的包含註釋。

## RunIdentifier 結構
<a name="aws-glue-api-data-quality-api-RunIdentifier"></a>

執行識別碼。

**欄位**
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  規則 ID。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  任務執行 ID。

## StatisticModelResult 結構
<a name="aws-glue-api-data-quality-api-StatisticModelResult"></a>

統計模型結果。

**欄位**
+ `LowerBound` – 數字 (雙位數)。

  下限。
+ `UpperBound` – 數字 (雙位數)。

  上限。
+ `PredictedValue` – 數字 (雙位數)。

  預測值。
+ `ActualValue` – 數字 (雙位數)。

  實際值。
+ `Date` – 時間戳記。

  日期。
+ `InclusionAnnotation` – UTF-8 字串 (有效值：`INCLUDE` \$1 `EXCLUDE`)。

  包含註釋。

## DataQualityGlueTable 結構
<a name="aws-glue-api-data-quality-api-DataQualityGlueTable"></a>

中 AWS Glue Data Catalog 用於 Data Quality Operations 輸入或輸出資料的資料庫和資料表。

**欄位**
+ `DatabaseName` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

   AWS Glue Data Catalog中的資料庫名稱。
+ `TableName` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

   AWS Glue Data Catalog中的資料表名稱。
+ `CatalogId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

   AWS Glue Data Catalog的唯一識別符。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連至 AWS Glue Data Catalog的連線名稱。
+ `AdditionalOptions` – 金鑰值對的映射陣列，不少於 1 對，也不可大於 10 對。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是描述字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  資料表的其他選項。目前支援兩個金鑰：
  + `pushDownPredicate`：篩選分割區，而無需列出和讀取資料集中的所有檔案。
  + `catalogPartitionPredicate`：使用 AWS Glue Data Catalog中的分割區索引以進行伺服器端分割區清理。
+ `PreProcessingQuery` – UTF-8 字串，長度不可超過 51200 個位元組，需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  SQL Query of SparkSQL 格式，可用於在執行資料品質操作 AWS Glue Data Catalog之前預先處理 中資料表的資料。

## 作業
<a name="aws-glue-api-data-quality-api-actions"></a>
+ [StartDataQualityRulesetEvaluationRun 動作 (Python：start\$1data\$1quality\$1ruleset\$1evaluation\$1run)](#aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun)
+ [CancelDataQualityRulesetEvaluationRun 行動 (Python：cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run)](#aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun)
+ [GetDataQualityRulesetEvaluationRun 動作 (Python：get\$1data\$1quality\$1ruleset\$1evaluation\$1run)](#aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun)
+ [ListDataQualityRulesetEvaluationRuns 動作 (Python：list\$1data\$1quality\$1ruleset\$1evaluation\$1runs)](#aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns)
+ [StartDataQualityRuleRecommendationRun 動作 (Python：start\$1data\$1quality\$1rule\$1recommendation\$1run)](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun)
+ [CancelDataQualityRuleRecommendationRun 動作 (Python：cancel\$1data\$1quality\$1rule\$1recommendation\$1run)](#aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun)
+ [GetDataQualityRuleRecommendationRun 動作 (Python：get\$1data\$1quality\$1rule\$1recommendation\$1run)](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun)
+ [ListDataQualityRuleRecommendationRuns 動作 (Python：list\$1data\$1quality\$1rule\$1recommendation\$1runs)](#aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns)
+ [GetDataQualityResult 動作 (Python：get\$1data\$1quality\$1result)](#aws-glue-api-data-quality-api-GetDataQualityResult)
+ [BatchGetDataQualityResult 動作 (Python：batch\$1get\$1data\$1quality\$1result)](#aws-glue-api-data-quality-api-BatchGetDataQualityResult)
+ [ListDataQualityResults 動作 (Python：list\$1data\$1quality\$1results)](#aws-glue-api-data-quality-api-ListDataQualityResults)
+ [CreateDataQualityRuleset 動作 (Python：create\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-CreateDataQualityRuleset)
+ [DeleteDataQualityRuleset 動作 (Python：delete\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-DeleteDataQualityRuleset)
+ [GetDataQualityRuleset 動作 (Python：get\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-GetDataQualityRuleset)
+ [ListDataQualityRulesets 動作 (Python：list\$1data\$1quality\$1rulesets)](#aws-glue-api-data-quality-api-ListDataQualityRulesets)
+ [UpdateDataQualityRuleset 動作 (Python：update\$1data\$1quality\$1ruleset)](#aws-glue-api-data-quality-api-UpdateDataQualityRuleset)
+ [ListDataQualityStatistics 動作 (Python：list\$1data\$1quality\$1statistics)](#aws-glue-api-data-quality-api-ListDataQualityStatistics)
+ [TimestampFilter 結構](#aws-glue-api-data-quality-api-TimestampFilter)
+ [CreateDataQualityRulesetRequest 結構](#aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest)
+ [GetDataQualityRulesetResponse 結構](#aws-glue-api-data-quality-api-GetDataQualityRulesetResponse)
+ [GetDataQualityResultResponse 結構](#aws-glue-api-data-quality-api-GetDataQualityResultResponse)
+ [StartDataQualityRuleRecommendationRunRequest 結構](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest)
+ [GetDataQualityRuleRecommendationRunResponse 結構](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse)
+ [BatchPutDataQualityStatisticAnnotation 動作 (Python：batch\$1put\$1data\$1quality\$1statistic\$1annotation)](#aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation)
+ [GetDataQualityModel 動作 (Python：get\$1data\$1quality\$1model)](#aws-glue-api-data-quality-api-GetDataQualityModel)
+ [GetDataQualityModelResult 動作 (Python：get\$1data\$1quality\$1model\$1result)](#aws-glue-api-data-quality-api-GetDataQualityModelResult)
+ [ListDataQualityStatisticAnnotations 動作 (Python：list\$1data\$1quality\$1statistic\$1annotations)](#aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations)
+ [PutDataQualityProfileAnnotation 動作 (Python：put\$1data\$1quality\$1profile\$1annotation)](#aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation)

## StartDataQualityRulesetEvaluationRun 動作 (Python：start\$1data\$1quality\$1ruleset\$1evaluation\$1run)
<a name="aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun"></a>

擁有規則集定義 （建議或您自己的定義） 後，您可以呼叫此操作，根據資料來源 (AWS Glue 資料表） 評估規則集。評估會計算您可以使用 `GetDataQualityResult` API 擷取的結果。

**請求**
+ `DataSource` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 (AWS Glue 資料表）。
+ `Role` – *必要：*UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (48 小時)。
+ `ClientToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於等冪性且建議將其設定為隨機 ID（例如 UUID），避免建立或啟動同一資源的多個執行個體。
+ `AdditionalRunOptions` – [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions) 物件。

  您可以為評估執行指定的其他執行選項。
+ `RulesetNames` – *必要：*UTF-8 字串的陣列，不可小於 1，也不可超過 10 個字串。

  規則集名稱清單。
+ `AdditionalDataSources` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是 [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  您可以為評估執行指定的其他資料來源的參考字串映射。

**回應**
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。

**錯誤**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConflictException`

## CancelDataQualityRulesetEvaluationRun 行動 (Python：cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run)
<a name="aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun"></a>

取消正針對資料來源評估規則集的執行。

**請求**
+ `RunId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。

**回應**
+ *無回應參數。*

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityRulesetEvaluationRun 動作 (Python：get\$1data\$1quality\$1ruleset\$1evaluation\$1run)
<a name="aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun"></a>

擷取針對資料來源評估規則集的特定執行。

**請求**
+ `RunId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。

**回應**
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此評估執行相關聯的資料來源 ( AWS Glue 資料表）。
+ `Role` – UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (48 小時)。
+ `AdditionalRunOptions` – [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions) 物件。

  您可以為評估執行指定的其他執行選項。
+ `Status` – UTF-8 字串 (有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`)。

  此回合的狀態。
+ `ErrorString` – UTF-8 字串。

  與任務執行相關聯的錯誤字串。
+ `StartedOn` – 時間戳記。

  此執行開始時的日期和時間。
+ `LastModifiedOn` – 時間戳記。

  時間戳記。修改此資料品質規則建議執行的最後一個時間點。
+ `CompletedOn` – 時間戳記。

  此任務執行完成的日期和時間。
+ `ExecutionTime` – 數字 (整數)。

  執行消耗資源所需的時間 (以秒為單位)。
+ `RulesetNames` – UTF-8 字串的陣列，不可小於 1，也不可超過 10 個字串。

  執行規則集名稱清單。此參數目前僅採用一個規則集名稱。
+ `ResultIds` – UTF-8 字串的陣列，不可小於 1，也不可超過 10 個字串。

  執行的資料品質結果的結果 ID 清單。
+ `AdditionalDataSources` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是 [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  您可以為評估執行指定的其他資料來源的參考字串映射。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityRulesetEvaluationRuns 動作 (Python：list\$1data\$1quality\$1ruleset\$1evaluation\$1runs)
<a name="aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns"></a>

列出符合篩選條件的所有執行，即針對資料來源評估規則集的執行。

**請求**
+ `Filter` – [DataQualityRulesetEvaluationRunFilter](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter) 物件。

  篩選條件。
+ `NextToken` – UTF-8 字串。

  位移結果的分頁字符。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回傳結果的數量上限。

**回應**
+ `Runs` – 一個 [DataQualityRulesetEvaluationRunDescription](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription) 物件陣列。

  代表資料品質規則集執行的 `DataQualityRulesetEvaluationRunDescription` 物件清單。
+ `NextToken` – UTF-8 字串。

  如有多個結果可用，即為分頁字符。

**錯誤**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## StartDataQualityRuleRecommendationRun 動作 (Python：start\$1data\$1quality\$1rule\$1recommendation\$1run)
<a name="aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun"></a>

當您不知道要寫入哪些規則時， 會啟動用來產生規則的建議執行。 AWS Glue Data Quality 會分析資料，並提出潛在規則集的建議。然後，您可以對規則集進行分類，並根據自己的喜好修改生成的規則集。

系統會在 90 天後自動刪除建議執行。

**請求**

Data Quality 規則建議請求的請求。
+ `DataSource` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 (AWS Glue 資料表）。
+ `Role` – *必要：*UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (48 小時)。
+ `CreatedRulesetName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  規則集的名稱。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。
+ `ClientToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於等冪性且建議將其設定為隨機 ID（例如 UUID），避免建立或啟動同一資源的多個執行個體。

**回應**
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。

**錯誤**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConflictException`

## CancelDataQualityRuleRecommendationRun 動作 (Python：cancel\$1data\$1quality\$1rule\$1recommendation\$1run)
<a name="aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun"></a>

取消用於產生規則的指定建議執行。

**請求**
+ `RunId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。

**回應**
+ *無回應參數。*

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityRuleRecommendationRun 動作 (Python：get\$1data\$1quality\$1rule\$1recommendation\$1run)
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun"></a>

取得用來產生規則的指定建議執行。

**請求**
+ `RunId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。

**回應**

Data Quality 規則建議執行的回應。
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 ( AWS Glue 資料表）。
+ `Role` – UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (48 小時)。
+ `Status` – UTF-8 字串 (有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`)。

  此回合的狀態。
+ `ErrorString` – UTF-8 字串。

  與任務執行相關聯的錯誤字串。
+ `StartedOn` – 時間戳記。

  此執行開始時的日期和時間。
+ `LastModifiedOn` – 時間戳記。

  時間戳記。修改此資料品質規則建議執行的最後一個時間點。
+ `CompletedOn` – 時間戳記。

  此任務執行完成的日期和時間。
+ `ExecutionTime` – 數字 (整數)。

  執行消耗資源所需的時間 (以秒為單位)。
+ `RecommendedRuleset` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  當啟動規則建議執行完成時，會建立建議的規則集 (一組規則)。此成員具有資料品質定義語言 (DQDL) 格式的規則。
+ `CreatedRulesetName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  執行建立的規則集的名稱。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityRuleRecommendationRuns 動作 (Python：list\$1data\$1quality\$1rule\$1recommendation\$1runs)
<a name="aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns"></a>

列出符合篩選條件的建議執行。

**請求**
+ `Filter` – [DataQualityRuleRecommendationRunFilter](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter) 物件。

  篩選條件。
+ `NextToken` – UTF-8 字串。

  位移結果的分頁字符。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回傳結果的數量上限。

**回應**
+ `Runs` – 一個 [DataQualityRuleRecommendationRunDescription](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription) 物件陣列。

  `DataQualityRuleRecommendationRunDescription` 物件的清單。
+ `NextToken` – UTF-8 字串。

  如有多個結果可用，即為分頁字符。

**錯誤**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityResult 動作 (Python：get\$1data\$1quality\$1result)
<a name="aws-glue-api-data-quality-api-GetDataQualityResult"></a>

擷取資料品質規則評估的結果。

**請求**
+ `ResultId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質結果的唯一結果 ID。

**回應**

資料品質結果的回應。
+ `ResultId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質結果的唯一結果 ID。
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質結果的設定檔 ID。
+ `Score` – 數字 (double)，不可大於 1.0。

  彙總資料品質分數。表示通過的規則數目與規則總數的比率。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與資料品質結果相關聯的資料表 (若有)。
+ `RulesetName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的規則集名稱。
+ `EvaluationContext` – UTF-8 字串。

  在 AWS Glue Studio 中任務的內容中，畫布中的每個節點通常會被指派某種名稱，而資料品質節點將具有名稱。如果存在多個節點，`evaluationContext` 可以區分節點。
+ `StartedOn` – 時間戳記。

  此資料品質結果執行開始的日期和時間。
+ `CompletedOn` – 時間戳記。

  此資料品質結果執行完成的日期和時間。
+ `JobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務名稱 (若有)。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務執行 ID (若有)。
+ `RulesetEvaluationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與規則集評估相關聯的唯一執行 ID。
+ `RuleResults` – 一個 [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult) 物件陣列，不可超過 2000 個結構。

  代表每個規則結果的 `DataQualityRuleResult` 物件清單。
+ `AnalyzerResults` – 一個 [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult) 物件陣列，不可超過 2000 個結構。

  代表每個分析器結果的 `DataQualityAnalyzerResult` 物件清單。
+ `Observations` – [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) 物件陣列，不可超過 50 個結構。

  代表評估規則和分析器後產生的觀測值的 `DataQualityObservation` 物件清單。
+ `AggregatedMetrics` – [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics) 物件。

   `DataQualityAggregatedMetrics` 物件的摘要，顯示已處理的資料列和規則的總計數，包括根據資料列層級結果的通過/失敗統計資料。

**錯誤**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `EntityNotFoundException`

## BatchGetDataQualityResult 動作 (Python：batch\$1get\$1data\$1quality\$1result)
<a name="aws-glue-api-data-quality-api-BatchGetDataQualityResult"></a>

擷取指定結果 ID 的資料品質結果清單。

**請求**
+ `ResultIds` – *必要：*UTF-8 字串的陣列，不可小於 1，也不可超過 100 個字串。

  資料品質結果的唯一結果 ID 清單。

**回應**
+ `Results` – *必要：*一個 [DataQualityResult](#aws-glue-api-data-quality-api-DataQualityResult) 物件。

  表示資料品質結果的 `DataQualityResult` 物件清單。
+ `ResultsNotFound` – UTF-8 字串的陣列，不可小於 1，也不可超過 100 個字串。

  找不到結果的結果 ID 清單。

**錯誤**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityResults 動作 (Python：list\$1data\$1quality\$1results)
<a name="aws-glue-api-data-quality-api-ListDataQualityResults"></a>

傳回您帳戶的所有資料品質執行結果。

**請求**
+ `Filter` – [DataQualityResultFilterCriteria](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria) 物件。

  篩選條件。
+ `NextToken` – UTF-8 字串。

  位移結果的分頁字符。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回傳結果的數量上限。

**回應**
+ `Results` – *必要：*一個 [DataQualityResultDescription](#aws-glue-api-data-quality-api-DataQualityResultDescription) 物件。

  `DataQualityResultDescription` 物件的清單。
+ `NextToken` – UTF-8 字串。

  如有多個結果可用，即為分頁字符。

**錯誤**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## CreateDataQualityRuleset 動作 (Python：create\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-CreateDataQualityRuleset"></a>

使用套用至指定 AWS Glue 資料表的 DQDL 規則建立資料品質規則集。

您可以使用資料品質定義語言 (DQDL) 建立規則集。如需詳細資訊，請參閱 AWS Glue 開發人員指南。

**請求**

用於建立資料品質規則集的請求。
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則集的唯一名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  資料品質規則集的描述。
+ `Ruleset` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  資料品質定義語言 (DQDL) 規則集。如需詳細資訊，請參閱 AWS Glue 開發人員指南。
+ `Tags` – 金鑰值對的映射陣列，不超過 50 對。

  每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  每個值都是 UTF-8 字串，長度不可超過 256 個位元組。

  套用至資料品質規則集的標籤清單。
+ `TargetTable` – [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 物件。

  與資料品質規則集關聯的目標資料表。
+ `RecommendationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  建議執行的唯一執行 ID。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。
+ `ClientToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於等冪性且建議將其設定為隨機 ID（例如 UUID），避免建立或啟動同一資源的多個執行個體。

**回應**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則集的唯一名稱。

**錯誤**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## DeleteDataQualityRuleset 動作 (Python：delete\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-DeleteDataQualityRuleset"></a>

刪除資料品質規則集。

**請求**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則集的名稱。

**回應**
+ *無回應參數。*

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityRuleset 動作 (Python：get\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleset"></a>

透過識別符或名稱傳回現有的規則集。

**請求**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  規則集的名稱。

**回應**

傳回資料品質規則集回應。
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  規則集的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  規則群組的描述。
+ `Ruleset` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  資料品質定義語言 (DQDL) 規則集。如需詳細資訊，請參閱 AWS Glue 開發人員指南。
+ `TargetTable` – [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 物件。

  目標資料表的名稱和資料庫名稱。
+ `CreatedOn` – 時間戳記。

  時間戳記。建立此資料品質規則集的時間和日期。
+ `LastModifiedOn` – 時間戳記。

  時間戳記。修改此資料品質規則集的最後一個時間點。
+ `RecommendationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  從建議執行建立規則集時，會產生此執行 ID 以將兩者連結在一起。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityRulesets 動作 (Python：list\$1data\$1quality\$1rulesets)
<a name="aws-glue-api-data-quality-api-ListDataQualityRulesets"></a>

傳回指定 AWS Glue 資料表清單的規則集分頁清單。

**請求**
+ `NextToken` – UTF-8 字串。

  位移結果的分頁字符。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回傳結果的數量上限。
+ `Filter` – [DataQualityRulesetFilterCriteria](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria) 物件。

  篩選條件。
+ `Tags` – 金鑰值對的映射陣列，不超過 50 對。

  每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  每個值都是 UTF-8 字串，長度不可超過 256 個位元組。

  鍵/值對標籤清單。

**回應**
+ `Rulesets` – 一個 [DataQualityRulesetListDetails](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails) 物件陣列。

  指定 AWS Glue 資料表清單的規則集分頁清單。
+ `NextToken` – UTF-8 字串。

  如有多個結果可用，即為分頁字符。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## UpdateDataQualityRuleset 動作 (Python：update\$1data\$1quality\$1ruleset)
<a name="aws-glue-api-data-quality-api-UpdateDataQualityRuleset"></a>

更新指定的資料品質規則集。

**請求**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則集的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  規則群組的描述。
+ `Ruleset` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  資料品質定義語言 (DQDL) 規則集。如需詳細資訊，請參閱 AWS Glue 開發人員指南。

**回應**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則集的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  規則群組的描述。
+ `Ruleset` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  資料品質定義語言 (DQDL) 規則集。如需詳細資訊，請參閱 AWS Glue 開發人員指南。

**錯誤**
+ `EntityNotFoundException`
+ `AlreadyExistsException`
+ `IdempotentParameterMismatchException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## ListDataQualityStatistics 動作 (Python：list\$1data\$1quality\$1statistics)
<a name="aws-glue-api-data-quality-api-ListDataQualityStatistics"></a>

擷取資料品質統計資料的清單。

**請求**
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  設定檔 ID。
+ `TimestampFilter` – [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter) 物件。

  時間戳記篩選條件。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  本次請求傳回結果的最大數量。
+ `NextToken` – UTF-8 字串。

  用於請求下一頁結果的分頁字符。

**回應**
+ `Statistics` – 一個 [StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary) 物件陣列。

  `StatisticSummaryList`。
+ `NextToken` – UTF-8 字串。

  用於請求下一頁結果的分頁字符。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`

## TimestampFilter 結構
<a name="aws-glue-api-data-quality-api-TimestampFilter"></a>

時間戳記篩選條件。

**欄位**
+ `RecordedBefore` – 時間戳記。

  應將統計資料包含在結果中的時間戳記起始點。
+ `RecordedAfter` – 時間戳記。

  應將統計資料包含在結果中的時間戳記截止點。

## CreateDataQualityRulesetRequest 結構
<a name="aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest"></a>

用於建立資料品質規則集的請求。

**欄位**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質規則集的唯一名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  資料品質規則集的描述。
+ `Ruleset` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  資料品質定義語言 (DQDL) 規則集。如需詳細資訊，請參閱 AWS Glue 開發人員指南。
+ `Tags` – 金鑰值對的映射陣列，不超過 50 對。

  每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  每個值都是 UTF-8 字串，長度不可超過 256 個位元組。

  套用至資料品質規則集的標籤清單。
+ `TargetTable` – [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 物件。

  與資料品質規則集關聯的目標資料表。
+ `RecommendationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  建議執行的唯一執行 ID。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。
+ `ClientToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於等冪性且建議將其設定為隨機 ID（例如 UUID），避免建立或啟動同一資源的多個執行個體。

## GetDataQualityRulesetResponse 結構
<a name="aws-glue-api-data-quality-api-GetDataQualityRulesetResponse"></a>

傳回資料品質規則集回應。

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  規則集的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  規則群組的描述。
+ `Ruleset` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  資料品質定義語言 (DQDL) 規則集。如需詳細資訊，請參閱 AWS Glue 開發人員指南。
+ `TargetTable` – [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 物件。

  目標資料表的名稱和資料庫名稱。
+ `CreatedOn` – 時間戳記。

  時間戳記。建立此資料品質規則集的時間和日期。
+ `LastModifiedOn` – 時間戳記。

  時間戳記。修改此資料品質規則集的最後一個時間點。
+ `RecommendationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  從建議執行建立規則集時，會產生此執行 ID 以將兩者連結在一起。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。

## GetDataQualityResultResponse 結構
<a name="aws-glue-api-data-quality-api-GetDataQualityResultResponse"></a>

資料品質結果的回應。

**欄位**
+ `ResultId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質結果的唯一結果 ID。
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料品質結果的設定檔 ID。
+ `Score` – 數字 (double)，不可大於 1.0。

  彙總資料品質分數。表示通過的規則數目與規則總數的比率。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與資料品質結果相關聯的資料表 (若有)。
+ `RulesetName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的規則集名稱。
+ `EvaluationContext` – UTF-8 字串。

  在 AWS Glue Studio 中任務的內容中，畫布中的每個節點通常會被指派某種名稱，而資料品質節點將具有名稱。如果存在多個節點，`evaluationContext` 可以區分節點。
+ `StartedOn` – 時間戳記。

  此資料品質結果執行開始的日期和時間。
+ `CompletedOn` – 時間戳記。

  此資料品質結果執行完成的日期和時間。
+ `JobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務名稱 (若有)。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與資料品質結果相關聯的任務執行 ID (若有)。
+ `RulesetEvaluationRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與規則集評估相關聯的唯一執行 ID。
+ `RuleResults` – 一個 [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult) 物件陣列，不可超過 2000 個結構。

  代表每個規則結果的 `DataQualityRuleResult` 物件清單。
+ `AnalyzerResults` – 一個 [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult) 物件陣列，不可超過 2000 個結構。

  代表每個分析器結果的 `DataQualityAnalyzerResult` 物件清單。
+ `Observations` – [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) 物件陣列，不可超過 50 個結構。

  代表評估規則和分析器後產生的觀測值的 `DataQualityObservation` 物件清單。
+ `AggregatedMetrics` – [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics) 物件。

   `DataQualityAggregatedMetrics` 物件的摘要，顯示已處理的資料列和規則的總計數，包括根據資料列層級結果的通過/失敗統計資料。

## StartDataQualityRuleRecommendationRunRequest 結構
<a name="aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest"></a>

Data Quality 規則建議請求的請求。

**欄位**
+ `DataSource` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 (AWS Glue 資料表）。
+ `Role` – *必要：*UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (48 小時)。
+ `CreatedRulesetName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  規則集的名稱。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。
+ `ClientToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於等冪性且建議將其設定為隨機 ID（例如 UUID），避免建立或啟動同一資源的多個執行個體。

## GetDataQualityRuleRecommendationRunResponse 結構
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse"></a>

Data Quality 規則建議執行的回應。

**欄位**
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此回合相關聯的唯一回合識別符。
+ `DataSource` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 ( AWS Glue 資料表）。
+ `Role` – UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (48 小時)。
+ `Status` – UTF-8 字串 (有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`)。

  此回合的狀態。
+ `ErrorString` – UTF-8 字串。

  與任務執行相關聯的錯誤字串。
+ `StartedOn` – 時間戳記。

  此執行開始時的日期和時間。
+ `LastModifiedOn` – 時間戳記。

  時間戳記。修改此資料品質規則建議執行的最後一個時間點。
+ `CompletedOn` – 時間戳記。

  此任務執行完成的日期和時間。
+ `ExecutionTime` – 數字 (整數)。

  執行消耗資源所需的時間 (以秒為單位)。
+ `RecommendedRuleset` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 65536 個位元組。

  當啟動規則建議執行完成時，會建立建議的規則集 (一組規則)。此成員具有資料品質定義語言 (DQDL) 格式的規則。
+ `CreatedRulesetName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  執行建立的規則集的名稱。
+ `DataQualitySecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  使用資料品質加密選項建立的安全組態名稱。

## BatchPutDataQualityStatisticAnnotation 動作 (Python：batch\$1put\$1data\$1quality\$1statistic\$1annotation)
<a name="aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation"></a>

針對特定資料品質統計資料隨時間變化的註釋資料點。API 同時需要 profileID 和 statisticID 作為 InclusionAnnotation 輸入的一部分。API 僅適用於跨多個設定檔的單一 statisticId。

**請求**
+ `InclusionAnnotations` – *必要：*一個 [DatapointInclusionAnnotation](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation) 物件。

  `DatapointInclusionAnnotation` 的清單。InclusionAnnotations 必須包含 profileId 和 statisticId。如果有多個 InclusionAnnotations，則清單必須參考跨多個 profileIds 的單一 statisticId。
+ `ClientToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用戶端字符。

**回應**
+ `FailedInclusionAnnotations` – 一個 [AnnotationError](#aws-glue-api-data-quality-api-AnnotationError) 物件陣列。

  `AnnotationError` 的清單。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## GetDataQualityModel 動作 (Python：get\$1data\$1quality\$1model)
<a name="aws-glue-api-data-quality-api-GetDataQualityModel"></a>

擷取模型的訓練狀態以及詳細資訊 (CompletedOn、StartedOn、FailureReason)。

**請求**
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `ProfileId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  設定檔 ID。

**回應**
+ `Status` – UTF-8 字串 (有效值：`RUNNING` \$1 `SUCCEEDED` \$1 `FAILED`)。

  資料品質模型的訓練狀態。
+ `StartedOn` – 時間戳記。

  資料品質模型訓練開始時間的時間戳記。
+ `CompletedOn` – 時間戳記。

  資料品質模型訓練完成時間的時間戳記。
+ `FailureReason` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  訓練失敗原因。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityModelResult 動作 (Python：get\$1data\$1quality\$1model\$1result)
<a name="aws-glue-api-data-quality-api-GetDataQualityModelResult"></a>

擷取所指定設定檔 ID 的統計資料預測。

**請求**
+ `StatisticId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `ProfileId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  設定檔 ID。

**回應**
+ `CompletedOn` – 時間戳記。

  資料品質模型訓練完成時間的時間戳記。
+ `Model` – 一個 [StatisticModelResult](#aws-glue-api-data-quality-api-StatisticModelResult) 物件陣列。

  `StatisticModelResult` 的清單

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityStatisticAnnotations 動作 (Python：list\$1data\$1quality\$1statistic\$1annotations)
<a name="aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations"></a>

擷取資料品質統計資料的註釋。

**請求**
+ `StatisticId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  統計資料 ID。
+ `ProfileId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  設定檔 ID。
+ `TimestampFilter` – [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter) 物件。

  時間戳記篩選條件。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  本次請求傳回結果的最大數量。
+ `NextToken` – UTF-8 字串。

  用於擷取下一組結果的分頁字符。

**回應**
+ `Annotations` – 一個 [StatisticAnnotation](#aws-glue-api-data-quality-api-StatisticAnnotation) 物件陣列。

  套用至統計資料的 `StatisticAnnotation` 清單
+ `NextToken` – UTF-8 字串。

  用於擷取下一組結果的分頁字符。

**錯誤**
+ `InvalidInputException`
+ `InternalServiceException`

## PutDataQualityProfileAnnotation 動作 (Python：put\$1data\$1quality\$1profile\$1annotation)
<a name="aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation"></a>

註釋設定檔的所有資料點。

**請求**
+ `ProfileId` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  要註釋的資料品質監控設定檔 ID。
+ `InclusionAnnotation` – *必要：*UTF-8 字串 (有效值：`INCLUDE` \$1 `EXCLUDE`)。

  要套用至設定檔的包含註釋值。

**回應**
+ *無回應參數。*

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`