ListExecutions - AWS Transfer Family

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListExecutions

指定されたワークフローについて、進行中のすべての実行を一覧表示します。

注記

指定されたワークフロー ID が見つからない場合、ListExecutionsResourceNotFound 例外を返します。

リクエストの構文

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

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

MaxResults

返される最大実行回数を指定します。

タイプ:整数

有効範囲: 最小値 は 1 です。最大値は 1000 です。

必須: いいえ

NextToken

ListExecutions は出力で NextToken を返します。以降のコマンドで NextToken パラメータを渡すことで、追加の実行を引き続き一覧表示できます。

これはページ処理などに役立ちます。1 つのワークフローを 100 回実行する場合、最初の 10 回のみを一覧表示することをお勧めします。もしそうなら、max-results を指定して API を呼び出す:

aws transfer list-executions --max-results 10

これは最初の 10 回の実行の詳細ならびに 11 回目を指すポインタ (NextToken) を返します。これで、受け取った NextToken 値を指定して、再度APIを呼び出すことができる:

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

この呼び出しは、次の 10 回の実行、11 回目~ 20 回目の実行を返します。次いで、100 回すべての実行の詳細が返るまでこの呼び出しを繰り返すことができます。

型: 文字列

長さの制限:最小長は 1 です。最大長は 6,144 です。

必須: いいえ

WorkflowId

ワークフローの一意の識別子。

型: 文字列

長さの制限: 固定長は 19 です。

Pattern: 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 です。最大長は 6,144 です。

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 を使用する方法の詳細については、以下を参照してください。