ListWorkflows - AWS Transfer Family

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

ListWorkflows

現在のリージョンの AWS アカウント に関連するすべてのワークフローを一覧表示します。

リクエストの構文

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

リクエストパラメータ

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

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

MaxResults

返されるワークフローの最大数を指定します。

型: 整数

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

必須: いいえ

NextToken

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

型: 文字列

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

必須: いいえ

レスポンスの構文

{ "NextToken": "string", "Workflows": [ { "Arn": "string", "Description": "string", "WorkflowId": "string" } ] }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

NextToken

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

型: 文字列

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

Workflows

各ワークフローについて ArnWorkflowId、およびDescription を返します。

型: ListedWorkflow オブジェクトの配列

エラー

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

InternalServiceError

この例外は、AWS Transfer Family サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード:500

InvalidNextTokenException

渡された NextToken パラメータが無効です。

HTTP ステータスコード:400

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード:400

ServiceUnavailableException

AWS Transfer Family サービスを利用できないためリクエストは失敗しました。

HTTP ステータスコード:500

その他の参照資料

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。