Spec-Zone.ru › AWS CLI v2

[ aws . osis ]

start-pipeline

Описание

Запускает конвейер приема данных OpenSearch. Дополнительную информацию см. в разделе Запуск конвейера приема данных OpenSearch.

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

Синтаксис

  start-pipeline
--pipeline-name <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]

Параметры

--pipeline-name (строка)

Имя конвейера для запуска.

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

Вывод

Конвейер -> (структура)

Информация о существующем конвейере приема данных OpenSearch.

ИмяКонвейера -> (строка)

Имя конвейера.

ArnКонвейера -> (строка)

Amazon Resource Name (ARN) конвейера.

МинимЕдиницы -> (целое число)

Минимальная мощность конвейера в Ingestion Compute Units (ICU).

МаксЕдиницы -> (целое число)

Максимальная мощность конвейера в Ingestion Compute Units (ICU).

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

Текущий статус конвейера.

ПричинаСтатуса -> (структура)

Причина текущего статуса конвейера.

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

Описание причины статуса конвейера.

ТелоКонфигурацииКонвейера -> (строка)

Конфигурация конвейера Data Prepper в формате YAML.

Создан -> (временная метка)

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

ПоследнееОбновление -> (временная метка)

Дата и время последнего обновления конвейера.

UrlsТочекПриема -> (список)

Точки приема для конвейера, куда можно отправлять данные.

(строка)

ПараметрыОпубликованияЖурналов -> (структура)

Параметры публикации журналов.

ВключенаПубликацияЖурналов -> (логическое значение)

Включена ли публикация журналов.

НазначениеЖурналовCloudWatchLogs -> (структура)

Назначение для журналов приема данных OpenSearch, отправляемых в Amazon CloudWatch Logs. Этот параметр требуется, если IsLoggingEnabled установлено в true.

ГруппаЖурналов -> (строка)

Имя группы журналов CloudWatch Logs для отправки журналов конвейера. Можно указать существующую группу журналов или создать новую. Например, /aws/vendedlogs/OpenSearchService/pipelines.

ТочкиVPC -> (список)

Точки интерфейсов VPC, имеющие доступ к конвейеру.

(структура)

Управляемая OpenSearch Ingestion точка VPC-интерфейса, которая будет иметь доступ к одному или нескольким конвейерам.

IdТочкиVPC -> (строка)

Уникальный идентификатор точки.

IdVPC -> (строка)

ID вашей VPC. Amazon Web Services PrivateLink генерирует это значение при создании VPC.

ПараметрыVPC -> (структура)

Информация о VPC, включая связанные подсети и группы безопасности.

ИдентификаторыПодсетей -> (список)

Список идентификаторов подсетей, связанных с точкой VPC.

(строка)

ИдентификаторыГруппБезопасности -> (список)

Список групп безопасности, связанных с точкой VPC.

(строка)

ПараметрыПрисоединенияVPC -> (структура)

Параметры для подключения VPC к конвейеру.

ПрисоединитьКVPC -> (логическое значение)

Подключена ли VPC к конвейеру.

БлокCIDR -> (строка)

Блок CIDR, который должен быть зарезервирован для OpenSearch Ingestion для создания сетевых интерфейсов (ENIs).

УправлениеТочкойVPC -> (строка)

Определяет, создаете ли вы или Amazon OpenSearch Ingestion службу и управляете точкой VPC, настроенной для конвейера.

ПараметрыБуфера -> (структура)

Параметры, которые определяют конфигурацию постоянного буфера. Чтобы настроить то, как OpenSearch Ingestion шифрует эти данные, задайте EncryptionAtRestOptions. Дополнительную информацию см. в разделе Постоянное буферирование.

ВключенПостоянныйБуфер -> (логическое значение)

Включен ли постоянный буфер.

ПараметрыШифрованияВОтдыхе -> (структура)

Параметры для управления тем, как OpenSearch шифрует данные буфера.

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

ARN ключа KMS, используемого для шифрования данных буфера. По умолчанию данные шифруются с помощью ключа Amazon Web Services.

ИмяСервисаТочкиVPC -> (строка)

Имя сервиса VPC-точки конвейера.

СервисыТочекVPC -> (список)

Список VPC-точек, которые OpenSearch Ingestion создал для других сервисов Amazon Web Services.

(структура)

Контейнер с информацией о VPC-точках, которые были созданы для других служб

ИмяСервиса -> (строка)

Имя сервиса, для которого была создана VPC-точка.

IdТочкиVPC -> (строка)

Уникальный идентификатор созданной VPC-точки.

Направления -> (список)

Направления, в которые конвейер записывает данные.

(структура)

Объект, представляющий направление конвейера.

ИмяСервиса -> (строка)

Имя сервиса, получающего данные от конвейера.

Точка -> (строка)

Точка, получающая данные от конвейера.

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

Список тегов, связанных с данным конвейером.

(структура)

Тег (пара ключ-значение) для конвейера OpenSearch Ingestion.

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

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

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

Значение, назначенное соответствующему ключу тега. Значения тегов могут быть null и не обязательно должны быть уникальными в наборе тегов. Например, в наборе тегов может быть пара ключ-значение project : Trinity и cost-center : Trinity

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

Spec-Zone.ru

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