翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListConnectors
指定したリージョンのコネクタを一覧表示します。
リクエストの構文
{
"MaxResults": number
,
"NextToken": "string
"
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- MaxResults
-
返されるコネクターの最大数。
タイプ:整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須: いいえ
- NextToken
-
ListConnectors
からさらに結果を得られる場合、出力でNextToken
パラメータが返されます。その後、NextToken
パラメータに後続のコマンドを渡すことで、さらにコネクターをリストアップし続けることができます。型: 文字列
長さの制限:最小長は 1 です。最大長は 6,144 です。
必須: いいえ
レスポンスの構文
{
"Connectors": [
{
"Arn": "string",
"ConnectorId": "string",
"Url": "string"
}
],
"NextToken": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- Connectors
-
各項目にコネクタの詳細を含む配列を返します。
型: ListedConnector オブジェクトの配列
- NextToken
-
トークンを返すと、
ListConnectors
このトークンを使用して再度呼び出し、追加の結果があれば、その結果を受け取ることができます。型: 文字列
長さの制限:最小長は 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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。