

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

# 任務 API
<a name="aws-glue-api-jobs"></a>

Jobs API 說明任務資料類型，並包含用於在其中使用任務、任務執行和觸發程序APIs AWS Glue。

**Topics**
+ [任務](aws-glue-api-jobs-job.md)
+ [任務執行](aws-glue-api-jobs-runs.md)
+ [觸發](aws-glue-api-jobs-trigger.md)

# 任務
<a name="aws-glue-api-jobs-job"></a>

任務 API 說明與建立、更新、刪除或檢視任務相關的資料類型和 API AWS Glue。

## 資料類型
<a name="aws-glue-api-jobs-job-objects"></a>
+ [Job 結構](#aws-glue-api-jobs-job-Job)
+ [ExecutionProperty 結構](#aws-glue-api-jobs-job-ExecutionProperty)
+ [NotificationProperty 結構](#aws-glue-api-jobs-job-NotificationProperty)
+ [JobCommand 結構](#aws-glue-api-jobs-job-JobCommand)
+ [ConnectionsList 結構](#aws-glue-api-jobs-job-ConnectionsList)
+ [JobUpdate 結構](#aws-glue-api-jobs-job-JobUpdate)
+ [SourceControlDetails 結構](#aws-glue-api-jobs-job-SourceControlDetails)

## Job 結構
<a name="aws-glue-api-jobs-job-Job"></a>

指定任務定義。

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

  您指派給此任務定義的名稱。
+ `JobMode` – UTF-8 字串 (有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`)。

  描述如何建立任務的模式。有效的值如下：
  + `SCRIPT` - 任務是使用 AWS Glue Studio 指令碼編輯器建立的。
  + `VISUAL` - 任務是使用 AWS Glue Studio 視覺化編輯器建立的。
  + `NOTEBOOK` - 任務是使用互動式工作階段筆記本建立的。

  當 `JobMode` 欄位遺失或為 null 時， `SCRIPT` 會指派為預設值。
+ `JobRunQueuingEnabled` – 布林值。

  指定是否針對此任務的任務執行啟用任務執行佇列。

  值為 true 表示已為任務執行啟用任務執行佇列。如果為 false 或未填入，則不會考慮將任務執行排入佇列。

  如果此欄位不符合任務執行中設定的值，則會使用任務執行欄位中的值。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  任務的描述。
+ `LogUri` – UTF-8 字串。

  此欄位保留供日後使用。
+ `Role` – UTF-8 字串。

  與此任務相關聯 IAM 角色的名稱或 Amazon Resource Name (ARN)。
+ `CreatedOn` – 時間戳記。

  此任務定義的建立日期和時間。
+ `LastModifiedOn` – 時間戳記。

  此任務定義上一次修改的時間點。
+ `ExecutionProperty` – [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty) 物件。

  `ExecutionProperty`，指定此任務可同時執行的最大數量。
+ `Command` – [JobCommand](#aws-glue-api-jobs-job-JobCommand) 物件。

  執行這個任務的 `JobCommand`。
+ `DefaultArguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  此任務每次執行的預設引數，以名稱值對的方式指定。

  您可以在此指定您自己的任務執行指令碼使用的引數，以及 AWS Glue 本身使用的引數。

  可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您想要將秘密保留在任務中，請從 AWS Glue 連線 AWS Secrets Manager 或其他秘密管理機制擷取秘密。

  如需如何指定和取用自有任務引數的資訊，請參閱本開發人員指南中的[使用 Python 呼叫 AWS Glue API](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 主題。

  如需有關設定 Spark 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主題。

  如需有關設定 Ray 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `NonOverridableArguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  在任務執行中提供任務引數時，此任務未被覆寫的引數，以名稱值對的方式指定。
+ `Connections` – [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList) 物件。

  用於此任務的連線。
+ `MaxRetries` – 數字 (整數)。

  如果 JobRun 失敗，此任務可重試的次數上限。
+ `AllocatedCapacity` – 數字 (整數)。

  此欄位已作廢。請改用 `MaxCapacity`。

  分配給此任務執行的 AWS Glue 資料處理單位 (DPUs) 數量。您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。

  
+ `Timeout` – 數字 (整數)，至少為 1。

  任務逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本的任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。

  對於 Glue 2.0 版或更新版本的任務，您不能指定 `Maximum capacity`。反之，您必須指定 `Worker type` 與 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，請勿設定 `MaxCapacity`。

  可配置給 `MaxCapacity` 的值取決於您執行的是​ Python shell 任務、Apache Spark ETL 任務或 Apache Spark Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming ETL 任務 (`JobCommand.Name`="gluestreaming") 時，您可以配置 2 到 100 個 DPU。預設值是 10 個 DPU。此任務類型沒有小數的 DPU 分配。
+ `WorkerType` – UTF-8 字串 （有效值： `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。

  AWS Glue 提供多種工作者類型，以因應不同的工作負載需求：

  G 工作者類型 (一般用途運算工作者)：
  + G.025X：0.25 DPU (2 個 vCPUs、4 GB 記憶體、84GB 磁碟）
  + G.1X：1 個 DPU (4 個 vCPU、16 GB 記憶體、94 GB 磁碟)
  + G.2X：2 個 DPU (8 個 vCPU、32 GB 記憶體、138 GB 磁碟)
  + G.4X：4 個 DPU (16 個 vCPU、64 GB 記憶體、256 GB 磁碟)
  + G.8X：8 個 DPU (32 個 vCPU、128 GB 記憶體、512 GB 磁碟)
  + G.12X：12 個 DPU (48 個 vCPU、192 GB 記憶體、768 GB 磁碟)
  + G.16X：16 個 DPU (64 個 vCPU、256 GB 記憶體、1,024 GB 磁碟)

  R 工作者類型 (記憶體最佳化工作者)：
  + R.1X：1 個 DPU (4 vCPUs、32 GB 記憶體、94GB 磁碟）
  + R.2X：2 個 DPU (8 vCPUs、64 GB 記憶體、128GB 磁碟）
  + R.4X：4 個 DPU (16 個 vCPUs、128 GB 記憶體、256GB 磁碟）
  + R.8X：8 個 DPU (32 個 vCPUs、256 GB 記憶體、512GB 磁碟）
+ `NumberOfWorkers` – 數字 (整數)。

  當任務執行時所配置的已定義 `workerType` 的工作者數目。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此任務搭配使用的 `SecurityConfiguration` 結構名稱。
+ `NotificationProperty` – [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 物件。

  指定任務通知的組態屬性。
+ `Running` – 布林值。

  此欄位保留供日後使用。
+ `GlueVersion` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Custom string pattern #48](aws-glue-api-common.md#regex_48)。

  在 Spark 任務中， `GlueVersion`會決定任務中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示針對 Spark 類型任務支援的版本。

  Ray 任務應將 `GlueVersion` 設定為 `4.0` 或更高版本。不過，Ray 任務中可用的 Ray、Python 和其他程式庫的版本由 Job 命令的 `Runtime` 參數決定。

  如需可用 AWS Glue 版本和對應 Spark 和 Python 版本的詳細資訊，請參閱 開發人員指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  建立時未指定 Glue 版本的任務，預設為 Glue 0.9。
+ `CodeGenConfigurationNodes` – 金鑰值對的映射陣列。

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

  每個值都是 [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) 物件。

  Glue Studio 視覺化組件和 Glue Studio 代碼的產生都根據有向無循環圖的表示形式。
+ `ExecutionClass` – UTF-8 字串，長度不可超過 16 個位元組 (有效值：`FLEX=""` \$1 `STANDARD=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有版本 3.0 和更高 AWS Glue 版本以及命令類型的任務`glueetl`才能`ExecutionClass`設定為 `FLEX`。彈性執行類別可用於 Spark 任務。
+ `SourceControlDetails` – [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails) 物件。

  任務原始檔控制組態的詳細資訊，可允許與遠端儲存庫雙向同步任務成品。
+ `MaintenanceWindow` – UTF-8 字串，需符合[Custom string pattern #34](aws-glue-api-common.md#regex_34)。

  此欄位指定串流任務維護時段的星期幾和小時。 會 AWS Glue 定期執行維護活動。在這些維護時段期間， AWS Glue 將需要重新啟動您的串流任務。

  AWS Glue 將在指定的維護時段後 3 小時內重新啟動任務。例如，如果您在 GMT 星期一上午 10：00 設定維護時段，您的任務將在 GMT 上午 10:00 到下午 1:00 之間重新啟動。
+ `ProfileName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與任務相關聯的 AWS Glue 用量描述檔名稱。

## ExecutionProperty 結構
<a name="aws-glue-api-jobs-job-ExecutionProperty"></a>

任務的執行屬性。

**欄位**
+ `MaxConcurrentRuns` – 數字 (整數)。

  一項任務可同時執行的最大數量。預設為 1。達到此閾值時，會傳回錯誤。可指定的最大值由服務限制來控制。

## NotificationProperty 結構
<a name="aws-glue-api-jobs-job-NotificationProperty"></a>

指定通知的組態屬性。

**欄位**
+ `NotifyDelayAfter` – 數字 (整數)，至少為 1。

  任務執行開始後，在傳送任務執行延遲通知之前所要等待的分鐘數。

## JobCommand 結構
<a name="aws-glue-api-jobs-job-JobCommand"></a>

指定任務執行時執行的程式碼。

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

  任務命令的名稱。用於 Apache Spark ETL 任務時，必須使用 `glueetl`。用於 Python shell 任務時，必須使用 `pythonshell`。用於 Apache Spark Streaming ETL 任務時，必須是 `gluestreaming`。對於 Ray 任務，這一定是 `glueray`。
+ `ScriptLocation` – UTF-8 字串，長度不可超過 400000 個位元組。

  指定指向執行任務指令碼的 Amazon Simple Storage Service (Amazon S3) 路徑。
+ `PythonVersion` – UTF-8 字串，需符合[Custom string pattern #49](aws-glue-api-common.md#regex_49)。

  用於執行 Python Shell 任務的 Python 版本。允許的值是 2 或 3。
+ `Runtime`：UTF-8 字串，長度不可超過 64 個位元組，且需符合 [Custom string pattern #33](aws-glue-api-common.md#regex_33)。

  在 Ray 任務中，執行期用於指定環境中可用的 Ray、Python 和其他程式庫的版本。此欄位不用於其他任務類型。如需支援的執行期環境值，請參閱《 AWS Glue 開發人員指南》中的[支援的 Ray 執行期環境](https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html)。

## ConnectionsList 結構
<a name="aws-glue-api-jobs-job-ConnectionsList"></a>

指定任務所使用的連線。

**欄位**
+ `Connections` – UTF-8 字串陣列，不可超過 1000 個字串。

  任務所使用連線的清單。

## JobUpdate 結構
<a name="aws-glue-api-jobs-job-JobUpdate"></a>

指定用於更新現有任務定義的資訊。此資訊將完全覆寫之前的任務定義。

**欄位**
+ `JobMode` – UTF-8 字串 (有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`)。

  描述如何建立任務的模式。有效的值如下：
  + `SCRIPT` - 任務是使用 AWS Glue Studio 指令碼編輯器建立的。
  + `VISUAL` - 任務是使用 AWS Glue Studio 視覺化編輯器建立的。
  + `NOTEBOOK` - 任務是使用互動式工作階段筆記本建立的。

  當 `JobMode` 欄位遺失或為 null 時， `SCRIPT` 會指派為預設值。
+ `JobRunQueuingEnabled` – 布林值。

  指定是否針對此任務的任務執行啟用任務執行佇列。

  值為 true 表示已為任務執行啟用任務執行佇列。如果為 false 或未填入，則不會考慮將任務執行排入佇列。

  如果此欄位不符合任務執行中設定的值，則會使用任務執行欄位中的值。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  正在定義的任務說明。
+ `LogUri` – UTF-8 字串。

  此欄位保留供日後使用。
+ `Role` – UTF-8 字串。

  與此任務關聯之 IAM 角色的名稱或 Amazon Resource Name (ARN)(必要)。
+ `ExecutionProperty` – [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty) 物件。

  `ExecutionProperty`，指定此任務可同時執行的最大數量。
+ `Command` – [JobCommand](#aws-glue-api-jobs-job-JobCommand) 物件。

  負責執行此任務的 `JobCommand` (必要)。
+ `DefaultArguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  此任務每次執行的預設引數，以名稱值對的方式指定。

  您可以在此指定您自己的任務執行指令碼使用的引數，以及 AWS Glue 本身使用的引數。

  可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您想要將秘密保留在任務中，請從 AWS Glue 連線 AWS Secrets Manager 或其他秘密管理機制擷取秘密。

  如需如何指定和取用自有任務引數的資訊，請參閱本開發人員指南中的[使用 Python 呼叫 AWS Glue API](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 主題。

  如需有關設定 Spark 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主題。

  如需有關設定 Ray 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `NonOverridableArguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  在任務執行中提供任務引數時，此任務未被覆寫的引數，以名稱值對的方式指定。
+ `Connections` – [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList) 物件。

  用於此任務的連線。
+ `MaxRetries` – 數字 (整數)。

  如果此任務失敗，可重試的次數上限。
+ `AllocatedCapacity` – 數字 (整數)。

  此欄位已作廢。請改用 `MaxCapacity`。

  要配置給此任務的 AWS Glue 資料處理單位 (DPUs) 數目。您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` – 數字 (整數)，至少為 1。

  任務逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本的任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。

  對於 Glue 2.0\$1 版任務，您不能指定 `Maximum capacity`。反之，您必須指定 `Worker type` 與 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，請勿設定 `MaxCapacity`。

  可配置給 `MaxCapacity` 的值取決於您執行的是​ Python shell 任務、Apache Spark ETL 任務或 Apache Spark Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming ETL 任務 (`JobCommand.Name`="gluestreaming") 時，您可以配置 2 到 100 個 DPU。預設值是 10 個 DPU。此任務類型沒有小數的 DPU 分配。
+ `WorkerType` – UTF-8 字串 （有效值： `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` \$1 `R.1X=""` `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。對於 Spark 任務，接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值。接受 Ray 任務的 Z.2X 值。如需詳細資訊，請參閱[定義 Spark 任務的任務屬性](https://docs.aws.amazon.com/glue/latest/dg/add-job.html#create-job)
+ `NumberOfWorkers` – 數字 (整數)。

  當任務執行時所配置的已定義 `workerType` 的工作者數目。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此任務搭配使用的 `SecurityConfiguration` 結構名稱。
+ `NotificationProperty` – [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 物件。

  指定任務通知的組態屬性。
+ `GlueVersion` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Custom string pattern #48](aws-glue-api-common.md#regex_48)。

  在 Spark 任務中， `GlueVersion`會決定任務中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示針對 Spark 類型任務支援的版本。

  Ray 任務應將 `GlueVersion` 設定為 `4.0` 或更高版本。不過，Ray 任務中可用的 Ray、Python 和其他程式庫的版本由 Job 命令的 `Runtime` 參數決定。

  如需可用 AWS Glue 版本和對應 Spark 和 Python 版本的詳細資訊，請參閱 開發人員指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  建立時未指定 Glue 版本的任務，預設為 Glue 0.9。
+ `CodeGenConfigurationNodes` – 金鑰值對的映射陣列。

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

  每個值都是 [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) 物件。

  Glue Studio 視覺化組件和 Glue Studio 代碼的產生都根據有向無循環圖的表示形式。
+ `ExecutionClass` – UTF-8 字串，長度不可超過 16 個位元組 (有效值：`FLEX=""` \$1 `STANDARD=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有版本 3.0 和更高 AWS Glue 版本以及命令類型的任務`glueetl`才能`ExecutionClass`設定為 `FLEX`。彈性執行類別可用於 Spark 任務。
+ `SourceControlDetails` – [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails) 物件。

  任務原始檔控制組態的詳細資訊，可允許與遠端儲存庫雙向同步任務成品。
+ `MaintenanceWindow` – UTF-8 字串，需符合[Custom string pattern #34](aws-glue-api-common.md#regex_34)。

  此欄位指定串流任務維護時段的星期幾和小時。 會 AWS Glue 定期執行維護活動。在這些維護時段期間， AWS Glue 將需要重新啟動您的串流任務。

  AWS Glue 將在指定的維護時段後 3 小時內重新啟動任務。例如，如果您在 GMT 星期一上午 10：00 設定維護時段，您的任務將在 GMT 上午 10:00 到下午 1:00 之間重新啟動。
+ `ProfileName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與任務相關聯的 AWS Glue 用量描述檔名稱。

## SourceControlDetails 結構
<a name="aws-glue-api-jobs-job-SourceControlDetails"></a>

任務原始檔控制組態的詳細資訊，可允許與遠端儲存庫雙向同步任務成品。

**欄位**
+ `Provider` – UTF-8 字串 (有效值：`GITHUB` \$1 `AWS_CODE_COMMIT`)。

  遠端儲存庫的提供者。
+ `Repository` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組。

  任務成品所在遠端儲存庫的名稱。
+ `Owner` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組。

  任務成品所在遠端儲存庫的擁有者。
+ `Branch` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組。

  遠端儲存庫中可供自由選用的分支。
+ `Folder` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組。

  遠端儲存庫中可供自由選用的資料夾。
+ `LastCommitId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組。

  遠端儲存庫中遞交的最後一個遞交 ID。
+ `LastSyncTimestamp` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組。

  最近一次執行任務同步作業的日期和時間。
+ `AuthStrategy` – UTF-8 字串 (有效值：`PERSONAL_ACCESS_TOKEN` \$1 `AWS_SECRETS_MANAGER`)。

  身分驗證的類型，可以是存放在 AWS Secrets Manager 中的身分驗證字符，或個人存取字符。
+ `AuthToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組。

  授權字符的值。

## 作業
<a name="aws-glue-api-jobs-job-actions"></a>
+ [CreateJob 動作 (Python: create\$1job)](#aws-glue-api-jobs-job-CreateJob)
+ [UpdateJob 動作 (Python: update\$1job)](#aws-glue-api-jobs-job-UpdateJob)
+ [GetJob 動作 (Python: get\$1job)](#aws-glue-api-jobs-job-GetJob)
+ [GetJobs 動作 (Python: get\$1jobs)](#aws-glue-api-jobs-job-GetJobs)
+ [DeleteJob 動作 (Python: delete\$1job)](#aws-glue-api-jobs-job-DeleteJob)
+ [ListJobs 動作 (Python: list\$1jobs)](#aws-glue-api-jobs-job-ListJobs)
+ [BatchGetJobs 動作 (Python: batch\$1get\$1jobs)](#aws-glue-api-jobs-job-BatchGetJobs)

## CreateJob 動作 (Python: create\$1job)
<a name="aws-glue-api-jobs-job-CreateJob"></a>

建立新任務定義。

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

  您指派給此任務定義的名稱。它在您的 帳戶中必須是唯一的。
+ `JobMode` – UTF-8 字串 (有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`)。

  描述如何建立任務的模式。有效的值如下：
  + `SCRIPT` - 任務是使用 AWS Glue Studio 指令碼編輯器建立的。
  + `VISUAL` - 任務是使用 AWS Glue Studio 視覺化編輯器建立的。
  + `NOTEBOOK` - 任務是使用互動式工作階段筆記本建立的。

  當 `JobMode` 欄位遺失或為 null 時， `SCRIPT` 會指派為預設值。
+ `JobRunQueuingEnabled` – 布林值。

  指定是否針對此任務的任務執行啟用任務執行佇列。

  值為 true 表示已為任務執行啟用任務執行佇列。如果為 false 或未填入，則不會考慮將任務執行排入佇列。

  如果此欄位不符合任務執行中設定的值，則會使用任務執行欄位中的值。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  正在定義的任務說明。
+ `LogUri` – UTF-8 字串。

  此欄位保留供日後使用。
+ `Role` – *必要：*UTF-8 字串。

  與此任務相關聯 IAM 角色的名稱或 Amazon Resource Name (ARN)。
+ `ExecutionProperty` – [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty) 物件。

  `ExecutionProperty`，指定此任務可同時執行的最大數量。
+ `Command` – *必要：*[JobCommand](#aws-glue-api-jobs-job-JobCommand) 物件。

  執行這個任務的 `JobCommand`。
+ `DefaultArguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  此任務每次執行的預設引數，以名稱值對的方式指定。

  您可以在此指定您自己的任務執行指令碼使用的引數，以及 AWS Glue 本身使用的引數。

  可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您想要將秘密保留在任務中，請從 AWS Glue 連線 AWS Secrets Manager 或其他秘密管理機制擷取秘密。

  如需如何指定和取用自有任務引數的資訊，請參閱本開發人員指南中的[使用 Python 呼叫 AWS Glue API](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 主題。

  如需有關設定 Spark 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主題。

  如需有關設定 Ray 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `NonOverridableArguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  在任務執行中提供任務引數時，此任務未被覆寫的引數，以名稱值對的方式指定。
+ `Connections` – [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList) 物件。

  用於此任務的連線。
+ `MaxRetries` – 數字 (整數)。

  如果此任務失敗，可重試的次數上限。
+ `AllocatedCapacity` – 數字 (整數)。

  此參數已棄用。請改用 `MaxCapacity`。

  要配置給此任務的 AWS Glue 資料處理單位 (DPUs) 數目。您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` – 數字 (整數)，至少為 1。

  任務逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本的任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。

  對於 Glue 2.0\$1 版任務，您不能指定 `Maximum capacity`。反之，您必須指定 `Worker type` 與 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，請勿設定 `MaxCapacity`。

  可配置給 `MaxCapacity` 的值取決於您執行的是​ Python shell 任務、Apache Spark ETL 任務或 Apache Spark Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming ETL 任務 (`JobCommand.Name`="gluestreaming") 時，您可以配置 2 到 100 個 DPU。預設值是 10 個 DPU。此任務類型沒有小數的 DPU 分配。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與此任務搭配使用的 `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)。
+ `NotificationProperty` – [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 物件。

  指定任務通知的組態屬性。
+ `GlueVersion` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Custom string pattern #48](aws-glue-api-common.md#regex_48)。

  在 Spark 任務中， `GlueVersion`會決定任務中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示針對 Spark 類型任務支援的版本。

  Ray 任務應將 `GlueVersion` 設定為 `4.0` 或更高版本。不過，Ray 任務中可用的 Ray、Python 和其他程式庫的版本由 Job 命令的 `Runtime` 參數決定。

  如需可用 AWS Glue 版本和對應 Spark 和 Python 版本的詳細資訊，請參閱 開發人員指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  建立時未指定 Glue 版本的任務，預設為 Glue 0.9。
+ `NumberOfWorkers` – 數字 (整數)。

  當任務執行時所配置的已定義 `workerType` 的工作者數目。
+ `WorkerType` – UTF-8 字串 （有效值： `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` \$1 `R.1X=""` `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。對於 Spark 任務，接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值。接受 Ray 任務的 Z.2X 值。
  + 用於 `G.025X` 工作者類型時，每個工作者會映射到 0.25 個 DPU (2 個 vCPU、4 GB 的記憶體)，外加 84 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議低容量串流任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的串流任務。
  + 用於 `G.1X` 工作者類型時，每個工作者會映射到 1 個 DPU (4 個 vCPU、16 GB 的記憶體)，外加 94 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.2X` 工作者類型時，每個工作者會映射到 2 個 DPU (8 個 vCPU、32 GB 的記憶體)，外加 138 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.4X` 工作者類型時，每個工作者會映射到 4 個 DPU (16 個 vCPU、64 GB 的記憶體)，外加 256 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於下列 AWS 區域中的 3.0 AWS Glue 版或更新版本 Spark ETL 任務：美國東部 （俄亥俄）、美國東部 （維吉尼亞北部）、美國西部 （加利佛尼亞北部）、美國西部 （奧勒岡）、亞太區域 （孟買）、亞太區域 （首爾）、亞太區域 （新加坡）、亞太區域 （雪梨）、亞太區域 （東京）、加拿大 （中部）、歐洲 （法蘭克福）、歐洲 （愛爾蘭）、歐洲 （倫敦）、歐洲 （西班牙）、歐洲 （斯德哥爾摩） 和 
  + 用於 `G.8X` 工作者類型時，每個工作者會映射到 8 個 DPU (32 個 vCPU、128 GB 的記憶體)，外加 512 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的 Spark ETL 任務，適用於與`G.4X`工作者類型支援的相同 AWS 區域。
  + 對於`G.12X`工作者類型，每個工作者會映射到具有 768GB 個 vCPUs、192 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`G.16X`工作者類型，每個工作者對應到具有 1024 GB 磁碟的 1024GB6 個 DPU (64 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.1X`工作者類型，每個工作者會映射到具有 94GB磁碟的 1 個 DPU (4 個 vCPUs，32 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.2X`工作者類型，每個工作者對應到具有 128GB磁碟的 2 個 DPU (8 個 vCPUs、64 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.4X`工作者類型，每個工作者會映射到具有 256GB磁碟的 4 個 DPU (16 個 vCPUs、128 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.8X`工作者類型，每個工作者對應到具有 512GB磁碟的 8 個 DPU (32 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於 `Z.2X` 工作者類型，每個工作者都會映射到 2 個 M-DPU (8 個 vCPU、64 GB 記憶體)，外加 128 GB 磁碟，並根據自動縮放器提供最多 8 個 Ray 工作者。
+ `CodeGenConfigurationNodes` – 金鑰值對的映射陣列。

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

  每個值都是 [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) 物件。

  Glue Studio 視覺化組件和 Glue Studio 代碼的產生都根據有向無循環圖的表示形式。
+ `ExecutionClass` – UTF-8 字串，長度不可超過 16 個位元組 (有效值：`FLEX=""` \$1 `STANDARD=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有版本 3.0 和更高 AWS Glue 版本以及命令類型的任務`glueetl`才能`ExecutionClass`設定為 `FLEX`。彈性執行類別可用於 Spark 任務。
+ `SourceControlDetails` – [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails) 物件。

  任務原始檔控制組態的詳細資訊，可允許與遠端儲存庫雙向同步任務成品。
+ `MaintenanceWindow` – UTF-8 字串，需符合[Custom string pattern #34](aws-glue-api-common.md#regex_34)。

  此欄位指定串流任務維護時段的星期幾和小時。 會 AWS Glue 定期執行維護活動。在這些維護時段期間， AWS Glue 將需要重新啟動您的串流任務。

  AWS Glue 將在指定的維護時段後 3 小時內重新啟動任務。例如，如果您在 GMT 星期一上午 10：00 設定維護時段，您的任務將在 GMT 上午 10:00 到下午 1:00 之間重新啟動。
+ `ProfileName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與任務相關聯的 AWS Glue 用量描述檔名稱。

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

  為此任務定義而提供的唯一名稱。

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

## UpdateJob 動作 (Python: update\$1job)
<a name="aws-glue-api-jobs-job-UpdateJob"></a>

更新現有的任務定義。此資訊將完全覆寫之前的任務定義。

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

  要更新之任務定義的名稱。
+ `JobUpdate` – *必要：*[JobUpdate](#aws-glue-api-jobs-job-JobUpdate) 物件。

  指定用於更新任務定義的值。未指定的組態將被移除或重置為預設值。
+ `ProfileName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與任務相關聯的 AWS Glue 用量描述檔名稱。

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

  傳回已更新之任務定義的名稱。

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

## GetJob 動作 (Python: get\$1job)
<a name="aws-glue-api-jobs-job-GetJob"></a>

擷取現有的任務定義。

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

  欲擷取的任務定義的名稱。

**回應**
+ `Job` – [任務](#aws-glue-api-jobs-job-Job) 物件。

  要求的任務定義。

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

## GetJobs 動作 (Python: get\$1jobs)
<a name="aws-glue-api-jobs-job-GetJobs"></a>

擷取所有目前的任務定義。

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

  接續符記，如果這是接續呼叫。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  回應的大小上限。

**回應**
+ `Jobs` – 一個 [任務](#aws-glue-api-jobs-job-Job) 物件陣列。

  任務定義的清單。
+ `NextToken` – UTF-8 字串。

  持續符記 (如果尚未傳回所有任務定義)。

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

## DeleteJob 動作 (Python: delete\$1job)
<a name="aws-glue-api-jobs-job-DeleteJob"></a>

刪除指定的任務定義。如果找不到此任務定義，就不會擲回例外狀況。

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

  欲刪除的任務定義的名稱。

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

  已刪除之任務定義的名稱。

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

## ListJobs 動作 (Python: list\$1jobs)
<a name="aws-glue-api-jobs-job-ListJobs"></a>

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

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

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

  接續符記，如果這是接續要求。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  所要回傳清單的大小上限。
+ `Tags` – 金鑰值對的對應陣列，不超過 50 對。

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

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

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

**回應**
+ `JobNames` – UTF-8 字串陣列。

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

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

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

## BatchGetJobs 動作 (Python: batch\$1get\$1jobs)
<a name="aws-glue-api-jobs-job-BatchGetJobs"></a>

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

**請求**
+ `JobNames` – *必要：*UTF-8 字串陣列。

  任務名稱清單，可能是從 `ListJobs` 操作傳回的名稱。

**回應**
+ `Jobs` – 一個 [任務](#aws-glue-api-jobs-job-Job) 物件陣列。

  任務定義的清單。
+ `JobsNotFound` – UTF-8 字串陣列。

  找不到任務名稱清單。

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

# 任務執行
<a name="aws-glue-api-jobs-runs"></a>

 Jobs Runs API 說明啟動、停止或檢視任務執行，以及重設任務書籤的相關資料類型和 API AWS Glue。您可以存取工作流程和任務執行的 90 天任務執行歷史記錄。

## 資料類型
<a name="aws-glue-api-jobs-runs-objects"></a>
+ [JobRun 結構](#aws-glue-api-jobs-runs-JobRun)
+ [Predecessor 結構](#aws-glue-api-jobs-runs-Predecessor)
+ [JobBookmarkEntry 結構](#aws-glue-api-jobs-runs-JobBookmarkEntry)
+ [BatchStopJobRunSuccessfulSubmission 結構](#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission)
+ [BatchStopJobRunError 結構](#aws-glue-api-jobs-runs-BatchStopJobRunError)
+ [NotificationProperty 結構](#aws-glue-api-jobs-runs-NotificationProperty)

## JobRun 結構
<a name="aws-glue-api-jobs-runs-JobRun"></a>

包含關於任務執行的資訊。

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

  此次任務執行的 ID。
+ `Attempt` – 數字 (整數)。

  嘗試執行此項任務的次數。
+ `PreviousRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  此任務先前執行作業的 ID。例如，使用 `StartJobRun` 動作所指定的 `JobRunId`。
+ `TriggerName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  起始此次任務執行的觸發條件的名稱。
+ `JobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  此次執行所用的任務定義名稱。
+ `JobMode` – UTF-8 字串 (有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`)。

  描述如何建立任務的模式。有效的值如下：
  + `SCRIPT` - 任務是使用 AWS Glue Studio 指令碼編輯器建立的。
  + `VISUAL` - 任務是使用 AWS Glue Studio 視覺化編輯器建立的。
  + `NOTEBOOK` - 任務是使用互動式工作階段筆記本建立的。

  當 `JobMode` 欄位遺失或為 null 時， `SCRIPT` 會指派為預設值。
+ `JobRunQueuingEnabled` – 布林值。

  指定任務執行是否已啟用任務執行佇列。

  值為 true 表示已為任務執行啟用任務執行佇列。如果為 false 或未填入，則不會考慮將任務執行排入佇列。
+ `StartedOn` – 時間戳記。

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

  此次任務執行上次修改的時間。
+ `CompletedOn` – 時間戳記。

  此次任務執行完成的日期和時間。
+ `JobRunState` – UTF-8 字串 (有效值：`STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`)。

  任務執行目前的狀態。如需異常終止之任務狀態的詳細資訊，請參閱 [AWS Glue 任務執行狀態](https://docs.aws.amazon.com/glue/latest/dg/job-run-statuses.html)。
+ `Arguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  與此次執行相關的任務引數。處理此任務執行時，這些引數會取代任務定義本身已設定的預設引數。

  您可以在此指定您自己的任務執行指令碼使用的引數，以及 AWS Glue 本身使用的引數。

  可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您想要將秘密保留在任務中，請從 AWS Glue 連線 AWS Secrets Manager 或其他秘密管理機制擷取秘密。

  如需如何指定和取用自有任務引數的資訊，請參閱本開發人員指南中的[使用 Python 呼叫 AWS Glue API](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 主題。

  如需有關設定 Spark 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主題。

  如需有關設定 Ray 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `ErrorMessage` – UTF-8 字串。

  與此次任務執行相關的錯誤訊息。
+ `PredecessorRuns` – 一個 [前置任務](#aws-glue-api-jobs-runs-Predecessor) 物件陣列。

  此次任務執行的前置任務的清單。
+ `AllocatedCapacity` – 數字 (整數)。

  此欄位已作廢。請改用 `MaxCapacity`。

  分配給此 JobRun 的 AWS Glue 資料處理單位 (DPU) 數量。 DPUs 可分配 2 到 100 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `ExecutionTime` – 數字 (整數)。

  任務執行消耗資源所需的時間 (以秒為單位)。
+ `Timeout` – 數字 (整數)，至少為 1。

  `JobRun` 逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。此值會覆寫父任務所設的逾時值。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。

  對於 Glue 2.0\$1 版任務，您不能指定 `Maximum capacity`。反之，您必須指定 `Worker type` 與 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，請勿設定 `MaxCapacity`。

  可配置給 `MaxCapacity` 的值取決於您執行的是​ Python shell 任務、Apache Spark ETL 任務或 Apache Spark Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming ETL 任務 (`JobCommand.Name`="gluestreaming") 時，您可以配置 2 到 100 個 DPU。預設值是 10 個 DPU。此任務類型沒有小數的 DPU 分配。
+ `WorkerType` – UTF-8 字串 （有效值： `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` \$1 `R.1X=""` `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。對於 Spark 任務，接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值。接受 Ray 任務的 Z.2X 值。
  + 用於 `G.1X` 工作者類型時，每個工作者會映射到 1 個 DPU (4 個 vCPU、16 GB 的記憶體)，外加 94 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.2X` 工作者類型時，每個工作者會映射到 2 個 DPU (8 個 vCPU、32 GB 的記憶體)，外加 138 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.4X` 工作者類型時，每個工作者會映射到 4 個 DPU (16 個 vCPU、64 GB 的記憶體)，外加 256 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於下列 AWS 區域中的 3.0 AWS Glue 版或更新版本 Spark ETL 任務：美國東部 （俄亥俄）、美國東部 （維吉尼亞北部）、美國西部 （奧勒岡）、亞太區域 （新加坡）、亞太區域 （雪梨）、亞太區域 （東京）、加拿大 （中部）、歐洲 （法蘭克福）、歐洲 （愛爾蘭） 和歐洲 （斯德哥爾摩）。
  + 用於 `G.8X` 工作者類型時，每個工作者會映射到 8 個 DPU (32 個 vCPU、128 GB 的記憶體)，外加 512 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的 Spark ETL 任務，其位於與`G.4X`工作者類型支援的相同 AWS 區域中。
  + 對於`G.12X`工作者類型，每個工作者會映射到具有 768GB 個 vCPUs、192 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`G.16X`工作者類型，每個工作者對應到具有 1024 GB 磁碟的 1024GB6 個 DPU (64 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 用於 `G.025X` 工作者類型時，每個工作者會映射到 0.25 個 DPU (2 個 vCPU、4 GB 的記憶體)，外加 84 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議低容量串流任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的串流任務。
  + 對於`R.1X`工作者類型，每個工作者對應到具有 94GB磁碟的 1 個 DPU (4 個 vCPUs，32 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.2X`工作者類型，每個工作者對應到具有 128GB磁碟的 2 個 DPU (8 個 vCPUs、64 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.4X`工作者類型，每個工作者會映射到具有 256GB磁碟的 4 個 DPU (16 個 vCPUs、128 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.8X`工作者類型，每個工作者會映射到具有 512GB 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於 `Z.2X` 工作者類型，每個工作者都會映射到 2 個 M-DPU (8 個 vCPU、64 GB 記憶體)，外加 128 GB 磁碟，並根據自動縮放器提供最多 8 個 Ray 工作者。
+ `NumberOfWorkers` – 數字 (整數)。

  當任務執行時所配置的已定義 `workerType` 的工作者數目。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  可與此任務執行搭配使用的 `SecurityConfiguration` 結構名稱。
+ `LogGroupName` – UTF-8 字串。

  用於確保記錄安全的名稱，可以使用 AWS KMS在 Amazon CloudWatch 中進行伺服器端加密。此名稱可為 `/aws-glue/jobs/`，在此情況下預設加密為 `NONE`。若您新增角色名稱及 `SecurityConfiguration` 名稱 (即 `/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/`)，則該安全組態將用於加密此日誌群組。
+ `NotificationProperty` – [NotificationProperty](#aws-glue-api-jobs-runs-NotificationProperty) 物件。

  指定任務執行通知的組態屬性。
+ `GlueVersion` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Custom string pattern #48](aws-glue-api-common.md#regex_48)。

  在 Spark 任務中， `GlueVersion`會決定任務中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示針對 Spark 類型任務支援的版本。

  Ray 任務應將 `GlueVersion` 設定為 `4.0` 或更高版本。不過，Ray 任務中可用的 Ray、Python 和其他程式庫的版本由 Job 命令的 `Runtime` 參數決定。

  如需可用 AWS Glue 版本和對應 Spark 和 Python 版本的詳細資訊，請參閱 開發人員指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  建立時未指定 Glue 版本的任務，預設為 Glue 0.9。
+ `DPUSeconds` – 數字 (雙位數)。

  此欄位可以針對具有執行類別 `FLEX` 的任務執行設定或在啟用 Auto Scaling 時設定，表示每個執行器在任務執行生命週期內執行的總時間 (以秒為單位) 乘以 DPU 因子 (`G.2X` 為 1、`G.1X` 為 2、`G.025X` 工作者為 0.25)。此值可能不同於 Auto Scaling 任務案例中的 `executionEngineRuntime` \$1 `MaxCapacity`，因為在給定時間執行的執行程序數量可能少於 `MaxCapacity`。因此，`DPUSeconds` 的值有可能小於 `executionEngineRuntime` \$1 `MaxCapacity`。
+ `ExecutionClass` – UTF-8 字串，長度不可超過 16 個位元組 (有效值：`FLEX=""` \$1 `STANDARD=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有 3.0 版及更高 AWS Glue 版本以及命令類型的任務`glueetl`才能`ExecutionClass`設定為 `FLEX`。彈性執行類別可用於 Spark 任務。
+ `MaintenanceWindow` – UTF-8 字串，需符合[Custom string pattern #34](aws-glue-api-common.md#regex_34)。

  此欄位會指定一週中的某一天，以及串流任務維護時段的小時。 會 AWS Glue 定期執行維護活動。在這些維護時段期間， AWS Glue 將需要重新啟動您的串流任務。

  AWS Glue 將在指定的維護時段後 3 小時內重新啟動任務。例如，如果您在 GMT 星期一上午 10：00 設定維護時段，您的任務將在 GMT 上午 10:00 到下午 1:00 之間重新啟動。
+ `ProfileName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與任務執行相關聯的 AWS Glue 用量描述檔名稱。
+ `StateDetail` – UTF-8 字串，長度不可超過 400000 個位元組。

  此欄位會保留與任務執行狀態相關的詳細資訊。欄位可以為 null。

  例如，當任務執行因任務執行佇列而處於 WAITING 狀態時， 欄位具有任務執行處於該狀態的原因。
+ `ExecutionRoleSessionPolicy` – UTF-8 字串，長度不可小於 2 個位元組，也不可以超過 2048 個位元組。

  此 StartJobRun API 的內嵌工作階段政策可讓您動態限制任務範圍的所指定執行角色的許可，而無需建立其他 IAM 角色。

## Predecessor 結構
<a name="aws-glue-api-jobs-runs-Predecessor"></a>

任務執行，在用來觸發此任務執行的觸發條件的述詞中使用。

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

  前置任務執行所用的任務定義名稱。
+ `RunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  前置任務執行作業的任務執行 ID。

## JobBookmarkEntry 結構
<a name="aws-glue-api-jobs-runs-JobBookmarkEntry"></a>

定義可供任務繼續處理的位置點。

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

  正在討論的任務的名稱。
+ `Version` – 數字 (整數)。

  任務的版本。
+ `Run` – 數字 (整數)。

  執行 ID 編號。
+ `Attempt` – 數字 (整數)。

  嘗試 ID 編號。
+ `PreviousRunId` – UTF-8 字串。

  與之前任務執行相關聯的唯一執行識別符。
+ `RunId` – UTF-8 字串。

  執行 ID 編號。
+ `JobBookmark` – UTF-8 字串。

  書籤本身。

## BatchStopJobRunSuccessfulSubmission 結構
<a name="aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission"></a>

記錄停止了指定 `JobRun` 的成功要求。

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

  先前停止的任務執行中所用的任務定義名稱。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  已停止之任務執行的 `JobRunId`。

## BatchStopJobRunError 結構
<a name="aws-glue-api-jobs-runs-BatchStopJobRunError"></a>

記錄在嘗試停止指定的任務執行時所發生的錯誤。

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

  正在討論的任務執行中所用的任務定義名稱。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  任務執行有問題的 `JobRunId`。
+ `ErrorDetail` – [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 物件。

  指定關於所發生錯誤的詳細資訊。

## NotificationProperty 結構
<a name="aws-glue-api-jobs-runs-NotificationProperty"></a>

指定通知的組態屬性。

**欄位**
+ `NotifyDelayAfter` – 數字 (整數)，至少為 1。

  任務執行開始後，在傳送任務執行延遲通知之前所要等待的分鐘數。

## 作業
<a name="aws-glue-api-jobs-runs-actions"></a>
+ [StartJobRun 動作 (Python: start\$1job\$1run)](#aws-glue-api-jobs-runs-StartJobRun)
+ [BatchStopJobRun 動作 (Python: batch\$1stop\$1job\$1run)](#aws-glue-api-jobs-runs-BatchStopJobRun)
+ [GetJobRun 動作 (Python: get\$1job\$1run)](#aws-glue-api-jobs-runs-GetJobRun)
+ [GetJobRuns 動作 (Python: get\$1job\$1runs)](#aws-glue-api-jobs-runs-GetJobRuns)
+ [GetJobBookmark 動作 (Python: get\$1job\$1bookmark)](#aws-glue-api-jobs-runs-GetJobBookmark)
+ [GetJobBookmarks 動作 (Python: get\$1job\$1bookmarks)](#aws-glue-api-jobs-runs-GetJobBookmarks)
+ [ResetJobBookmark 動作 (Python: reset\$1job\$1bookmark)](#aws-glue-api-jobs-runs-ResetJobBookmark)

## StartJobRun 動作 (Python: start\$1job\$1run)
<a name="aws-glue-api-jobs-runs-StartJobRun"></a>

使用任務定義開始任務執行。

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

  欲使用的任務定義的名稱。
+ `JobRunQueuingEnabled` – 布林值。

  指定任務執行是否已啟用任務執行佇列。

  值為 true 表示已為任務執行啟用任務執行佇列。如果為 false 或未填入，則不會考慮將任務執行排入佇列。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  要重試之先前 `JobRun` 的 ID。
+ `Arguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  與此次執行相關的任務引數。處理此任務執行時，這些引數會取代任務定義本身已設定的預設引數。

  您可以在此指定您自己的任務執行指令碼使用的引數，以及 AWS Glue 本身使用的引數。

  可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您想要將秘密保留在任務中，請從 AWS Glue 連線 AWS Secrets Manager 或其他秘密管理機制擷取秘密。

  如需如何指定和取用自有任務引數的資訊，請參閱本開發人員指南中的[使用 Python 呼叫 AWS Glue API](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 主題。

  如需有關設定 Spark 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主題。

  如需有關設定 Ray 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `AllocatedCapacity` – 數字 (整數)。

  此欄位已作廢。請改用 `MaxCapacity`。

  要配置給此 JobRun 的 AWS Glue 資料處理單位 (DPU) 數量。 DPUs 您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` – 數字 (整數)，至少為 1。

  `JobRun` 逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。此值會覆寫父任務所設的逾時值。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。

  對於 Glue 2.0\$1 版任務，您不能指定 `Maximum capacity`。反之，您必須指定 `Worker type` 與 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，請勿設定 `MaxCapacity`。

  可配置給 `MaxCapacity` 的值取決於您執行的是​ Python shell 任務、Apache Spark ETL 任務或 Apache Spark Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming ETL 任務 (`JobCommand.Name`="gluestreaming") 時，您可以配置 2 到 100 個 DPU。預設值是 10 個 DPU。此任務類型沒有小數的 DPU 分配。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  可與此任務執行搭配使用的 `SecurityConfiguration` 結構名稱。
+ `NotificationProperty` – [NotificationProperty](#aws-glue-api-jobs-runs-NotificationProperty) 物件。

  指定任務執行通知的組態屬性。
+ `WorkerType` – UTF-8 字串 (有效值：`Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。接受 Spark 任務的 G.1X、G.2X、G.4X、G.8X 或 G.025X 值。接受 Ray 任務的 Z.2X 值。
  + 用於 `G.1X` 工作者類型時，每個工作者會映射到 1 個 DPU (4 個 vCPU、16 GB 的記憶體)，外加 94 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.2X` 工作者類型時，每個工作者會映射到 2 個 DPU (8 個 vCPU、32 GB 的記憶體)，外加 138 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.4X` 工作者類型時，每個工作者會映射到 4 個 DPU (16 個 vCPU、64 GB 的記憶體)，外加 256 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於下列 AWS 區域中的 3.0 AWS Glue 版或更新版本 Spark ETL 任務：美國東部 （俄亥俄）、美國東部 （維吉尼亞北部）、美國西部 （奧勒岡）、亞太區域 （新加坡）、亞太區域 （雪梨）、亞太區域 （東京）、加拿大 （中部）、歐洲 （法蘭克福）、歐洲 （愛爾蘭） 和歐洲 （斯德哥爾摩）。
  + 用於 `G.8X` 工作者類型時，每個工作者會映射到 8 個 DPU (32 個 vCPU、128 GB 的記憶體)，外加 512 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的 Spark ETL 任務，其位於與`G.4X`工作者類型支援的相同 AWS 區域中。
  + 對於`G.12X`工作者類型，每個工作者會映射到具有 768GB 個 vCPUs、192 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`G.16X`工作者類型，每個工作者對應到具有 1024 GB 磁碟的 1024GB6 個 DPU (64 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 用於 `G.025X` 工作者類型時，每個工作者會映射到 0.25 個 DPU (2 個 vCPU、4 GB 的記憶體)，外加 84 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議低容量串流任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的串流任務。
  + 對於`R.1X`工作者類型，每個工作者對應到具有 94GB磁碟的 1 個 DPU (4 個 vCPUs，32 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.2X`工作者類型，每個工作者對應到具有 128GB磁碟的 2 個 DPU (8 個 vCPUs、64 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.4X`工作者類型，每個工作者會映射到具有 256GB磁碟的 4 個 DPU (16 個 vCPUs、128 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.8X`工作者類型，每個工作者會映射到具有 512GB 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於 `Z.2X` 工作者類型，每個工作者都會映射到 2 個 M-DPU (8 個 vCPU、64 GB 記憶體)，外加 128 GB 磁碟，並根據自動縮放器提供最多 8 個 Ray 工作者。
+ `NumberOfWorkers` – 數字 (整數)。

  當任務執行時所配置的已定義 `workerType` 的工作者數目。
+ `ExecutionClass` – UTF-8 字串，長度不可超過 16 個位元組 (有效值：`FLEX=""` \$1 `STANDARD=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有 3.0 版及更高 AWS Glue 版本以及命令類型的任務`glueetl`才能`ExecutionClass`設定為 `FLEX`。彈性執行類別可用於 Spark 任務。
+ `ProfileName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  與任務執行相關聯的 AWS Glue 用量描述檔名稱。
+ `ExecutionRoleSessionPolicy` – UTF-8 字串，長度不可小於 2 個位元組，也不可以超過 2048 個位元組。

  此 StartJobRun API 的內嵌工作階段政策可讓您動態限制任務範圍的所指定執行角色的許可，而無需建立其他 IAM 角色。

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

  指派給此次任務執行的 ID。

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

## BatchStopJobRun 動作 (Python: batch\$1stop\$1job\$1run)
<a name="aws-glue-api-jobs-runs-BatchStopJobRun"></a>

針對指定的任務定義停止一個或多個任務執行作業。

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

  用於停止任務執行的任務定義的名稱。
+ `JobRunIds` – *必要：*UTF-8 字串的陣列，不可小於 1 或超過 25 個字串。

  因該項任務定義而應停止的 `JobRunIds` 清單。

**回應**
+ `SuccessfulSubmissions` – 一個 [BatchStopJobRunSuccessfulSubmission](#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission) 物件陣列。

  已成功提交停用要求的 JobRun 的清單。
+ `Errors` – 一個 [BatchStopJobRunError](#aws-glue-api-jobs-runs-BatchStopJobRunError) 物件陣列。

  在嘗試停止 `JobRuns` 時所發生錯誤的清單，包括針對每項錯誤列出的 `JobRunId`，以及關於錯誤的詳細資訊。

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

## GetJobRun 動作 (Python: get\$1job\$1run)
<a name="aws-glue-api-jobs-runs-GetJobRun"></a>

擷取特定任務執行作業的中繼資料。您可以存取工作流程和任務執行的 365 天任務執行歷史記錄。

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

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

  此次任務執行的 ID。
+ `PredecessorsIncluded` – 布林值。

  如果應傳回前置任務執行作業的清單，則此值為 true。

**回應**
+ `JobRun` – [JobRun](#aws-glue-api-jobs-runs-JobRun) 物件。

  所要求任務執行作業的中繼資料。

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

## GetJobRuns 動作 (Python: get\$1job\$1runs)
<a name="aws-glue-api-jobs-runs-GetJobRuns"></a>

擷取特定任務定義所有執行作業的中繼資料。

`GetJobRuns` 會依時間順序傳回任務執行，並先傳回最新的任務。

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

  要擷取其所有任務執行作業資料的任務定義的名稱。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續呼叫。
+ `MaxResults` – 數字 （整數），不可小於 1 或大於 200。

  回應的大小上限。

**回應**
+ `JobRuns` – 一個 [JobRun](#aws-glue-api-jobs-runs-JobRun) 物件陣列。

  任務執行中繼資料物件的清單。
+ `NextToken` – UTF-8 字串。

  持續符記 (如果尚未傳回所有重新要求的任務執行作業的結果)。

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

## GetJobBookmark 動作 (Python: get\$1job\$1bookmark)
<a name="aws-glue-api-jobs-runs-GetJobBookmark"></a>

傳回任務書籤項目的資訊。

如需有關啟用和使用任務書籤的詳細資訊，請參閱：
+ [使用任務書籤追蹤處理的資料](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [使用的任務參數 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [任務結構](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

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

  正在討論的任務的名稱。
+ `Version` – 數字 (整數)。

  任務的版本。
+ `RunId` – UTF-8 字串。

  與此任務執行相關聯的唯一執行識別符。

**回應**
+ `JobBookmarkEntry` – [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry) 物件。

  一種結構，定義任務可繼續處理的點。

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

## GetJobBookmarks 動作 (Python: get\$1job\$1bookmarks)
<a name="aws-glue-api-jobs-runs-GetJobBookmarks"></a>

傳回任務書籤項目的資訊。此清單是按照遞減的版本號碼排序的。

如需有關啟用和使用任務書籤的詳細資訊，請參閱：
+ [使用任務書籤追蹤處理的資料](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [使用的任務參數 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [任務結構](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

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

  正在討論的任務的名稱。
+ `MaxResults` – 數字 (整數)。

  回應的大小上限。
+ `NextToken` – 數字 (整數)。

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

**回應**
+ `JobBookmarkEntries` – 一個 [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry) 物件陣列。

  任務書籤項目的清單，定義工作可以繼續處理的點。
+ `NextToken` – 數字 (整數)。

  接續符記，如果傳回所有項目，其值為 1；如果沒有傳回所有請求的任務執行，則傳回 > 1 的值。

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

## ResetJobBookmark 動作 (Python: reset\$1job\$1bookmark)
<a name="aws-glue-api-jobs-runs-ResetJobBookmark"></a>

重設書籤項目。

如需有關啟用和使用任務書籤的詳細資訊，請參閱：
+ [使用任務書籤追蹤處理的資料](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [使用的任務參數 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [任務結構](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

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

  正在討論的任務的名稱。
+ `RunId` – UTF-8 字串。

  與此任務執行相關聯的唯一執行識別符。

**回應**
+ `JobBookmarkEntry` – [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry) 物件。

  重設的書籤項目。

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

# 觸發
<a name="aws-glue-api-jobs-trigger"></a>

Triggers API 說明與建立、更新或刪除，以及啟動和停止任務觸發程序相關的資料類型和 API AWS Glue。

## 資料類型
<a name="aws-glue-api-jobs-trigger-objects"></a>
+ [Trigger 結構](#aws-glue-api-jobs-trigger-Trigger)
+ [TriggerUpdate 結構](#aws-glue-api-jobs-trigger-TriggerUpdate)
+ [Predicate 結構](#aws-glue-api-jobs-trigger-Predicate)
+ [Condition 結構](#aws-glue-api-jobs-trigger-Condition)
+ [Action 結構](#aws-glue-api-jobs-trigger-Action)
+ [EventBatchingCondition 結構](#aws-glue-api-jobs-trigger-EventBatchingCondition)

## Trigger 結構
<a name="aws-glue-api-jobs-trigger-Trigger"></a>

關於特定觸發條件的資訊。

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

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

  與觸發條件相關聯的工作流程名稱。
+ `Id` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  保留以供日後使用。
+ `Type` – UTF-8 字串 (有效值：`SCHEDULED` \$1 `CONDITIONAL` \$1 `ON_DEMAND` \$1 `EVENT`)。

  此處觸發條件的類型。
+ `State` – UTF-8 字串 (有效值：`CREATING` \$1 `CREATED` \$1 `ACTIVATING` \$1 `ACTIVATED` \$1 `DEACTIVATING` \$1 `DEACTIVATED` \$1 `DELETING` \$1 `UPDATING`)。

  觸發條件目前的狀態。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  此觸發條件的說明。
+ `Schedule` – UTF-8 字串。

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

  此觸發條件起始的動作。
+ `Predicate` – [述詞](#aws-glue-api-jobs-trigger-Predicate) 物件。

  此觸發條件的述詞，定義了觸發的時間點。
+ `EventBatchingCondition` – [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition) 物件。

  在引發 EventBridge 事件觸發之前，必須符合的批次條件 (指定接收的事件數目或批次時段已過期)。

## TriggerUpdate 結構
<a name="aws-glue-api-jobs-trigger-TriggerUpdate"></a>

一種結構，用來提供更新觸發條件時所使用的資訊。此物件在更新先前的觸發條件定義時，會完全覆寫掉之前的內容。

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

  保留以供日後使用。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  此觸發條件的說明。
+ `Schedule` – UTF-8 字串。

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

  此觸發條件起始的動作。
+ `Predicate` – [述詞](#aws-glue-api-jobs-trigger-Predicate) 物件。

  此觸發條件的述詞，定義了觸發的時間點。
+ `EventBatchingCondition` – [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition) 物件。

  在引發 EventBridge 事件觸發之前，必須符合的批次條件 (指定接收的事件數目或批次時段已過期)。

## Predicate 結構
<a name="aws-glue-api-jobs-trigger-Predicate"></a>

定義觸發條件的述詞，此述詞會決定觸發的時間點。

**欄位**
+ `Logical` – UTF-8 字串 (有效值：`AND` \$1 `ANY`)。

  如果只列出一個條件，則為選用欄位。如果列出了多個條件，則此為必要欄位。
+ `Conditions` – [條件](#aws-glue-api-jobs-trigger-Condition) 物件陣列，不可超過 500 個結構。

  觸發條件的清單，這些條件決定了觸發的時間點。

## Condition 結構
<a name="aws-glue-api-jobs-trigger-Condition"></a>

定義觸發的條件。

**欄位**
+ `LogicalOperator` – UTF-8 字串 (有效值：`EQUALS`)。

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

  任務的名稱，此條件會套用至該任務的 `JobRuns`，此觸發條件也會等待起始該任務。
+ `State` – UTF-8 字串 (有效值：`STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`)。

  條件的狀態。目前，觸發條件可聆聽的任務狀態只有 `SUCCEEDED`、`STOPPED`、`FAILED` 和 `TIMEOUT`。觸發條件可聆聽的爬蟲程式狀態只有 `SUCCEEDED`、`FAILED` 和 `CANCELLED`。
+ `CrawlerName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  要套用此條件的爬取程式名稱。
+ `CrawlState` – UTF-8 字串 (有效值：`RUNNING` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ERROR`)。

  要套用此條件的爬取程式狀態。

## Action 結構
<a name="aws-glue-api-jobs-trigger-Action"></a>

定義觸發條件要起始的動作。

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

  要執行的任務的名稱。
+ `Arguments` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  此觸發條件觸發時所使用的任務引數。處理此任務執行時，這些引數會取代任務定義本身已設定的預設引數。

  您可以在此指定您自己的任務執行指令碼使用的引數，以及 AWS Glue 本身使用的引數。

  如需如何指定和取用自有任務引數的資訊，請參閱本開發人員指南中的[使用 Python 呼叫 AWS Glue API](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 主題。

  如需 AWS Glue 用於設定任務的鍵/值對相關資訊，請參閱 開發人員指南中的 [使用的特殊參數 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)主題。
+ `Timeout` – 數字 (整數)，至少為 1。

  `JobRun` 逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。此會覆寫父任務所設的逾時值。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  可與此動作搭配使用的 `SecurityConfiguration` 結構名稱。
+ `NotificationProperty` – [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 物件。

  指定任務執行通知的組態屬性。
+ `CrawlerName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  要搭配此動作使用的爬取程式名稱。

## EventBatchingCondition 結構
<a name="aws-glue-api-jobs-trigger-EventBatchingCondition"></a>

在引發 EventBridge 事件觸發之前，必須符合的批次條件 (指定接收的事件數目或批次時段已過期)。

**欄位**
+ `BatchSize` – *必要：*數字 (整數)，不可小於 1，也不可以大於 100。

  引發 EventBridge 事件觸發之前，必須從 Amazon EventBridge 收到的事件數目。
+ `BatchWindow` – 數字 (整數)，不可小於 1，也不可以大於 900。

  引發 EventBridge 事件觸發之後的時段 (以秒為單位)。時段在接收到第一個事件時啟動。

## 作業
<a name="aws-glue-api-jobs-trigger-actions"></a>
+ [CreateTrigger 動作 (Python: create\$1trigger)](#aws-glue-api-jobs-trigger-CreateTrigger)
+ [StartTrigger 動作 (Python: start\$1trigger)](#aws-glue-api-jobs-trigger-StartTrigger)
+ [GetTrigger 動作 (Python: get\$1trigger)](#aws-glue-api-jobs-trigger-GetTrigger)
+ [GetTriggers 動作 (Python: get\$1triggers)](#aws-glue-api-jobs-trigger-GetTriggers)
+ [UpdateTrigger 動作 (Python: update\$1trigger)](#aws-glue-api-jobs-trigger-UpdateTrigger)
+ [StopTrigger 動作 (Python: stop\$1trigger)](#aws-glue-api-jobs-trigger-StopTrigger)
+ [DeleteTrigger 動作 (Python: delete\$1trigger)](#aws-glue-api-jobs-trigger-DeleteTrigger)
+ [ListTriggers 動作 (Python: list\$1triggers)](#aws-glue-api-jobs-trigger-ListTriggers)
+ [BatchGetTriggers 動作 (Python: batch\$1get\$1triggers)](#aws-glue-api-jobs-trigger-BatchGetTriggers)

## CreateTrigger 動作 (Python: create\$1trigger)
<a name="aws-glue-api-jobs-trigger-CreateTrigger"></a>

建立新的觸發條件。

可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您想要將秘密保留在任務中，請從 AWS Glue 連線、 AWS Secrets Manager 或其他秘密管理機制擷取秘密。

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

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

  與觸發條件相關聯的工作流程名稱。
+ `Type` – *必要：*UTF-8 字串 (有效值：`SCHEDULED` \$1 `CONDITIONAL` \$1 `ON_DEMAND` \$1 `EVENT`)。

  新觸發條件的類型。
+ `Schedule` – UTF-8 字串。

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

  當觸發類型為 SCHEDULED 時，此欄位為必要。
+ `Predicate` – [述詞](#aws-glue-api-jobs-trigger-Predicate) 物件。

  用來指定新觸發條件觸發時間點的述詞。

  當觸發類型為 `CONDITIONAL` 時，此欄位為必要。
+ `Actions` – *必要：*一個 [Action](#aws-glue-api-jobs-trigger-Action) 物件。

  此觸發條件觸發時所起始的動作。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  新觸發條件的說明。
+ `StartOnCreation` – 布林值。

  設定 `true`，即可在建立時啟動 `SCHEDULED` 和 `CONDITIONAL` 觸發。True 不支援 `ON_DEMAND` 觸發。
+ `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)。
+ `EventBatchingCondition` – [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition) 物件。

  在引發 EventBridge 事件觸發之前，必須符合的批次條件 (指定接收的事件數目或批次時段已過期)。

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

  觸發條件的名稱。

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

## StartTrigger 動作 (Python: start\$1trigger)
<a name="aws-glue-api-jobs-trigger-StartTrigger"></a>

啟動現有的觸發條件。請參閱[觸發任務](https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html)，以了解如何啟動不同類型觸發條件的資訊。

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

  所要啟動觸發條件的名稱。

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

  已啟動的觸發條件的名稱。

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

## GetTrigger 動作 (Python: get\$1trigger)
<a name="aws-glue-api-jobs-trigger-GetTrigger"></a>

擷取觸發條件的定義。

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

  要擷取的觸發條件的名稱。

**回應**
+ `Trigger` – [觸發條件](#aws-glue-api-jobs-trigger-Trigger) 物件。

  要求的觸發條件定義。

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

## GetTriggers 動作 (Python: get\$1triggers)
<a name="aws-glue-api-jobs-trigger-GetTriggers"></a>

取得與任務相關的所有觸發條件。

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

  接續符記，如果這是接續呼叫。
+ `DependentJobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  擷取觸發之任務的名稱。將會傳回可起始此項任務的觸發條件，如果沒有此等觸發條件，將傳回所有的觸發條件。
+ `MaxResults` – 數字 （整數），不可小於 1 或大於 200。

  回應的大小上限。

**回應**
+ `Triggers` – 一個 [觸發條件](#aws-glue-api-jobs-trigger-Trigger) 物件陣列。

  指定任務適用的觸發條件的清單。
+ `NextToken` – UTF-8 字串。

  持續符記 (如果尚未傳回所有要求的觸發條件)。

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

## UpdateTrigger 動作 (Python: update\$1trigger)
<a name="aws-glue-api-jobs-trigger-UpdateTrigger"></a>

更新觸發定義。

可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您想要將秘密保留在任務中，請從 AWS Glue 連線、 AWS Secrets Manager 或其他秘密管理機制擷取秘密。

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

  所要更新觸發條件的名稱。
+ `TriggerUpdate` – *必要：*[TriggerUpdate](#aws-glue-api-jobs-trigger-TriggerUpdate) 物件。

  新的值，用來更新觸發條件。

**回應**
+ `Trigger` – [觸發條件](#aws-glue-api-jobs-trigger-Trigger) 物件。

  產生的觸發條件定義。

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

## StopTrigger 動作 (Python: stop\$1trigger)
<a name="aws-glue-api-jobs-trigger-StopTrigger"></a>

停止指定的觸發條件。

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

  所要停止的觸發條件的名稱。

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

  已停止的觸發條件的名稱。

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

## DeleteTrigger 動作 (Python: delete\$1trigger)
<a name="aws-glue-api-jobs-trigger-DeleteTrigger"></a>

刪除指定的觸發條件。如果找不到此觸發條件，就不會擲回例外狀況。

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

  所要刪除的觸發條件的名稱。

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

  已刪除的觸發條件的名稱。

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

## ListTriggers 動作 (Python: list\$1triggers)
<a name="aws-glue-api-jobs-trigger-ListTriggers"></a>

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

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

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

  接續符記，如果這是接續要求。
+ `DependentJobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

   要擷取其觸發條件的工作的名稱。這時會傳回可起始此任務的觸發條件。如果這時沒有這種觸發條件，則會傳回所有的觸發條件。
+ `MaxResults` – 數字 （整數），不可小於 1 或大於 200。

  所要回傳清單的大小上限。
+ `Tags` – 金鑰值對的對應陣列，不超過 50 對。

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

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

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

**回應**
+ `TriggerNames` – UTF-8 字串陣列。

  這個帳戶下所有觸發條件的名稱，或是使用指定標籤的觸發條件。
+ `NextToken` – UTF-8 字串。

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

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

## BatchGetTriggers 動作 (Python: batch\$1get\$1triggers)
<a name="aws-glue-api-jobs-trigger-BatchGetTriggers"></a>

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

**請求**
+ `TriggerNames` – *必要：*UTF-8 字串陣列。

  觸發條件名稱清單，可能是從 `ListTriggers` 操作傳回的名稱。

**回應**
+ `Triggers` – 一個 [觸發條件](#aws-glue-api-jobs-trigger-Trigger) 物件陣列。

  觸發條件定義的清單。
+ `TriggersNotFound` – UTF-8 字串陣列。

  找不到觸發條件名稱清單。

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