Spec-Zone.ru › AWS CLI v2

[ aws . securityhub ]

batch-get-security-controls

Описание

Предоставляет подробную информацию о наборе управляющих элементов безопасности для текущей учетной записи Amazon Web Services и региона Amazon Web Services.

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

Синтаксис

  batch-get-security-controls
--security-control-ids <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]

Параметры

--security-control-ids (список)

Список управляющих элементов безопасности (определённых с помощью SecurityControlId , SecurityControlArn или их комбинации). Идентификатор управляющего элемента безопасности или Amazon Resource Name (ARN) одинаковы во всех стандартах.

(строка)

Синтаксис:

"string" "string" ...

--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
  • текст
  • таблица
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Получение подробной информации о управляющих элементах безопасности

Следующий batch-get-security-controls пример получает подробную информацию о управляющих элементах безопасности ACM.1 и IAM.1 в текущей учетной записи AWS и регионе AWS.

aws securityhub batch-get-security-controls \
    --security-control-ids '["ACM.1", "IAM.1"]'

Вывод:

{
    "SecurityControls": [
        {
            "SecurityControlId": "ACM.1",
            "SecurityControlArn": "arn:aws:securityhub:us-east-2:123456789012:security-control/ACM.1",
            "Title": "Imported and ACM-issued certificates should be renewed after a specified time period",
            "Description": "This control checks whether an AWS Certificate Manager (ACM) certificate is renewed within the specified time period. It checks both imported certificates and certificates provided by ACM. The control fails if the certificate isn't renewed within the specified time period. Unless you provide a custom parameter value for the renewal period, Security Hub uses a default value of 30 days.",
            "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/ACM.1/remediation",
            "SeverityRating": "MEDIUM",
            "SecurityControlStatus": "ENABLED"
            "UpdateStatus": "READY",
            "Parameters": {
                "daysToExpiration": {
                    "ValueType": CUSTOM,
                    "Value": {
                        "Integer": 15
                    }
                }
            },
            "LastUpdateReason": "Updated control parameter"
        },
        {
            "SecurityControlId": "IAM.1",
            "SecurityControlArn": "arn:aws:securityhub:us-east-2:123456789012:security-control/IAM.1",
            "Title": "IAM policies should not allow full \"*\" administrative privileges",
            "Description": "This AWS control checks whether the default version of AWS Identity and Access Management (IAM) policies (also known as customer managed policies) do not have administrator access with a statement that has \"Effect\": \"Allow\" with \"Action\": \"*\" over \"Resource\": \"*\". It only checks for the Customer Managed Policies that you created, but not inline and AWS Managed Policies.",
            "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/IAM.1/remediation",
            "SeverityRating": "HIGH",
            "SecurityControlStatus": "ENABLED"
            "UpdateStatus": "READY",
            "Parameters": {}
        }
    ]
}

Дополнительную информацию см. в разделе Просмотр подробной информации о элементе управления в Руководстве пользователя AWS Security Hub.

Вывод

SecurityControls -> (список)

Массив, возвращающий идентификатор, Amazon Resource Name (ARN) и другие сведения о управляющем элементе безопасности. Та же информация возвращается, независимо от того, включает ли запрос SecurityControlId или SecurityControlArn.

(структура)

Управляющий элемент безопасности в Security Hub описывает рекомендацию по безопасности, связанную с определенным ресурсом.

SecurityControlId -> (строка)

Уникальный идентификатор управляющего элемента безопасности во всех стандартах. Значения для этого поля обычно состоят из имени сервиса Amazon Web Services и числа, например APIGateway.3.

SecurityControlArn -> (строка)

Amazon Resource Name (ARN) управляющего элемента безопасности во всех стандартах, например arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. Этот параметр не упоминает конкретный стандарт.

Title -> (строка)

Название управляющего элемента безопасности.

Description -> (строка)

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

RemediationUrl -> (строка)

Ссылка на документацию Security Hub, объясняющую, как исправить результат с ошибкой для управляющего элемента безопасности.

SeverityRating -> (строка)

Уровень серьезности управляющего элемента безопасности. Дополнительную информацию о том, как Security Hub определяет серьезность элементов управления, см. в разделе Назначение уровня серьезности результатам проверки элементов управления в Руководстве пользователя Security Hub.

SecurityControlStatus -> (строка)

Статус включения управляющего элемента безопасности в определенном стандарте.

UpdateStatus -> (строка)

Указывает, отображаются ли настраиваемые свойства управляющего элемента безопасности в результатах Security Hub. Статус READY означает, что Security Hub использует текущие значения параметров элемента управления при выполнении проверок безопасности элемента управления. Статус UPDATING означает, что все проверки безопасности могут не использовать текущие значения параметров.

Parameters -> (массив)

Объект, который определяет имя параметра элемента управления, его текущее значение и был ли он настроен пользователем.

key -> (строка)

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

Объект, предоставляющий текущее значение параметра управляющего элемента безопасности и указывает, был ли он настроен пользователем.

ValueType -> (строка)

Определяет, использует ли параметр элемента управления пользовательское значение или подчиняется поведению Security Hub по умолчанию.

Когда ValueType устанавливается равным DEFAULT, поведение по умолчанию может быть определённым значением Security Hub по умолчанию или поведение по умолчанию может игнорировать определённый параметр. Когда ValueType устанавливается равным DEFAULT, Security Hub игнорирует введённые пользователем данные для поля Value.

Когда ValueType устанавливается равным CUSTOM, поле Value не может быть пустым.

Value -> (метка соединённой структуры)

Текущее значение параметра элемента управления.

Примечание

Это структура с меткой. Только один из следующих ключей верхнего уровня может быть задан: Integer, IntegerList, Double, String, StringList, Boolean, Enum, EnumList.

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

Параметр элемента управления, являющийся целым числом.

IntegerList -> (список)

Параметр элемента управления, являющийся списком целых чисел.

(целое число)

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

Параметр элемента управления, являющийся дробным числом.

String -> (строка)

Параметр элемента управления, являющийся строкой.

StringList -> (список)

Параметр элемента управления, являющийся списком строк.

(строка)

Boolean -> (логическое значение)

Параметр элемента управления, являющийся логическим значением.

Enum -> (строка)

Параметр элемента управления, являющийся перечислением.

EnumList -> (список)

Параметр элемента управления, являющийся списком перечислений.

(строка)

LastUpdateReason -> (строка)

Последняя причина обновления настраиваемых свойств управляющего элемента безопасности. Отличается от поля UpdateReason в API ` BatchUpdateStandardsControlAssociations https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html`__, которое отслеживает причину обновления статуса включения элемента управления. Это поле принимает буквенно-цифровые символы, а также пробелы, дефисы и подчёркивания.

UnprocessedIds -> (список)

Управляющий элемент безопасности (определённый с помощью SecurityControlId , SecurityControlArn или их комбинации), для которого не удалось вернуть данные.

(структура)

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

SecurityControlId -> (строка)

Элемент управления (определённый с помощью SecurityControlId , SecurityControlArn или их комбинации), для которого не удалось вернуть ответ.

ErrorCode -> (строка)

Код ошибки для необработанного управляющего элемента безопасности.

ErrorReason -> (строка)

Причина, по которой управляющий элемент безопасности не был обработан.

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

Spec-Zone.ru

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