Spec-Zone.ru › AWS CLI v2

[ aws . osis ]

stop-pipeline

Описание

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

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

Синтаксис

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

Вывод

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

Информация об существующем конвейере загрузки OpenSearch.

PipelineName -> (строка)

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

PipelineArn -> (строка)

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

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

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

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

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

Status -> (строка)

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

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

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

Description -> (строка)

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

PipelineConfigurationBody -> (строка)

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

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

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

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

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

IngestEndpointUrls -> (список)

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

(строка)

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

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

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

Должны ли публиковаться журналы.

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

Назначение для журналов загрузки OpenSearch, отправляемых в 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-сервисной конечной точки для конвейера.

ServiceVpcEndpoints -> (список)

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

(структура)

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

ServiceName -> (строка)

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

VpcEndpointId -> (строка)

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

Destinations -> (список)

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

(структура)

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

ServiceName -> (строка)

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

Endpoint -> (строка)

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

Tags -> (список)

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

(структура)

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

Key -> (строка)

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

Value -> (строка)

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

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

Spec-Zone.ru

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