Spec-Zone.ru › AWS CLI v2

[ aws . osis ]

получить-пайплайн

Описание

Получает информацию об инструменте OpenSearch Ingestion пайплайне.

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

Синтаксис

  get-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
  • текст
  • таблица
  • 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.

Вывод

Пайплайн -> (структура)

Подробная информация о запрошенном пайплайне.

PipelineName -> (строка)

Имя пайплайна.

PipelineArn -> (строка)

Amazon Resource Name (ARN) пайплайна.

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

Минимальная емкость пайплайна в единицах вычислительной мощности Ingestion (ICU).

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

Максимальная емкость пайплайна в единицах вычислительной мощности Ingestion (ICU).

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

Текущий статус пайплайна.

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

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

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

Описание причины, по которой пайплайн имеет определенный статус.

PipelineConfigurationBody -> (строка)

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

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

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

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

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

IngestEndpointUrls -> (список)

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

(строка)

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

Ключевые значения, представляющие параметры публикации журналов.

IsLoggingEnabled -> (логическое значение)

Включить или выключить публикацию журналов.

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

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

LogGroup -> (строка)

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

VpcEndpoints -> (список)

Конечные точки интерфейса VPC, имеющие доступ к пайплайну.

(структура)

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

VpcEndpointId -> (строка)

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

VpcId -> (строка)

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

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

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

AttachToVpc -> (логическое значение)

Присоединен ли VPC к пайплайну.

CidrBlock -> (строка)

Блок CIDR, который будет зарезервирован для OpenSearch Ingestion для создания интерфейсов сети elastic (ENI).

VpcEndpointManagement -> (строка)

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

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

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

PersistentBufferEnabled -> (логическое значение)

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

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

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

KmsKeyArn -> (строка)

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

VpcEndpointService -> (строка)

Имя службы VPC endpoint для пайплайна.

ServiceVpcEndpoints -> (список)

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

(структура)

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

ServiceName -> (строка)

Имя службы, для которой была создана конечная точка VPC.

VpcEndpointId -> (строка)

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

Destinations -> (список)

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

(структура)

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

ServiceName -> (строка)

Имя службы, получающей данные от пайплайна.

Endpoint -> (строка)

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

Tags -> (список)

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

(структура)

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

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

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

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

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

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

Spec-Zone.ru

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