put-events
Описание
Отправляет пользовательские события в Amazon EventBridge, чтобы их можно было сопоставить с правилами.
Вы можете объединить несколько записей событий в один запрос для повышения эффективности. Однако общий размер записи должен быть меньше 256 КБ. Вы можете рассчитать размер записи перед отправкой событий. Дополнительную информацию см. в разделе Расчет размера записи события PutEvents в * Руководстве пользователя Amazon EventBridge *.
PutEvents принимает данные в формате JSON. Для данных типа JSON number (целое число) ограничения следующие: минимальное значение — -9 223 372 036 854 775 808, максимальное значение — 9 223 372 036 854 775 807.
Примечание
PutEvents будет обрабатывать вложенные JSON до 1000 уровней вложенности.См. также: Документацию API AWS
Синтаксис
put-events
--entries <value>
[--endpoint-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]
Параметры
--entries (список)
Запись, определяющая событие в вашей системе. Вы можете указать несколько параметров для записи, таких как источник и тип события, ресурсы, связанные с событием, и так далее.
(структура)
Представляет событие, которое нужно отправить.
Время -> (метка времени)
Источник -> (строка)
Источник события.
Примечание
Detail , DetailType и Source обязательны для того, чтобы EventBridge успешно отправил событие в канал событий. Если вы включаете записи событий в запросе, в котором отсутствуют эти свойства, EventBridge не обрабатывает эту запись. Если вы отправляете запрос, в котором ни одна запись не содержит все эти свойства, EventBridge отклоняет весь запрос.Ресурсы -> (список)
Ресурсы Amazon Web Services, идентифицируемые с помощью имени ресурса Amazon (ARN), которые в первую очередь затрагивает событие. Может присутствовать любое количество, включая ноль.
(строка)
DetailType -> (строка)
Свободный текст с максимальной длиной 128 символов, используемый для определения ожидаемых полей в деталях события.
Примечание
Detail , DetailType и Source обязательны для того, чтобы EventBridge успешно отправил событие в канал событий. Если вы включаете записи событий в запросе, в котором отсутствуют эти свойства, EventBridge не обрабатывает эту запись. Если вы отправляете запрос, в котором ни одна запись не содержит все эти свойства, EventBridge отклоняет весь запрос.Detail -> (строка)
Действительный JSON-объект. Других схем нет. JSON-объект может содержать поля и вложенные подобъекты.
Примечание
Detail , DetailType и Source обязательны для того, чтобы EventBridge успешно отправил событие в канал событий. Если вы включаете записи событий в запросе, в котором отсутствуют эти свойства, EventBridge не обрабатывает эту запись. Если вы отправляете запрос, в котором ни одна запись не содержит все эти свойства, EventBridge отклоняет весь запрос.EventBusName -> (строка)
Имя или ARN канала событий для получения события. Только правила, связанные с этим каналом событий, используются для сопоставления события. Если вы это опустите, используется канал событий по умолчанию.
Примечание
Если вы используете глобальный конечный пункт с пользовательским каналом, вы можете ввести здесь имя или имя ресурса Amazon (ARN) канала событий в основной или дополнительной зоне. EventBridge затем определяет соответствующий канал событий в другой зоне на основе конечной точки, на которую ссылаетсяEndpointId . Указание ARN канала событий предпочтительнее.TraceHeader -> (строка)
Заголовок трассировки X-Ray, который представляет собой http-заголовок (X-Amzn-Trace-Id), содержащий идентификатор трассировки, связанный с событием.
Дополнительную информацию о заголовках трассировки X-Ray см. в Руководстве разработчика X-Ray.
Упрощённый синтаксис:
Time=timestamp,Source=string,Resources=string,string,DetailType=string,Detail=string,EventBusName=string,TraceHeader=string ...
Синтаксис JSON:
[
{
"Time": timestamp,
"Source": "string",
"Resources": ["string", ...],
"DetailType": "string",
"Detail": "string",
"EventBusName": "string",
"TraceHeader": "string"
}
...
]
--endpoint-id (строка)
Поддомен URL конечной точки. Например, если URL конечной точки — https://abcde.veo.endpoints.event.amazonaws.com, то EndpointId — abcde.veo .
Предупреждение
При использовании Java необходимо включитьauth-crt в пути к классу.--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.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в *Руководстве пользователя AWS CLI*.
Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. Дополнительную информацию см. в разделе Использование кавычек со строками в *Руководстве пользователя AWS CLI*.
Чтобы отправить пользовательское событие в CloudWatch Events
В этом примере отправляется пользовательское событие в CloudWatch Events. Событие содержится в файле putevents.json:
aws events put-events --entries file://putevents.json
Вот содержимое файла putevents.json:
[
{
"Source": "com.mycompany.myapp",
"Detail": "{ \"key1\": \"value1\", \"key2\": \"value2\" }",
"Resources": [
"resource1",
"resource2"
],
"DetailType": "myDetailType"
},
{
"Source": "com.mycompany.myapp",
"Detail": "{ \"key1\": \"value3\", \"key2\": \"value4\" }",
"Resources": [
"resource1",
"resource2"
],
"DetailType": "myDetailType"
}
]
Вывод
FailedEntryCount -> (целое число)
Entries -> (список)
Результаты успешно и неуспешно обработанных событий. Если обработка была успешной, запись содержит идентификатор события. В противном случае вы можете использовать код ошибки и сообщение об ошибке, чтобы определить проблему с записью.
Для каждой записи индекс элемента ответа совпадает с индексом в массиве запроса.
(структура)
Представляет результаты события, отправленного в шину событий.
Если отправка была успешной, запись содержит идентификатор события. В противном случае вы можете использовать код ошибки и сообщение об ошибке, чтобы определить проблему с записью.
Дополнительную информацию об ошибках, общих для всех действий, см. в разделе Общие ошибки.
EventId -> (строка)
ErrorCode -> (строка)
Код ошибки, указывающий причину неудачи отправки события.
Перезапустимые ошибки включают:
- ``InternalFailure `` Обработка запроса завершилась неудачей из-за неизвестной ошибки, исключения или сбоя.
- ``ThrottlingException `` Запрос был отклонен из-за ограничения запросов.
Неперезапустимые ошибки включают:
- ``AccessDeniedException `` У вас недостаточно прав для выполнения этого действия.
-
InvalidAccountIdExceptionПредоставленный идентификатор учетной записи недействителен. -
InvalidArgumentУказанный параметр недействителен. -
MalformedDetailПредоставленный JSON недействителен. -
RedactionFailureОтмена события CloudTrail завершилась неудачей. -
NotAuthorizedForSourceExceptionУ вас нет разрешений на публикацию событий с этим источником в эту шину событий. -
NotAuthorizedForDetailTypeExceptionУ вас нет разрешений на публикацию событий с этим типом детализации в эту шину событий.
ErrorMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.