Spec-Zone.ru › AWS CLI v2

[ aws . discovery ]

list-configurations

Описание

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

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

list-configurations — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, передав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: configurations

Синтаксис

  list-configurations
--configuration-type <value>
[--filters <value>]
[--order-by <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--configuration-type (строка)

Действительная конфигурация, идентифицированная службой Application Discovery Service.

Возможные значения:

  • SERVER
  • PROCESS
  • CONNECTION
  • APPLICATION

--filters (список)

Вы можете фильтровать запрос, используя различные логические операторы и формат «ключ-значение». Например:

{"key": "serverType", "value": "webServer"}

Полный список параметров фильтрации и рекомендации по их использованию с этим действием см. в руководстве пользователя Amazon Web Services Application Discovery Service, раздел «Использование действия ListConfigurations».

(структура)

Фильтр, который может использовать условные операторы.

Подробнее о фильтрах см. в руководстве пользователя Amazon Web Services Application Discovery Service, раздел «Запрос элементов конфигурации, обнаруженных».

name -> (строка)

Имя фильтра.

values -> (список)

Строковое значение для фильтрации. Например, если вы выбрали фильтр destinationServer.osVersion, вы можете указать значение Ubuntu.

(строка)

condition -> (строка)

Условный оператор. Допустимые операторы: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. Если вы задаете несколько фильтров, система использует все фильтры как если бы они были объединены оператором И. Если вы задаете несколько значений для конкретного фильтра, система различает значения с помощью оператора ИЛИ. Вызов либо DescribeConfigurations, либо ListConfigurations возвращает атрибуты соответствующих элементов конфигурации.

Сокращенный синтаксис:

name=string,values=string,string,condition=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "values": ["string", ...],
    "condition": "string"
  }
  ...
]

--order-by (список)

Некоторые критерии фильтрации возвращают вывод, который можно отсортировать в порядке возрастания или убывания. Список характеристик вывода для каждого фильтра см. в руководстве пользователя Amazon Web Services Application Discovery Service, раздел «Использование действия ListConfigurations».

(структура)

Поле и направление для упорядоченного вывода.

fieldName -> (строка)

Поле для сортировки.

sortOrder -> (строка)

Направление сортировки.

Сокращенный синтаксис:

fieldName=string,sortOrder=string ...

Синтаксис JSON:

[
  {
    "fieldName": "string",
    "sortOrder": "ASC"|"DESC"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределяют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное в JSON значение, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной выборки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в руководстве пользователя AWS Command Line Interface, раздел «Постраничность».

--page-size (целое число)

Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в руководстве пользователя AWS Command Line Interface, раздел «Постраничность».

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для продолжения постраничной выборки, передайте значение NextToken в аргумент starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в руководстве пользователя AWS Command Line Interface, раздел «Постраничность».

--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 (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Показать версию этого инструмента.

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с пакетом сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки config/env.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительная информация приведена в руководстве пользователя AWS CLI, в разделе «Начало работы».

Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. руководство пользователя AWS CLI, раздел «Использование кавычек со строками».

Для перечисления всех обнаруженных серверов, удовлетворяющих набору условий фильтрации

В этом примере команды перечисляются обнаруженные серверы, соответствующие любому из двух шаблонов имен хостов и не работающие под Ubuntu.

Команда:

aws discovery list-configurations --configuration-type SERVER --filters name="server.hostName",values="172-31-35","172-31-42",condition="CONTAINS" name="server.osName",values="Ubuntu",condition="NOT_CONTAINS"

Вывод:

{
    "configurations": [
      {
            "server.osVersion": "3.14.48-33.39.amzn1.x86_64",
            "server.type": "EC2",
            "server.hostName": "ip-172-31-42-208",
            "server.timeOfCreation": "2016-10-28 23:44:30.0",
            "server.configurationId": "d-server-099385097ef9fbcfb",
            "server.osName": "Linux - Amazon Linux AMI release 2015.03",
            "server.agentId": "i-c142b99e"
        },
        {
            "server.osVersion": "3.14.48-33.39.amzn1.x86_64",
            "server.type": "EC2",
            "server.hostName": "ip-172-31-35-152",
            "server.timeOfCreation": "2016-10-28 23:44:00.0",
            "server.configurationId": "d-server-0c4f2dd1fee22c6c1",
            "server.osName": "Linux - Amazon Linux AMI release 2015.03",
            "server.agentId": "i-4447bc1b"
        }
    ]
}

Вывод

configurations -> (список)

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

(карта)

key -> (строка)

value -> (строка)

nextToken -> (строка)

Токен для получения следующего набора результатов. Например, если ваш вызов ListConfigurations вернул 100 элементов, но вы установили ListConfigurationsRequest$maxResults в 10, вы получили набор из 10 результатов вместе с этим токеном. Используйте этот токен в следующем запросе для получения следующего набора из 10.

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

Spec-Zone.ru

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