Spec-Zone.ru › AWS CLI v2

[ aws . ivschat ]

обновить-настройку-вещания

Описание

Обновляет указанную настройку вещания.

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

Синтаксис

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

Идентификатор конфигурации вещания, который нужно обновить.

--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"
  }
}

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

Примеры

Примечание

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

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

Для обновления конфигурации вещания комнаты

Следующий update-logging-configuration пример обновляет ресурс LoggingConfiguration с заданными данными.

aws ivschat update-logging-configuration \
    --destination-configuration s3={bucketName=demo-logging-bucket} \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --name "test-logging-config"

Вывод:

{
    "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 -> (строка)

Идентификатор конфигурации вещания, сгенерированный системой. Это относительный идентификатор, часть 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