Spec-Zone.ru › AWS CLI v2

[ aws . events ]

put-partner-events

Описание

Используется партнерами SaaS для записи событий в партнёрский канал событий клиента. Клиенты Amazon Web Services не используют эту операцию.

Сведения о расчёте размера пакета событий см. в разделе «Расчет размера записи события EventBridge PutEvents» в Руководстве пользователя EventBridge.

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

Синтаксис

  put-partner-events
--entries <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]

Параметры

--entries (список)

Список событий для записи в канал событий.

(структура)

Подробности о событии, сгенерированном партнёром SaaS.

Время -> (метка времени)

Дата и время события.

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

Источник события, генерирующий запись.

Примечание

Detail , DetailType , и Source необходимы для успешной отправки события EventBridge в канал событий. Если в запросе есть записи событий, в которых отсутствуют эти свойства, EventBridge отклонит эту запись. Если вы отправите запрос, в котором ни одна запись не содержит этих свойств, EventBridge отклонит весь запрос.

Ресурсы -> (список)

Ресурсы Amazon Web Services, идентифицированные с помощью Amazon Resource Name (ARN), которые в основном касаются события. Может быть любое количество, включая ноль.

(строка)

Тип детали -> (строка)

Свободная строка с максимальной длиной 128 символов, используемая для определения ожидаемых полей в детали события.

Примечание

Detail , DetailType , и Source необходимы для успешной отправки события EventBridge в канал событий. Если в запросе есть записи событий, в которых отсутствуют эти свойства, EventBridge отклонит эту запись. Если вы отправите запрос, в котором ни одна запись не содержит этих свойств, EventBridge отклонит весь запрос.

Детали -> (строка)

Действительная строка JSON. Других схем нет. Строка JSON может содержать поля и вложенные подобъекты.

Примечание

Detail , DetailType , и Source необходимы для успешной отправки события EventBridge в канал событий. Если в запросе есть записи событий, в которых отсутствуют эти свойства, EventBridge отклонит эту запись. Если вы отправите запрос, в котором ни одна запись не содержит этих свойств, EventBridge отклонит весь запрос.

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

Time=timestamp,Source=string,Resources=string,string,DetailType=string,Detail=string ...

Синтаксис JSON:

[
  {
    "Time": timestamp,
    "Source": "string",
    "Resources": ["string", ...],
    "DetailType": "string",
    "Detail": "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.

Вывод

FailedEntryCount -> (целое число)

Количество событий из этой операции, которые не удалось записать в партнёрский канал событий.

Entries -> (список)

Результаты для каждой записи события, отправленного партнёром в этом запросе. Если событие было успешно отправлено, в записи есть идентификатор события. В противном случае можно использовать код ошибки и сообщение об ошибке для определения проблемы с записью.

Для каждой записи индекс элемента ответа совпадает с индексом в массиве запроса.

(структура)

Результат записи события, отправленного партнёром в этом запросе. Если событие было успешно отправлено, в записи есть идентификатор события. В противном случае можно использовать код ошибки и сообщение об ошибке для определения проблемы с записью.

EventId -> (строка)

Идентификатор события.

ErrorCode -> (строка)

Код ошибки, указывающий причину неудачи отправки события.

ErrorMessage -> (строка)

Сообщение об ошибке, объясняющее причину неудачи отправки события.

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

Spec-Zone.ru

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