[ aws . resource-explorer-2 ]
list-resources
Описание
Возвращает список ресурсов и их подробностей, соответствующих указанным критериям. Этот запрос должен использовать представление. Если вы явно не укажете представление, Resource Explorer использует представление по умолчанию для региона Amazon Web Services, в котором вы вызываете эту операцию.
См. также: Документацию API AWS
list-resources использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команды, опции и вложенные параметры, помеченные типом document, должны быть предоставлены в формате JSON. Краткая синтаксическая запись не поддерживает типы документов.
list-resources — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запросов: Resources
Синтаксис
list-resources
[--filters <value>]
[--view-arn <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]
Параметры
--filters (структура)
Массив строк, определяющий, какие ресурсы включены в результаты запросов, выполненных с использованием этого представления. Когда вы используете это представление в операции Search, строка фильтра объединяется с параметром поиска QueryString с использованием логического оператора AND.
Сведения о поддерживаемом синтаксисе см. в справочнике по запросам поиска для Resource Explorer в руководстве пользователя Amazon Web Services Resource Explorer.
Предупреждение
Эта строка запроса в контексте этой операции поддерживает только префиксы фильтра с необязательными операторами. Она не поддерживает свободный текст. Например, строкаregion:us* service:ec2 -tag:stage=prod включает все ресурсы Amazon EC2 во всех регионах Amazon Web Services, начинающиеся с букв us и не помеченные ключом Stage, имеющим значение prod.FilterString -> (строка)
Краткая синтаксическая запись:
FilterString=string
Синтаксис JSON:
{
"FilterString": "string"
}
--view-arn (строка)
--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 (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- включено
- выключено
- автоматически
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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-auto-prompt (логическое значение)
Автоматический запрос параметров входных данных CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров входных данных CLI.
Вывод
NextToken -> (строка)
NextToken в последующем вызове операции для получения следующей части вывода. Вы должны повторять это до тех пор, пока элемент ответа NextToken не вернет значение null. Токены постраничного вывода истекают через 24 часа.Resources -> (список)
Список структур, описывающих ресурсы, соответствующие запросу.
(структура)
Ресурс в Amazon Web Services, обнаруженный Amazon Web Services Resource Explorer, для которого в индексе региона Amazon Web Services, содержащем ресурс, хранится информация.
Arn -> (строка)
LastReportedAt -> (временная метка)
OwningAccountId -> (строка)
Properties -> (список)
Структура с дополнительными деталями, специфичными для типа ресурса. Эти свойства могут быть добавлены, если включена интеграция между Resource Explorer и другими сервисами Amazon Web Services.
(структура)
Структура, описывающая свойство ресурса.
Data -> (документ)
LastReportedAt -> (временная метка)
Name -> (строка)
Region -> (строка)
ResourceType -> (строка)
Service -> (строка)
ViewArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.