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

# 爬蟲程式和分類器 API
<a name="aws-glue-api-crawler"></a>

爬蟲程式和分類器 API 說明 AWS Glue 爬蟲程式和分類器資料類型，並包含用於建立、刪除、更新和列出爬蟲程式或分類器的 API。

**Topics**
+ [分類器 API](aws-glue-api-crawler-classifiers.md)
+ [爬蟲程式 API](aws-glue-api-crawler-crawling.md)
+ [資料欄統計資料 API](aws-glue-api-crawler-column-statistics.md)
+ [爬蟲程式排程器 API](aws-glue-api-crawler-scheduler.md)

# 分類器 API
<a name="aws-glue-api-crawler-classifiers"></a>

分類器 API 說明 AWS Glue 分類器資料類型，並包含用於建立、刪除、更新和列出分類器的 API。

## 資料類型
<a name="aws-glue-api-crawler-classifiers-objects"></a>
+ [Classifier 結構](#aws-glue-api-crawler-classifiers-Classifier)
+ [GrokClassifier 結構](#aws-glue-api-crawler-classifiers-GrokClassifier)
+ [XMLClassifier 結構](#aws-glue-api-crawler-classifiers-XMLClassifier)
+ [JsonClassifier 結構](#aws-glue-api-crawler-classifiers-JsonClassifier)
+ [CsvClassifier 結構](#aws-glue-api-crawler-classifiers-CsvClassifier)
+ [CreateGrokClassifierRequest 結構](#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest)
+ [UpdateGrokClassifierRequest 結構](#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest)
+ [CreateXMLClassifierRequest 結構](#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest)
+ [UpdateXMLClassifierRequest 結構](#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest)
+ [CreateJsonClassifierRequest 結構](#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest)
+ [UpdateJsonClassifierRequest 結構](#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest)
+ [CreateCsvClassifierRequest 結構](#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest)
+ [UpdateCsvClassifierRequest 結構](#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest)

## Classifier 結構
<a name="aws-glue-api-crawler-classifiers-Classifier"></a>

探索任務會觸發分類器。分類器會檢查指定的檔案是否採用其能處理的格式。如果是，則分類器會以符合該資料格式的 `StructType` 物件形式，建立結構描述。

您可以使用 AWS Glue 提供的標準分類器，也可以編寫自己的分類器，以最佳方式分類資料來源，並指定要用於它們的適當結構描述。分類器可以是 `grok` 分類器、`XML` 分類器或 `JSON` 分類器，或者透過 `Classifier` 物件中其中一個欄位指定的自訂 `CSV` 分類器。

**欄位**
+ `GrokClassifier` – [GrokClassifier](#aws-glue-api-crawler-classifiers-GrokClassifier) 物件。

  使用 `grok` 的分類器。
+ `XMLClassifier` – [XMLClassifier](#aws-glue-api-crawler-classifiers-XMLClassifier) 物件。

  XML 內容的分類器。
+ `JsonClassifier` – [JsonClassifier](#aws-glue-api-crawler-classifiers-JsonClassifier) 物件。

  JSON 內容的分類器。
+ `CsvClassifier` – [CsvClassifier](#aws-glue-api-crawler-classifiers-CsvClassifier) 物件。

  逗點分隔值 (CSV) 的分類器。

## GrokClassifier 結構
<a name="aws-glue-api-crawler-classifiers-GrokClassifier"></a>

使用 `grok` 模式的分類器。

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

  分類器名稱。
+ `Classification` – *必要：*UTF-8 字串。

  分類器符合的資料格式識別符，例如 Twitter、JSON、Omniture 日誌等。
+ `CreationTime` – 時間戳記。

  此分類器登錄時的時間。
+ `LastUpdated` – 時間戳記。

  此分類器的上次更新時間。
+ `Version` – 數字 (long)。

  此分類器的版本。
+ `GrokPattern` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2048 個位元組，且需符合[A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern)。

  此分類器套用到資料存放區的 grok 模式。如需詳細資訊，請參閱[撰寫自訂分類器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html)中的內建模式。
+ `CustomPatterns` – UTF-8 字串，長度不可超過 16000 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  此分類器定義的選用自訂 grok 模式。如需詳細資訊，請參閱[撰寫自訂分類器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html)中的自訂模式。

## XMLClassifier 結構
<a name="aws-glue-api-crawler-classifiers-XMLClassifier"></a>

`XML` 內容的分類器。

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

  分類器名稱。
+ `Classification` – *必要：*UTF-8 字串。

  分類器符合的資料格式識別碼。
+ `CreationTime` – 時間戳記。

  此分類器登錄時的時間。
+ `LastUpdated` – 時間戳記。

  此分類器的上次更新時間。
+ `Version` – 數字 (long)。

  此分類器的版本。
+ `RowTag` – UTF-8 字串。

  XML 標籤，指定包含所剖析之 XML 文件中各記錄的元素。這個設定無法識別自我關閉的元素 (由 `/>` 關閉)。僅包含屬性的空白資料列元素若結尾為關閉標籤便能剖析 (例如，可以是 `<row item_a="A" item_b="B"></row>`，但不能是 `<row item_a="A" item_b="B" />`)。

## JsonClassifier 結構
<a name="aws-glue-api-crawler-classifiers-JsonClassifier"></a>

`JSON` 內容的分類器。

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

  分類器名稱。
+ `CreationTime` – 時間戳記。

  此分類器登錄時的時間。
+ `LastUpdated` – 時間戳記。

  此分類器的上次更新時間。
+ `Version` – 數字 (long)。

  此分類器的版本。
+ `JsonPath` – *必要：*UTF-8 字串。

  定義分類器要分類的 JSON 資料的`JsonPath`字串。 AWS Glue 支援 JsonPath 的子集，如[撰寫 JsonPath 自訂分類器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)中所述。

## CsvClassifier 結構
<a name="aws-glue-api-crawler-classifiers-CsvClassifier"></a>

自訂 `CSV` 內容的分類器。

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

  分類器名稱。
+ `CreationTime` – 時間戳記。

  此分類器登錄時的時間。
+ `LastUpdated` – 時間戳記。

  此分類器的上次更新時間。
+ `Version` – 數字 (long)。

  此分類器的版本。
+ `Delimiter` - UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1 個位元組，且需符合 [Custom string pattern #26](aws-glue-api-common.md#regex_26)。

  表示用於分隔資料列中每個欄位項目的自訂符號。
+ `QuoteSymbol` - UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1 個位元組，且需符合 [Custom string pattern #26](aws-glue-api-common.md#regex_26)。

  用來表示將內容結合成單一欄位值的自訂符號。其必須不同於欄位分隔符號。
+ `ContainsHeader` – UTF-8 字串 (有效值：`UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`)。

  表示 CSV 檔案是否包含標頭。
+ `Header` – UTF-8 字串陣列。

  表示欄位名稱之字串的清單。
+ `DisableValueTrimming` – 布林值。

  指定在確認欄位值類型之前不要裁剪值。預設值為 `true`。
+ `AllowSingleColumn` – 布林值。

  啟用處理僅包含一個欄位的檔案。
+ `CustomDatatypeConfigured` – 布林值。

  啟用要設定的自訂資料類型。
+ `CustomDatatypes` – UTF-8 字串陣列。

  指定資料類型清單包括 "BINARY"、"BOOLEAN"、"DATE"、"DECIMAL"、"DOUBLE"、"FLOAT"、"INT"、"LONG"、"SHORT"、"STRING"、"TIMESTAMP"。
+ `Serde` – UTF-8 字串 (有效值：`OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`)。

  設定用於在分類器中處理 CSV 的 SerDe，並且將在資料目錄中套用該 Serde。有效值為 `OpenCSVSerDe`、`LazySimpleSerDe` 和 `None`。您可以指定希望爬蟲程式執行偵測時的 `None` 值。

## CreateGrokClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest"></a>

指定 `CreateClassifier` 要建立的 `grok` 分類器。

**欄位**
+ `Classification` – *必要：*UTF-8 字串。

  分類器符合的資料格式識別符，例如 Twitter、JSON、Omniture 日誌、Amazon CloudWatch Logs 等。
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  新分類器名稱。
+ `GrokPattern` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2048 個位元組，且需符合[A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern)。

  此分類器使用的 grok 模式。
+ `CustomPatterns` – UTF-8 字串，長度不可超過 16000 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  此分類器使用的選用自訂 grok 模式。

## UpdateGrokClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest"></a>

指定當傳送到 `UpdateClassifier` 時要更新的 grok 分類器。

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

  `GrokClassifier` 的名稱。
+ `Classification` – UTF-8 字串。

  分類器符合的資料格式識別符，例如 Twitter、JSON、Omniture 日誌、Amazon CloudWatch Logs 等。
+ `GrokPattern` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2048 個位元組，需符合[A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern)。

  此分類器使用的 grok 模式。
+ `CustomPatterns` – UTF-8 字串，長度不可超過 16000 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  此分類器使用的選用自訂 grok 模式。

## CreateXMLClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest"></a>

指定 `CreateClassifier` 要建立的 XML 分類器。

**欄位**
+ `Classification` – *必要：*UTF-8 字串。

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

  分類器名稱。
+ `RowTag` – UTF-8 字串。

  XML 標籤，指定包含所剖析之 XML 文件中各記錄的元素。這個設定無法識別自我關閉的元素 (由 `/>` 關閉)。僅包含屬性的空白資料列元素若結尾為關閉標籤便能剖析 (例如，可以是 `<row item_a="A" item_b="B"></row>`，但不能是 `<row item_a="A" item_b="B" />`)。

## UpdateXMLClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest"></a>

指定要更新的 XML 分類器。

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

  分類器名稱。
+ `Classification` – UTF-8 字串。

  分類器符合的資料格式識別碼。
+ `RowTag` – UTF-8 字串。

  XML 標籤，指定包含所剖析之 XML 文件中各記錄的元素。這個設定無法識別自我關閉的元素 (由 `/>` 關閉)。僅包含屬性的空白資料列元素若結尾為關閉標籤便能剖析 (例如，可以是 `<row item_a="A" item_b="B"></row>`，但不能是 `<row item_a="A" item_b="B" />`)。

## CreateJsonClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest"></a>

指定 `CreateClassifier` 要建立的 JSON 分類器。

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

  分類器名稱。
+ `JsonPath` – *必要：*UTF-8 字串。

  定義分類器要分類的 JSON 資料的`JsonPath`字串。 AWS Glue 支援 JsonPath 子集，如[撰寫 JsonPath 自訂分類器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)中所述。

## UpdateJsonClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest"></a>

指定要更新的 JSON 分類器。

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

  分類器名稱。
+ `JsonPath` – UTF-8 字串。

  定義分類器要分類的 JSON 資料的`JsonPath`字串。 AWS Glue 支援 JsonPath 子集，如[撰寫 JsonPath 自訂分類器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)中所述。

## CreateCsvClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest"></a>

指定 `CreateClassifier` 要建立的自訂 CSV 分類器。

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

  分類器名稱。
+ `Delimiter` - UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1 個位元組，且需符合 [Custom string pattern #26](aws-glue-api-common.md#regex_26)。

  表示用於分隔資料列中每個欄位項目的自訂符號。
+ `QuoteSymbol` - UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1 個位元組，且需符合 [Custom string pattern #26](aws-glue-api-common.md#regex_26)。

  用來表示將內容結合成單一欄位值的自訂符號。必須不同於欄位分隔符號。
+ `ContainsHeader` – UTF-8 字串 (有效值：`UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`)。

  表示 CSV 檔案是否包含標頭。
+ `Header` – UTF-8 字串陣列。

  表示欄位名稱之字串的清單。
+ `DisableValueTrimming` – 布林值。

  指定在確認欄位值類型之前不要裁剪值。預設值為 true。
+ `AllowSingleColumn` – 布林值。

  啟用處理僅包含一個欄位的檔案。
+ `CustomDatatypeConfigured` – 布林值。

  啟用自訂資料類型的組態。
+ `CustomDatatypes` – UTF-8 字串陣列。

  建立支援的自訂資料類型清單。
+ `Serde` – UTF-8 字串 (有效值：`OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`)。

  設定用於在分類器中處理 CSV 的 SerDe，並且將在資料目錄中套用該 Serde。有效值為 `OpenCSVSerDe`、`LazySimpleSerDe` 和 `None`。您可以指定希望爬蟲程式執行偵測時的 `None` 值。

## UpdateCsvClassifierRequest 結構
<a name="aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest"></a>

指定要更新的自訂 CSV 分類器。

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

  分類器名稱。
+ `Delimiter` - UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1 個位元組，且需符合 [Custom string pattern #26](aws-glue-api-common.md#regex_26)。

  表示用於分隔資料列中每個欄位項目的自訂符號。
+ `QuoteSymbol` - UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1 個位元組，且需符合 [Custom string pattern #26](aws-glue-api-common.md#regex_26)。

  用來表示將內容結合成單一欄位值的自訂符號。其必須不同於欄位分隔符號。
+ `ContainsHeader` – UTF-8 字串 (有效值：`UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`)。

  表示 CSV 檔案是否包含標頭。
+ `Header` – UTF-8 字串陣列。

  表示欄位名稱之字串的清單。
+ `DisableValueTrimming` – 布林值。

  指定在確認欄位值類型之前不要裁剪值。預設值為 true。
+ `AllowSingleColumn` – 布林值。

  啟用處理僅包含一個欄位的檔案。
+ `CustomDatatypeConfigured` – 布林值。

  指定自訂資料類型的組態。
+ `CustomDatatypes` – UTF-8 字串陣列。

  指定支援的自訂資料類型清單。
+ `Serde` – UTF-8 字串 (有效值：`OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`)。

  設定用於在分類器中處理 CSV 的 SerDe，並且將在資料目錄中套用該 Serde。有效值為 `OpenCSVSerDe`、`LazySimpleSerDe` 和 `None`。您可以指定希望爬蟲程式執行偵測時的 `None` 值。

## 作業
<a name="aws-glue-api-crawler-classifiers-actions"></a>
+ [CreateClassifier 動作 (Python: create\$1classifier)](#aws-glue-api-crawler-classifiers-CreateClassifier)
+ [DeleteClassifier 動作 (Python: delete\$1classifier)](#aws-glue-api-crawler-classifiers-DeleteClassifier)
+ [GetClassifier 動作 (Python: get\$1classifier)](#aws-glue-api-crawler-classifiers-GetClassifier)
+ [GetClassifiers 動作 (Python: get\$1classifiers)](#aws-glue-api-crawler-classifiers-GetClassifiers)
+ [UpdateClassifier 動作 (Python: update\$1classifier)](#aws-glue-api-crawler-classifiers-UpdateClassifier)

## CreateClassifier 動作 (Python: create\$1classifier)
<a name="aws-glue-api-crawler-classifiers-CreateClassifier"></a>

在使用者的帳戶內建立分類器。可能是 `GrokClassifier`、`XMLClassifier`、`JsonClassifier`，或 `CsvClassifier`，視出現的要求欄位而定。

**請求**
+ `GrokClassifier` – [CreateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest) 物件。

  指定要建立之分類器的 `GrokClassifier` 物件。
+ `XMLClassifier` – [CreateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest) 物件。

  指定要建立之分類器的 `XMLClassifier` 物件。
+ `JsonClassifier` – [CreateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest) 物件。

  指定要建立之分類器的 `JsonClassifier` 物件。
+ `CsvClassifier` – [CreateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest) 物件。

  指定要建立之分類器的 `CsvClassifier` 物件。

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

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

## DeleteClassifier 動作 (Python: delete\$1classifier)
<a name="aws-glue-api-crawler-classifiers-DeleteClassifier"></a>

從 Data Catalog 移除分類器。

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

  要移除的分類器名稱。

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

**錯誤**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetClassifier 動作 (Python: get\$1classifier)
<a name="aws-glue-api-crawler-classifiers-GetClassifier"></a>

擷取指定名稱的分類器。

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

  要擷取的分類器名稱。

**回應**
+ `Classifier` – [分類器](#aws-glue-api-crawler-classifiers-Classifier) 物件。

  要求的分類器。

**錯誤**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetClassifiers 動作 (Python: get\$1classifiers)
<a name="aws-glue-api-crawler-classifiers-GetClassifiers"></a>

列出 Data Catalog 中所有的分類器物件。

**請求**
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  所要回傳的清單大小 (選用)。
+ `NextToken` – UTF-8 字串。

  選擇性的接續符記。

**回應**
+ `Classifiers` – 一個 [分類器](#aws-glue-api-crawler-classifiers-Classifier) 物件陣列。

  要求的分類器物件清單。
+ `NextToken` – UTF-8 字串。

  接續符記。

**錯誤**
+ `OperationTimeoutException`

## UpdateClassifier 動作 (Python: update\$1classifier)
<a name="aws-glue-api-crawler-classifiers-UpdateClassifier"></a>

修改現有的分類器 (`GrokClassifier`、`XMLClassifier`、`JsonClassifier` 或 `CsvClassifier`，視出現的欄位而定)。

**請求**
+ `GrokClassifier` – [UpdateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest) 物件。

  含更新欄位的 `GrokClassifier` 物件。
+ `XMLClassifier` – [UpdateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest) 物件。

  含更新欄位的 `XMLClassifier` 物件。
+ `JsonClassifier` – [UpdateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest) 物件。

  含更新欄位的 `JsonClassifier` 物件。
+ `CsvClassifier` – [UpdateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest) 物件。

  含更新欄位的 `CsvClassifier` 物件。

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

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

# 爬蟲程式 API
<a name="aws-glue-api-crawler-crawling"></a>

爬蟲程式 API 說明 AWS Glue 爬蟲程式資料類型，以及用於建立、刪除、更新和列出爬蟲程式的 API。

## 資料類型
<a name="aws-glue-api-crawler-crawling-objects"></a>
+ [Crawler 結構](#aws-glue-api-crawler-crawling-Crawler)
+ [Schedule 結構](#aws-glue-api-crawler-crawling-Schedule)
+ [CrawlerTargets 結構](#aws-glue-api-crawler-crawling-CrawlerTargets)
+ [S3Target 結構](#aws-glue-api-crawler-crawling-S3Target)
+ [S3DeltaCatalogTarget 結構](#aws-glue-api-crawler-crawling-S3DeltaCatalogTarget)
+ [S3DeltaDirectTarget 結構](#aws-glue-api-crawler-crawling-S3DeltaDirectTarget)
+ [JdbcTarget 結構](#aws-glue-api-crawler-crawling-JdbcTarget)
+ [MongoDBTarget 結構](#aws-glue-api-crawler-crawling-MongoDBTarget)
+ [DynamoDBTarget 結構](#aws-glue-api-crawler-crawling-DynamoDBTarget)
+ [DeltaTarget 結構](#aws-glue-api-crawler-crawling-DeltaTarget)
+ [IcebergTarget 結構](#aws-glue-api-crawler-crawling-IcebergTarget)
+ [HudiTarget 結構](#aws-glue-api-crawler-crawling-HudiTarget)
+ [CatalogTarget 結構](#aws-glue-api-crawler-crawling-CatalogTarget)
+ [CrawlerMetrics 結構](#aws-glue-api-crawler-crawling-CrawlerMetrics)
+ [CrawlerHistory 結構](#aws-glue-api-crawler-crawling-CrawlerHistory)
+ [CrawlsFilter 結構](#aws-glue-api-crawler-crawling-CrawlsFilter)
+ [SchemaChangePolicy 結構](#aws-glue-api-crawler-crawling-SchemaChangePolicy)
+ [LastCrawlInfo 結構](#aws-glue-api-crawler-crawling-LastCrawlInfo)
+ [RecrawlPolicy 結構](#aws-glue-api-crawler-crawling-RecrawlPolicy)
+ [LineageConfiguration 結構](#aws-glue-api-crawler-crawling-LineageConfiguration)
+ [LakeFormationConfiguration 結構](#aws-glue-api-crawler-crawling-LakeFormationConfiguration)

## Crawler 結構
<a name="aws-glue-api-crawler-crawling-Crawler"></a>

指定爬蟲程式，以檢驗資料來源並使用分類器嘗試判斷其結構描述。如果成功，爬蟲程式會將與資料來源有關的中繼資料記錄到 AWS Glue Data Catalog。

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

  爬蟲程式的名稱。
+ `Role` – UTF-8 字串。

  用來存取 Amazon Simple Storage Service (Amazon S3) 資料等客戶資源 IAM 角色的 Amazon Resource Name (ARN)。
+ `Targets` – [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets) 物件。

  待編目的目標集合。
+ `DatabaseName` – UTF-8 字串。

  爬蟲程式輸出存放所在的資料庫名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  爬蟲程式的描述。
+ `Classifiers` – UTF-8 字串陣列。

  UTF-8 字串的清單，可藉由這些字串指定要與爬蟲程式建立關聯的自訂分類器。
+ `RecrawlPolicy` – [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy) 物件。

  一種政策，指定是否要再次網路爬取整個資料集，或只網路爬取自上次執行爬蟲程式後新增的資料夾。
+ `SchemaChangePolicy` – [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy) 物件。

  指定爬蟲程式更新及刪除行為的政策。
+ `LineageConfiguration` – [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration) 物件。

  指定是否為爬蟲程式啟用資料歷程的組態。
+ `State` – UTF-8 字串 (有效值：`READY` \$1 `RUNNING` \$1 `STOPPING`)。

  指出爬蟲程式是否正在執行，或是否正在等待執行。
+ `TablePrefix` – UTF-8 字串，長度不可超過 128 個位元組。

  新增到所建立資料表名稱之前的字首。
+ `Schedule` – [Schedule](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule) 物件。

  如為排程的爬蟲程式，也就是爬蟲程式執行的排程。
+ `CrawlElapsedTime` – 數字 (long)。

  如果爬蟲程式正在執行，包含爬蟲程式上次啟動後經過的總時間。
+ `CreationTime` – 時間戳記。

  爬蟲程式建立的時間。
+ `LastUpdated` – 時間戳記。

  爬蟲程式上次更新的時間。
+ `LastCrawl` – [LastCrawlInfo](#aws-glue-api-crawler-crawling-LastCrawlInfo) 物件。

  最後一次編目的狀態，以及發生錯誤時的可能錯誤資訊。
+ `Version` – 數字 (long)。

  爬蟲程式的版本。
+ `Configuration` – UTF-8 字串。

  爬蟲程式組態資訊。此版本的 JSON 字串可讓使用者指定爬蟲程式的各種行為。如需詳細資訊，請參閱[設定爬蟲程式組態選項](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)。
+ `CrawlerSecurityConfiguration` – UTF-8 字串，長度不可超過 128 個位元組。

  此爬蟲程式要使用的 `SecurityConfiguration` 結構。
+ `LakeFormationConfiguration` – [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration) 物件。

  指定爬蟲程式是否應使用爬蟲程式的 AWS Lake Formation 登入資料，而非 IAM 角色登入資料。

## Schedule 結構
<a name="aws-glue-api-crawler-crawling-Schedule"></a>

排程物件，使用 `cron` 陳述式來將事件排程。

**欄位**
+ `ScheduleExpression` – UTF-8 字串。

  用來指定排程的 `cron` 表達式 (請參閱[適用於任務與爬蟲程式的依時排程](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)。例如，如果要每天在 12:15 UTC 執行某項動作，您可以指定：`cron(15 12 * * ? *)`。
+ `State` – UTF-8 字串 (有效值：`SCHEDULED` \$1 `NOT_SCHEDULED` \$1 `TRANSITIONING`)。

  排程的狀態。

## CrawlerTargets 結構
<a name="aws-glue-api-crawler-crawling-CrawlerTargets"></a>

指定要編目的資料存放區。

**欄位**
+ `S3Targets` – 一個 [S3Target](#aws-glue-api-crawler-crawling-S3Target) 物件陣列。

  指定 Amazon Simple Storage Service (Amazon S3) 的目標。
+ `JdbcTargets` – 一個 [JdbcTarget](#aws-glue-api-crawler-crawling-JdbcTarget) 物件陣列。

  指定 JDBC 目標。
+ `MongoDBTargets` – 一個 [MongoDBTarget](#aws-glue-api-crawler-crawling-MongoDBTarget) 物件陣列。

  指定 Amazon DocumentDB 或 MongoDB 目標。
+ `DynamoDBTargets` – 一個 [DynamoDBTarget](#aws-glue-api-crawler-crawling-DynamoDBTarget) 物件陣列。

  指定 Amazon DynamoDB 的目標。
+ `CatalogTargets` – 一個 [CatalogTarget](#aws-glue-api-crawler-crawling-CatalogTarget) 物件陣列。

  指定 AWS Glue Data Catalog 目標。
+ `DeltaTargets` – 一個 [DeltaTarget](#aws-glue-api-crawler-crawling-DeltaTarget) 物件陣列。

  指定 Delta 資料存放區目標。
+ `IcebergTargets` – 一個 [IcebergTarget](#aws-glue-api-crawler-crawling-IcebergTarget) 物件陣列。

  指定 Apache Iceberg 資料存放區目標。
+ `HudiTargets` – 一個 [HudiTarget](#aws-glue-api-crawler-crawling-HudiTarget) 物件陣列。

  指定 Apache Hudi 資料存放區目標。

## S3Target 結構
<a name="aws-glue-api-crawler-crawling-S3Target"></a>

指定 Amazon Simple Storage Service (Amazon S3) 中資料存放區。

**欄位**
+ `Path` – UTF-8 字串。

  至 Amazon S3 目標的路徑。
+ `Exclusions` – UTF-8 字串陣列。

  用於排除於編目的 glob 模式清單。如需詳細資訊，請參閱[使用爬蟲程式建立資料表目錄](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  連線的名稱，允許任務或爬蟲程式在 Amazon Virtual Private Cloud 環境 (Amazon VPC) 內存取 Amazon S3 中的資料。
+ `SampleSize` – 數字 (整數)。

  設定在資料集中網路爬取範例檔案時，每個分葉資料夾中要編目的檔案數目。如果未設定，則會網路爬取所有檔案。有效值是介於 1 到 249 之間的整數。
+ `EventQueueArn` – UTF-8 字串。

  有效的 Amazon SQS ARN。例如 `arn:aws:sqs:region:account:sqs`。
+ `DlqEventQueueArn` – UTF-8 字串。

  有效的 Amazon 無法投遞 SQS ARN。例如 `arn:aws:sqs:region:account:deadLetterQueue`。

## S3DeltaCatalogTarget 結構
<a name="aws-glue-api-crawler-crawling-S3DeltaCatalogTarget"></a>

指定在 AWS Glue Data Catalog 中寫入 Delta Lake 資料來源的目標。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  資料目標的名稱。
+ `Inputs` – *必要：*UTF-8 字串的陣列，不可小於 1 或超過 1 個字串。

  輸入到資料目標的節點。
+ `PartitionKeys` – UTF-8 字串陣列。

  指定使用一系列索引鍵的原生分割。
+ `Table` – *必要：*UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  要寫入之資料庫中資料表的名稱。
+ `Database` – *必要：*UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  要寫入之資料庫的名稱。
+ `AdditionalOptions` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，需符合 [Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  每個值都是 UTF-8 字串，需符合 [Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  指定連接器的其他連接選項。
+ `SchemaChangePolicy` – [CatalogSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy) 物件。

  可以針對爬蟲程式指定更新行為的政策。
+ `AutoDataQuality` – [AutoDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality) 物件。

  指定是否自動啟用 S3 Delta 目錄目標的資料品質評估。設為 `true` 時，會在寫入操作期間自動執行資料品質檢查。
+ `OutputSchemas` – 一個 [GlueSchema](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueSchema) 物件陣列。

  指定 S3 Delta 目錄目標的資料結構描述。

## S3DeltaDirectTarget 結構
<a name="aws-glue-api-crawler-crawling-S3DeltaDirectTarget"></a>

指定寫入 Delta Lake 資料來源的目標 Amazon S3。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  資料目標的名稱。
+ `Inputs` – *必要：*UTF-8 字串的陣列，不可小於 1 或超過 1 個字串。

  輸入到資料目標的節點。
+ `PartitionKeys` – UTF-8 字串陣列。

  指定使用一系列索引鍵的原生分割。
+ `Path` – *必要：*UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  要寫入 Delta Lake 資料來源的 Amazon S3 路徑。
+ `Compression` – *必要：*UTF-8 字串 (有效值：`uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`)。

  指定資料的壓縮方式。一般來說，如果資料具有標準副檔名，則不需要此項目。可能值為 `"gzip"` 和 `"bzip"`。
+ `NumberTargetPartitions` – UTF-8 字串。

  指定跨 Amazon S3 分佈 Delta Lake 資料集檔案的目標分區數目。
+ `Format` – *必要：*UTF-8 字串 (有效值：`json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`)。

  指定目標的資料輸出格式。
+ `AdditionalOptions` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，需符合 [Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  每個值都是 UTF-8 字串，需符合 [Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  指定連接器的其他連接選項。
+ `SchemaChangePolicy` – [DirectSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 物件。

  可以針對爬蟲程式指定更新行為的政策。
+ `AutoDataQuality` – [AutoDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality) 物件。

  指定是否自動啟用 S3 Delta 直接目標的資料品質評估。設為 `true` 時，會在寫入操作期間自動執行資料品質檢查。

## JdbcTarget 結構
<a name="aws-glue-api-crawler-crawling-JdbcTarget"></a>

指定要編目的 JDBC 資料存放區。

**欄位**
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連接到 JDBC 目標的連線名稱。
+ `Path` – UTF-8 字串。

  JDBC 目標的路徑。
+ `Exclusions` – UTF-8 字串陣列。

  用於排除於編目的 glob 模式清單。如需詳細資訊，請參閱[使用爬蟲程式建立資料表目錄](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `EnableAdditionalMetadata` – UTF-8 字串陣列。

  指定值 `RAWTYPES` 或 `COMMENTS`，以在表格回應中啟用其他中繼資料。`RAWTYPES` 提供本機層級的資料類型。`COMMENTS` 提供與資料庫中的資料欄或資料表關聯的註解。

  若您不需要其他中繼資料，請讓欄位保持空白。

## MongoDBTarget 結構
<a name="aws-glue-api-crawler-crawling-MongoDBTarget"></a>

指定要網路爬取的 Amazon DocumentDB 資料庫或 MongoDB 資料存放區。

**欄位**
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連接到 Amazon DocumentDB 或 MongoDB 目標的連線名稱。
+ `Path` – UTF-8 字串。

  Amazon DocumentDB 或 MongoDB 目標 (資料庫/集合) 的路徑。
+ `ScanAll` – 布林值。

  指出是否掃描所有記錄，還是從資料表中取樣資料列。當資料表不是高傳輸量資料表時，掃描所有記錄可能需要很長的時間。

  一個 `true` 值代表會掃描所有記錄，而一個 `false` 值代表會取樣記錄。如果未指定任何值，則預設值為 `true`。

## DynamoDBTarget 結構
<a name="aws-glue-api-crawler-crawling-DynamoDBTarget"></a>

指定要抓取的 Amazon DynamoDB 資料表。

**欄位**
+ `Path` – UTF-8 字串。

  所要抓取 DynamoDB 資料表的名稱。
+ `scanAll` – 布林值。

  指出是否掃描所有記錄，還是從資料表中取樣資料列。當資料表不是高傳輸量資料表時，掃描所有記錄可能需要很長的時間。

  一個 `true` 值代表會掃描所有記錄，而一個 `false` 值代表會取樣記錄。如果未指定任何值，則預設值為 `true`。
+ `scanRate` – 數字 (雙位數)。

   AWS Glue 爬蟲程式要使用的已設定讀取容量單位百分比。讀取容量單位是 DynamoDB 定義的術語，此數值可作為每秒可在該資料表上執行的讀取次數速率限制符號。

  有效值為 null 值或介於 0.1 到 1.5 之間的值。當使用者未提供值，且預設為已設定讀取容量單位的 0.5 (針對已佈建的資料表)，或最大設定讀取容量單位的 0.25 (針對使用隨需模式的資料表) 時，系統會使用 Null 值。

## DeltaTarget 結構
<a name="aws-glue-api-crawler-crawling-DeltaTarget"></a>

指定用於網路爬取一個或多個 Delta 資料表的 Delta 資料存放區。

**欄位**
+ `DeltaTables` – UTF-8 字串陣列。

  Delta 資料表的 Amazon S3 路徑清單。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連接到 Delta 資料表目標的連線名稱。
+ `WriteManifest` – 布林值。

  指定是否將資訊清單檔案寫入 Delta 資料表路徑。
+ `CreateNativeDeltaTable` – 布林值。

  指定爬蟲程式是否要建立原生資料表，以便與支援直接查詢 Delta 交易記錄日誌的查詢引擎整合。

## IcebergTarget 結構
<a name="aws-glue-api-crawler-crawling-IcebergTarget"></a>

指定 Apache Iceberg 資料來源，其中 Iceberg 資料表存放在 Amazon S3中。

**欄位**
+ `Paths` – UTF-8 字串陣列。

  包含 Iceberg 中繼資料資料夾做為 的一或多個 Amazon S3 路徑`s3://bucket/prefix`。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連線到 Iceberg 目標的連線名稱。
+ `Exclusions` – UTF-8 字串陣列。

  用於排除於編目的 glob 模式清單。如需詳細資訊，請參閱[使用爬蟲程式建立資料表目錄](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `MaximumTraversalDepth` – 數字 (整數)。

  爬蟲程式可以周遊的 Amazon S3 路徑深度上限，以探索 Amazon S3 路徑中的 Iceberg 中繼資料資料夾。用來限制爬蟲程式執行時間。

## HudiTarget 結構
<a name="aws-glue-api-crawler-crawling-HudiTarget"></a>

指定 Apache Hudi 資料來源。

**欄位**
+ `Paths` – UTF-8 字串陣列。

  Hudi Amazon S3 的位置字串陣列，每個字串都會指出 Hudi 資料表中繼資料檔案所在的根資料夾。Hudi 資料夾可能位於根資料夾的子資料夾中。

  爬蟲程式將掃描路徑下所有資料夾中的 Hudi 資料夾。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連線到 Hudi 目標的連線名稱。如果您的 Hudi 檔案存放在需要 VPC 授權的儲存貯體中，則可以在此處設定其連線屬性。
+ `Exclusions` – UTF-8 字串陣列。

  用於排除於編目的 glob 模式清單。如需詳細資訊，請參閱[使用爬蟲程式建立資料表目錄](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `MaximumTraversalDepth` – 數字 (整數)。

  爬蟲程式可以周遊的 Amazon S3 路徑深度上限，以探索 Amazon S3 路徑中的 Hudi 中繼資料資料夾。用來限制爬蟲程式執行時間。

## CatalogTarget 結構
<a name="aws-glue-api-crawler-crawling-CatalogTarget"></a>

指定 AWS Glue Data Catalog 目標。

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

  要同步的資料庫名稱。
+ `Tables` – *必要：*UTF-8 字串的陣列，至少要有 1 個字串。

  要同步的資料表清單。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  配對使用 `Catalog` 連接類型與 `NETWORK` 連接類型時，Amazon S3 支援的資料目錄資料表的連接名稱將作為編目的目標。
+ `EventQueueArn` – UTF-8 字串。

  有效的 Amazon SQS ARN。例如 `arn:aws:sqs:region:account:sqs`。
+ `DlqEventQueueArn` – UTF-8 字串。

  有效的 Amazon 無法投遞 SQS ARN。例如 `arn:aws:sqs:region:account:deadLetterQueue`。

## CrawlerMetrics 結構
<a name="aws-glue-api-crawler-crawling-CrawlerMetrics"></a>

指定爬蟲程式的指標。

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

  爬蟲程式的名稱。
+ `TimeLeftSeconds` – 數字 (雙精度浮點數)，不可大於 None (無)。

  完成執行中爬蟲程式的預估剩餘時間。
+ `StillEstimating` – 布林值。

  假如爬蟲程式仍在預估完成執行所需要的時間，將顯示 True。
+ `LastRuntimeSeconds` – 數字 (雙精度浮點數)，不可大於 None (無)。

  爬蟲程式最近一次執行的持續時間 (以秒為單位)。
+ `MedianRuntimeSeconds` – 數字 (雙精度浮點數)，不可大於 None (無)。

  此爬蟲程式執行的中位數持續時間 (以秒為單位)。
+ `TablesCreated` – 數字 (整數)，不可大於 None (無)。

  此爬蟲程式建立的資料表數量。
+ `TablesUpdated` – 數字 (整數)，不可大於 None (無)。

  此爬蟲程式更新的資料表數量。
+ `TablesDeleted` – 數字 (整數)，不可大於 None (無)。

  此爬蟲程式刪除的資料表數量。

## CrawlerHistory 結構
<a name="aws-glue-api-crawler-crawling-CrawlerHistory"></a>

包含爬蟲程式的執行資訊。

**欄位**
+ `CrawlId` – UTF-8 字串。

  每次網路爬取的 UUID 識別碼。
+ `State` – UTF-8 字串 (有效值：`RUNNING` \$1 `COMPLETED` \$1 `FAILED` \$1 `STOPPED`)。

  網路爬取的狀態。
+ `StartTime` – 時間戳記。

  開始編目的日期和時間。
+ `EndTime` – 時間戳記。

  網路爬取結束的日期和時間。
+ `Summary` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  JSON 中特定網路爬取的執行摘要。包含已新增、更新或刪除的目錄資料表和分割區。
+ `ErrorMessage` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  如果發生錯誤，則為與此網路爬取相關聯的錯誤訊息。
+ `LogGroup` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，且需符合 [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id)。

  與編目相關聯的日誌群組。
+ `LogStream` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，且需符合 [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id)。

  與編目相關聯的日誌串流。
+ `MessagePrefix` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  此網路爬取相關 CloudWatch 訊息的字首。
+ `DPUHour` – 數字 (雙精度浮點數)，不可大於 None (無)。

  網路爬取所使用的資料處理單位 (DPU) 的數目 (以小時為單位)。

## CrawlsFilter 結構
<a name="aws-glue-api-crawler-crawling-CrawlsFilter"></a>

欄位、比較運算子和值的清單，您可以用來篩選指定爬蟲程式的爬蟲程式執行。

**欄位**
+ `FieldName` – UTF-8 字串 (有效值：`CRAWL_ID` \$1 `STATE` \$1 `START_TIME` \$1 `END_TIME` \$1 `DPU_HOUR`)。

  用來篩選特定爬蟲程式的爬蟲程式執行的索引鍵。每個欄位名稱的有效值為：
  + `CRAWL_ID`：代表網路爬取之 UUID 識別碼的字串。
  + `STATE`：代表網路爬取狀態的字串。
  + `START_TIME` 和 `END_TIME`：時間戳記，以毫秒為單位。
  + `DPU_HOUR`：用於網路爬取的資料處理單位 (DPU) 小時數。
+ `FilterOperator` – UTF-8 字串 (有效值：`GT` \$1 `GE` \$1 `LT` \$1 `LE` \$1 `EQ` \$1 `NE`)。

  對值進行操作的已定義比較程式。可用的運算子包括：
  + `GT`：大於。
  + `GE`：大於或等於。
  + `LT`：小於。
  + `LE`：小於或等於。
  + `EQ`：等於。
  + `NE`：不等於。
+ `FieldValue` – UTF-8 字串。

  在網路爬取欄位上提供用於比較的值。

## SchemaChangePolicy 結構
<a name="aws-glue-api-crawler-crawling-SchemaChangePolicy"></a>

可以針對爬蟲程式指定更新和刪除行為的政策。

**欄位**
+ `UpdateBehavior` – UTF-8 字串 (有效值：`LOG` \$1 `UPDATE_IN_DATABASE`)。

  爬蟲程式找到變更結構描述時的更新行為。
+ `DeleteBehavior` – UTF-8 字串 (有效值：`LOG` \$1 `DELETE_FROM_DATABASE` \$1 `DEPRECATE_IN_DATABASE`)。

  爬蟲程式找到刪除物件時的刪除行為。

## LastCrawlInfo 結構
<a name="aws-glue-api-crawler-crawling-LastCrawlInfo"></a>

關於最近一次編目的狀態和錯誤探索。

**欄位**
+ `Status` – UTF-8 字串 (有效值：`SUCCEEDED` \$1 `CANCELLED` \$1 `FAILED`)。

  最近一次編目的狀態。
+ `ErrorMessage` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  如果發生錯誤，則為最後一次編目的錯誤資訊。
+ `LogGroup` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，且需符合 [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id)。

  最後一次編目的日誌群組。
+ `LogStream` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，且需符合 [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id)。

  最後一次編目的日誌串流。
+ `MessagePrefix` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  此爬蟲程式相關訊息的字首。
+ `StartTime` – 時間戳記。

  爬蟲程式開始的時間。

## RecrawlPolicy 結構
<a name="aws-glue-api-crawler-crawling-RecrawlPolicy"></a>

在第一次網路爬取完成後網路爬取 Amazon S3 資料來源時，指定是要再次網路爬取整個資料集，還是只網路爬取自上次爬蟲程式執行以來新增的資料夾。如需詳細資訊，請參閱開發人員指南中的 [AWS Glue中的增量網路爬取](https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html)。

**欄位**
+ `RecrawlBehavior` – UTF-8 字串 (有效值：`CRAWL_EVERYTHING` \$1 `CRAWL_NEW_FOLDERS_ONLY` \$1 `CRAWL_EVENT_MODE`)。

  指定是否要再次網路爬取整個資料集，或只網路爬取自上次執行爬蟲程式後新增的資料夾。

  值為 `CRAWL_EVERYTHING` 指定再次網路爬取整個資料集。

  值為 `CRAWL_NEW_FOLDERS_ONLY` 指定只網路爬取自上次執行爬蟲程式之後，已新增的資料夾。

  `CRAWL_EVENT_MODE` 值會指定只網路爬取 Amazon S3 事件所識別的變更。

## LineageConfiguration 結構
<a name="aws-glue-api-crawler-crawling-LineageConfiguration"></a>

指定爬蟲程式的資料歷程組態設定。

**欄位**
+ `CrawlerLineageSettings` – UTF-8 字串 (有效值：`ENABLE` \$1 `DISABLE`)。

  指定是否啟用爬蟲程式的資料歷程。有效的值如下：
  + ENABLE：啟用爬蟲程式的資料歷程
  + DISABLE：停用爬蟲程式的資料歷程

## LakeFormationConfiguration 結構
<a name="aws-glue-api-crawler-crawling-LakeFormationConfiguration"></a>

指定爬蟲程式的 AWS Lake Formation 組態設定。

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

  指定是否使用爬蟲程式的 AWS Lake Formation 登入資料，而非 IAM 角色登入資料。
+ `AccountId` – UTF-8 字串，長度不可超過 12 個位元組。

  跨帳戶網路爬取的必要項目。對於與目標資料相同的帳戶網路爬取，則可以將其保留為 null。

## 作業
<a name="aws-glue-api-crawler-crawling-actions"></a>
+ [CreateCrawler 動作 (Python: create\$1crawler)](#aws-glue-api-crawler-crawling-CreateCrawler)
+ [DeleteCrawler 動作 (Python: delete\$1crawler)](#aws-glue-api-crawler-crawling-DeleteCrawler)
+ [GetCrawler 動作 (Python: get\$1crawler)](#aws-glue-api-crawler-crawling-GetCrawler)
+ [GetCrawlers 動作 (Python: get\$1crawlers)](#aws-glue-api-crawler-crawling-GetCrawlers)
+ [GetCrawlerMetrics 動作 (Python: get\$1crawler\$1metrics)](#aws-glue-api-crawler-crawling-GetCrawlerMetrics)
+ [UpdateCrawler 動作 (Python: update\$1crawler)](#aws-glue-api-crawler-crawling-UpdateCrawler)
+ [StartCrawler 動作 (Python: start\$1crawler)](#aws-glue-api-crawler-crawling-StartCrawler)
+ [StopCrawler 動作 (Python: stop\$1crawler)](#aws-glue-api-crawler-crawling-StopCrawler)
+ [BatchGetCrawlers 動作 (Python: batch\$1get\$1crawlers)](#aws-glue-api-crawler-crawling-BatchGetCrawlers)
+ [ListCrawlers 動作 (Python: list\$1crawlers)](#aws-glue-api-crawler-crawling-ListCrawlers)
+ [ListCrawls 動作 (Python：list\$1crawls)](#aws-glue-api-crawler-crawling-ListCrawls)

## CreateCrawler 動作 (Python: create\$1crawler)
<a name="aws-glue-api-crawler-crawling-CreateCrawler"></a>

建立新的爬蟲程式，為其指定目標、角色、組態和選用的排程。至少必須在 `s3Targets` 欄位、`jdbcTargets` 欄位或 `DynamoDBTargets` 欄位中指定一個抓取目標。

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

  新爬蟲程式的名稱。
+ `Role` – *必要：*UTF-8 字串。

  新爬蟲程式用來存取客戶資源的 IAM 角色或某 IAM 角色的 Amazon Resource Name (ARN)。
+ `DatabaseName` – UTF-8 字串。

  寫入結果的 AWS Glue 資料庫，例如：`arn:aws:daylight:us-east-1::database/sometable/*`。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  新爬蟲程式的描述。
+ `Targets` – *必要：*[CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets) 物件。

  待編目的目標集合清單。
+ `Schedule` – UTF-8 字串。

  用來指定排程的 `cron` 表達式 (請參閱[適用於任務與爬蟲程式的依時排程](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)。例如，如果要每天在 12:15 UTC 執行某項動作，您可以指定：`cron(15 12 * * ? *)`。
+ `Classifiers` – UTF-8 字串陣列。

  使用者已註冊的自訂分類器清單。依預設，所有內建分類器均包含在編目內，但這些自訂分類器一律覆寫特定分類的預設分類器。
+ `TablePrefix` – UTF-8 字串，長度不可超過 128 個位元組。

  用於為所建立之資料表建立目錄的資料表字首。
+ `SchemaChangePolicy` – [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy) 物件。

  爬蟲程式的更新和刪除行為政策。
+ `RecrawlPolicy` – [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy) 物件。

  一種政策，指定是否要再次網路爬取整個資料集，或只網路爬取自上次執行爬蟲程式後新增的資料夾。
+ `LineageConfiguration` – [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration) 物件。

  指定爬蟲程式的資料歷程組態設定。
+ `LakeFormationConfiguration` – [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration) 物件。

  指定爬蟲程式的 AWS Lake Formation 組態設定。
+ `Configuration` – UTF-8 字串。

  爬蟲程式組態資訊。此版本的 JSON 字串可讓使用者指定爬蟲程式的各種行為。如需詳細資訊，請參閱[設定爬蟲程式組態選項](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)。
+ `CrawlerSecurityConfiguration` – UTF-8 字串，長度不可超過 128 個位元組。

  此爬蟲程式要使用的 `SecurityConfiguration` 結構。
+ `Tags` – 金鑰值對的對應陣列，不超過 50 對。

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

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

  要搭配此爬蟲程式要求使用的標籤。您可以使用標籤來限制對於爬蟲程式的存取情況。如需 中標籤的詳細資訊 AWS Glue，請參閱《 開發人員指南》[AWS 中的 中的標籤 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。

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

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

## DeleteCrawler 動作 (Python: delete\$1crawler)
<a name="aws-glue-api-crawler-crawling-DeleteCrawler"></a>

從 移除指定的爬蟲程式 AWS Glue Data Catalog，除非爬蟲程式狀態為 `RUNNING`。

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

  要移除之爬蟲程式的名稱。

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

**錯誤**
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

## GetCrawler 動作 (Python: get\$1crawler)
<a name="aws-glue-api-crawler-crawling-GetCrawler"></a>

擷取特定爬蟲程式的中繼資料。

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

  要擷取中繼資料之爬蟲程式的名稱。

**回應**
+ `Crawler` – [爬蟲程式](#aws-glue-api-crawler-crawling-Crawler) 物件。

  特定爬蟲程式的中繼資料。

**錯誤**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetCrawlers 動作 (Python: get\$1crawlers)
<a name="aws-glue-api-crawler-crawling-GetCrawlers"></a>

從客戶帳戶中定義之所有爬蟲程式擷取中繼資料。

**請求**
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  每次呼叫要傳回的爬蟲程式數量。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續要求。

**回應**
+ `Crawlers` – 一個 [爬蟲程式](#aws-glue-api-crawler-crawling-Crawler) 物件陣列。

  爬蟲程式中繼資料清單。
+ `NextToken` – UTF-8 字串。

  持續字元，如果傳回的清單沒有達到此客戶帳戶中定義的結尾。

**錯誤**
+ `OperationTimeoutException`

## GetCrawlerMetrics 動作 (Python: get\$1crawler\$1metrics)
<a name="aws-glue-api-crawler-crawling-GetCrawlerMetrics"></a>

擷取指定爬蟲程式的指標。

**請求**
+ `CrawlerNameList` – UTF-8 字串的陣列，不可超過 100 個字串。

  要擷取指標之爬蟲程式的名稱清單。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  所要回傳清單的大小上限。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續呼叫。

**回應**
+ `CrawlerMetricsList` – 一個 [CrawlerMetrics](#aws-glue-api-crawler-crawling-CrawlerMetrics) 物件陣列。

  指定爬蟲程式的指標清單。
+ `NextToken` – UTF-8 字串。

  接續字元，如果傳回的清單未包含最後一個可用指標。

**錯誤**
+ `OperationTimeoutException`

## UpdateCrawler 動作 (Python: update\$1crawler)
<a name="aws-glue-api-crawler-crawling-UpdateCrawler"></a>

更新爬蟲程式。如果爬蟲程式執行中，您必須先使用 `StopCrawler` 停止爬蟲程式，然後再更新。

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

  新爬蟲程式的名稱。
+ `Role` – UTF-8 字串。

  新爬蟲程式用來存取客戶資源的 IAM 角色或某 IAM 角色的 Amazon Resource Name (ARN)。
+ `DatabaseName` – UTF-8 字串。

  存放結果的 AWS Glue 資料庫，例如：`arn:aws:daylight:us-east-1::database/sometable/*`。
+ `Description` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  新爬蟲程式的描述。
+ `Targets` – [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets) 物件。

  待編目的目標清單。
+ `Schedule` – UTF-8 字串。

  用來指定排程的 `cron` 表達式 (請參閱[適用於任務與爬蟲程式的依時排程](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)。例如，如果要每天在 12:15 UTC 執行某項動作，您可以指定：`cron(15 12 * * ? *)`。
+ `Classifiers` – UTF-8 字串陣列。

  使用者已註冊的自訂分類器清單。依預設，所有內建分類器均包含在編目內，但這些自訂分類器一律覆寫特定分類的預設分類器。
+ `TablePrefix` – UTF-8 字串，長度不可超過 128 個位元組。

  用於為所建立之資料表建立目錄的資料表字首。
+ `SchemaChangePolicy` – [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy) 物件。

  爬蟲程式的更新和刪除行為政策。
+ `RecrawlPolicy` – [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy) 物件。

  一種政策，指定是否要再次網路爬取整個資料集，或只網路爬取自上次執行爬蟲程式後新增的資料夾。
+ `LineageConfiguration` – [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration) 物件。

  指定爬蟲程式的資料歷程組態設定。
+ `LakeFormationConfiguration` – [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration) 物件。

  指定爬蟲程式的 AWS Lake Formation 組態設定。
+ `Configuration` – UTF-8 字串。

  爬蟲程式組態資訊。此版本的 JSON 字串可讓使用者指定爬蟲程式的各種行為。如需詳細資訊，請參閱[設定爬蟲程式組態選項](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)。
+ `CrawlerSecurityConfiguration` – UTF-8 字串，長度不可超過 128 個位元組。

  此爬蟲程式要使用的 `SecurityConfiguration` 結構。

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

**錯誤**
+ `InvalidInputException`
+ `VersionMismatchException`
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `OperationTimeoutException`

## StartCrawler 動作 (Python: start\$1crawler)
<a name="aws-glue-api-crawler-crawling-StartCrawler"></a>

使用指定的爬蟲程式開始編目，無論排程。如果爬蟲程式已經在執行中，則會傳回 [CrawlerRunningException](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-exceptions.html#aws-glue-api-exceptions-CrawlerRunningException)。

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

  要啟動的爬蟲程式名稱。

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

**錯誤**
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `OperationTimeoutException`

## StopCrawler 動作 (Python: stop\$1crawler)
<a name="aws-glue-api-crawler-crawling-StopCrawler"></a>

如果指定的爬蟲程式正在執行中，停止編目。

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

  要停止的爬蟲程式名稱。

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

**錯誤**
+ `EntityNotFoundException`
+ `CrawlerNotRunningException`
+ `CrawlerStoppingException`
+ `OperationTimeoutException`

## BatchGetCrawlers 動作 (Python: batch\$1get\$1crawlers)
<a name="aws-glue-api-crawler-crawling-BatchGetCrawlers"></a>

為指定的爬蟲程式名稱清單，傳回資源中繼資料的清單。呼叫 `ListCrawlers` 操作之後，您便可以呼叫此操作來存取您已授與許可的資料。此操作支援所有 IAM 許可，包括使用標籤的許可條件。

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

  爬蟲程式名稱清單，可能是從 `ListCrawlers` 操作傳回的名稱。

**回應**
+ `Crawlers` – 一個 [爬蟲程式](#aws-glue-api-crawler-crawling-Crawler) 物件陣列。

  爬蟲程式定義的清單。
+ `CrawlersNotFound` – UTF-8 字串的陣列，不可超過 100 個字串。

  未尋獲爬蟲程式的名稱清單。

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

## ListCrawlers 動作 (Python: list\$1crawlers)
<a name="aws-glue-api-crawler-crawling-ListCrawlers"></a>

擷取此 AWS 帳戶中所有爬蟲程式資源的名稱，或使用指定標籤的資源。您可運用此操作，查看帳戶下有哪些可用資源及其名稱。

此操作會接收您可在回應時做為篩選條件的選用 `Tags` 欄位，因此已標記的資源可分組進行擷取。如果您選擇使用標籤進行篩選，則此時只會擷取包含該標籤的資源。

**請求**
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  所要回傳清單的大小上限。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續要求。
+ `Tags` – 金鑰值對的對應陣列，不超過 50 對。

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

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

  指定只傳回包含這些標籤的資源。

**回應**
+ `CrawlerNames` – UTF-8 字串的陣列，不可超過 100 個字串。

  這個帳戶下所有爬蟲程式的名稱，或是使用指定標籤的爬蟲程式。
+ `NextToken` – UTF-8 字串。

  接續字元，如果傳回的清單未包含最後一個可用指標。

**錯誤**
+ `OperationTimeoutException`

## ListCrawls 動作 (Python：list\$1crawls)
<a name="aws-glue-api-crawler-crawling-ListCrawls"></a>

傳回指定爬蟲程式的所有網路爬取。僅傳回自爬蟲程式歷史記錄功能啟動日期以來發生的網路爬取，而且最多只會保留 12 個月的網路爬取。不會傳回較舊的網路爬取。

您可以使用此 API 來：
+ 擷取指定爬蟲程式的所有網路爬取。
+ 在有限的計數內擷取指定爬蟲程式的所有網路爬取。
+ 擷取特定時間範圍內指定爬蟲程式的所有網路爬取。
+ 擷取具有特定狀態、網路爬取 ID 或 DPU 小時值的指定爬蟲程式的所有網路爬取。

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

  您希望擷取其執行的爬蟲程式名稱。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回傳結果的數量上限。預設值為 20，最大值為 100。
+ `Filters` – 一個 [CrawlsFilter](#aws-glue-api-crawler-crawling-CrawlsFilter) 物件陣列。

  依照您在下列 `CrawlsFilter` 物件的清單中指定的條件篩選網路爬取。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續呼叫。

**回應**
+ `Crawls` – 一個 [CrawlerHistory](#aws-glue-api-crawler-crawling-CrawlerHistory) 物件陣列。

  `CrawlerHistory` 物件的清單，代表符合您條件的網路爬取執行。
+ `NextToken` – UTF-8 字串。

  為一種接續符記，用於將傳回的符記清單分頁，而如果清單目前的區段不是最後區段就會傳回。

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

# 資料欄統計資料 API
<a name="aws-glue-api-crawler-column-statistics"></a>

資料欄統計資料 API 描述傳回資料表中資料欄統計資料的 AWS Glue APIs。

## 資料類型
<a name="aws-glue-api-crawler-column-statistics-objects"></a>
+ [ColumnStatisticsTaskRun 結構](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun)
+ [ColumnStatisticsTaskSettings 結構](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings)
+ [ExecutionAttempt 結構](#aws-glue-api-crawler-column-statistics-ExecutionAttempt)

## ColumnStatisticsTaskRun 結構
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun"></a>

顯示資料欄統計資料執行之詳細資料的物件。

**欄位**
+ `CustomerId` – UTF-8 字串，長度不可超過 12 個位元組。

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

  適用於特定資料欄統計資料任務執行的識別碼。
+ `DatabaseName` – UTF-8 字串。

  資料表所在的資料庫。
+ `TableName` – UTF-8 字串。

  產生資料欄統計資料之資料表的名稱。
+ `ColumnNameList` – UTF-8 字串陣列。

  欄名稱之清單。若未提供，則依預設系統將會使用資料表的所有資料欄名稱。
+ `CatalogID` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料表所在的 Data Catalog 的 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `Role` – UTF-8 字串。

  服務用於產生統計資料的 IAM 角色。
+ `SampleSize`：數字 (雙位數)，不可大於 100。

  用來產生統計資料的資料列百分比。若未提供，則系統將會使用整個資料表產生統計資料。
+ `SecurityConfiguration` – UTF-8 字串，長度不可超過 128 個位元組。

  用於加密資料欄統計資料任務執行之 CloudWatch 日誌的安全組態名稱。
+ `NumberOfWorkers` – 數字 (整數)，至少為 1。

  用於產生資料欄統計資料的工作者數量。此任務已預先設定為自動擴展至 25 個執行個體。
+ `WorkerType` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於產生統計資料的工作者類型。預設值為 `g.1x`。
+ `ComputationType` – UTF-8 字串 (有效值：`FULL` \$1 `INCREMENTAL`)。

  資料欄統計資料運算的類型。
+ `Status` – UTF-8 字串 (有效值：`STARTING` \$1 `RUNNING` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `STOPPED`)。

  任務執行的狀態。
+ `CreationTime` – 時間戳記。

  此任務建立的時間。
+ `LastUpdated` – 時間戳記。

  此任務上次修改的時間點。
+ `StartTime` – 時間戳記。

  任務的開始時間。
+ `EndTime` – 時間戳記。

  任務的結束時間。
+ `ErrorMessage` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  任務的錯誤訊息。
+ `DPUSeconds` – 數字 (雙精度浮點數)，不可大於 None (無)。

  所有自動擴展之工作者的計算 DPU 用量 (以秒為單位)。

## ColumnStatisticsTaskSettings 結構
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings"></a>

資料欄統計資料任務的設定。

**欄位**
+ `DatabaseName` – UTF-8 字串。

  資料表所在的資料庫名稱。
+ `TableName` – UTF-8 字串。

  為其產生資料欄統計資料的資料表名稱。
+ `Schedule` – [Schedule](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule) 物件。

  執行資料欄統計資料的排程 (以 CRON 語法指定)。
+ `ColumnNameList` – UTF-8 字串陣列。

  要為其執行統計資料的資料欄名稱清單。
+ `CatalogID` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料庫存放所在 Data Catalog 的 ID。
+ `Role` – UTF-8 字串。

  用於執行資料欄統計資料的角色。
+ `SampleSize`：數字 (雙位數)，不可大於 100。

  要取樣的資料百分比。
+ `SecurityConfiguration` – UTF-8 字串，長度不可超過 128 個位元組。

  用於加密 CloudWatch 日誌的安全組態名稱。
+ `ScheduleType` – UTF-8 字串 (有效值：`CRON` \$1 `AUTO`)。

  資料欄統計資料任務的排程類型。可能的值為 `CRON` 或 `AUTO`。
+ `SettingSource` – UTF-8 字串 (有效值：`CATALOG` \$1 `TABLE`)。

  設定資料欄統計資料任務的來源。可能的值為 `CATALOG` 或 `TABLE`。
+ `LastExecutionAttempt` – [ExecutionAttempt](#aws-glue-api-crawler-column-statistics-ExecutionAttempt) 物件。

  資料欄統計資料任務執行的最後一次 `ExecutionAttempt`。

## ExecutionAttempt 結構
<a name="aws-glue-api-crawler-column-statistics-ExecutionAttempt"></a>

資料欄統計資料任務執行的執行嘗試。

**欄位**
+ `Status` – UTF-8 字串 (有效值：`FAILED` \$1 `STARTED`)。

  最後一個資料欄統計資料任務執行的狀態。
+ `ColumnStatisticsTaskRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  最後一個資料欄統計資料任務執行的任務執行 ID。
+ `ExecutionTimestamp` – 時間戳記。

  最後一個資料欄統計資料任務執行時的時間戳記。
+ `ErrorMessage` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  與最後一個資料欄統計資料任務執行關聯的錯誤訊息。

## 作業
<a name="aws-glue-api-crawler-column-statistics-actions"></a>
+ [StartColumnStatisticsTaskRun 動作 (Python：start\$1column\$1statistics\$1task\$1run)](#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun)
+ [GetColumnStatisticsTaskRun 動作 (Python：get\$1column\$1statistics\$1task\$1run)](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun)
+ [GetColumnStatisticsTaskRuns 動作 (Python：get\$1column\$1statistics\$1task\$1runs)](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns)
+ [ListColumnStatisticsTaskRuns 動作 (Python：list\$1column\$1statistics\$1task\$1runs)](#aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns)
+ [StopColumnStatisticsTaskRun 動作 (Python：stop\$1column\$1statistics\$1task\$1run)](#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun)
+ [CreateColumnStatisticsTaskSettings 動作 (Python：create\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings)
+ [UpdateColumnStatisticsTaskSettings 動作 (Python：update\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings)
+ [GetColumnStatisticsTaskSettings 動作 (Python：get\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings)
+ [DeleteColumnStatisticsTaskSettings 動作 (Python：delete\$1column\$1statistics\$1task\$1settings)](#aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings)
+ [StartColumnStatisticsTaskRunSchedule 動作 (Python：start\$1column\$1statistics\$1task\$1run\$1schedule)](#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule)
+ [StopColumnStatisticsTaskRunSchedule 動作 (Python：stop\$1column\$1statistics\$1task\$1run\$1schedule)](#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule)

## StartColumnStatisticsTaskRun 動作 (Python：start\$1column\$1statistics\$1task\$1run)
<a name="aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun"></a>

針對指定的資料表和資料欄，啟動資料欄統計資料任務執行。

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

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

  用於產生統計資料的資料表名稱。
+ `ColumnNameList` – UTF-8 字串陣列。

  用於產生統計資料之資料欄名稱的清單。若未提供，則依預設系統將會使用資料表的所有資料欄名稱。
+ `Role` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  服務用於產生統計資料的 IAM 角色。
+ `SampleSize`：數字 (雙位數)，不可大於 100。

  用來產生統計資料的資料列百分比。若未提供，則系統將會使用整個資料表產生統計資料。
+ `CatalogID` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料表所在之 Data Catalog 的 ID。若沒有提供，則依預設會使用 AWS 帳戶 ID。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於加密資料欄統計資料任務執行之 CloudWatch 日誌的安全組態名稱。

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

  資料欄統計資料任務執行的識別碼。

**錯誤**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ColumnStatisticsTaskRunningException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InvalidInputException`

## GetColumnStatisticsTaskRun 動作 (Python：get\$1column\$1statistics\$1task\$1run)
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun"></a>

取得已知任務執行 ID 之任務執行的相關中繼資料/資訊。

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

  適用於特定資料欄統計資料任務執行的識別碼。

**回應**
+ `ColumnStatisticsTaskRun` – [ColumnStatisticsTaskRun](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun) 物件。

  表示資料欄統計資料執行之詳細資料的 `ColumnStatisticsTaskRun` 物件。

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

## GetColumnStatisticsTaskRuns 動作 (Python：get\$1column\$1statistics\$1task\$1runs)
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns"></a>

擷取與指定資料表相關聯之所有執行的相關資訊。

**請求**
+ `DatabaseName` – *必要：*UTF-8 字串。

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

   資料表的名稱。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回應的大小上限。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續呼叫。

**回應**
+ `ColumnStatisticsTaskRuns` – 一個 [ColumnStatisticsTaskRun](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun) 物件陣列。

  資料欄統計資料任務執行的清單。
+ `NextToken` – UTF-8 字串。

  持續權杖 (如果尚未傳回所有任務執行)。

**錯誤**
+ `OperationTimeoutException`

## ListColumnStatisticsTaskRuns 動作 (Python：list\$1column\$1statistics\$1task\$1runs)
<a name="aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns"></a>

列出特定帳戶的所有任務執行。

**請求**
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回應的大小上限。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續呼叫。

**回應**
+ `ColumnStatisticsTaskRunIds` – UTF-8 字串的陣列，不可超過 100 個字串。

  資料欄統計資料任務執行 ID 的清單。
+ `NextToken` – UTF-8 字串。

  持續權杖 (如果尚未傳回所有任務執行 ID)。

**錯誤**
+ `OperationTimeoutException`

## StopColumnStatisticsTaskRun 動作 (Python：stop\$1column\$1statistics\$1task\$1run)
<a name="aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun"></a>

停止指定資料表的任務執行。

**請求**
+ `DatabaseName` – *必要：*UTF-8 字串。

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

   資料表的名稱。

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

**錯誤**
+ `EntityNotFoundException`
+ `ColumnStatisticsTaskNotRunningException`
+ `ColumnStatisticsTaskStoppingException`
+ `OperationTimeoutException`

## CreateColumnStatisticsTaskSettings 動作 (Python：create\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings"></a>

建立資料欄統計資料任務的設定。

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

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

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

  用於執行資料欄統計資料的角色。
+ `Schedule` – UTF-8 字串。

  執行資料欄統計資料的排程 (以 CRON 語法指定)。
+ `ColumnNameList` – UTF-8 字串陣列。

  要為其執行統計資料的資料欄名稱清單。
+ `SampleSize`：數字 (雙位數)，不可大於 100。

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

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

  用於加密 CloudWatch 日誌的安全組態名稱。
+ `Tags` – 金鑰值對的映射陣列，不超過 50 對。

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

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

  標籤的映射。

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

**錯誤**
+ `AlreadyExistsException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ColumnStatisticsTaskRunningException`

## UpdateColumnStatisticsTaskSettings 動作 (Python：update\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings"></a>

更新資料欄統計資料任務的設定。

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

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

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

  用於執行資料欄統計資料的角色。
+ `Schedule` – UTF-8 字串。

  執行資料欄統計資料的排程 (以 CRON 語法指定)。
+ `ColumnNameList` – UTF-8 字串陣列。

  要為其執行統計資料的資料欄名稱清單。
+ `SampleSize`：數字 (雙位數)，不可大於 100。

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

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

  用於加密 CloudWatch 日誌的安全組態名稱。

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

**錯誤**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `VersionMismatchException`
+ `OperationTimeoutException`

## GetColumnStatisticsTaskSettings 動作 (Python：get\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings"></a>

取得資料欄統計資料任務的設定。

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

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

  為其擷取資料欄統計資料的資料表名稱。

**回應**
+ `ColumnStatisticsTaskSettings` – [ColumnStatisticsTaskSettings](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings) 物件。

  代表資料欄統計資料任務設定的 `ColumnStatisticsTaskSettings` 物件。

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

## DeleteColumnStatisticsTaskSettings 動作 (Python：delete\$1column\$1statistics\$1task\$1settings)
<a name="aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings"></a>

刪除資料欄統計資料任務的設定。

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

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

  為其刪除資料欄統計資料的資料表名稱。

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

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

## StartColumnStatisticsTaskRunSchedule 動作 (Python：start\$1column\$1statistics\$1task\$1run\$1schedule)
<a name="aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule"></a>

啟動資料欄統計資料任務執行排程。

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

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

  要為其啟動資料欄統計資料任務執行排程的資料表名稱。

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

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

## StopColumnStatisticsTaskRunSchedule 動作 (Python：stop\$1column\$1statistics\$1task\$1run\$1schedule)
<a name="aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule"></a>

停止資料欄統計資料任務執行排程。

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

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

  要對其停止資料欄統計資料任務執行排程的資料表名稱。

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

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

## 例外狀況
<a name="aws-glue-api-crawler-column-statistics-exceptions"></a>
+ [ColumnStatisticsTaskRunningException 結構](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException)
+ [ColumnStatisticsTaskNotRunningException 結構](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException)
+ [ColumnStatisticsTaskStoppingException 結構](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException)
+ [ColumnStatisticsTaskAutoConcurrencyLimitException 結構](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException)
+ [InvalidCatalogSettingException 結構](#aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException)

## ColumnStatisticsTaskRunningException 結構
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException"></a>

當您在執行資料欄統計資料產生任務期間，嘗試啟動其他任務時發生的例外狀況。

**欄位**
+ `Message` – UTF-8 字串。

  說明問題的訊息。

## ColumnStatisticsTaskNotRunningException 結構
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException"></a>

當您在沒有任務執行期間，嘗試停止任務執行時發生的例外狀況。

**欄位**
+ `Message` – UTF-8 字串。

  說明問題的訊息。

## ColumnStatisticsTaskStoppingException 結構
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException"></a>

當您嘗試停止任務執行時發生的例外狀況。

**欄位**
+ `Message` – UTF-8 字串。

  說明問題的訊息。

## ColumnStatisticsTaskAutoConcurrencyLimitException 結構
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException"></a>

當您已達到並行自動統計資料任務的限制時擲回例外狀況。

**欄位**
+ `Message` – UTF-8 字串。

  說明問題的訊息。

## InvalidCatalogSettingException 結構
<a name="aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException"></a>

在目錄設定發生問題時擲回例外狀況。

**欄位**
+ `Message` – UTF-8 字串。

  說明問題的訊息。

# 爬蟲程式排程器 API
<a name="aws-glue-api-crawler-scheduler"></a>

爬蟲程式排程器 API 說明 AWS Glue 爬蟲程式資料類型，以及用於建立、刪除、更新和列出爬蟲程式的 API。

## 資料類型
<a name="aws-glue-api-crawler-scheduler-objects"></a>
+ [Schedule 結構](#aws-glue-api-crawler-scheduler-Schedule)

## Schedule 結構
<a name="aws-glue-api-crawler-scheduler-Schedule"></a>

排程物件，使用 `cron` 陳述式來將事件排程。

**欄位**
+ `ScheduleExpression` – UTF-8 字串。

  用來指定排程的 `cron` 表達式 (請參閱[適用於任務與爬蟲程式的依時排程](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)。例如，如果要每天在 12:15 UTC 執行某項動作，您可以指定：`cron(15 12 * * ? *)`。
+ `State` – UTF-8 字串 (有效值：`SCHEDULED` \$1 `NOT_SCHEDULED` \$1 `TRANSITIONING`)。

  排程的狀態。

## 作業
<a name="aws-glue-api-crawler-scheduler-actions"></a>
+ [UpdateCrawlerSchedule 動作 (Python: update\$1crawler\$1schedule)](#aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule)
+ [StartCrawlerSchedule 動作 (Python: start\$1crawler\$1schedule)](#aws-glue-api-crawler-scheduler-StartCrawlerSchedule)
+ [StopCrawlerSchedule 動作 (Python: stop\$1crawler\$1schedule)](#aws-glue-api-crawler-scheduler-StopCrawlerSchedule)

## UpdateCrawlerSchedule 動作 (Python: update\$1crawler\$1schedule)
<a name="aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule"></a>

使用 `cron` 表達式來更新爬蟲程式排程。

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

  要更新排程之爬蟲程式的名稱。
+ `Schedule` – UTF-8 字串。

  更新的 `cron` 表達式，用來指定排程 (請參閱[適用於任務與爬蟲程式的依時排程](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)。例如，如果要每天在 12:15 UTC 執行某項動作，您可以指定：`cron(15 12 * * ? *)`。

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

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `VersionMismatchException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

## StartCrawlerSchedule 動作 (Python: start\$1crawler\$1schedule)
<a name="aws-glue-api-crawler-scheduler-StartCrawlerSchedule"></a>

將指定爬蟲程式的排程狀態變更為 `SCHEDULED` (除非爬蟲程式已在執行中，或排程狀態已經是 `SCHEDULED`。)

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

  要排程的爬蟲程式的名稱。

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

**錯誤**
+ `EntityNotFoundException`
+ `SchedulerRunningException`
+ `SchedulerTransitioningException`
+ `NoScheduleException`
+ `OperationTimeoutException`

## StopCrawlerSchedule 動作 (Python: stop\$1crawler\$1schedule)
<a name="aws-glue-api-crawler-scheduler-StopCrawlerSchedule"></a>

將指定爬蟲程式的排程狀態設定為 `NOT_SCHEDULED`，但如果爬蟲程式已在執行中，此動作不會停止爬蟲程式。

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

  要更新其排程狀態的爬蟲程式的名稱。

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

**錯誤**
+ `EntityNotFoundException`
+ `SchedulerNotRunningException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`