Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

describe-channel

Описание

Возвращает полные данные канала в Amazon Chime AppInstance.

Примечание

Заголовок запроса x-amz-chime-bearer обязателен. Используйте ARN AppInstanceUser или AppInstanceBot, выполняющего вызов API, в качестве значения в заголовке.

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

Синтаксис

  describe-channel
--channel-arn <value>
--chime-bearer <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]

Параметры

--channel-arn (строка)

ARN канала.

--chime-bearer (строка)

ARN AppInstanceUser или AppInstanceBot, выполняющего вызов API.

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

Вывод

Канал -> (структура)

Подробные данные канала.

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

Имя канала.

ChannelArn -> (строка)

ARN канала.

Режим -> (строка)

Режим канала.

Конфиденциальность -> (строка)

Настройки конфиденциальности канала.

Метаданные -> (строка)

Метаданные канала.

Создано -> (структура)

AppInstanceUser, создавший канал.

Arn -> (строка)

ARN в удостоверении.

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

Имя в удостоверении.

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

Время, когда AppInstanceUser создал канал.

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

Время, когда член отправил последнее сообщение в канале.

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

Время последнего обновления канала.

ChannelFlowArn -> (строка)

ARN потока канала.

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

Атрибуты, необходимые для настройки и создания канала с динамической (эластичной) емкостью. Эластичный канал может поддерживать максимум 1 миллион участников.

MaximumSubChannels -> (целое число)

Максимальное количество дочерних каналов, которые вы хотите разрешить в эластичном канале.

TargetMembershipsPerSubChannel -> (целое число)

Максимальное количество участников, разрешенных в дочернем канале.

MinimumMembershipPercentage -> (целое число)

Минимальный разрешенный процент пользователей TargetMembershipsPerSubChannel. Используется потолок вычисленного значения для балансировки участников среди дочерних каналов эластичного канала.

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

Настройки, контролирующие время истечения срока действия канала.

ExpirationDays -> (целое число)

Срок в днях, после которого система автоматически удаляет канал.

ExpirationCriterion -> (строка)

Условия, которые должны быть выполнены для истечения срока действия канала.

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

Spec-Zone.ru

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