Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

describe-agreement

Описание

Описывает соглашение, которое идентифицируется по AgreementId.

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

Синтаксис

  describe-agreement
--agreement-id <value>
--server-id <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 (строка)

Идентификатор сервера, связанный с соглашением.

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

Вывод

Соглашение -> (структура)

Подробная информация о заданном соглашении, возвращаемая в виде объекта DescribedAgreement.

Arn -> (строка)

Уникальное имя Amazon Resource Name (ARN) для соглашения.

AgreementId -> (строка)

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

Описание -> (строка)

Название или краткое описание, используемое для идентификации соглашения.

Статус -> (строка)

Текущий статус соглашения, либо ACTIVE, либо INACTIVE.

ServerId -> (строка)

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

LocalProfileId -> (строка)

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

PartnerProfileId -> (строка)

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

BaseDirectory -> (строка)

Директория назначения (папка) для файлов, передаваемых с использованием протокола AS2.

AccessRole -> (строка)

Коннекторы используются для отправки файлов с использованием протокола 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.

Теги -> (список)

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

(структура)

Создаёт пару ключ-значение для определённого ресурса. Теги — метаданные, которые вы можете использовать для поиска и группирования ресурса в различных целях. Вы можете применять теги к серверам, пользователям и ролям. Ключ тега может принимать более одного значения. Например, для группировки серверов в целях учёта вы можете создать тег, называемый Group, и назначить значения Research и Accounting этой группе.

Ключ -> (строка)

Название, присвоенное тегу, который вы создаёте.

Значение -> (строка)

Содержит одно или несколько значений, которые вы назначили созданному вами имени ключа.

PreserveFilename -> (строка)

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

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

EnforceMessageSigning -> (строка)

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

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

CustomDirectories -> (структура)

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

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

FailedFilesDirectory -> (строка)

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

MdnFilesDirectory -> (строка)

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

PayloadFilesDirectory -> (строка)

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

StatusFilesDirectory -> (строка)

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

TemporaryFilesDirectory -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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