Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

put-event-stream

Описание

Создаёт новый поток событий для приложения или обновляет настройки существующего потока событий для приложения.

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

Синтаксис

  put-event-stream
--application-id <value>
--write-event-stream <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]

Параметры

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

Уникальный идентификатор приложения. Этот идентификатор отображается как Идентификатор проекта в консоли Amazon Pinpoint.

--write-event-stream (структура)

Указывает Amazon Resource Name (ARN) потока событий для публикации событий и роль AWS Identity and Access Management (IAM) для использования при публикации этих событий.

DestinationStreamArn -> (строка)

Amazon Resource Name (ARN) потока данных Amazon Kinesis или потока доставки Amazon Kinesis Data Firehose, в который вы хотите опубликовать данные событий.

Для потока данных Kinesis формат ARN: arn:aws:kinesis:region:account-id:stream/stream_name

Для потока доставки Kinesis Data Firehose формат ARN: arn:aws:firehose:region:account-id:deliverystream/stream_name

RoleArn -> (строка)

Роль AWS Identity and Access Management (IAM), которая предоставляет Amazon Pinpoint разрешение на публикацию данных событий в поток в вашей учётной записи AWS.

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

DestinationStreamArn=string,RoleArn=string

Синтаксис JSON:

{
  "DestinationStreamArn": "string",
  "RoleArn": "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.

Вывод

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

Указывает настройки публикации данных событий в поток данных Amazon Kinesis или поток доставки Amazon Kinesis Data Firehose.

ApplicationId -> (строка)

Уникальный идентификатор приложения, для которого публикуются данные событий.

DestinationStreamArn -> (строка)

Amazon Resource Name (ARN) потока данных Amazon Kinesis или потока доставки Amazon Kinesis Data Firehose, в который публикуются данные событий.

Для потока данных Kinesis формат ARN: arn:aws:kinesis:region:account-id:stream/stream_name

Для потока доставки Kinesis Data Firehose формат ARN: arn:aws:firehose:region:account-id:deliverystream/stream_name

ExternalId -> (строка)

(Устарело) Ваш идентификатор учётной записи AWS, который вы назначили ключу внешнего идентификатора в политике доверия IAM. Amazon Pinpoint ранее использовал это значение для принятия роли IAM при публикации данных событий, но мы убрали эту необходимость. Мы не рекомендуем использовать внешние идентификаторы для ролей IAM, принимаемых Amazon Pinpoint.

LastModifiedDate -> (строка)

Дата в формате ISO 8601, когда поток событий был в последний раз изменён.

LastUpdatedBy -> (строка)

Пользователь IAM, который в последний раз изменил поток событий.

RoleArn -> (строка)

Роль AWS Identity and Access Management (IAM), которая предоставляет Amazon Pinpoint разрешение на публикацию данных событий в поток в вашей учётной записи AWS.

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

Spec-Zone.ru

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