ListAgreements - AWS Transfer Family

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

ListAgreements

指定した内容でServerIdによって識別されるサーバーの契約書のリストを返します。結果を特定の数に制限したい場合は、MaxResults パラメータに値を指定します。以前にコマンドを実行してNextTokenの値を受け取った場合は、その値を指定して、中断したところから契約書を一覧表示できます。

リクエストの構文

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

リクエストパラメータ

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

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

MaxResults

返される契約の最大数。

タイプ:整数

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

必須: いいえ

NextToken

ListAgreements からさらに結果を得られる場合、出力で NextToken パラメータが返されます。その後、NextToken パラメータに後続のコマンドを渡すことで、追加のアグリーメントをリストアップし続けることができます。

型: 文字列

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

必須: いいえ

ServerId

契約書のリストを取得したいサーバーの識別子。

型: 文字列

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

Pattern: s-([0-9a-f]{17})

必須:はい

レスポンスの構文

{ "Agreements": [ { "AgreementId": "string", "Arn": "string", "Description": "string", "LocalProfileId": "string", "PartnerProfileId": "string", "ServerId": "string", "Status": "string" } ], "NextToken": "string" }

レスポンス要素

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

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

Agreements

各項目に契約書の詳細を含む配列を返します。

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

NextToken

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

型: 文字列

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

エラー

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

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