Spec-Zone.ru › AWS CLI v2

[ aws . chatbot ]

описание-настроек-каналов-slack

Описание

Перечисляет конфигурации каналов Slack, необязательно отфильтрованные по ChatConfigurationArn

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

describe-slack-channel-configurations является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: SlackChannelConfigurations

Синтаксис

  describe-slack-channel-configurations
[--chat-configuration-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--chat-configuration-arn (строка)

Необязательный Amazon Resource Name (ARN) SlackChannelConfiguration для описания.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания места начала постраничной обработки. Это NextToken из ранее укороченного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

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

Вывод

NextToken -> (строка)

Необязательный токен, возвращенный предыдущим запросом. Используйте этот токен для постраничной обработки результатов этого действия. Если этот параметр указан, в ответе содержатся только результаты за этим токеном, до значения, указанного параметром MaxResults.

SlackChannelConfigurations -> (список)

Список конфигураций каналов Slack.

(структура)

Конфигурация AWS Chatbot для Slack.

SlackTeamName -> (строка)

Название рабочей области Slack.

SlackTeamId -> (строка)

Идентификатор рабочей области Slack, авторизованной с Amazon Chime.

SlackChannelId -> (строка)

Идентификатор канала Slack.

Чтобы получить этот идентификатор, откройте Slack, щелкните правой кнопкой мыши по имени канала в левой панели, а затем выберите Копировать ссылку. Идентификатор канала — это 9-значная строка в конце URL-адреса. Например, ABCBBLZZZ.

SlackChannelName -> (строка)

Имя канала Slack.

ChatConfigurationArn -> (строка)

Amazon Resource Name (ARN) SlackChannelConfiguration.

IamRoleArn -> (строка)

Определяемая пользователем роль, которую принимает AWS Chatbot. Это не служба-связанная роль.

Дополнительную информацию см. в разделе Политики IAM для AWS Chatbot в Руководстве администратора AWS Chatbot.

SnsTopicArns -> (список)

ARN тем SNS, которые отправляют уведомления в AWS Chatbot.

(строка)

ConfigurationName -> (строка)

Имя конфигурации.

LoggingLevel -> (строка)

Уровни ведения журналов включают ERROR , INFO или NONE.

GuardrailPolicyArns -> (список)

Список ARN политик IAM, которые применяются в качестве ограждений канала. AWS управляемая политика AdministratorAccess применяется по умолчанию, если это не задано.

(строка)

UserAuthorizationRequired -> (булево)

Включает требование использования роли пользователя в вашей конфигурации чата.

Tags -> (список)

Карта тегов, назначенных ресурсу. Тег — это строковая карта пар ключ-значение.

(структура)

Пара ключ-значение. Тег состоит из ключа тега и значения тега. Ключи и значения тегов обязательны, но значения тегов могут быть пустыми (нулевыми) строками.

Предупреждение

Не включайте конфиденциальную или чувствительную информацию в это поле.

Дополнительную информацию см. в разделе Ограничения тегов, определенных пользователем, в Руководстве пользователя AWS Billing and Cost Management.

TagKey -> (строка)

Ключ тега.

TagValue -> (строка)

Значение тега.

State -> (строка)

Либо ENABLED или DISABLED. Ресурс возвращает DISABLED, если политика AWS Chatbot организации явно запретила эту конфигурацию. Например, если Amazon Chime отключен.

StateReason -> (строка)

Предоставляется, если State равен DISABLED. Предоставляет контекст причины, по которой ресурс отключен.

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

Spec-Zone.ru

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