# クローラースケジューラ 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`