DescribeExecution - AWS Transfer Family

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

DescribeExecution

您可以使用 DescribeExecution 來檢查指定工作流程執行的詳細資訊。

注意

此API呼叫只會傳回進行中工作流程的詳細資訊。

如果您為未進行中的執行提供 ID,或者執行不符合指定的工作流程 ID,則會收到ResourceNotFound例外狀況。

請求語法

{ "ExecutionId": "string", "WorkflowId": "string" }

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

請求接受下列JSON格式的資料。

ExecutionId

用於執行工作流程的唯一識別碼。

類型:字串

長度限制條件:固定長度為 36。

模式:[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

必要:是

WorkflowId

工作流程的唯一識別碼。

類型:字串

長度限制條件:固定長度為 19。

模式:w-([a-z0-9]{17})

必要:是

回應語法

{ "Execution": { "ExecutionId": "string", "ExecutionRole": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "LoggingConfiguration": { "LoggingRole": "string", "LogGroupName": "string" }, "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Results": { "OnExceptionSteps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ], "Steps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ] }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" }, "WorkflowId": "string" }

回應元素

如果動作成功,服務會傳回 200 HTTP 個回應。

服務會以 JSON 格式傳回下列資料。

Execution

包含工作流程執行詳細資訊的結構。

類型:DescribedExecution 物件

WorkflowId

工作流程的唯一識別碼。

類型:字串

長度限制條件:固定長度為 19。

模式:w-([a-z0-9]{17})

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InternalServiceError

當 AWS Transfer Family 服務發生錯誤時,就會擲回此例外狀況。

HTTP 狀態碼:500

InvalidRequestException

當用戶端提交格式不正確的請求時,就會擲回此例外狀況。

HTTP 狀態碼:400

ResourceNotFoundException

當 AWS Transfer Family 服務找不到資源時,就會擲回此例外狀況。

HTTP 狀態碼:400

ServiceUnavailableException

請求失敗,因為 AWS Transfer Family 服務無法使用。

HTTP 狀態碼:500

另請參閱

如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: