Spec-Zone.ru › AWS CLI v2

[ aws . devops-guru ]

get-resource-collection

Описание

Возвращает списки ресурсов Amazon Web Services, которые имеют указанный тип коллекции ресурсов. Два типа коллекций ресурсов Amazon Web Services, которые поддерживаются, — это стеки Amazon Web Services CloudFormation и ресурсы Amazon Web Services, содержащие одинаковый тег Amazon Web Services. DevOps Guru может быть настроен для анализа ресурсов Amazon Web Services, определенных в стеках или помеченных с помощью одного и того же ключа тега. Вы можете указать до 500 стеков Amazon Web Services CloudFormation.

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

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

Синтаксис

  get-resource-collection
--resource-collection-type <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

--resource-collection-type (строка)

Тип коллекции ресурсов Amazon Web Services, которые нужно вернуть. Единственное допустимое значение — CLOUD_FORMATION для стеков Amazon Web Services CloudFormation.

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

  • AWS_CLOUD_FORMATION
  • AWS_SERVICE
  • AWS_TAGS

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

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

Маркер для указания начала постраничной навигации. Это NextToken из ранее укороченного ответа.

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

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

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

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение null или 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 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.

Вывод

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

Запрашиваемый список коллекций ресурсов Amazon Web Services. Два поддерживаемых типа коллекций ресурсов Amazon Web Services — это стеки Amazon Web Services CloudFormation и ресурсы Amazon Web Services, содержащие одинаковый тег Amazon Web Services. DevOps Guru может быть настроен для анализа ресурсов Amazon Web Services, определенных в стеках или помеченных с помощью одного и того же ключа тега. Вы можете указать до 500 стеков Amazon Web Services CloudFormation.

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

Информация о стеках Amazon Web Services CloudFormation. Вы можете использовать до 500 стеков для указания ресурсов Amazon Web Services в вашей учетной записи для анализа. Дополнительную информацию см. в разделе «Стеки» в руководстве пользователя Amazon Web Services CloudFormation.

StackNames -> (список)

Массив имен стеков CloudFormation.

(строка)

Tags -> (список)

Теги Amazon Web Services, используемые для фильтрации ресурсов в коллекции ресурсов.

Теги помогают вам идентифицировать и организовывать ваши ресурсы Amazon Web Services. Многие сервисы Amazon Web Services поддерживают теги, поэтому вы можете назначить один и тот же тег ресурсам из разных сервисов, чтобы указать, что ресурсы связаны. Например, вы можете назначить один и тот же тег ресурсу таблицы Amazon DynamoDB и функции Lambda. Дополнительную информацию об использовании тегов см. в документе «Рекомендации по использованию тегов».

У каждого тега Amazon Web Services есть две части.

  • Ключ тега (например, CostCenter, Environment, Project или Secret). Ключи тегов чувствительны к регистру.
  • Необязательное поле, известное как значение тега (например, 111122223333, Production или имя команды). Пропуск значения тега эквивалентно использованию пустой строки. Как и ключи тегов, значения тегов чувствительны к регистру.

Вместе они известны как пары «ключ-значение».

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

Строка, используемая для ключа в теге, который вы используете для определения покрытия ресурсов, должна начинаться с префикса Devops-guru-. Ключ тега может быть DevOps-Guru-deployment-application или devops-guru-rds-application. При создании ключа регистр символов в ключе может быть любым. После создания ключа он чувствителен к регистру. Например, DevOps Guru работает с ключом, названным devops-guru-rds, и ключом, названным DevOps-Guru-RDS, и эти ключи действуют как два разных ключа. Возможные пары «ключ-значение» в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers.

(структура)

Коллекция тегов Amazon Web Services, используемая для фильтрации инсайтов. Это используется для возврата инсайтов, сгенерированных только из ресурсов, содержащих теги в коллекции тегов.

AppBoundaryKey -> (строка)

Ключ тега Amazon Web Services, используемый для идентификации ресурсов Amazon Web Services, которые анализирует DevOps Guru. Все ресурсы Amazon Web Services в вашей учетной записи и регионе, помеченные этим ключом, составляют границу приложения и анализа DevOps Guru.

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

Строка, используемая для ключа в теге, который вы используете для определения покрытия ресурсов, должна начинаться с префикса Devops-guru-. Ключ тега может быть DevOps-Guru-deployment-application или devops-guru-rds-application. При создании ключа регистр символов в ключе может быть любым. После создания ключа он чувствителен к регистру. Например, DevOps Guru работает с ключом, названным devops-guru-rds, и ключом, названным DevOps-Guru-RDS, и эти ключи действуют как два разных ключа. Возможные пары «ключ-значение» в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers.

TagValues -> (список)

Значения в коллекции тегов Amazon Web Services.

Значение тега — это необязательное поле, используемое для сопоставления строки с ключом тега (например, 111122223333, Production или имя команды). Ключ и значение — это пара «ключ-значение» тега. Пропуск значения тега эквивалентно использованию пустой строки. Как и ключи тегов, значения тегов чувствительны к регистру. Вы можете указать максимум 256 символов для значения тега.

(строка)

NextToken -> (строка)

Маркер постраничной навигации для получения следующей страницы результатов для этой операции. Если больше страниц нет, это значение равно null.

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

Spec-Zone.ru

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