Spec-Zone.ru › AWS CLI v2

[ aws . connectcampaigns ]

описание-кампании

Описание

Описывает конкретную кампанию.

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

Синтаксис

  describe-campaign
--id <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]

Параметры

--id (строка)

Идентификатор, представляющий кампанию

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

Вывод

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

Кампания Amazon Connect.

id -> (строка)

Идентификатор, представляющий кампанию

arn -> (строка)

Имя ресурса кампании Amazon Connect.

name -> (строка)

Название кампании Amazon Connect.

connectInstanceId -> (строка)

Идентификатор экземпляра Amazon Connect

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

Возможные типы параметров конфигурации диаллера

Примечание

Это структура помеченного объединения. Может быть установлен только один из следующих верхних ключей: progressiveDialerConfig, predictiveDialerConfig, agentlessDialerConfig.

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

Конфигурация Progressive Dialer

bandwidthAllocation -> (вещественное число)

Распределение полосы пропускания ресурса очереди.

dialingCapacity -> (вещественное число)

Распределяет емкость набора для этой кампании между несколькими активными кампаниями.

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

Конфигурация Predictive Dialer

bandwidthAllocation -> (вещественное число)

Распределение полосы пропускания ресурса очереди.

dialingCapacity -> (вещественное число)

Распределяет емкость набора для этой кампании между несколькими активными кампаниями.

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

Конфигурация Agentless Dialer

dialingCapacity -> (вещественное число)

Распределяет емкость набора для этой кампании между несколькими активными кампаниями.

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

Настройка, используемая для исходящих звонков.

connectContactFlowId -> (строка)

Идентификатор контактного потока для исходящего звонка.

connectSourcePhoneNumber -> (строка)

Номер телефона, связанный с экземпляром Amazon Connect, в формате E.164. Если вы не указываете номер исходного телефона, вы должны указать очередь.

connectQueueId -> (строка)

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

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

Настройка обнаружения голосового почтового ящика

enableAnswerMachineDetection -> (логическое значение)

Включить или отключить обнаружение голосового почтового ящика

awaitAnswerMachinePrompt -> (логическое значение)

Включить или отключить ожидание ответа голосового почтового ящика

tags -> (карта)

Карта тегов с ключом и значением.

key -> (строка)

Ключ тега.

value -> (строка)

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

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

Spec-Zone.ru

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