翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListServers
AWS アカウントに関連付けられているファイル転送プロトコル対応サーバーを一覧表示します。
リクエストの構文
{
"MaxResults": number,
"NextToken": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- MaxResults
-
ListServersクエリへのレスポンスとして返すサーバーの数を指定します。型: 整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須: いいえ
- NextToken
-
ListServersコマンドから付加的な結果を取得する際には、出力でNextTokenパラメータが返されます。以降のコマンドでNextTokenパラメータを渡すことで、追加のサーバーを引き続き一覧表示できます。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
必須: いいえ
レスポンスの構文
{
"NextToken": "string",
"Servers": [
{
"Arn": "string",
"Domain": "string",
"EndpointType": "string",
"IdentityProviderType": "string",
"LoggingRole": "string",
"ServerId": "string",
"State": "string",
"UserCount": number
}
]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- NextToken
-
ListServersオペレーションから付加的な結果を得られる場合、出力でNextTokenパラメータが返されます。次のコマンドでは、NextTokenパラメータを渡すことで追加のサーバーを引き続き一覧表示できます。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
- Servers
-
一覧表示されたサーバーの配列。
型: ListedServer オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidNextTokenException
-
渡された
NextTokenパラメータが無効です。HTTP ステータスコード：400
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
例
例
次の例では、 に存在するサーバーを一覧表示します AWS アカウント。
例の NextToken 値は実際のものではないことに注意してください。これらはパラメータの使用方法を示すためのものです。
リクエスト例
{
"MaxResults": 1,
"NextToken": "token-from-previous-API-call"
}レスポンス例
{
"NextToken": "another-token-to-continue-listing",
"Servers": [
{
"Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef",
"Domain": "S3",
"IdentityProviderType": "SERVICE_MANAGED",
"EndpointType": "PUBLIC",
"LoggingRole": "arn:aws:iam::111112222222:role/my-role",
"ServerId": "s-01234567890abcdef",
"State": "ONLINE",
"UserCount": 3
}
]
}その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
