Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

get-integration

Описание

Возвращает информацию об одной интеграции между CloudWatch Logs и OpenSearch Service.

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

Синтаксис

  get-integration
--integration-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]

Параметры

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

Имя интеграции, о которой требуется получить информацию. Чтобы найти имя вашей интеграции, используйте ListIntegrations

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, 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.

Вывод

integrationName -> (строка)

Название интеграции.

integrationType -> (строка)

Тип интеграции. Интеграции с OpenSearch Service имеют тип OPENSEARCH.

integrationStatus -> (строка)

Текущий статус этой интеграции.

integrationDetails -> (структура помеченного объединения)

Структура, содержащая информацию о конфигурации интеграции. Для интеграции с OpenSearch Service это включает информацию о ресурсах OpenSearch Service, таких как коллекция, рабочее пространство и политики.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: openSearchIntegrationDetails.

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

Эта структура содержит полную информацию об одной интеграции между CloudWatch Logs и OpenSearch Service.

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

Эта структура содержит информацию о источнике данных OpenSearch Service, используемом для этой интеграции. Этот источник данных был создан в ходе настройки интеграции. Источник данных OpenSearch Service определяет источник и место назначения для запросов OpenSearch Service. Он включает роль, необходимую для выполнения запросов и записи в коллекции.

Дополнительную информацию о источниках данных OpenSearch Service см. в разделе Создание интеграций источников данных OpenSearch Service с Amazon S3.

dataSourceName -> (строка)

Имя источника данных OpenSearch Service.

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

Эта структура содержит информацию о статусе этого ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

Эта структура содержит информацию об приложении OpenSearch Service, используемом для этой интеграции. Приложение OpenSearch Service — это веб-приложение, которое было создано интеграцией с CloudWatch Logs. Оно предоставляет панели мониторинга журналов.

applicationEndpoint -> (строка)

Адрес приложения.

applicationArn -> (строка)

Amazon Resource Name (ARN) приложения.

applicationId -> (строка)

Идентификатор приложения.

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

Эта структура содержит информацию о статусе этого ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

Эта структура содержит информацию о коллекции OpenSearch Service, используемой для этой интеграции. Эта коллекция была создана в ходе настройки интеграции. Коллекция OpenSearch Service — это логическая группа одного или нескольких индексов, которые представляют рабочую нагрузку аналитики. Дополнительную информацию см. в разделе Создание и управление серверными коллекциями OpenSearch Service.

collectionEndpoint -> (строка)

Адрес коллекции.

collectionArn -> (строка)

ARN коллекции.

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

Эта структура содержит информацию о статусе этого ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

Эта структура содержит информацию о рабочем пространстве OpenSearch Service, используемом для этой интеграции. Рабочее пространство OpenSearch Service — это набор панелей мониторинга вместе с другими инструментами OpenSearch Service. Это рабочее пространство было создано автоматически в ходе настройки интеграции. Дополнительную информацию см. в разделе Централизованный пользовательский интерфейс OpenSearch (панели мониторинга) с OpenSearch Service.

workspaceId -> (строка)

Идентификатор этого рабочего пространства.

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

Эта структура содержит информацию о статусе ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

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

policyName -> (строка)

Имя политики шифрования.

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

Эта структура содержит информацию о статусе этого ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

Эта структура содержит информацию о политике сети OpenSearch Service, используемой для этой интеграции. Политика сети назначает параметры доступа к сети для коллекций. Дополнительную информацию см. в разделе Политики сети в Руководстве разработчика OpenSearch Service.

policyName -> (строка)

Имя политики сети.

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

Эта структура содержит информацию о статусе этого ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

Эта структура содержит информацию о политике доступа к данным OpenSearch Service, используемой для этой интеграции. Политика доступа определяет элементы управления доступом к коллекции. Эта политика доступа к данным была автоматически создана в ходе настройки интеграции. Дополнительную информацию о политиках доступа к данным OpenSearch Service см. в разделе Управление доступом к данным для Amazon OpenSearch Serverless в Руководстве разработчика OpenSearch Service.

policyName -> (строка)

Имя политики доступа к данным.

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

Эта структура содержит информацию о статусе этого ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

Эта структура содержит информацию о политике жизненного цикла данных OpenSearch Service, используемой для этой интеграции. Политика жизненного цикла определяет продолжительность данных в коллекции. Она была автоматически создана при настройке интеграции.

Дополнительную информацию см. в разделе Использование политик жизненного цикла данных с OpenSearch Service Serverless в Руководстве разработчика OpenSearch Service.

policyName -> (строка)

Имя политики жизненного цикла.

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

Эта структура содержит информацию о статусе этого ресурса OpenSearch Service.

status -> (строка)

Текущий статус этого ресурса.

statusMessage -> (строка)

Сообщение с дополнительной информацией о статусе этого ресурса.

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

Spec-Zone.ru

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