# クローラーおよび分類子 API
クローラーおよび分類子 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
分類子 API では、AWS Glue 分類子のデータ型について説明します。これには、分類子を作成、削除、更新、および一覧表示するための API が含まれます。
## データ型
+ [分類子の構造](#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)
## 分類子の構造
分類子は、クロールタスクでトリガーされます。分類子は、指定されたファイルが処理可能な形式であるかどうかをチェックします。処理可能な場合、分類子は、そのデータ形式と一致する `StructType` オブジェクトの形式でスキーマを作成します。
AWS Glue に用意されている標準の分類子を使用することも、独自の分類子を作成して、データソースの最適な分類を行い、これらに使用する適切なスキーマを指定することもできます。分類子として、`Classifier` オブジェクトの各フィールドに指定されている `grok` 分類子、`XML` 分類子、`JSON` 分類子、または `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 の構造
`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 文字列。16,000 バイト長以下。[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 の構造
`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 タグ。これは、自己終了要素 (`/>` で終了) を識別することはできません。属性のみを含む空の行要素は、終了タグで終わる場合は解析できます (例: `|
` は解析できますが、`|
` は解析できません)。
## JsonClassifier の構造
`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 は、「[Writing JsonPath Custom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)」に記載されているように、JsonPath のサブセットをサポートしています。
## CsvClassifier の構造
カスタム `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 バイト長ちょうど。[Custom string pattern #26](aws-glue-api-common.md#regex_26) に一致。
行内の各列エントリを区切るものを示すカスタム記号。
+ `QuoteSymbol` – UTF-8 文字列。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` – ブール。
1 つの列のみを含むファイルの処理を有効にします。
+ `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 を設定します。有効な値は、`OpenCSVSerDe`、`LazySimpleSerDe`、`None` です。クローラーが検出を行う場合は、`None` 値を指定できます。
## CreateGrokClassifierRequest の構造
作成する `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 文字列。16,000 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
この分類子によって使用されたオプションのカスタム Grok パターン。
## UpdateGrokClassifierRequest の構造
`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 ～ 2,048 バイト長。[A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern) に一致。
この分類子によって使用される grok パターン。
+ `CustomPatterns` - UTF-8 文字列。16,000 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
この分類子によって使用されたオプションのカスタム Grok パターン。
## CreateXMLClassifierRequest の構造
作成する `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 タグ。これは、自己終了要素 (`/>` で終了) を識別することはできません。属性のみを含む空の行要素は、終了タグで終わる場合は解析できます (例: `|
` は解析できますが、`|
` は解析できません)。
## UpdateXMLClassifierRequest の構造
更新する 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 タグ。これは、自己終了要素 (`/>` で終了) を識別することはできません。属性のみを含む空の行要素は、終了タグで終わる場合は解析できます (例: `|
` は解析できますが、`|
` は解析できません)。
## CreateJsonClassifierRequest の構造
作成する `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 は、「[Writing JsonPath Custom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)」に記載されているように、JsonPath のサブセットをサポートしています。
## UpdateJsonClassifierRequest の構造
更新する 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 は、「[Writing JsonPath Custom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)」に記載されているように、JsonPath のサブセットをサポートしています。
## CreateCsvClassifierRequest の構造
作成する `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 バイト長ちょうど。[Custom string pattern #26](aws-glue-api-common.md#regex_26) に一致。
行内の各列エントリを区切るものを示すカスタム記号。
+ `QuoteSymbol` – UTF-8 文字列。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` – ブール。
1 つの列のみを含むファイルの処理を有効にします。
+ `CustomDatatypeConfigured` – ブール。
カスタムデータ型の設定を有効にします。
+ `CustomDatatypes` – UTF-8 文字列の配列。
サポートされているカスタムデータ型のリストを作成します。
+ `Serde` – UTF-8 文字列 (有効な値: `OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`)。
分類子で CSV を処理するため、データカタログに適用される SerDe を設定します。有効な値は、`OpenCSVSerDe`、`LazySimpleSerDe`、`None` です。クローラーが検出を行う場合は、`None` 値を指定できます。
## UpdateCsvClassifierRequest の構造
更新する カスタム CSV 分類子を指定します。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
分類子名。
+ `Delimiter` – UTF-8 文字列。1 バイト長ちょうど。[Custom string pattern #26](aws-glue-api-common.md#regex_26) に一致。
行内の各列エントリを区切るものを示すカスタム記号。
+ `QuoteSymbol` – UTF-8 文字列。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` – ブール。
1 つの列のみを含むファイルの処理を有効にします。
+ `CustomDatatypeConfigured` – ブール。
カスタムデータ型の設定を指定します。
+ `CustomDatatypes` – UTF-8 文字列の配列。
サポートされているカスタムデータ型のリストを指定します。
+ `Serde` – UTF-8 文字列 (有効な値: `OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`)。
分類子で CSV を処理するため、データカタログに適用される SerDe を設定します。有効な値は、`OpenCSVSerDe`、`LazySimpleSerDe`、`None` です。クローラーが検出を行う場合は、`None` 値を指定できます。
## 操作
+ [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)
ユーザーのアカウントに分類子を作成します。これは、どのリクエストのフィールドが存在するかに応じて、`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)
データカタログから分類子を削除します。
**リクエスト**
+ `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)
分類子を名前で取得します。
**リクエスト**
+ `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)
データカタログの分類子オブジェクトのすべてを一覧表示します。
**リクエスト**
+ `MaxResults` – 1～1000 の数値 (整数)。
返されるリストのサイズ (オプション)。
+ `NextToken` – UTF–8 文字列。
オプションの継続トークン。
**応答**
+ `Classifiers` – [分類子](#aws-glue-api-crawler-classifiers-Classifier) オブジェクトの配列。
分類子オブジェクトのリクエストされたリスト。
+ `NextToken` – UTF–8 文字列。
継続トークン。
**エラー**
+ `OperationTimeoutException`
## UpdateClassifier アクション (Python: update\$1classifier)
既存の分類子を変更します (フィールドが存在するかどうかに応じて `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
クローラー API では、AWS Glue クローラーのデータ型と、クローラーを作成、削除、更新、および一覧表示するための API について説明します。
## データタイプ
+ [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 構造
データソースを検査し、分類子を使用してスキーマを判別しようとするクローラープログラムを指定します。成功すると、クローラーはデータソースに関するメタデータを 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 リソースネーム (ARN)。
+ `Targets` – [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets) オブジェクト。
クロールするターゲットのコレクション。
+ `DatabaseName` – UTF–8 文字列。
クローラーの出力が保存されている場所のデータベース名。
+ `Description` – 説明文字列。2,048 バイト長以下。[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` – [スケジュール](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) オブジェクト。
クローラーが IAM ロールの認証情報の代わりに AWS Lake Formation の認証情報を使用すべきかどうかを指定します。
## Schedule 構造
`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 構造
クロールするデータストアを指定します。
**フィールド**
+ `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 構造
Amazon Simple Storage Service (Amazon S3) のデータストアを指定します。
**フィールド**
+ `Path` – UTF-8 文字列。
Simple Storage Service (Amazon S3) ターゲットへのパス。
+ `Exclusions` – UTF-8 文字列の配列。
クロールから除外するために使用される glob パターンのリスト。詳細については、「[クローラーを使用したカタログテーブル](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)」を参照してください。
+ `ConnectionName` – UTF-8 文字列。1～2048 バイト長。
ジョブまたはクローラーが 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 構造
AWS Glue データカタログ内の Delta Lake データソースに書き込むターゲットを指定します。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。[Custom string pattern #63](aws-glue-api-common.md#regex_63) に一致。
データターゲットの名前。
+ `Inputs` – *必須:* UTF-8 文字列の配列。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` – キーバリューペアのマップ配列。
各キーは、[Custom string pattern #61](aws-glue-api-common.md#regex_61) に適合する UTF-8 文字列です。
各値は、[Custom string pattern #61](aws-glue-api-common.md#regex_61) に適合する UTF-8 文字列です。
コネクタの追加接続オプションを指定します。
+ `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 構造
Amazon S3 内の Delta Lake データソースに書き込むターゲットを指定します。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。[Custom string pattern #63](aws-glue-api-common.md#regex_63) に一致。
データターゲットの名前。
+ `Inputs` – *必須:* UTF-8 文字列の配列。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` – キーバリューペアのマップ配列。
各キーは、[Custom string pattern #61](aws-glue-api-common.md#regex_61) に適合する UTF-8 文字列です。
各値は、[Custom string pattern #61](aws-glue-api-common.md#regex_61) に適合する UTF-8 文字列です。
コネクタの追加接続オプションを指定します。
+ `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 構造
クロールする 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 構造
クロールする Amazon DocumentDB または MongoDB データストアを指定します。
**フィールド**
+ `ConnectionName` – UTF-8 文字列。1～2,048 バイト長。
Amazon DocumentDB または MongoDB ターゲットに接続するために使用する接続名。
+ `Path` – UTF–8 文字列。
Amazon DocumentDB または MongoDB ターゲット (データベース/コレクション) のパス。
+ `ScanAll` – ブール。
すべてのレコードをスキャンするか、テーブルから行をサンプリングするかを示します。テーブルが高スループットテーブルではない場合、すべてのレコードのスキャンには時間がかかることがあります。
`true` 値はすべてのレコードをスキャンすることを意味し、`false` 値はレコードをサンプリングすることを意味します。値を指定しないと、`true` 値にデフォルト設定されます。
## DynamoDBTarget 構造
クロールする Amazon DynamoDB テーブルを指定します。
**フィールド**
+ `Path` – UTF-8 文字列。
クロールする DynamoDB テーブルの名前。
+ `scanAll` – ブール。
すべてのレコードをスキャンするか、テーブルから行をサンプリングするかを示します。テーブルが高スループットテーブルではない場合、すべてのレコードのスキャンには時間がかかることがあります。
`true` 値はすべてのレコードをスキャンすることを意味し、`false` 値はレコードをサンプリングすることを意味します。値を指定しないと、`true` 値にデフォルト設定されます。
+ `scanRate` – 数値 (double)。
AWS Glue クローラーで使用する設定済み読み取りキャパシティーユニットの割合を指定します。読み取りキャパシティーユニットは、DynamoDB で定義されている用語で、テーブルに対して実行できる読み取り回数/秒のレート制限として機能する数値です。
有効な値は NULL または 0.1～1.5 の値です。NULL 値は、ユーザーが値を指定しない場合に使用され、設定済み読み取りキャパシティーユニットでは 0.5 (プロビジョニングされたテーブルの場合)、は最大の設定済み読み取りキャパシティーユニットの場合は 0.25 (オンデマンドモードを使用するテーブルの場合) にデフォルト設定されます。
## DeltaTarget 構造
1 つ以上の Delta テーブルをクロールする Delta データストアを指定します。
**フィールド**
+ `DeltaTables` – UTF-8 文字列の配列。
Delta テーブルへの Simple Storage Service (Amazon S3) パスのリスト。
+ `ConnectionName` – UTF-8 文字列。1～2,048 バイト長。
Delta テーブルターゲットに接続するために使用する接続の名前。
+ `WriteManifest` – ブール。
マニフェストファイルを Delta テーブルパスに書き込むかどうかを指定します。
+ `CreateNativeDeltaTable` – ブール。
クローラーがネイティブテーブルを作成するかどうかを指定します。これにより、Delta トランザクションログの直接クエリをサポートするクエリエンジンとの統合が可能になります。
## IcebergTarget 構造
Amazon S3 内の Iceberg テーブルが格納されている Apache Iceberg データソースを指定します。
**フィールド**
+ `Paths` – UTF-8 文字列の配列。
`s3://bucket/prefix` のように、Iceberg メタデータフォルダを含む 1 つ以上の Amazon S3 パス。
+ `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 パス内の Iceberg メタデータフォルダを発見するために横断できる Amazon S3 パスの最大深度。クローラーの実行時間を制限するために使用されます。
## HudiTarget 構造
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 パス内の Hudi メタデータフォルダを発見するために横断できる Amazon S3 パスの最大深度。クローラーの実行時間を制限するために使用されます。
## CatalogTarget 構造
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 バイト長。
`NETWORK` 接続タイプとペアになっている `Catalog` 接続タイプを使用するときにクロールのターゲットとなる Amazon S3-backed データカタログテーブルの接続の名前。
+ `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 構造
指定されたクローラーのメトリクス。
**フィールド**
+ `CrawlerName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
クローラー名。
+ `TimeLeftSeconds` – 数値 (double)。None 以下。
実行中のクロールを完了までの予測時間。
+ `StillEstimating` – ブール。
クローラーがこの実行を完了するのにどれくらいの時間がかかるかをまだ見積もっている場合は true です。
+ `LastRuntimeSeconds` – 数値 (double)。None 以下。
クローラーの最新の実行にかかる時間 (秒単位)。
+ `MedianRuntimeSeconds` – 数値 (double)。None 以下。
このクローラーの実行時間の中央値 (秒単位)。
+ `TablesCreated` – 数値 (整数)、None 以下。
このクローラーで作成されたテーブルの数。
+ `TablesUpdated` – 数値 (整数)、None 以下。
このクローラーで更新されたテーブルの数。
+ `TablesDeleted` – 数値 (整数)、None 以下。
このクローラーで削除されたテーブルの数。
## CrawlerHistory 構造
クローラーの実行に関する情報が含まれます。
**フィールド**
+ `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` – 説明文字列。2,048 バイト長以下。[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` – 数値 (double)。None 以下。
クロールに使用されるデータ処理単位 (DPU) の数 (時間単位)。
## CrawlsFilter 構造
指定されたクローラーのクローラー実行をフィルタリングするために使用できるフィールド、コンパレータ、および値のリスト。
**フィールド**
+ `FieldName` – UTF-8 文字列 (有効な値: `CRAWL_ID` \$1 `STATE` \$1 `START_TIME` \$1 `END_TIME` \$1 `DPU_HOUR`)。
指定されたクローラーに対するクローラーの実行をフィルタリングするために使用されるキー。各フィールド名に有効な値は次のとおりです。
+ `CRAWL_ID`: クロールの UUID 識別子を表す文字列。
+ `STATE`: クロールの状態を表す文字列。
+ `START_TIME` および `END_TIME`: epoch タイムスタンプ (ミリ秒単位)。
+ `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 構造
クローラーの更新と削除の動作を指定するポリシー。
**フィールド**
+ `UpdateBehavior` – UTF-8 文字列 (有効な値: `LOG` \$1 `UPDATE_IN_DATABASE`)。
クローラーが変更されたスキーマを検出したときの更新動作。
+ `DeleteBehavior` – UTF-8 文字列 (有効な値: `LOG` \$1 `DELETE_FROM_DATABASE` \$1 `DEPRECATE_IN_DATABASE`)。
クローラーが削除されたオブジェクトを検出したときの削除動作。
## LastCrawlInfo 構造
最新のクロールについてのステータスとエラー情報。
**フィールド**
+ `Status` – UTF-8 文字列 (有効な値: `SUCCEEDED` \$1 `CANCELLED` \$1 `FAILED`)。
最後のクロールのステータス。
+ `ErrorMessage` – 説明文字列、2,048 バイト長以下、[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 構造
最初のクロールの完了後に 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` の値は Simple Storage Service (Amazon S3) イベントによって識別される変更のみをクロールするように指定します。
## LineageConfiguration 構造
クローラーのデータ系統設定を指定します。
**フィールド**
+ `CrawlerLineageSettings` – UTF-8 文字列 (有効な値: `ENABLE` \$1 `DISABLE`)。
クローラーに対してデータ系統を有効にするかどうかを指定します。次の値を指定できます。
+ ENABLE: クローラーのデータ系統を有効にします。
+ DISABLE：クローラーのデータ系統を無効にします。
## LakeFormationConfiguration 構造
クローラーの AWS Lake Formation 構成設定を指定します。
**フィールド**
+ `UseLakeFormationCredentials` – ブール。
IAM ロールの認証情報の代わりに AWS Lake Formation の認証情報を使用するかどうかを指定します。
+ `AccountId` - UTF-8 文字列。12 バイト長以下。
クロスアカウントクロールに必要です。ターゲットデータと同じアカウントのクロールでは、null のままにすることができます。
## 操作
+ [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 Action (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)
指定されたターゲット、ロール、設定、およびオプションのスケジュールを使用して、新しいクローラーを作成します。`s3Targets`、`jdbcTargets`、または`DynamoDBTargets` フィールドで、少なくとも 1 つ以上のクロールを指定する必要があります。
**リクエスト**
+ `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 リソースネーム (ARN)。
+ `DatabaseName` – UTF–8 文字列。
`arn:aws:daylight:us-east-1::database/sometable/*` など、結果が書き込まれる AWS Glue データベース。
+ `Description` – 説明文字列。2,048 バイト長以下。[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 Tags in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)」を参照してください。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
## DeleteCrawler アクション (Python: delete\$1crawler)
クローラーの状態が `RUNNING` でないかぎり、指定したクローラーを AWS Glue Data Catalog から削除します。
**リクエスト**
+ `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)
指定されたクローラーのメタデータを取得します。
**リクエスト**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
メタデータを取得するクローラーの名前。
**応答**
+ `Crawler` – [Crawler](#aws-glue-api-crawler-crawling-Crawler) オブジェクト。
指定されたクローラーのメタデータ。
**エラー**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
## GetCrawlers アクション (Python: get\$1crawlers)
顧客アカウントで定義されたすべてのクローラーのメタデータを取得します。
**リクエスト**
+ `MaxResults` – 1～1000 の数値 (整数)。
各呼び出しで返されるクローラーの数。
+ `NextToken` – UTF–8 文字列。
継続トークン (これが継続リクエストの場合)。
**応答**
+ `Crawlers` – [Crawler](#aws-glue-api-crawler-crawling-Crawler) オブジェクトの配列。
クローラーメタデータのリスト。
+ `NextToken` – UTF–8 文字列。
継続トークン (返されるリストがこの顧客アカウントで定義されたリストの最後に達していない場合)。
**エラー**
+ `OperationTimeoutException`
## GetCrawlerMetrics アクション (Python: get\$1crawler\$1metrics)
指定されたクローラーに関するメトリクスを取得します。
**リクエスト**
+ `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)
クローラーを更新します。クローラーが実行されている場合、クローラーを更新する前に `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 リソースネーム (ARN)。
+ `DatabaseName` – UTF–8 文字列。
`arn:aws:daylight:us-east-1::database/sometable/*` など、結果が保存される AWS Glue データベース。
+ `Description` - UTF-8 文字列。2,048 バイト長以下。[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)
スケジュールされているものに関係なく、指定されたクローラーを使用してクロールを開始します。クローラーがすでに実行中である場合は、[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)
指定されたクローラーが実行されている場合は、クロールを停止します。
**リクエスト**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
停止するクローラーの名前。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `CrawlerNotRunningException`
+ `CrawlerStoppingException`
+ `OperationTimeoutException`
## BatchGetCrawlers Action (Python: batch\$1get\$1crawlers)
指定されたクローラー名のリストのリソースメタデータのリストを返します。`ListCrawlers` オペレーションを呼び出した後で、このオペレーションを呼び出すことで、アクセス許可が付与されているデータにアクセスできます。このオペレーションは、タグを使用するアクセス許可条件を含め、すべての IAM のアクセス許可をサポートします。
**リクエスト**
+ `CrawlerNames` – *必須:* UTF-8 文字列の配列。文字列 100 個以下。
クローラー名のリスト。これは `ListCrawlers` 操作から返された名前であることもあります。
**応答**
+ `Crawlers` – [Crawler](#aws-glue-api-crawler-crawling-Crawler) オブジェクトの配列。
クローラー定義のリスト。
+ `CrawlersNotFound` - UTF-8 文字列の配列、文字列 100 個以下。
クローラーの名前のリストが見つかりません。
**エラー**
+ `InvalidInputException`
+ `OperationTimeoutException`
## ListCrawlers アクション (Python: list\$1crawlers)
この 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)
指定されたクローラーのすべてのクロールを返します。クローラー履歴機能の起動日以降に発生したクロールのみを返し、最大 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
列統計 API は、テーブル内の列の統計を返す AWS Glue API の説明を記述します。
## データ型
+ [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 の構造
列統計実行の詳細を示すオブジェクト。
**フィールド**
+ `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) に一致。
テーブルが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `Role` – UTF–8 文字列。
統計を生成するためにサービスが引き受ける IAM ロール。
+ `SampleSize` – 数値 (double)。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` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
ジョブのエラーメッセージ。
+ `DPUSeconds` – 数値 (double)。None 以下。
すべての自動スケーリングされたワーカーについて計算された DPU 使用量 (秒)。
## ColumnStatisticsTaskSettings 構造
列統計のタスクの設定。
**フィールド**
+ `DatabaseName` – UTF-8 文字列。
テーブルが存在するデータベースの名前。
+ `TableName` – UTF–8 文字列。
列統計が生成されるテーブルの名前。
+ `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) に一致。
データベースが存在するデータカタログの ID。
+ `Role` – UTF–8 文字列。
列統計の実行に使用されるロール。
+ `SampleSize` – 数値 (double)。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 構造
列統計タスク実行の実行試行。
**フィールド**
+ `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` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
列統計タスクの最後の実行に関連付けられたエラーメッセージ。
## 操作
+ [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)
指定されたテーブルと列のために列統計タスク実行を開始します。
**リクエスト**
+ `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` – 数値 (double)。100 以下。
統計の生成に使用される行の割合。何も指定されない場合は、テーブル全体が統計の生成に使用されます。
+ `CatalogID` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの 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)
タスク実行 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)
指定されたテーブルに関連付けられたすべての実行に関する情報を取得します。
**リクエスト**
+ `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)
特定のアカウントについてのすべてのタスク実行をリストします。
**リクエスト**
+ `MaxResults` – 1～1000 の数値 (整数)。
応答の最大サイズ。
+ `NextToken` – UTF-8 文字列。
継続トークン (これが継続呼び出しの場合)。
**応答**
+ `ColumnStatisticsTaskRunIds` - UTF-8 文字列の配列、文字列 100 個以下。
列統計タスク実行 ID のリスト。
+ `NextToken` – UTF–8 文字列。
継続トークン (すべてのタスク実行 ID がまだ返されていない場合)。
**エラー**
+ `OperationTimeoutException`
## StopColumnStatisticsTaskRun アクション (Python: stop\$1column\$1statistics\$1task\$1run)
指定されたテーブルについてのタスク実行を停止します。
**リクエスト**
+ `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)
列統計タスクの設定を作成します。
**リクエスト**
+ `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` – 数値 (double)。100 以下。
サンプルのデータの割合。
+ `CatalogID` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
データベースが存在するデータカタログの 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)
列統計タスクの設定を更新します。
**リクエスト**
+ `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` – 数値 (double)。100 以下。
サンプルのデータの割合。
+ `CatalogID` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
データベースが存在するデータカタログの 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)
列統計タスクの設定を取得します。
**リクエスト**
+ `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)
列統計タスクの設定を削除します。
**リクエスト**
+ `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)
列統計タスク実行スケジュールを開始します。
**リクエスト**
+ `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)
列統計タスク実行スケジュールを停止します。
**リクエスト**
+ `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`
## 例外
+ [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 の構造
列統計生成ジョブの実行中に別のジョブの開始を試行するとスローされる例外。
**フィールド**
+ `Message` – UTF-8 文字列。
問題を説明するメッセージ。
## ColumnStatisticsTaskNotRunningException の構造
実行中のタスクがないときにタスク実行の停止を試行するとスローされる例外。
**フィールド**
+ `Message` – UTF-8 文字列。
問題を説明するメッセージ。
## ColumnStatisticsTaskStoppingException の構造
タスク実行の停止を試行するとスローされる例外。
**フィールド**
+ `Message` – UTF-8 文字列。
問題を説明するメッセージ。
## ColumnStatisticsTaskAutoConcurrencyLimitException 構造
自動統計ジョブの同時実行数の上限に既に達している場合にスローされる例外。
**フィールド**
+ `Message` – UTF-8 文字列。
問題を説明するメッセージ。
## InvalidCatalogSettingException 構造
カタログ設定に問題がある場合にスローされる例外。
**フィールド**
+ `Message` – UTF-8 文字列。
問題を説明するメッセージ。
# クローラースケジューラ API
クローラースケジューラ API では、AWS Glue クローラーのデータ型と、クローラーを作成、削除、更新、および一覧表示するための API について説明します。
## データ型
+ [Schedule 構造](#aws-glue-api-crawler-scheduler-Schedule)
## Schedule 構造
`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`)。
スケジュールの状態。
## 操作
+ [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)
`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)
クローラーがすでに実行中、またはスケジュールの状態がすでに `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)
指定されたクローラーのスケジュールの状態を `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`