start-directory-listing

Описание

Получает список содержимого каталога с удаленного сервера SFTP. Вы указываете идентификатор подключения, путь к выходному файлу и путь к удалённому каталогу. Вы также можете указать необязательное значение MaxItems для управления максимальным количеством элементов, которые выводятся из удаленного каталога. Этот API возвращает список всех файлов и каталогов в удалённом каталоге (до максимального значения), но не возвращает файлы или папки в подкаталогах. То есть он возвращает только список файлов и каталогов на одном уровне вложенности.

После получения файла со списком вы можете указать файлы, которые хотите передать, в параметр RetrieveFilePaths вызова API StartFileTransfer.

Имена выходных файлов имеют вид `` идентификатор-подключения -идентификатор-списка .json`` . Выходной файл содержит следующую информацию:

• filePath : полный путь удалённого файла, относительно каталога запроса списка для вашего подключения SFTP на удалённом сервере.
• modifiedTimestamp : время последнего изменения файла в формате UTC. Этот параметр необязателен. Если атрибуты удалённого файла не содержат отметки времени, он пропускается в списке файлов.
• size : размер файла в байтах. Этот параметр необязателен. Если атрибуты удалённого файла не содержат размер файла, он пропускается в списке файлов.
• path : полный путь удалённого каталога, относительно каталога запроса списка для вашего подключения SFTP на удалённом сервере.
• truncated : флаг, показывающий, содержит ли выходной список все элементы, содержащиеся в удалённом каталоге или нет. Если значение вашего параметра Truncated равно true, вы можете увеличить значение, указанное в необязательном входном атрибуте max-items, чтобы получить возможность вывода большего количества элементов (до максимального размера списка в 10 000 элементов).

См. также: Документация AWS API

Синтаксис

  start-directory-listing
--connector-id <value>
--remote-directory-path <value>
[--max-items <value>]
--output-directory-path <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--connector-id (строка)

--remote-directory-path (строка)

--max-items (целое число)

--output-directory-path (строка)

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON, так как строка будет интерпретироваться буквально. Это значение не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение по умолчанию или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выводится пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию для команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого подключения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

• json
• текст
• таблица
• yaml
• yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из вашего файла с данными учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

• включено
• выключено
• авто

--no-sign-request (логическое значение)

Не подписывать запросы. Данные учетных данных не будут загружаться, если этот аргумент указан.

--ca-bundle (строка)

Файл с сертификатами CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставляемого с двоичным блоком, fileb:// всегда будет рассматриваться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-паджинатор для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров ввода CLI.

Вывод

ListingId -> (строка)

OutputFileName -> (строка)