Spec-Zone.ru › AWS CLI v2

[ aws . ivschat ]

создание-конфигурации-логирования

Описание

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

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

Синтаксис

  create-logging-configuration
[--name <value>]
--destination-configuration <value>
[--tags <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 (строка)

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

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

Сложный тип, содержащий конфигурацию назначения, где будет регистрироваться содержимое чата. В конфигурации может быть только один тип назначения (cloudWatchLogs , firehose или s3) в 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, где будет регистрироваться активность чата.

Сокращённый синтаксис:

s3={bucketName=string},cloudWatchLogs={logGroupName=string},firehose={deliveryStreamName=string}

Синтаксис JSON:

{
  "s3": {
    "bucketName": "string"
  },
  "cloudWatchLogs": {
    "logGroupName": "string"
  },
  "firehose": {
    "deliveryStreamName": "string"
  }
}

--tags (массив)

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

key -> (строка)

value -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для создания ресурса LoggingConfiguration чата

Следующий create-logging-configuration пример создаёт ресурс LoggingConfiguration, который позволяет клиентам хранить и записывать отправленные сообщения.

aws ivschat create-logging-configuration \
    --destination-configuration s3={bucketName=demo-logging-bucket} \
    --name "test-logging-config" \
    --tags "key1=value1, key2=value2"

Вывод:

{
    "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 конфигурации логирования, назначенный системой.

id -> (строка)

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

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

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

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

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

name -> (строка)

Имя конфигурации логирования из запроса (если указано).

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

Сложный тип, содержащий конфигурацию назначения, где будет регистрироваться содержимое чата, из запроса. В конфигурации имеется только один тип назначения (cloudWatchLogs, firehose или s3) в 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).

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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