Spec-Zone.ru › AWS CLI v2

[ aws . ivschat ]

list-logging-configurations

Описание

Получает сводную информацию обо всех конфигурациях логирования в регионе AWS, где обрабатывается запрос API.

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

Синтаксис

  list-logging-configurations
[--next-token <value>]
[--max-results <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]

Параметры

--next-token (строка)

Первые конфигурации логирования для получения. Используется для пагинации; см. поле ответа nextToken.

--max-results (целое число)

Максимальное количество конфигураций логирования для возврата. По умолчанию: 50.

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

Для получения сводной информации обо всех конфигурациях логирования для пользователя в регионе AWS, где обрабатывается запрос API

Следующий пример list-logging-configurations показывает список информации обо всех ресурсах LoggingConfiguration для пользователя в регионе AWS, где обрабатывается запрос API.

aws ivschat list-logging-configurations \
    --max-results 2 \
    --next-token ""

Вывод:

{
    "nextToken": "set-2",
    "loggingConfigurations": [
        {
            "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
            "createTime": "2022-09-14T17:48:00.653000+00:00",
            "destinationConfiguration": {
                "s3": {
                    "bucketName": "demo-logging-bucket"
                }
            },
            "id": "ABcdef34ghIJ",
            "name": "test-logging-config",
            "state": "ACTIVE",
            "tags": { "key1" : "value1", "key2" : "value2" },
            "updateTime": "2022-09-14T17:48:01.104000+00:00"
        }
        ...
    ]
}

Для получения дополнительной информации см. Раздел «Начало работы с Amazon IVS Chat» в Руководстве пользователя Amazon Interactive Video Service.

Вывод

loggingConfigurations -> (список)

Список соответствующих конфигураций логирования (только сводная информация). В destinationConfiguration существует только один тип назначения (cloudWatchLogs, firehose или s3).

(структура)

Сводная информация о конфигурации логирования.

arn -> (строка)

ARN конфигурации логирования.

id -> (строка)

Идентификатор конфигурации логирования, сгенерированный системой. Это относительный идентификатор, часть ARN, которая однозначно идентифицирует комнату.

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

Время создания конфигурации логирования. Это временная метка в формате ISO 8601; обратите внимание, что она возвращается в виде строки.

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

Время последнего обновления конфигурации логирования. Это временная метка в формате ISO 8601; обратите внимание, что она возвращается в виде строки.

name -> (строка)

Имя конфигурации логирования. Значение не обязательно должно быть уникальным.

destinationConfiguration -> (структура помеченного союза)

Сложная структура, содержащая конфигурацию назначения, куда будет регистрироваться содержимое чата.

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: s3, cloudWatchLogs, firehose.

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

Конфигурация назначения Amazon S3, куда будет регистрироваться активность чата.

bucketName -> (строка)

Имя ведра Amazon S3, куда будет регистрироваться активность чата.

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

Конфигурация назначения Amazon CloudWatch Logs, куда будет регистрироваться активность чата.

logGroupName -> (строка)

Имя назначения Amazon Cloudwatch Logs, куда будет регистрироваться активность чата.

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

Конфигурация назначения Amazon Kinesis Data Firehose, куда будет регистрироваться активность чата.

deliveryStreamName -> (строка)

Имя потока доставки Amazon Kinesis Firehose, куда будет регистрироваться активность чата.

state -> (строка)

Состояние конфигурации логирования. При значении ACTIVE конфигурация готова для регистрации содержимого чата.

tags -> (массив)

Теги для присоединения к ресурсу. Массив карт, каждая из которых имеет вид string:string (key:value). См. раздел «Рекомендации и стратегии по применению тегов к ресурсам Amazon Web Services и Редактор тегов» для получения дополнительных сведений, включая ограничения, применяемые к тегам и «Пределы и требования к именованию тегов»; в Amazon IVS Chat нет ограничений по тегам, кроме тех, которые описаны там.

key -> (строка)

value -> (строка)

nextToken -> (строка)

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

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

Spec-Zone.ru

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