Spec-Zone.ru › AWS CLI v2

[ aws . securityhub ]

get-finding-history

Описание

Возвращает историю нахождения в Security Hub за последние 90 дней. История включает изменения, внесенные в любые поля в формате обнаружения безопасности Amazon Web Services (ASFF).

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

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

Синтаксис

  get-finding-history
--finding-identifier <value>
[--start-time <value>]
[--end-time <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-identifier (структура)

Определяет, для какого обнаружения требуется получить историю нахождения.

Id -> (строка)

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

ProductArn -> (строка)

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

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

Id=string,ProductArn=string

Синтаксис JSON:

{
  "Id": "string",
  "ProductArn": "string"
}

--start-time (метка времени)

Метка времени, указывающая начальную точку истории запрошенного обнаружения.

Если вы предоставите значения для StartTime и EndTime, Security Hub вернёт историю обнаружений за указанный период. Если вы предоставите значение для StartTime, но не для EndTime, Security Hub вернёт историю обнаружений с StartTime до момента вызова API. Если вы предоставите значение для EndTime, но не для StartTime, Security Hub вернёт историю обнаружений с метки времени CreatedAt обнаружения до EndTime. Если вы не предоставите ни StartTime, ни EndTime, Security Hub вернёт историю обнаружений с метки времени CreatedAt обнаружения до момента вызова API. Во всех этих сценариях ответ ограничен 100 результатами, а максимальный период времени ограничен 90 днями.

Для получения дополнительной информации о валидации и форматировании полей метки времени в Security Hub см. Метки времени.

--end-time (метка времени)

Метка времени в формате ISO 8601, указывающая конечную точку истории запрошенного обнаружения.

Если вы предоставите значения для StartTime и EndTime, Security Hub вернёт историю обнаружений за указанный период. Если вы предоставите значение для StartTime, но не для EndTime, Security Hub вернёт историю обнаружений с StartTime до момента вызова API. Если вы предоставите значение для EndTime, но не для StartTime, Security Hub вернёт историю обнаружений с метки времени CreatedAt обнаружения до EndTime. Если вы не предоставите ни StartTime, ни EndTime, Security Hub вернёт историю обнаружений с метки времени CreatedAt обнаружения до момента вызова API. Во всех этих сценариях ответ ограничен 100 результатами, а максимальный период времени ограничен 90 днями.

Для получения дополнительной информации о валидации и форматировании полей метки времени в Security Hub см. Метки времени.

--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
  • text
  • таблица
  • 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.

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

Получение истории нахождения

Следующий пример get-finding-history получает историю за последние 90 дней для указанного обнаружения. В этом примере результаты ограничены двумя записями истории нахождения.

aws securityhub get-finding-history \
    --finding-identifier Id="arn:aws:securityhub:us-east-1:123456789012:security-control/S3.17/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",ProductArn="arn:aws:securityhub:us-east-1::product/aws/securityhub"

Вывод:

{
    "Records": [
        {
            "FindingIdentifier": {
                "Id": "arn:aws:securityhub:us-east-1:123456789012:security-control/S3.17/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
                "ProductArn": "arn:aws:securityhub:us-east-1::product/aws/securityhub"
            },
            "UpdateTime": "2023-06-02T03:15:25.685000+00:00",
            "FindingCreated": false,
            "UpdateSource": {
                "Type": "BATCH_IMPORT_FINDINGS",
                "Identity": "arn:aws:securityhub:us-east-1::product/aws/securityhub"
            },
            "Updates": [
                {
                    "UpdatedField": "Compliance.RelatedRequirements",
                    "OldValue": "[\"NIST.800-53.r5 SC-12(2)\",\"NIST.800-53.r5 SC-12(3)\",\"NIST.800-53.r5 SC-12(6)\",\"NIST.800-53.r5 CM-3(6)\",\"NIST.800-53.r5 SC-13\",\"NIST.800-53.r5 SC-28\",\"NIST.800-53.r5 SC-28(1)\",\"NIST.800-53.r5 SC-7(10)\"]",
                    "NewValue": "[\"NIST.800-53.r5 SC-12(2)\",\"NIST.800-53.r5 CM-3(6)\",\"NIST.800-53.r5 SC-13\",\"NIST.800-53.r5 SC-28\",\"NIST.800-53.r5 SC-28(1)\",\"NIST.800-53.r5 SC-7(10)\",\"NIST.800-53.r5 CA-9(1)\",\"NIST.800-53.r5 SI-7(6)\",\"NIST.800-53.r5 AU-9\"]"
                },
                {
                    "UpdatedField": "LastObservedAt",
                    "OldValue": "2023-06-01T09:15:38.587Z",
                    "NewValue": "2023-06-02T03:15:22.946Z"
                },
                {
                    "UpdatedField": "UpdatedAt",
                    "OldValue": "2023-06-01T09:15:31.049Z",
                    "NewValue": "2023-06-02T03:15:14.861Z"
                },
                {
                    "UpdatedField": "ProcessedAt",
                    "OldValue": "2023-06-01T09:15:41.058Z",
                    "NewValue": "2023-06-02T03:15:25.685Z"
                }
            ]
        },
        {
            "FindingIdentifier": {
                "Id": "arn:aws:securityhub:us-east-1:123456789012:security-control/S3.17/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
                "ProductArn": "arn:aws:securityhub:us-east-1::product/aws/securityhub"
            },
            "UpdateTime": "2023-05-23T02:06:51.518000+00:00",
            "FindingCreated": "true",
            "UpdateSource": {
                "Type": "BATCH_IMPORT_FINDINGS",
                "Identity": "arn:aws:securityhub:us-east-1::product/aws/securityhub"
            },
            "Updates": []
        }
    ]
}

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

Вывод

Записи -> (список)

Список событий, изменивших указанную проблему в течение указанного периода времени.

(структура)

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

ИдентификаторПроблемы -> (структура)

Идентифицирует проблему, для которой необходимо получить историю.

Идентификатор -> (строка)

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

ProductArn -> (строка)

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

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

Метка времени, которая указывает, когда Security Hub обработала обновлённую запись о проблеме.

Дополнительную информацию о валидации и формате полей метки времени в Security Hub см. в разделе Метки времени.

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

Указывает, отмечает ли событие создание новой проблемы. Значение True означает, что проблема была недавно создана. Значение False означает, что проблема не была недавно создана.

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

Идентифицирует источник события, изменившего проблему. Например, интегрированная служба Amazon Web Services или интеграция стороннего партнёра может вызвать ` BatchImportFindings https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html`__, или клиент Security Hub может вызвать ` BatchUpdateFindings https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html`__.

Тип -> (строка)

Описание типа события изменения проблемы, например, вызов ` BatchImportFindings https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html`__ (интегрированной службой Amazon Web Services или интеграцией стороннего партнёра) или ` BatchUpdateFindings https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html`__ (клиентом Security Hub).

Identity -> (строка)

Идентификатор источника, который инициировал событие изменения проблемы. Например, Amazon Resource Name (ARN) партнёра, вызвавшего BatchImportFindings, или клиента, вызвавшего BatchUpdateFindings.

Обновления -> (список)

Массив объектов, предоставляющих подробности о событии изменения проблемы, включая поле формата безопасности ASFF Amazon Web Services (ASFF), которое было изменено, значение поля до изменения и значение поля после изменения.

(структура)

Массив объектов, предоставляющих подробности о изменении проблемы, включая поле формата безопасности ASFF Amazon Web Services (ASFF), которое было изменено, значение поля до изменения и значение поля после изменения.

ИзменённоеПоле -> (строка)

Поле ASFF, которое было изменено во время события изменения проблемы.

СтароеЗначение -> (строка)

Значение поля ASFF до события изменения проблемы.

НовоеЗначение -> (строка)

Значение поля ASFF после события изменения проблемы. Для сохранения места и читаемости Security Hub опускает это значение, если ` FindingHistoryRecord https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord.html`__ превышает лимиты базы данных.

NextToken -> (строка)

Маркер для целей постраничной навигации. Предоставьте этот маркер в последующем запросе к ` GetFindingsHistory https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_GetFindingsHistory.html`__, чтобы получить до 100 дополнительных результатов истории для той же проблемы, которую вы указали в начальном запросе.

NextToken -> (строка)

Маркер для целей постраничной навигации. Предоставьте этот маркер в последующем запросе к GetFindingsHistory, чтобы получить до 100 дополнительных результатов истории для той же проблемы, которую вы указали в начальном запросе.

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

Spec-Zone.ru

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