翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
StartDirectoryListing
リモート SFTP サーバーからディレクトリの内容のリストを取得します。コネクタ ID、出力パス、リモートディレクトリパスを指定します。オプションMaxItemsの値を指定して、リモートディレクトリからリストされる項目の最大数を制御することもできます。この API は、リモートディレクトリ内のすべてのファイルとディレクトリのリスト (最大値まで) を返しますが、サブディレクトリ内のファイルやフォルダは返しません。つまり、ファイルとディレクトリのリストを 1 レベルの深さでのみ返します。
出品ファイルを受け取ったら、StartFileTransferAPI コールの RetrieveFilePathsパラメータに転送するファイルを指定できます。
出力ファイルの命名規則は です connector-ID-listing-ID.json。出力ファイルには、次の情報が含まれています。
-
filePath: リモートサーバー上の SFTP コネクタのリストリクエストのディレクトリを基準とした、リモートファイルの完全なパス。 -
modifiedTimestamp: ファイルが最後に変更された時刻を UTC 時間形式で表します。このフィールドはオプションです。リモートファイル属性にタイムスタンプが含まれていない場合、ファイルリストから除外されます。 -
size: ファイルのサイズ、バイト単位。このフィールドはオプションです。リモートファイル属性にファイルサイズが含まれていない場合は、ファイルリストから省略されます。 -
path: リモートサーバー上の SFTP コネクタのリストリクエストのディレクトリに対するリモートディレクトリの完全なパス。 -
truncated: リスト出力にリモートディレクトリに含まれるすべての項目が含まれているかどうかを示すフラグ。Truncated出力値が true の場合、オプションのmax-items入力属性で指定された値を増やして、より多くの項目を一覧表示できます (最大許容リストサイズは 10,000 項目まで）。
リクエストの構文
{
"ConnectorId": "string",
"MaxItems": number,
"OutputDirectoryPath": "string",
"RemoteDirectoryPath": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- ConnectorId
-
コネクタの一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
パターン：
c-([0-9a-f]{17})必須：はい
- MaxItems
-
取得するファイル/ディレクトリ名の最大数を指定できるオプションのパラメータ。デフォルト値は 1,000 です。
タイプ：整数
値の範囲: 最小値 は 1 です。最大値は 10,000 です。
必須：いいえ
- OutputDirectoryPath
-
ディレクトリリストの結果を保存する Amazon S3 ストレージのパス (バケットとプレフィックス) を指定します。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
Pattern:
(.)+必須：はい
- RemoteDirectoryPath
-
コンテンツを一覧表示するリモート SFTP サーバーのディレクトリを指定します。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
Pattern:
(.)+必須：はい
レスポンスの構文
{
"ListingId": "string",
"OutputFileName": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ListingId
-
ディレクトリリスト呼び出しの一意の識別子を返します。
型: 文字列
長さの制限：最小長は 1 です。最大長は 512 です。
パターン：
[0-9a-zA-Z./-]+ - OutputFileName
-
結果が保存されているファイル名を返します。これは、コネクタ ID とリスト ID の組み合わせです
<connector-id>-<listing-id>.json。型: 文字列
長さ制限: 最小長は 26 です。最大長は 537 です。
パターン：
c-([0-9a-f]{17})-[0-9a-zA-Z./-]+.json
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード：400
例
例
次の例では、指定されたコネクタによって識別されるリモート SFTP サーバー上の homeフォルダの内容を一覧表示します。結果は、Amazon S3 の場所 、/DOC-EXAMPLE-BUCKET/connector-filesおよび という名前のファイルに配置されますc-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json。
リクエスト例
{
"ConnectorId": "c-AAAA1111BBBB2222C",
"MaxItems": "10",
"OutputDirectoryPath": "/DOC-EXAMPLE-BUCKET/connector-files",
"RemoteDirectoryPath": "/home"
}レスポンス例
{
"ListingId": "6666abcd-11aa-22bb-cc33-0000aaaa3333",
"OutputFileName": "c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json"
}// under bucket "DOC-EXAMPLE-BUCKET" connector-files/c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json { "files": [ { "filePath": "/home/what.txt", "modifiedTimestamp": "2024-01-30T20:34:54Z", "size" : 2323 }, { "filePath": "/home/how.pgp", "modifiedTimestamp": "2024-01-30T20:34:54Z", "size" : 51238 } ], "paths": [ { "path": "/home/magic" }, { "path": "/home/aws" }, ], "truncated": false }
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
