Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

describe-resource-scan

Описание

Описывает детали сканирования ресурсов.

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

Синтаксис

  describe-resource-scan
--resource-scan-id <value>
[--cli-input-json | --cli-input-yaml]
[--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) сканирования ресурсов.

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

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

ResourceScanId -> (строка)

Amazon Resource Name (ARN) сканирования ресурсов. Формат — arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. Пример — ``arn:aws:cloudformation:us-east-1 :123456789012 :resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 `` .

Status -> (строка)

Статус сканирования ресурсов.

IN_PROGRESS

Сканирование ресурсов все еще в процессе.

COMPLETE

Сканирование ресурсов завершено.

EXPIRED

Сканирование ресурсов истекло.

FAILED

Сканирование ресурсов завершилось неудачно.

StatusReason -> (строка)

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

StartTime -> (временная метка)

Время начала сканирования ресурсов.

EndTime -> (временная метка)

Время завершения сканирования ресурсов.

PercentageCompleted -> (дробное число)

Процент завершения сканирования ресурсов.

ResourceTypes -> (список)

Список типов ресурсов для указанного сканирования. Типы ресурсов доступны только для сканирований с Status, установленным на COMPLETE или FAILED.

(строка)

ResourcesScanned -> (целое число)

Количество ресурсов, которые были перечислены. Это доступно только для сканирований с Status, установленным на COMPLETE, EXPIRED или FAILED.

ResourcesRead -> (целое число)

Количество ресурсов, которые были прочитаны. Это доступно только для сканирований с Status, установленным на COMPLETE, EXPIRED или FAILED.

Примечание

Это поле может быть равно 0, если сканирование ресурсов завершилось неудачно с ResourceScanLimitExceededException.

ScanFilters -> (список)

Использовавшиеся фильтры сканирования.

(структура)

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

Types -> (список)

Массив строк, где каждая строка представляет тип ресурса Amazon Web Services, который нужно отсканировать. Каждая строка определяет тип ресурса в формате AWS::ServiceName::ResourceType, например, AWS::DynamoDB::Table. Полный список поддерживаемых типов ресурсов см. в таблице поддержки типов ресурсов в руководстве пользователя CloudFormation.

Для сканирования всех типов ресурсов в рамках службы можно использовать символ подстановки, представленный звездочкой (*). Звездочку можно разместить только в конце строки, например, AWS::S3::*.

(строка)

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

Spec-Zone.ru

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