Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

start-file-transfer

Описание

Начинает передачу файла между локальным хранилищем Amazon Web Services и удаленным сервером AS2 или SFTP.

  • Для AS2-соединения вы указываете ConnectorId и один или несколько SendFilePaths, чтобы определить файлы, которые вы хотите передать.
  • Для SFTP-соединения передача файла может быть исходящей или входящей. В обоих случаях вы указываете ConnectorId. В зависимости от направления передачи, вы также указываете следующие элементы:
    • Если вы передаёте файл с SFTP-сервера партнера в хранилище Amazon Web Services, вы указываете один или несколько RetrieveFilePaths, чтобы определить файлы, которые вы хотите передать, и LocalDirectoryPath, чтобы указать целевую папку.
    • Если вы передаёте файл на SFTP-сервер партнера из хранилища Amazon Web Services, вы указываете один или несколько SendFilePaths, чтобы определить файлы, которые вы хотите передать, и RemoteDirectoryPath, чтобы указать целевую папку.

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

Синтаксис

  start-file-transfer
--connector-id <value>
[--send-file-paths <value>]
[--retrieve-file-paths <value>]
[--local-directory-path <value>]
[--remote-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 (строка)

Уникальный идентификатор соединения.

--send-file-paths (список)

Один или несколько путей к источникам в хранилище Amazon S3. Каждая строка представляет путь к исходному файлу для одной исходящей передачи файла. Например, `` amzn-s3-demo-bucket /myfile.txt `` .

Примечание

Замените `` amzn-s3-demo-bucket `` на ваш фактический бакет.

(строка)

Синтаксис:

"string" "string" ...

--retrieve-file-paths (список)

Один или несколько путей к источникам на сервере SFTP партнера. Каждая строка представляет собой путь к исходному файлу для одной входящей передачи файла.

(строка)

Синтаксис:

"string" "string" ...

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

Для входящей передачи, LocaDirectoryPath указывает место назначения для одного или нескольких файлов, которые передаются с сервера SFTP партнера.

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

Для исходящей передачи, RemoteDirectoryPath указывает место назначения для одного или нескольких файлов, которые передаются на сервер SFTP партнера. Если вы не указываете RemoteDirectoryPath, место назначения для передаваемых файлов — домашний каталог пользователя SFTP.

--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
  • text
  • таблица
  • 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.

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

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

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

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

Вывод

TransferId -> (строка)

Возвращает уникальный идентификатор передачи файла.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API