Spec-Zone.ru › AWS CLI v2

[ aws . resource-groups ]

list-group-resources

Описание

Возвращает список Amazon Resource Name (ARN) ресурсов, которые являются членами указанной группы ресурсов.

Минимальные разрешения

Для выполнения этой команды у вас должны быть следующие разрешения:

  • resource-groups:ListGroupResources
  • cloudformation:DescribeStacks
  • cloudformation:ListStackResources
  • tag:GetResources

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

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

Синтаксис

  list-group-resources
[--group-name <value>]
[--group <value>]
[--filters <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]

Параметры

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

Предупреждение

  • Устаревший параметр - не используйте его. Используйте поле запроса ``Group`` вместо него. *

--group (строка)

Имя или Amazon Resource Name (ARN) группы ресурсов.

--filters (список)

Фильтры, отформатированные как объекты ResourceFilter, которые вы хотите применить к операции ListGroupResources. Фильтрует результаты, чтобы включать только те ресурсы указанных типов.

  • resource-type - Фильтруйте ресурсы по их типу. Укажите до пяти типов ресурсов в формате AWS::ServiceCode::ResourceType. Например, AWS::EC2::Instance или AWS::S3::Bucket.

При указании фильтра resource-type для ListGroupResources, Resource Groups проверяет ваши типы ресурсов на соответствие типам, определённым в запросе, связанном с группой. Например, если группа содержит только S3-ведра, потому что её запрос указывает только этот тип ресурса, но ваш фильтр resource-type включает EC2-инстансы, AWS Resource Groups не фильтрует EC2-инстансы. В этом случае запрос ListGroupResources возвращает ошибку BadRequestException с сообщением, похожим на следующее:

The resource types specified as filters in the request are not valid.

Ошибка включает список типов ресурсов, которые не прошли проверку, потому что они не являются частью запроса, связанного с группой. Эта проверка не происходит, когда запрос группы указывает AWS::AllSupported, потому что группа, основанная на таком запросе, может содержать любые разрешённые типы ресурсов для типа запроса (запросы на основе тегов или стеков Amazon CloudFront).

(структура)

Пара имя-значение фильтра, используемая для получения более конкретных результатов из списка ресурсов.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Разрешённые значения фильтров варьируются в зависимости от имени фильтра ресурса и чувствительны к регистру.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "resource-type",
    "Values": ["string", ...]
  }
  ...
]

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

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

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

Примеры

Примечание

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

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

Для перечисления всех ресурсов в группе ресурсов

Пример 1: Следующий пример list-resource-groups перечисляет все ресурсы, которые являются частью указанной группы ресурсов.

aws resource-groups list-group-resources \
    --group-name tbq-WebServer

Вывод:

{
    "ResourceIdentifiers": [
        {
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-09f77fa38c12345ab",
            "ResourceType": "AWS::EC2::Instance"
        }
    ]
}

Пример 2: Следующий пример перечисляет все ресурсы в группе, которые также имеют тип «resource-type» «AWS::EC2::Instance»:

aws resource-groups list-group-resources
–group-name tbq-WebServer –filters Name=resource-type,Values=AWS::EC2::Instance

Вывод

Ресурсы -> (список)

Массив ресурсов, по которому можно определить идентификатор, тип и статус членства каждого ресурса в группе.

(структура)

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

Идентификатор -> (структура)

Структура, содержащая ARN ресурса и его тип.

ResourceArn -> (строка)

Идентификатор Amazon-ресурса (ARN) ресурса.

ResourceType -> (строка)

Тип ресурса, например AWS::EC2::Instance .

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

Структура, содержащая статус членства этого ресурса в группе.

Примечание

Это поле присутствует в ответе только в случае, если группа имеет тип AWS::EC2::HostManagement .

Имя -> (строка)

Текущий статус.

ResourceIdentifiers -> (список)

Предупреждение

** Устаревший параметр - не используйте. Используйте поле ответа ``Resources`` вместо него. **

(структура)

Структура, содержащая ARN ресурса и его тип.

ResourceArn -> (строка)

Идентификатор Amazon-ресурса (ARN) ресурса.

ResourceType -> (строка)

Тип ресурса, например AWS::EC2::Instance .

NextToken -> (строка)

Если присутствует, указывает на то, что доступно больше вывода, чем включено в текущий ответ. Используйте это значение в параметре запроса NextToken в последующем вызове операции, чтобы получить следующую часть вывода. Вы должны повторять это до тех пор, пока элемент ответа NextToken не вернётся со значением null .

QueryErrors -> (список)

Список объектов QueryError. Каждая ошибка содержит ErrorCode и Message. Возможные значения для ErrorCode - CLOUDFORMATION_STACK_INACTIVE , CLOUDFORMATION_STACK_NOT_EXISTING , CLOUDFORMATION_STACK_UNASSUMABLE_ROLE и RESOURCE_TYPE_NOT_SUPPORTED.

(структура)

Структура ошибки из двух частей, которая может возникнуть в ListGroupResources или SearchResources.

ErrorCode -> (строка)

Указывает код ошибки, который был поднят.

Message -> (строка)

Сообщение, которое объясняет ErrorCode.

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

Spec-Zone.ru

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