Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

list-log-sources

Описание

Получает источники журналов.

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

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

Синтаксис

  list-log-sources
[--accounts <value>]
[--regions <value>]
[--sources <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, для которых отображаются источники журналов.

(строка)

Синтаксис:

"string" "string" ...

--regions (список)

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

(строка)

Синтаксис:

"string" "string" ...

--sources (список)

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

(структура помеченных объединений)

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

Примечание

Это структура помеченных объединений. Можно установить только один из следующих верхних ключей: awsLogSource, customLogSource.

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

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

sourceName -> (строка)

Имя источника Amazon Web Services. Это значение должно быть уникальным в регионе.

sourceVersion -> (строка)

Версия источника Amazon Web Services. Это значение должно быть уникальным в регионе.

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

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

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

Атрибуты стороннего пользовательского источника.

crawlerArn -> (строка)

ARN-адрес ползунка Glue.

databaseArn -> (строка)

ARN-адрес базы данных Glue, в которую записываются результаты, например: arn:aws:daylight:us-east-1::database/sometable/*.

tableArn -> (строка)

ARN-адрес таблицы Glue.

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

Подробности поставщика журналов для стороннего пользовательского источника.

location -> (строка)

Расположение раздела в ведре Amazon S3 для Security Lake.

roleArn -> (строка)

ARN-адрес IAM-роли, которая будет использоваться сущностью для помещения журналов в раздел пользовательского источника. Security Lake применит соответствующие политики доступа к этой роли, но вы должны вручную создать политику доверия для этой роли. Имя IAM-роли должно начинаться с текста «Security Lake». IAM-роль должна доверять logProviderAccountId для принятия роли.

sourceName -> (строка)

Имя стороннего пользовательского источника. Это значение должно быть уникальным в регионе.

sourceVersion -> (строка)

Версия стороннего пользовательского источника. Это значение должно быть уникальным в регионе.

Укороченный синтаксис:

awsLogSource={sourceName=string,sourceVersion=string},customLogSource={attributes={crawlerArn=string,databaseArn=string,tableArn=string},provider={location=string,roleArn=string},sourceName=string,sourceVersion=string} ...

Синтаксис JSON:

[
  {
    "awsLogSource": {
      "sourceName": "ROUTE53"|"VPC_FLOW"|"SH_FINDINGS"|"CLOUD_TRAIL_MGMT"|"LAMBDA_EXECUTION"|"S3_DATA"|"EKS_AUDIT"|"WAF",
      "sourceVersion": "string"
    },
    "customLogSource": {
      "attributes": {
        "crawlerArn": "string",
        "databaseArn": "string",
        "tableArn": "string"
      },
      "provider": {
        "location": "string",
        "roleArn": "string"
      },
      "sourceName": "string",
      "sourceVersion": "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

Для получения источников журналов Amazon Security Lake

Следующий пример list-log-sources приводит список источников журналов Amazon Security Lake в указанной учетной записи.

aws securitylake list-log-sources \
    --accounts "123456789012"

Вывод:

{
    "account": "123456789012",
    "region": "xy-region-1",
    "sources": [
        {
               "awsLogSource": {
                "sourceName": "VPC_FLOW",
                "sourceVersion": "2.0"
            }
        },
        {
            "awsLogSource": {
                "sourceName": "SH_FINDINGS",
                "sourceVersion": "2.0"
            }
        }
    ]
}

Дополнительную информацию см. в разделе Управление источниками в Руководстве пользователя Amazon Security Lake.

Вывод

nextToken -> (строка)

Если возвращается nextToken, доступны дополнительные результаты. Вы можете повторить вызов, используя возвращённый маркер, чтобы получить следующую страницу.

sources -> (список)

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

(структура)

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

account -> (строка)

Укажите учётную запись, из которой вы хотите собирать журналы.

region -> (строка)

Укажите регионы, из которых вы хотите собирать журналы.

sources -> (список)

Укажите источники, из которых вы хотите собирать журналы.

(структура помеченных объединений)

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

Примечание

Это структура помеченных объединений. Можно задать только один из следующих верхнеуровневых ключей: awsLogSource, customLogSource.

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

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

sourceName -> (строка)

Имя источника Amazon Web Services. Это значение должно быть уникальным для региона.

sourceVersion -> (строка)

Версия источника Amazon Web Services. Это значение должно быть уникальным для региона.

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

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

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

Атрибуты стороннего пользовательского источника.

crawlerArn -> (строка)

ARN обходчика Glue.

databaseArn -> (строка)

ARN базы данных Glue, в которую записываются результаты, например: arn:aws:daylight:us-east-1::database/sometable/*.

tableArn -> (строка)

ARN таблицы Glue.

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

Подробности поставщика журналов для стороннего пользовательского источника.

location -> (строка)

Расположение раздела в ведре Amazon S3 для Security Lake.

roleArn -> (строка)

ARN роли IAM, которая должна использоваться сущностью, помещающей журналы в раздел вашего пользовательского источника. Security Lake применит соответствующие политики доступа к этой роли, но вы должны предварительно вручную создать политику доверия для этой роли. Имя роли IAM должно начинаться с текста ‘Security Lake’. Роль IAM должна доверять logProviderAccountId для принятия роли.

sourceName -> (строка)

Имя стороннего пользовательского источника. Это значение должно быть уникальным для региона.

sourceVersion -> (строка)

Версия стороннего пользовательского источника. Это значение должно быть уникальным для региона.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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