ListProfiles - AWS Transfer Family

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

ListProfiles

システムのプロファイルのリストを返します。結果を特定の数に制限したい場合は、MaxResults パラメータに値を指定します。以前にコマンドを実行して NextToken の値を受け取った場合は、その値を入力することで、前回の続きからプロファイルをリストアップすることができます。

リクエストの構文

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

リクエストパラメータ

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

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

MaxResults

返されるプロファイルの最大数。

タイプ:整数

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

必須: いいえ

NextToken

返されなかった結果が他にもある場合は、NextTokenパラメーターが返されます。ListProfilesの値を以降の呼び出しに使用して、結果を一覧表示し続けることができます。

型: 文字列

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

必須: いいえ

ProfileType

LOCAL タイププロファイルのみを一覧表示するか、PARTNER タイププロファイルのみを一覧表示するかを示します。リクエストで指定されていない場合、コマンドはすべてのタイプのプロファイルを一覧表示します。

型: 文字列

有効な値:LOCAL | PARTNER

必須:いいえ

レスポンスの構文

{ "NextToken": "string", "Profiles": [ { "Arn": "string", "As2Id": "string", "ProfileId": "string", "ProfileType": "string" } ] }

レスポンス要素

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

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

NextToken

トークンを返すと、ListProfiles このトークンを使用して再度呼び出し、追加の結果があれば、その結果を受け取ることができます。

型: 文字列

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

Profiles

配列を返します。各項目にはプロファイルの詳細が含まれます。

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

エラー

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

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