Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

list-resource-scan-related-resources

Описание

Выводит список связанных ресурсов для списка ресурсов из сканирования ресурсов. Ответ указывает, управляются ли каждый возвращаемый ресурс службой CloudFormation.

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

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

Синтаксис

  list-resource-scan-related-resources
--resource-scan-id <value>
--resources <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]

Параметры

--resource-scan-id (строка)

Amazon Resource Name (ARN) сканирования ресурсов.

--resources (список)

Список ресурсов, для которых требуется получить связанные ресурсы. Можно указать до 100 ресурсов.

(структура)

Идентифицирует отсканированный ресурс. Используется с действием API ListResourceScanRelatedResources.

ResourceType -> (строка)

Тип ресурса, например AWS::DynamoDB::Table. Список поддерживаемых ресурсов см. в разделе Поддержка типов ресурсов для импорта и обнаружения дрейфа в Руководстве пользователя CloudFormation.

ResourceIdentifier -> (словарь)

Список до 256 пар ключ-значение, идентифицирующих отсканированный ресурс. Ключ — имя одного из основных идентификаторов ресурса. (Основные идентификаторы указаны в списке primaryIdentifier в схеме ресурса.) Значение — значение этого основного идентификатора. Например, для ресурса AWS::DynamoDB::Table основные идентификаторы — TableName, поэтому пара ключ-значение может быть "TableName": "MyDDBTable". Дополнительную информацию см. в разделе primaryIdentifier в Руководстве пользователя командной строки CloudFormation (CLI).

key -> (строка)

value -> (строка)

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

ResourceType=string,ResourceIdentifier={KeyName1=string,KeyName2=string} ...

Синтаксис JSON:

[
  {
    "ResourceType": "string",
    "ResourceIdentifier": {"string": "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
  • текст
  • таблица
  • 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.

Вывод

RelatedResources -> (список)

Список до MaxResults ресурсов в указанном сканировании ресурсов, связанных с указанными ресурсами.

(структура)

Отсканированный ресурс, возвращаемый действием ListResourceScanResources или ListResourceScanRelatedResources.

ResourceType -> (строка)

Тип ресурса, например AWS::DynamoDB::Table. Список поддерживаемых ресурсов см. в разделе Поддержка типов ресурсов для импорта и обнаружения дрейфа в Руководстве пользователя CloudFormation

ResourceIdentifier -> (словарь)

Список до 256 пар ключ-значение, идентифицирующих отсканированный ресурс. Ключ — имя одного из основных идентификаторов ресурса. (Основные идентификаторы указаны в списке primaryIdentifier в схеме ресурса.) Значение — значение этого основного идентификатора. Например, для ресурса AWS::DynamoDB::Table основные идентификаторы — TableName, поэтому пара ключ-значение может быть "TableName": "MyDDBTable". Дополнительную информацию см. в разделе primaryIdentifier в Руководстве пользователя командной строки CloudFormation (CLI).

key -> (строка)

value -> (строка)

ManagedByStack -> (булево)

Если true, ресурс управляется стеком CloudFormation.

NextToken -> (строка)

Если запрос не возвращает все оставшиеся результаты, NextToken устанавливается в токен. Чтобы получить следующий набор результатов, вызовите ListResourceScanRelatedResources снова и используйте это значение для параметра NextToken. Если запрос возвращает все результаты, NextToken устанавливается в пустую строку.

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

Spec-Zone.ru

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