本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
工作流程
工作流程API描述與建立、更新或檢視 中的工作流程API相關的資料類型和 AWS Glue。工作流程和任務執行的任務執行歷史記錄可存取 90 天。
資料類型
JobNodeDetails 結構
工作流程中顯示的 Job 節點詳細資訊。
欄位
-
JobRuns
– 一個 JobRun 物件陣列。job 節點代表的任務資訊。
CrawlerNodeDetails 結構
工作流程中顯示的 Crawler 節點詳細資訊。
欄位
-
Crawls
– 一個 編目 物件陣列。crawl 節點代表的編目清單。
TriggerNodeDetails 結構
工作流程中顯示的 Trigger 節點詳細資訊。
欄位
-
Trigger
– 觸發條件 物件。trigger 節點代表的觸發資訊。
Crawl 結構
工作流程中的編目詳細資訊。
欄位
-
State
– UTF-8 字串 (有效值:RUNNING
|CANCELLING
| |CANCELLED
SUCCEEDED
|FAILED
| |ERROR
)。爬蟲程式的狀態。
-
StartedOn
– 時間戳記。開始編目的日期和時間。
-
CompletedOn
– 時間戳記。完成編目的日期和時間。
-
ErrorMessage
– 描述字串,長度不可超過 2048 個位元組,需符合URI address multi-line string pattern。與此編目相關聯的錯誤訊息。
-
LogGroup
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 512 個位元組,需符合 Log group string pattern。與編目相關聯的日誌群組。
-
LogStream
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 512 個位元組,需符合 Log-stream string pattern。與編目相關聯的日誌串流。
Node 結構
節點代表工作流程圖表上的 AWS Glue 元件 (觸發器、爬蟲程式或任務)。
欄位
-
Type
– UTF-8 字串 (有效值:CRAWLER
|JOB
|TRIGGER
)。節點表示的 AWS Glue 元件類型。
-
Name
– UTF-8 個字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。節點所代表的 AWS Glue 元件名稱。
-
UniqueId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。工作流程內指派給節點的唯一 ID。
-
TriggerDetails
– TriggerNodeDetails 物件。當節點代表 Trigger 時的觸發詳細資訊。
-
JobDetails
– JobNodeDetails 物件。當節點代表 Job 時的任務詳細資訊。
-
CrawlerDetails
– CrawlerNodeDetails 物件。當節點代表 Crawler 時的爬蟲程式詳細資訊。
Edge 結構
邊緣代表兩個元件之間的導向連線,這些 AWS Glue 元件是邊緣所屬工作流程的一部分。
欄位
-
SourceId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。節點開始所在工作流程的唯一節點。
-
DestinationId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。節點結束所在工作流程的唯一節點。
Workflow 結構
工作流程是多個相依 AWS Glue 任務和爬蟲程式的集合,這些任務和爬蟲程式會執行來完成複雜的ETL任務。每項工作流程都管理其所有任務和爬蟲程式的執行和監控。
欄位
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。工作流程的名稱。
-
Description
– UTF-8 字串。工作流程的描述。
-
DefaultRunProperties
– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。
每個值都是 UTF-8 字串。
要做為每項工作流程執行一部分使用的屬性集合。執行屬性可供工作流程中的每個任務使用。任務可以修改流程中下一個任務的屬性。
-
CreatedOn
– 時間戳記。工作流程建立的日期和時間。
-
LastModifiedOn
– 時間戳記。工作流程上次修改的日期和時間。
-
LastRun
– WorkflowRun 物件。上次執行工作流程的資訊。
-
Graph
– WorkflowGraph 物件。圖形表示屬於工作流程的所有 AWS Glue 元件作為節點,以及它們之間的導向連線作為邊緣。
-
CreationStatus
– UTF-8 字串 (有效值:CREATING
|CREATED
|CREATION_FAILED
)。工作流程的建立狀態。
-
MaxConcurrentRuns
– 數字 (整數)。您可以使用此參數來防止不想要的資料更新、控制成本,或在某些情況下,防止超過任何元件任務的並行執行次數上限。此參數若保留空白,即不限制並行工作流程執行的數目。
-
BlueprintDetails
– BlueprintDetails 物件。此結構指出建立此特定工作流程的藍圖詳細資訊。
WorkflowGraph 結構
工作流程圖代表完整的工作流程,包含工作流程中的所有 AWS Glue 元件,以及它們之間所有的導向連線。
WorkflowRun 結構
工作流程回合是執行提供所有執行時間資訊的工作流程。
欄位
-
Name
– UTF-8 個字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。已執行的工作流程名稱。
-
WorkflowRunId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。此工作流程回合的 ID。
-
PreviousRunId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。先前工作流程執行的 ID。
-
WorkflowRunProperties
– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。
每個值都是 UTF-8 字串。
在執行期間設定的工作流程回合屬性。
-
StartedOn
– 時間戳記。工作流程回合開始的日期和時間。
-
CompletedOn
– 時間戳記。工作流程回合完成的日期和時間。
-
Status
– UTF-8 字串 (有效值:RUNNING
|COMPLETED
|STOPPING
|STOPPED
|ERROR
)。工作流程回合的狀態。
-
ErrorMessage
– UTF-8 字串。此錯誤訊息說明啟動工作流程執行時可能發生的任何錯誤。目前唯一的錯誤訊息是「並行執行超過工作流程:
foo
。」 -
Statistics
– WorkflowRunStatistics 物件。該回合的統計資料。
-
Graph
– WorkflowGraph 物件。圖形表示屬於工作流程的所有 AWS Glue 元件作為節點,以及它們之間的導向連線作為邊緣。
-
StartingEventBatchCondition
– StartingEventBatchCondition 物件。啟動工作流程執行的批次條件。
WorkflowRunStatistics 結構
工作流程回合統計資料,提供關於工作流程回合的統計資料。
欄位
-
TotalActions
– 數字 (整數)。工作流程回合的動作總數。
-
TimeoutActions
– 數字 (整數)。逾時動作的總數。
-
FailedActions
– 數字 (整數)。失敗動作的總數。
-
StoppedActions
– 數字 (整數)。已停止動作的總數。
-
SucceededActions
– 數字 (整數)。成功動作的總數。
-
RunningActions
– 數字 (整數)。正在執行狀態的動作總數。
-
ErroredActions
– 數字 (整數)。指出工作流程執行中ERROR處於 狀態的任務執行計數。
-
WaitingActions
– 數字 (整數)。指出工作流程執行中處於 WAITING 狀態的任務執行計數。
StartingEventBatchCondition 結構
啟動工作流程執行的批次條件。批次大小中到達的事件數量,在這種情況下, BatchSize 成員不是零,或者批次時段過期,在這種情況下, BatchWindow 成員不是零。
欄位
-
BatchSize
– 數字 (整數)。批次中的事件數目。
-
BatchWindow
– 數字 (整數)。批次間隔的持續時間 (以秒為單位)。
Blueprint 結構
藍圖的詳細資訊。
欄位
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,需符合 Custom string pattern #31。藍圖的名稱。
-
Description
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 512 個位元組。藍圖的描述。
-
CreatedOn
– 時間戳記。藍圖註冊的日期和時間。
-
LastModifiedOn
– 時間戳記。上次修改藍圖的日期和時間。
-
ParameterSpec
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 131072 個位元組。指出藍圖參數規格清單的JSON字串。
-
BlueprintLocation
– UTF-8 字串。指定 Amazon S3 中發佈藍圖的路徑。
-
BlueprintServiceLocation
– UTF-8 字串。在 Amazon S3 中指定一個路徑,當您呼叫
CreateBlueprint/UpdateBlueprint
以將藍圖註冊到 AWS Glue時要複製藍圖的路徑。 -
Status
– UTF-8 字串 (有效值:CREATING
|ACTIVE
|UPDATING
|FAILED
)。藍圖註冊的狀態。
-
正在建立 — 藍圖註冊正在進行中。
-
使用中 — 藍圖已成功註冊。
-
正在更新 — 正在進行藍圖註冊的更新。
-
失敗 — 藍圖註冊失敗。
-
-
ErrorMessage
– UTF-8 字串。錯誤訊息。
-
LastActiveDefinition
– LastActiveDefinition 物件。當藍圖有多個版本且最新版本發生某些錯誤時,此屬性會指出服務可用的上次成功藍圖定義。
BlueprintDetails 結構
藍圖的詳細資訊。
欄位
-
BlueprintName
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,需符合 Custom string pattern #31。藍圖的名稱。
-
RunId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。此藍圖的執行 ID。
LastActiveDefinition 結構
當藍圖有多個版本且最新版本發生某些錯誤時,此屬性會指出服務可用的上次成功藍圖定義。
欄位
-
Description
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 512 個位元組。藍圖的描述。
-
LastModifiedOn
– 時間戳記。上次修改藍圖的日期和時間。
-
ParameterSpec
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 131072 個位元組。指定藍圖參數的JSON字串。
-
BlueprintLocation
– UTF-8 字串。在 AWS Glue 開發人員發佈藍圖的 Amazon S3 中指定路徑。
-
BlueprintServiceLocation
– UTF-8 字串。在 Amazon S3 中指定一個路徑,當您建立或更新藍圖時從中複製藍圖。
BlueprintRun 結構
藍圖執行的詳細資訊
欄位
-
BlueprintName
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,需符合 Custom string pattern #31。藍圖的名稱。
-
RunId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。此藍圖執行的執行 ID。
-
WorkflowName
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。由於成功執行藍圖而建立的工作流程名稱。如果藍圖執行發生錯誤,則不會建立工作流程。
-
State
– UTF-8 字串 (有效值:RUNNING
|SUCCEEDED
|FAILED
|ROLLING_BACK
)。藍圖的執行狀態。可能值為:
-
執行中 — 藍圖執行正在進行中。
-
成功 — 藍圖執行成功完成。
-
失敗 — 藍圖執行失敗且已完成回復。
-
復原 — 藍圖執行失敗且正在進行回復。
-
-
StartedOn
– 時間戳記。藍圖執行開始的日期和時間。
-
CompletedOn
– 時間戳記。藍圖執行完成的日期和時間。
-
ErrorMessage
– UTF-8 字串。指出執行藍圖時看到的任何錯誤。
-
RollbackErrorMessage
– UTF-8 字串。如果在建立一個工作流程的實體有任何錯誤,我們會嘗試回復建立的實體直到該點並刪除它們。此屬性指出嘗試刪除所建立的實體時看到的錯誤。
-
Parameters
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 131072 個位元組。藍圖參數為字串。您必須為每個索引鍵提供一個值,這是
Blueprint$ParameterSpec
中定義的參數規格所必需的。 -
RoleArn
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 1024 個位元組,且需符合 Custom string pattern #30。角色 ARN。此角色將由 AWS Glue 服務擔任,並用於建立工作流程和其他工作流程實體。
作業
CreateWorkflow 動作 (Python:create_workflow)
建立新的工作流程。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要指派給工作流程的名稱。它在您帳戶中應該是唯一的。
-
Description
– UTF-8 字串。工作流程的描述。
-
DefaultRunProperties
– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。
每個值都是 UTF-8 字串。
要做為每項工作流程執行一部分使用的屬性集合。
可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您打算將秘密保留在任務中,請從 AWS Glue Connection、 AWS Secrets Manager 或其他秘密管理機制擷取秘密。
-
Tags
– 金鑰值對的映射陣列,不超過 50 對。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組。
每個值都是 UTF-8 字串,長度不可超過 256 個位元組。
要用於這個工作流程的標籤。
-
MaxConcurrentRuns
– 數字 (整數)。您可以使用此參數來防止不想要的資料更新、控制成本,或在某些情況下,防止超過任何元件任務的並行執行次數上限。此參數若保留空白,即不限制並行工作流程執行的數目。
回應
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。提供為請求之一部分的工作流程名稱。
錯誤
AlreadyExistsException
InvalidInputException
InternalServiceException
OperationTimeoutException
ResourceNumberLimitExceededException
ConcurrentModificationException
UpdateWorkflow 動作 (Python: update_workflow)
更新現有的工作流程。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要更新的工作流程名稱。
-
Description
– UTF-8 字串。工作流程的描述。
-
DefaultRunProperties
– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。
每個值都是 UTF-8 字串。
要做為每項工作流程執行一部分使用的屬性集合。
可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您打算將秘密保留在任務中,請從 AWS Glue Connection、 AWS Secrets Manager 或其他秘密管理機制擷取秘密。
-
MaxConcurrentRuns
– 數字 (整數)。您可以使用此參數來防止不想要的資料更新、控制成本,或在某些情況下,防止超過任何元件任務的並行執行次數上限。此參數若保留空白,即不限制並行工作流程執行的數目。
回應
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。在輸入中指定的工作流程名稱。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
ConcurrentModificationException
DeleteWorkflow 動作 (Python:Delete_workflow)
刪除工作流程。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要刪除的工作流程名稱。
回應
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。在輸入中指定的工作流程名稱。
錯誤
InvalidInputException
InternalServiceException
OperationTimeoutException
ConcurrentModificationException
GetWorkflow 動作 (Python:get_workflow)
擷取工作流程的資源中繼資料。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要擷取的工作流程名稱。
-
IncludeGraph
– 布林值。傳回工作流程資源中繼資料時,指定是否包含圖形。
回應
-
Workflow
– 工作流程 物件。工作流程的資源中繼資料。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
ListWorkflows 動作 (Python:list_workflows)
在帳戶中建立的工作流程清單名稱。
請求
-
NextToken
– UTF-8 字串。接續符記,如果這是接續要求。
-
MaxResults
– 數字 (整數),不可小於 1 或大於 25。所要回傳清單的大小上限。
回應
-
Workflows
– UTF-8 個字串的陣列,不可小於 1 個或超過 25 個字串。帳戶中的工作流程名稱清單。
-
NextToken
– UTF-8 字串。若未傳回所有的工作流程名稱,則為接續字符。
錯誤
InvalidInputException
InternalServiceException
OperationTimeoutException
BatchGetWorkflows 動作 (Python: batch_get_workflows)
針對指定的工作流程清單,傳回資源中繼資料的清單。呼叫 ListWorkflows
操作之後,您便可以呼叫此操作來存取您已授與許可的資料。此操作支援所有IAM許可,包括使用標籤的許可條件。
請求
-
Names
– 必要:UTF-8 個字串的陣列,不可小於 1 個或超過 25 個字串。工作流程名稱清單,可能是從
ListWorkflows
操作傳回的名稱。 -
IncludeGraph
– 布林值。傳回工作流程資源中繼資料時,指定是否包含圖形。
回應
-
Workflows
– 工作流程 物件陣列,不小於 1 個結構,也不大於 25 個結構。工作流程資源中繼資料清單。
-
MissingWorkflows
– UTF-8 個字串的陣列,不可少於 1 個或超過 25 個字串。找不到工作流程名稱清單。
錯誤
InternalServiceException
OperationTimeoutException
InvalidInputException
GetWorkflowRun 動作 (Python: get_workflow_run)
擷取指定工作流程回合的中繼資料。工作流程和任務執行的任務執行歷史記錄可存取 90 天。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。正在執行的工作流程名稱。
-
RunId
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。工作流程回合的 ID。
-
IncludeGraph
– 布林值。指定回應是否包含工作流程圖。
回應
-
Run
– WorkflowRun 物件。請求的工作流程回合中繼資料。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
GetWorkflowRuns 動作 (Python:get_workflow_runs)
擷取指定工作流程所有回合的中繼資料。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。應傳回回合中繼資料的工作流程名稱。
-
IncludeGraph
– 布林值。指定回應是否包含工作流程圖。
-
NextToken
– UTF-8 字串。回應的大小上限。
-
MaxResults
– 數字 (整數),不可小於 1,也不可以大於 1000。要包含在回應中的工作流程回合最大數量。
回應
-
Runs
– WorkflowRun 物件陣列,不小於 1 個結構,也不大於 1000 個結構。工作流程回合中繼資料物件的清單。
-
NextToken
– UTF-8 字串。接續字符 (如果尚未傳回所有請求的工作流程回合)。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
GetWorkflowRunProperties 動作 (Python:get_workflow_run_properties)
擷取在執行期間設定的工作流程回合屬性。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。已執行的工作流程名稱。
-
RunId
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。應該傳回其回合屬性的工作流程回合 ID。
回應
-
RunProperties
– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。
每個值都是 UTF-8 字串。
在指定回合期間設定的工作流程回合屬性。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
PutWorkflowRunProperties 動作 (Python: put_workflow_run_properties)
針對指定的工作流程回合放置指定的工作流程回合屬性。如果指定的回合已有屬性,則會覆寫該值,否則會將屬性新增到現有的屬性。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。已執行的工作流程名稱。
-
RunId
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。應該更新回合屬性的工作流程回合 ID。
-
RunProperties
– 必要:金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。
每個值都是 UTF-8 字串。
針對指定回合放置的屬性。
可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您打算將秘密保留在任務中,請從 AWS Glue Connection、 AWS Secrets Manager 或其他秘密管理機制擷取秘密。
回應
無回應參數。
錯誤
AlreadyExistsException
EntityNotFoundException
InvalidInputException
InternalServiceException
OperationTimeoutException
ResourceNumberLimitExceededException
ConcurrentModificationException
CreateBlueprint 動作 (Python:create_blueprint)
向 註冊藍圖 AWS Glue。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,需符合 Custom string pattern #31。藍圖的名稱。
-
Description
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 512 個位元組。藍圖的描述。
-
BlueprintLocation
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 8192 個位元組,需符合 Custom string pattern #32。指定 Amazon S3 中發佈藍圖的路徑。
-
Tags
– 金鑰值對的對應陣列,不超過 50 對。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組。
每個值都是 UTF-8 字串,長度不可超過 256 個位元組。
要套用至此藍圖的標籤。
回應
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。傳回已註冊藍圖的名稱。
錯誤
AlreadyExistsException
InvalidInputException
OperationTimeoutException
InternalServiceException
ResourceNumberLimitExceededException
UpdateBlueprint 動作 (Python: update_blueprint)
更新已註冊的藍圖。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,需符合 Custom string pattern #31。藍圖的名稱。
-
Description
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 512 個位元組。藍圖的描述。
-
BlueprintLocation
– 必要:UTF-8 個字串,長度不可小於 1 個位元組,也不可以超過 8192 個位元組,需符合 Custom string pattern #32。指定 Amazon S3 中發佈藍圖的路徑。
回應
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。傳回已更新的藍圖名稱。
錯誤
EntityNotFoundException
ConcurrentModificationException
InvalidInputException
OperationTimeoutException
InternalServiceException
IllegalBlueprintStateException
DeleteBlueprint 動作 (Python:Delete_blueprint)
刪除現有的藍圖。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。欲刪除的藍圖名稱。
回應
-
Name
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。傳回已刪除藍圖的名稱。
錯誤
InvalidInputException
OperationTimeoutException
InternalServiceException
ListBlueprints 動作 (Python:list_blueprints)
列出帳戶中的所有藍圖名稱。
請求
-
NextToken
– UTF-8 字串。接續符記,如果這是接續要求。
-
MaxResults
– 數字 (整數),不可小於 1 或大於 25。所要回傳清單的大小上限。
-
Tags
– 金鑰值對的對應陣列,不超過 50 對。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組。
每個值都是 UTF-8 字串,長度不可超過 256 個位元組。
依 AWS 資源標籤篩選清單。
回應
-
Blueprints
– UTF-8 個字串的陣列。帳戶中的藍圖名稱清單。
-
NextToken
– UTF-8 字串。持續符記 (如果並非所有藍圖名稱都已傳回)。
錯誤
InvalidInputException
InternalServiceException
OperationTimeoutException
BatchGetBlueprints 動作 (Python: batch_get_blueprints)
擷取有關藍圖清單的資訊。
請求
-
Names
– 必要:UTF-8 個字串的陣列,不可小於 1 個或超過 25 個字串。藍圖名稱清單。
-
IncludeBlueprint
– 布林值。指定回應是否包含藍圖。
-
IncludeParameterSpec
– 布林值。指定是否要在回應中包含藍圖的參數做為JSON字串。
回應
-
Blueprints
– 一個 藍圖 物件陣列。以
Blueprints
物件傳回藍圖清單。 -
MissingBlueprints
– UTF-8 個字串的陣列。傳回找不到的
BlueprintNames
清單。
錯誤
InternalServiceException
OperationTimeoutException
InvalidInputException
StartBlueprintRun 動作 (Python: start_blueprint_run)
啟動指定工作流程的新執行。
請求
-
BlueprintName
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,需符合 Custom string pattern #31。藍圖的名稱。
-
Parameters
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 131072 個位元組。指定參數為
BlueprintParameters
物件。 -
RoleArn
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 1024 個位元組,需符合 Custom string pattern #30。指定用來建立工作流程IAM的角色。
回應
-
RunId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。此藍圖執行的執行 ID。
錯誤
InvalidInputException
OperationTimeoutException
InternalServiceException
ResourceNumberLimitExceededException
EntityNotFoundException
IllegalBlueprintStateException
GetBlueprintRun 動作 (Python:get_blueprint_run)
擷取藍圖執行的詳細資訊。
請求
-
BlueprintName
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,需符合 Custom string pattern #31。藍圖的名稱。
-
RunId
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。您要擷取的藍圖執行的執行 ID。
回應
-
BlueprintRun
– BlueprintRun 物件。其會傳回
BlueprintRun
物件。
錯誤
EntityNotFoundException
InternalServiceException
OperationTimeoutException
GetBlueprintRuns 動作 (Python:get_blueprint_runs)
擷取指定藍圖的藍圖執行詳細資訊
請求
-
BlueprintName
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。藍圖的名稱。
-
NextToken
– UTF-8 字串。接續符記,如果這是接續要求。
-
MaxResults
– 數字 (整數),不可小於 1,也不可以大於 1000。所要回傳清單的大小上限。
回應
-
BlueprintRuns
– 一個 BlueprintRun 物件陣列。傳回
BlueprintRun
物件的清單。 -
NextToken
– UTF-8 字串。持續符記 (如果並非所有藍圖都已傳回)。
錯誤
EntityNotFoundException
InternalServiceException
OperationTimeoutException
InvalidInputException
StartWorkflowRun 動作 (Python: start_workflow_run)
啟動指定工作流程的新執行。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要啟動的工作流程名稱。
-
RunProperties
– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。
每個值都是 UTF-8 字串。
針對新的工作流程執行的工作流程執行屬性。
可以記錄任務引數。不要將純文字袐密當做引數傳遞。如果您打算將秘密保留在任務中,請從 AWS Glue Connection、 AWS Secrets Manager 或其他秘密管理機制擷取秘密。
回應
-
RunId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合 Single-line string pattern。新執行的 ID。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
ResourceNumberLimitExceededException
ConcurrentRunsExceededException
StopWorkflowRun 動作 (Python: stop_workflow_run)
停止執行指定的工作流程執行。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要停止的工作流程名稱。
-
RunId
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要停止的工作流程執行的 ID。
回應
無回應參數。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
IllegalWorkflowStateException
ResumeWorkflowRun 動作 (Python:Res resume_workflow_run)
重新啟動先前部分完成工作流程執行的所選節點,並繼續執行工作流程。會執行所選節點以及從所選節點下游的所有節點。
請求
-
Name
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要繼續的工作流程名稱。
-
RunId
– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。要繼續的工作流程執行的 ID。
-
NodeIds
– 必要:UTF-8 個字串的陣列。您要重新啟動之節點的IDs節點清單。要重新啟動的節點必須在原始執行中嘗試執行。
回應
-
RunId
– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern。指派給已繼續工作流程執行的新 ID。工作流程執行的每次繼續都會有一個新的執行 ID。
-
NodeIds
– UTF-8 個字串的陣列。實際重新啟動的IDs節點清單。
錯誤
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
ConcurrentRunsExceededException
IllegalWorkflowStateException