Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

get-trail

Описание

Возвращает информацию о настройках указанного трейла.

См. также: AWS API Documentation

Синтаксис

  get-trail
--name <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]

Параметры

--name (строка)

Имя или Amazon Resource Name (ARN) трейла, для которого требуется получить информацию о настройках.

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

Вывод

Трейл -> (структура)

Настройки трейла.

Имя -> (строка)

Имя трейла, заданное при вызове CreateTrail. Максимальная длина — 128 символов.

S3BucketName -> (строка)

Имя Amazon S3 bucket, в который CloudTrail предоставляет файлы трейла. См. правила именования Amazon S3 Bucket.

S3KeyPrefix -> (строка)

Указывает префикс ключа Amazon S3, который следует за именем bucket, назначенного для доставки файлов журналов. Дополнительная информация: Поиск файлов журналов CloudTrail. Максимальная длина — 200 символов.

SnsTopicName -> (строка)

Это поле больше не используется. Используйте SnsTopicARN.

SnsTopicARN -> (строка)

Указывает ARN Amazon SNS-темы, которую CloudTrail использует для отправки уведомлений при доставке файлов журналов. Следующий формат ARN темы.

arn:aws:sns:us-east-2:123456789012:MyTopic

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

Установите True, чтобы включить вызовы API Amazon Web Services от глобальных служб Amazon Web Services, таких как IAM. В противном случае, False.

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

Указывает, существует ли трейл только в одном регионе или во всех регионах.

HomeRegion -> (строка)

Регион, в котором был создан трейл.

TrailARN -> (строка)

Указывает ARN трейла. Следующий формат ARN трейла.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

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

Указывает, включена ли валидация файлов журналов.

CloudWatchLogsLogGroupArn -> (строка)

Указывает Amazon Resource Name (ARN), уникальный идентификатор, представляющий группу журналов, в которую будут передаваться журналы CloudTrail.

CloudWatchLogsRoleArn -> (строка)

Указывает роль для конечной точки CloudWatch Logs для принятия роли пользователя для записи в группу журналов пользователя.

KmsKeyId -> (строка)

Указывает идентификатор ключа KMS, который шифрует журналы, передаваемые CloudTrail. Значение — полностью заданный ARN ключа KMS в следующем формате.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

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

Указывает, есть ли у трейла пользовательские селекторы событий.

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

Указывает, содержит ли трейл типы инсайтов, указанные в списке InsightSelector.

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

Указывает, является ли трейл трейлом организации.

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

Spec-Zone.ru

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