# 爬网程序计划程序 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`