создать-соглашение
Описание
Создаёт соглашение. Соглашение — это двустороннее соглашение о торговом партнёрстве или сотрудничестве между сервером семейства Transfer и процессом AS2. Соглашение определяет отношения передачи файлов и сообщений между сервером и процессом AS2. Для определения соглашения семейство Transfer объединяет сервер, локальный профиль, профиль партнёра, сертификат и другие атрибуты.
Партнёр идентифицируется с помощью PartnerProfileId, а процесс AS2 — с помощью LocalProfileId.
Примечание
Укажите либоBaseDirectory, либо CustomDirectories, но не оба. Указание обоих значений приведёт к ошибке команды.См. также: Документация AWS API
Синтаксис
create-agreement
[--description <value>]
--server-id <value>
--local-profile-id <value>
--partner-profile-id <value>
[--base-directory <value>]
--access-role <value>
[--status <value>]
[--tags <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]
Параметры
--description (строка)
--server-id (строка)
--local-profile-id (строка)
--partner-profile-id (строка)
--base-directory (строка)
Директория назначения (папка) для файлов, переданных с использованием протокола AS2.
Пример BaseDirectory — /*amzn-s3-demo-bucket* /home/mydirectory.
--access-role (строка)
Коннекторы используются для отправки файлов с использованием протоколов AS2 или SFTP. Для роли доступа укажите Amazon Resource Name (ARN) роли управления идентификацией и доступом, которую следует использовать.
При использовании 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 для этого ключа.
Убедитесь, что роль доступа предоставляет чтение и запись в родительскую директорию расположения файла, используемого в запросе StartFileTransfer. Кроме того, убедитесь, что роль предоставляет разрешение secretsmanager:GetSecretValue для Secrets Manager.
--status (строка)
Статус соглашения. Соглашение может быть либо ACTIVE, либо INACTIVE.
Возможные значения:
ACTIVEINACTIVE
--tags (список)
Ключевые пары, которые можно использовать для группирования и поиска соглашений.
(структура)
Создаёт пару «ключ-значение» для определённого ресурса. Теги — это метаданные, которые вы можете использовать для поиска и группирования ресурса в различных целях. Вы можете применять теги к серверам, пользователям и ролям. Ключ тега может принимать несколько значений. Например, чтобы сгруппировать серверы для целей бухгалтерского учёта, вы можете создать тег под названием Group и назначить значения Research и Accounting этой группе.
Ключ -> (строка)
Значение -> (строка)
Упрощённый синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--preserve-filename (строка)
Определяет, добавляет ли семейство Transfer уникальную строку символов в конец имени файла полезной нагрузки сообщения AS2 при сохранении.
-
ENABLED: имя файла, предоставленное вашим торговым партнёром, сохраняется при сохранении файла. -
DISABLED(значение по умолчанию): при сохранении файла семейством Transfer имя файла изменяется, как описано в разделах «Имена и расположения файлов» .
Возможные значения:
ENABLEDDISABLED
--enforce-message-signing (строка)
Определяет, будут ли приниматься неподписанные сообщения от ваших торговых партнёров.
-
ENABLED: семейство Transfer отклоняет неподписанные сообщения от вашего торгового партнёра. -
DISABLED(значение по умолчанию): семейство Transfer принимает неподписанные сообщения от вашего торгового партнёра.
Возможные значения:
ENABLEDDISABLED
--custom-directories (структура)
Структура CustomDirectoriesType. Эта структура указывает пользовательские директории для хранения различных файлов сообщений AS2. Вы можете указать директории для следующих типов файлов.
- Файлы ошибок
- Файлы MDN
- Файлы полезной нагрузки
- Файлы состояния
- Временные файлы
FailedFilesDirectory -> (строка)
MdnFilesDirectory -> (строка)
PayloadFilesDirectory -> (строка)
StatusFilesDirectory -> (строка)
TemporaryFilesDirectory -> (строка)
Упрощённый синтаксис:
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
- текст
- таблица
- 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.