Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

обновить-соглашение

Описание

Обновляет некоторые параметры существующего соглашения. Укажите AgreementId и ServerId для соглашения, которое вы хотите обновить, а также новые значения параметров для обновления.

Примечание

Укажите либо BaseDirectory, либо CustomDirectories, но не оба. Указание обоих приведет к ошибке команды.

Если вы обновляете соглашение с использованием базового каталога на пользовательские каталоги, базовый каталог больше не используется. Аналогично, если вы меняете пользовательские каталоги на базовый каталог, пользовательские каталоги больше не используются.

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

Синтаксис

  update-agreement
--agreement-id <value>
--server-id <value>
[--description <value>]
[--status <value>]
[--local-profile-id <value>]
[--partner-profile-id <value>]
[--base-directory <value>]
[--access-role <value>]
[--preserve-filename <value>]
[--enforce-message-signing <value>]
[--custom-directories <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]

Параметры

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

Уникальный идентификатор соглашения. Этот идентификатор возвращается при создании соглашения.

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

Уникальный системный идентификатор экземпляра сервера. Это конкретный сервер, используемый соглашением.

--description (строка)

Для замены существующего описания предоставьте краткое описание соглашения.

--status (строка)

Вы можете обновить статус соглашения, активировав неактивное соглашение или наоборот.

Возможные значения:

  • ACTIVE
  • INACTIVE

--local-profile-id (строка)

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

Для изменения идентификатора локального профиля укажите новое значение здесь.

--partner-profile-id (строка)

Уникальный идентификатор профиля партнёра. Для изменения идентификатора профиля партнёра укажите новое значение здесь.

--base-directory (строка)

Для изменения каталога назначения (папки) для передаваемых файлов укажите папку ведра, которую вы хотите использовать; например, ``/amzn-s3-demo-bucket /home /mydirectory `` .

--access-role (строка)

Коннекторы используются для отправки файлов с использованием протоколов AS2 или SFTP. Для роли доступа укажите Amazon Resource Name (ARN) роли управления доступом и идентификацией, которую необходимо использовать.

Для коннекторов AS2

С AS2 вы можете отправлять файлы, вызывая StartFileTransfer и указывая пути к файлам в параметре запроса SendFilePaths. Мы используем родительский каталог файла (например, для --send-file-paths /bucket/dir/file.txt, родительским каталогом является /bucket/dir/) для временного хранения обработанного файла сообщения AS2, сохранения MDN при их получении от партнера и записи конечного JSON-файла, содержащего соответствующие метаданные передачи. Поэтому, AccessRole должен предоставлять доступ для чтения и записи в родительский каталог местоположения файла, используемого в запросе StartFileTransfer. Кроме того, необходимо предоставить доступ для чтения и записи в родительский каталог файлов, которые вы намерены отправлять с помощью StartFileTransfer.

Если вы используете базовый аутентификацию для своего коннектора AS2, роли доступа требуется разрешение secretsmanager:GetSecretValue для секрета. Если секрет зашифрован с помощью управляемого клиентом ключа вместо управляемого Amazon Web Services ключа в Secrets Manager, то роли также требуется разрешение kms:Decrypt для этого ключа.

Для коннекторов SFTP

Убедитесь, что роль доступа предоставляет доступ для чтения и записи в родительский каталог расположения файла, используемого в запросе StartFileTransfer. Кроме того, убедитесь, что роль предоставляет разрешение secretsmanager:GetSecretValue для Secrets Manager.

--preserve-filename (строка)

Определяет, добавляет ли Transfer Family уникальную строку символов в конец имени файла полезной нагрузки сообщения AS2 при его сохранении.

  • ENABLED: имя файла, предоставленное вашим торговым партнёром, сохраняется при сохранении файла.
  • DISABLED (значение по умолчанию): при сохранении файла Transfer Family корректирует имя файла, как описано в Имена и расположения файлов.

Возможные значения:

  • ENABLED
  • DISABLED

--enforce-message-signing (строка)

Определяет, будут ли приниматься неподписанные сообщения от ваших торговых партнёров.

  • ENABLED: Transfer Family отклоняет неподписанные сообщения от вашего торгового партнёра.
  • DISABLED (значение по умолчанию): Transfer Family принимает неподписанные сообщения от вашего торгового партнёра.

Возможные значения:

  • ENABLED
  • DISABLED

--custom-directories (структура)

Структура CustomDirectoriesType. Эта структура определяет пользовательские каталоги для хранения различных файлов сообщений AS2. Вы можете указать каталоги для следующих типов файлов.

  • Файлы с ошибками
  • Файлы MDN
  • Файлы полезной нагрузки
  • Файлы состояния
  • Временные файлы

FailedFilesDirectory -> (строка)

Указывает расположение для хранения файлов сообщений AS2 с ошибками.

MdnFilesDirectory -> (строка)

Указывает расположение для хранения файлов MDN.

PayloadFilesDirectory -> (строка)

Указывает расположение для хранения полезной нагрузки файлов сообщений AS2.

StatusFilesDirectory -> (строка)

Указывает расположение для хранения сообщений состояния AS2.

TemporaryFilesDirectory -> (строка)

Указывает расположение для хранения временных файлов сообщений AS2.

Сокращённый синтаксис:

FailedFilesDirectory=string,MdnFilesDirectory=string,PayloadFilesDirectory=string,StatusFilesDirectory=string,TemporaryFilesDirectory=string

Синтаксис JSON:

{
  "FailedFilesDirectory": "string",
  "MdnFilesDirectory": "string",
  "PayloadFilesDirectory": "string",
  "StatusFilesDirectory": "string",
  "TemporaryFilesDirectory": "string"
}

--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.

Вывод

AgreementId -> (строка)

Уникальный идентификатор соглашения. Этот идентификатор возвращается при создании соглашения.

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

Spec-Zone.ru

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