Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

list-audit-suppressions

Описание

Отображает ваши списки аудиторских записей Device Defender.

Требуется разрешение на доступ к действию ListAuditSuppressions.

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

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

Синтаксис

  list-audit-suppressions
[--check-name <value>]
[--resource-identifier <value>]
[--ascending-order | --no-ascending-order]
[--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]

Параметры

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

Имя проверки аудита. Проверки должны быть включены для вашей учетной записи. (Используйте DescribeAccountAuditConfiguration, чтобы увидеть список всех проверок, включая те, которые включены, или используйте UpdateAccountAuditConfiguration, чтобы выбрать, какие проверки включить.)

--resource-identifier (структура)

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

deviceCertificateId -> (строка)

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

caCertificateId -> (строка)

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

cognitoIdentityPoolId -> (строка)

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

clientId -> (строка)

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

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

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

policyName -> (строка)

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

policyVersionId -> (строка)

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

account -> (строка)

Учетная запись, с которой связан ресурс.

iamRoleArn -> (строка)

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

roleAliasArn -> (строка)

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

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

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

issuerCertificateSubject -> (строка)

Подпись сертификата издателя.

issuerId -> (строка)

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

issuerCertificateSerialNumber -> (строка)

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

deviceCertificateArn -> (строка)

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

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

deviceCertificateId=string,caCertificateId=string,cognitoIdentityPoolId=string,clientId=string,policyVersionIdentifier={policyName=string,policyVersionId=string},account=string,iamRoleArn=string,roleAliasArn=string,issuerCertificateIdentifier={issuerCertificateSubject=string,issuerId=string,issuerCertificateSerialNumber=string},deviceCertificateArn=string

Синтаксис JSON:

{
  "deviceCertificateId": "string",
  "caCertificateId": "string",
  "cognitoIdentityPoolId": "string",
  "clientId": "string",
  "policyVersionIdentifier": {
    "policyName": "string",
    "policyVersionId": "string"
  },
  "account": "string",
  "iamRoleArn": "string",
  "roleAliasArn": "string",
  "issuerCertificateIdentifier": {
    "issuerCertificateSubject": "string",
    "issuerId": "string",
    "issuerCertificateSerialNumber": "string"
  },
  "deviceCertificateArn": "string"
}

--ascending-order | --no-ascending-order (логическое значение)

Определяет, перечислены ли подавления в порядке возрастания даты истечения срока действия. Если параметр не задан, ascendingOrder=true.

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

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения вызова AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, получая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов службы AWS.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

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

Примеры

Примечание

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

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

Для перечисления всех подавлений обнаружения аудиторских данных

Следующий list-audit-suppressions пример перечисляет все активные подавления обнаружения аудиторских данных.

aws iot list-audit-suppressions

Вывод:

{
    "suppressions": [
        {
        "checkName": "DEVICE_CERTIFICATE_EXPIRING_CHECK",
            "resourceIdentifier": {
                "deviceCertificateId": "c7691e<shortened>"
            },
        "expirationDate": 1597881600.0,
        "suppressIndefinitely": false
        }
    ]
}

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

Вывод

suppressions -> (список)

Список подавлений аудита.

(структура)

Фильтры конкретных результатов аудита Device Defender.

checkName -> (строка)

Имя проверки аудита. Проверки должны быть включены для вашей учетной записи. (Используйте DescribeAccountAuditConfiguration, чтобы увидеть список всех проверок, включая те, что включены, или используйте UpdateAccountAuditConfiguration, чтобы выбрать, какие проверки включить.)

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

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

deviceCertificateId -> (строка)

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

caCertificateId -> (строка)

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

cognitoIdentityPoolId -> (строка)

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

clientId -> (строка)

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

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

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

policyName -> (строка)

Название политики.

policyVersionId -> (строка)

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

account -> (строка)

Учетная запись, с которой связан ресурс.

iamRoleArn -> (строка)

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

roleAliasArn -> (строка)

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

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

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

issuerCertificateSubject -> (строка)

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

issuerId -> (строка)

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

issuerCertificateSerialNumber -> (строка)

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

deviceCertificateArn -> (строка)

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

expirationDate -> (метка времени)

Дата истечения срока действия (метка времени в секундах эпохи), к которой вы хотите придерживаться подавления.

suppressIndefinitely -> (булево)

Указывает, должен ли подавление существовать неопределенно или нет.

description -> (строка)

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

nextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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