Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

получение источников данных озера данных

Описание

Извлекает моментальный снимок текущего региона, включая информацию о том, включен ли Amazon Security Lake для этих учетных записей и из каких источников Security Lake собирает данные.

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

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

Синтаксис

  get-data-lake-sources
[--accounts <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]

Параметры

--accounts (список)

Идентификатор учетной записи Amazon Web Services, для которой извлекается моментальный снимок текущего региона Amazon Web Services, включая включенные учетные записи и источники журналов.

(строка)

Синтаксис:

"string" "string" ...

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

Набор сертификатов 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-data-lake-sources пример получает моментальный снимок сбора журналов для указанной учетной записи в текущем регионе AWS. Учетная запись имеет включенный Amazon Security Lake.

aws securitylake get-data-lake-sources \
    --accounts "123456789012"

Вывод:

{
    "dataLakeSources": [
        {
            "account": "123456789012",
            "sourceName": "SH_FINDINGS",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "VPC_FLOW",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "NOT_COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "LAMBDA_EXECUTION",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "ROUTE53",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "CLOUD_TRAIL_MGMT",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        }
    ],
    "dataLakeArn": null
}

Дополнительную информацию см. в разделе Сбор данных из AWS-сервисов в Руководстве пользователя Amazon Security Lake.

Вывод

dataLakeArn -> (строка)

Идентификатор ресурса Amazon (ARN), созданный вами для предоставления подписчику. Дополнительную информацию об ARN и о том, как использовать их в политиках, см. в Руководстве пользователя Amazon Security Lake.

dataLakeSources -> (список)

Список включенных учетных записей и включенных источников.

(структура)

Amazon Security Lake собирает журналы и события из поддерживаемых Amazon Web Services-сервисов и пользовательских источников. Список поддерживаемых Amazon Web Services-сервисов см. в Руководстве пользователя Amazon Security Lake.

account -> (строка)

Идентификатор учетной записи Security Lake, для которой собираются журналы.

eventClasses -> (список)

Классы событий Open Cybersecurity Schema Framework (OCSF) описывают тип данных, которые пользовательский источник будет отправлять в Security Lake. Список поддерживаемых классов событий см. в Руководстве пользователя Amazon Security Lake.

(строка)

sourceName -> (строка)

Поддерживаемые Amazon Web Services-сервисы, из которых собираются журналы и события. Amazon Security Lake поддерживает сбор журналов и событий для нативно поддерживаемых Amazon Web Services-сервисов.

sourceStatuses -> (список)

Статус журнала для учетной записи Security Lake.

(структура)

Извлекает статус журналов для учетной записи Amazon Security Lake.

resource -> (строка)

Определяет путь, по которому доступны сохраненные журналы, содержащие информацию о ваших системах, приложениях и сервисах.

status -> (строка)

Статус работоспособности сервисов, включая коды ошибок и шаблоны.

nextToken -> (строка)

Указывает, доступны ли еще результаты. Значение nextToken — уникальный токен страничной навигации для каждой страницы. Повторите вызов, используя возвращенный токен, чтобы получить следующую страницу. Не изменяйте другие аргументы.

Каждый токен страничной навигации действует в течение 24 часов. Использование истекшего токена страничной навигации приведет к возврату ошибки HTTP 400 InvalidToken.

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

Spec-Zone.ru

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