Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

get-channel

Описание

Возвращает информацию о конкретном канале.

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

Синтаксис

  get-channel
--channel <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]

Параметры

--channel (строка)

ARN или UUID канала.

--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-auto-prompt (логическое значение)

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

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

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

Вывод

ChannelArn -> (строка)

ARN канала, возвращенного запросом GetChannel.

Name -> (строка)

Имя канала CloudTrail. Для каналов, связанных с сервисом, имя имеет вид aws-service-channel/service-name/custom-suffix, где service-name представляет имя сервиса Amazon Web Services, создавшего канал, а custom-suffix — суффикс, сгенерированный сервисом Amazon Web Services.

Source -> (строка)

Источник канала CloudTrail.

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

Предоставляет информацию о конфигурации расширенных селекторов событий для канала и о том, применяется ли канал ко всем регионам или только к одному региону.

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

Указывает, применяется ли канал к одному региону или ко всем регионам.

AdvancedEventSelectors -> (список)

Расширенные селекторы событий, настроенные для канала.

(структура)

Расширенные селекторы событий позволяют создавать точные селекторы для управления CloudTrail, данных и событий сетевой активности. Они помогают контролировать расходы, регистрируя только те события, которые важны для вас. Более подробную информацию о настройке расширенных селекторов событий см. в разделах "Регистрация событий данных", "Регистрация событий сетевой активности" и "Регистрация событий управления" в руководстве пользователя CloudTrail.

Вы не можете применить одновременно селекторы событий и расширенные селекторы событий к одному трейлу.

Сведения о настраиваемых полях расширенных селекторов событий см. в разделе AdvancedEventSelector в справочнике API CloudTrail.

Name -> (строка)

Необязательное описательное имя для расширенного селектора событий, например, "Регистрация событий данных только для двух ведер S3".

FieldSelectors -> (список)

Содержит все операторы селектора в расширенном селекторе событий.

(структура)

Один оператор селектора в расширенном селекторе событий.

Field -> (строка)

Поле в записи события CloudTrail, по которому фильтруются события для регистрации. Для хранилищ данных событий CloudTrail Insights, элементов конфигурации Config, доказательств Audit Manager или событий за пределами Amazon Web Services поле используется только для выбора событий, поскольку фильтрация не поддерживается.

Дополнительную информацию см. в разделе AdvancedFieldSelector в справочнике API CloudTrail.

Примечание

Селекторы не поддерживают использование символов подстановки, например, *. Для соответствия нескольким значениям с одним условием можно использовать StartsWith, EndsWith, NotStartsWith или NotEndsWith, чтобы явно сопоставлять начало или конец поля события.

Equals -> (список)

Оператор, включающий события, соответствующие точному значению поля записи события, указанному в качестве значения Field. Это единственный допустимый оператор, который можно использовать с полями readOnly, eventCategory и resources.type.

(строка)

StartsWith -> (список)

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

(строка)

EndsWith -> (список)

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

(строка)

NotEquals -> (список)

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

(строка)

NotStartsWith -> (список)

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

(строка)

NotEndsWith -> (список)

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

(строка)

Destinations -> (список)

Назначенные цели канала. Для каналов, созданных для интеграций, назначениями являются хранилища данных событий, регистрирующие события, поступающие через канал. Для каналов, связанных с сервисом, назначением является сервис Amazon Web Services, создавший канал, связанный с сервисом, для получения событий.

(структура)

Содержит информацию о цели, получающей события.

Type -> (строка)

Тип цели для событий, поступающих из канала. Для каналов, используемых для интеграции CloudTrail Lake, значение — EVENT_DATA_STORE. Для каналов, связанных с сервисом, значение — AWS_SERVICE.

Location -> (строка)

Для каналов, используемых для интеграции CloudTrail Lake, местоположением является ARN хранилища данных событий, которое получает события из канала. Для каналов, связанных с сервисом, местоположением является имя сервиса Amazon Web Services.

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

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

LatestIngestionSuccessTime -> (временная метка)

Временная метка последней успешной загрузки событий для канала.

LatestIngestionSuccessEventID -> (строка)

Идентификатор события последней успешной загрузки событий.

LatestIngestionErrorCode -> (строка)

Код ошибки последней неудачной загрузки событий.

LatestIngestionAttemptTime -> (временная метка)

Временная метка последней попытки загрузки событий для канала.

LatestIngestionAttemptEventID -> (строка)

Идентификатор события последней попытки загрузки событий.

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

Spec-Zone.ru

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