ListExecutions - AWS Transfer Family
請求語法請求參數回應語法回應元素錯誤另請參閱

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

ListExecutions

列出指定工作流程的所有進行中執行。

注意

如果找不到指定的工作流程 ID，則會ListExecutions傳回ResourceNotFound例外狀況。

請求語法

{
   "MaxResults": number,
   "NextToken": "string",
   "WorkflowId": "string"
}

請求參數

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

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

MaxResults

指定要傳回的最大執行次數。

類型：整數

有效範圍：最小值為 1。最大值為 1000。

必要：否

NextToken

ListExecutions返回輸出中的NextToken參數。然後，您可以在後續命令中傳遞NextToken參數，以繼續列出其他執行項目。

例如，這對於分頁很有用。如果您有 100 個工作流程的執行，您可能只想列出前 10 個。如果是這樣，請指定以下內容來呼叫 APImax-results：

aws transfer list-executions --max-results 10

這將返回前 10 個執行的詳細信息，以及指向第 11 個執行的指針（NextToken）。您現在可以再次呼叫 API，提供您收到的NextToken值：

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

此呼叫會傳回接下來的 10 個執行，即第 11 至 20 次。然後，您可以重複呼叫，直到傳回所有 100 個執行的詳細資料為止。

類型：字串

長度限制：長度下限為 1。長度上限為 6144。

必要：否

WorkflowId

工作流程的唯一識別碼。

類型：字串

長度約束：固定長度為 19。

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

必要：是

回應語法

{
   "Executions": [ 
      { 
         "ExecutionId": "string",
         "InitialFileLocation": { 
            "EfsFileLocation": { 
               "FileSystemId": "string",
               "Path": "string"
            },
            "S3FileLocation": { 
               "Bucket": "string",
               "Etag": "string",
               "Key": "string",
               "VersionId": "string"
            }
         },
         "ServiceMetadata": { 
            "UserDetails": { 
               "ServerId": "string",
               "SessionId": "string",
               "UserName": "string"
            }
         },
         "Status": "string"
      }
   ],
   "NextToken": "string",
   "WorkflowId": "string"
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

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

Executions

返回每個執行的詳細信息，在一個ListedExecution數組。

類型：ListedExecution 物件陣列

NextToken

ListExecutions返回輸出中的NextToken參數。然後，您可以在後續命令中傳遞NextToken參數，以繼續列出其他執行項目。

類型：字串

長度限制：長度下限為 1。長度上限為 6144。

WorkflowId

工作流程的唯一識別碼。

類型：字串

長度約束：固定長度為 19。

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

錯誤

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

InternalServiceError

當在 AWS Transfer Family 服務中發生錯誤時，拋出此異常。

HTTP 狀態碼：500

InvalidNextTokenException

傳遞的NextToken參數無效。

HTTP 狀態碼：400

InvalidRequestException

當客戶端提交格式錯誤的請求時，拋出此異常。

HTTP 狀態碼：400

ResourceNotFoundException

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

HTTP 狀態碼：400

ServiceUnavailableException

申請失敗，因為 AWS Transfer Family 服務不可用。

HTTP 狀態碼：500

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：