Spec-Zone.ru › AWS CLI v2

[ aws . ivschat ]

получить-конфигурацию-логирования

Описание

Получает указанную конфигурацию логирования.

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

Синтаксис

  get-logging-configuration
--identifier <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]

Параметры

--identifier (строка)

Идентификатор конфигурации логирования для получения.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Для получения информации о ресурсе LoggingConfiguration

Следующий get-logging-configuration пример получает информацию о ресурсе LoggingConfiguration для указанного ARN.

aws ivschat get-logging-configuration \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"

Вывод:

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

Вывод

arn -> (строка)

ARN конфигурации логирования из запроса (если identifier был ARN).

id -> (строка)

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

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

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

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

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

name -> (строка)

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

destinationConfiguration -> (структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: 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).

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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