Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

Получение связанных ресурсов для результата аудита

Описание

Связанные ресурсы результата аудита. При вызове данного API могут быть возвращены следующие ресурсы:

  • СЕРТИФИКАТ_УСТРОЙСТВА
  • СЕРТИФИКАТ_УЦ
  • ПОЛИТИКА_IOT
  • ОБЛАЧНЫЙ_ПУЛ_ИДЕНТИФИКАЦИИ_COGNITO
  • ИД_КЛИЕНТА
  • НАСТРОЙКИ_АККАУНТА
  • ПСЕВДОНИМ_РОЛИ
  • РОЛЬ_IAM
  • СЕРТИФИКАТ_ИССУЕРА

Примечание

Данный API аналогичен API DescribeAuditFinding’s RelatedResources, но предоставляет пагинацию и не ограничен 10 ресурсами. При вызове DescribeAuditFinding для проверки промежуточного УЦ, аннулированного для активных сертификатов устройств, RelatedResources не будет заполнен. Для перечисления сертификатов необходимо использовать API ListRelatedResourcesForAuditFinding.

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

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

Синтаксис

  list-related-resources-for-audit-finding
--finding-id <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]

Параметры

--finding-id (строка)

Идентификатор результата аудита.

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

Пакет сертификатов УЦ для использования при проверке сертификатов 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 -> (список)

Связанные ресурсы.

(структура)

Информация о связанном ресурсе.

resourceType -> (строка)

Тип ресурса.

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

Информация, идентифицирующая ресурс.

deviceCertificateId -> (строка)

Идентификатор сертификата, прикрепленного к ресурсу.

caCertificateId -> (строка)

Идентификатор сертификата УЦ, используемого для авторизации сертификата.

cognitoIdentityPoolId -> (строка)

Идентификатор пула идентификации Amazon Cognito.

clientId -> (строка)

Идентификатор клиента.

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

Версия политики, связанной с ресурсом.

policyName -> (строка)

Имя политики.

policyVersionId -> (строка)

Идентификатор версии политики, связанной с ресурсом.

account -> (строка)

Аккаунт, с которым связан ресурс.

iamRoleArn -> (строка)

ARN роли IAM, обладающей чрезмерно широкими действиями.

roleAliasArn -> (строка)

ARN псевдонима роли, обладающей чрезмерно широкими действиями.

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

Идентификатор сертификата изготовителя.

issuerCertificateSubject -> (строка)

Предмет сертификата изготовителя.

issuerId -> (строка)

Идентификатор изготовителя.

issuerCertificateSerialNumber -> (строка)

Серийный номер сертификата изготовителя.

deviceCertificateArn -> (строка)

ARN идентифицированного сертификата устройства.

additionalInfo -> (карта)

Дополнительная информация о ресурсе.

key -> (строка)

value -> (строка)

nextToken -> (строка)

Токен, который можно использовать для получения следующего набора результатов, или null для первого вызова API.

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

Spec-Zone.ru

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