Spec-Zone.ru › AWS CLI v2

[ aws . cloudsearch ]

describe-domains

Описание

Получает информацию о поисковых доменах, принадлежащих этому аккаунту. Можно ограничить вывод определёнными доменами. По умолчанию отображаются все домены. Чтобы получить количество индексируемых документов в домене, воспользуйтесь консолью или отправьте запрос matchall на конечную точку поиска вашего домена: q=matchall&q.parser=structured&size=0 . Дополнительную информацию см. в руководстве разработчика Amazon CloudSearch Получение информации о поисковом домене.

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

Синтаксис

  describe-domains
[--domain-names <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]

Параметры

--domain-names (список)

Имена доменов, которые необходимо включить в ответ.

(строка)

Строка, представляющая имя домена. Имена доменов уникальны для доменов, принадлежащих одному аккаунту в одном регионе AWS. Имена доменов начинаются с буквы или цифры и могут содержать следующие символы: a-z (строчные), 0-9 и - (тире).

Синтаксис:

"string" "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

DomainStatusList -> (список)

Список, содержащий состояние каждого запрошенного домена.

(структура)

Текущее состояние поискового домена.

DomainId -> (строка)

Внутренне сгенерированный уникальный идентификатор домена.

DomainName -> (строка)

Строка, представляющая имя домена. Имена доменов уникальны для доменов, принадлежащих одному аккаунту в одном регионе AWS. Имена доменов начинаются с буквы или цифры и могут содержать следующие символы: a-z (строчные), 0-9 и - (тире).

ARN -> (строка)

Amazon Resource Name (ARN) поискового домена. Дополнительную информацию см. в разделе «Идентификаторы сущностей IAM» в руководстве Использование AWS Identity and Access Management.

Created -> (булево)

True, если поисковый домен создан. Создание домена после вызова CreateDomain может занять несколько минут. Созданные поисковые домены возвращаются DescribeDomains со значением false для Created до тех пор, пока создание домена не будет завершено.

Deleted -> (булево)

True, если поисковый домен был удалён. После вызова DeleteDomain система должна очистить ресурсы, выделенные для поискового домена. Недавно удалённые поисковые домены возвращаются DescribeDomains со значением true для IsDeleted в течение нескольких минут, пока завершается очистка ресурсов.

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

Конечная точка сервиса для обновления документов в поисковом домене.

Endpoint -> (строка)

Конечная точка, на которую можно отправить запросы к сервису. Например, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com или doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

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

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

Endpoint -> (строка)

Конечная точка, на которую можно отправить запросы к сервису. Например, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com или doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

RequiresIndexDocuments -> (булево)

True, если необходимо вызвать IndexDocuments для активации текущей конфигурации домена.

Processing -> (булево)

True, если выполняется обработка для активации текущей конфигурации домена.

SearchInstanceType -> (строка)

Тип экземпляра, используемого для обработки запросов поиска.

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

Количество разделов, по которым распределён поисковый индекс.

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

Количество экземпляров поиска, доступных для обработки запросов поиска.

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

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

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

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

Spec-Zone.ru

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