[ aws . connectcampaignsv2 ]
describe-campaign
Описание
Описывает конкретную кампанию.
См. также: AWS API Documentation
Синтаксис
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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Регион для использования. Перекрывает настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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 -> (строка)
name -> (строка)
connectInstanceId -> (строка)
channelSubtypeConfig -> (структура)
Настройка типа подтипов каналов кампании
telephony -> (структура)
Настройка типа подтипов каналов телефонии
capacity -> (двойное число)
connectQueueId -> (строка)
outboundMode -> (структура помеченного объединения)
Исходящий режим телефонии
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:progressive, predictive, agentless.progressive -> (структура)
Настройка прогрессивного режима
bandwidthAllocation -> (двойное число)
predictive -> (структура)
Настройка предиктивного режима
bandwidthAllocation -> (двойное число)
agentless -> (структура)
defaultOutboundConfig -> (структура)
Настройка исходящего режима телефонии по умолчанию
connectContactFlowId -> (строка)
connectSourcePhoneNumber -> (строка)
answerMachineDetectionConfig -> (структура)
Настройка обнаружения автоответчика
enableAnswerMachineDetection -> (булево значение)
awaitAnswerMachinePrompt -> (булево значение)
sms -> (структура)
Настройка типа подтипа канала SMS
capacity -> (двойное число)
outboundMode -> (структура помеченного объединения)
Исходящий режим SMS
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:agentless.agentless -> (структура)
defaultOutboundConfig -> (структура)
Настройка исходящего режима SMS по умолчанию
connectSourcePhoneNumberArn -> (строка)
wisdomTemplateArn -> (строка)
email -> (структура)
Настройка типа подтипа канала электронной почты
capacity -> (двойное число)
outboundMode -> (структура помеченного объединения)
Исходящий режим электронной почты
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:agentless.agentless -> (структура)
defaultOutboundConfig -> (структура)
Настройка исходящего режима электронной почты по умолчанию
connectSourceEmailAddress -> (строка)
sourceEmailAddressDisplayName -> (строка)
wisdomTemplateArn -> (строка)
source -> (структура помеченного объединения)
Источник кампании
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:customerProfilesSegmentArn, eventTrigger.customerProfilesSegmentArn -> (строка)
eventTrigger -> (структура)
Триггер события кампании
customerProfilesDomainArn -> (строка)
connectCampaignFlowArn -> (строка)
schedule -> (структура)
График кампании
startTime -> (метка времени)
endTime -> (метка времени)
refreshFrequency -> (строка)
communicationTimeConfig -> (структура)
Настройка времени коммуникации кампании
localTimeZoneConfig -> (структура)
Настройка часового пояса
defaultTimeZone -> (строка)
localTimeZoneDetection -> (список)
Список методов определения часового пояса
(строка)
telephony -> (структура)
Настройка временного интервала
openHours -> (структура помеченного объединения)
Настройка рабочего времени
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:dailyHours.dailyHours -> (массив)
Массив ежедневных часов
key -> (строка)
value -> (список)
Список интервалов времени
(структура)
Интервал времени в формате 24 часов
startTime -> (строка)
endTime -> (строка)
restrictedPeriods -> (структура помеченного объединения)
Настройка ограниченного периода
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:restrictedPeriodList.restrictedPeriodList -> (список)
Список ограниченных периодов
(структура)
Ограниченный период
name -> (строка)
startDate -> (строка)
endDate -> (строка)
sms -> (структура)
Настройка временного интервала
openHours -> (структура помеченного объединения)
Настройка рабочего времени
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:dailyHours.dailyHours -> (массив)
Массив ежедневных часов
key -> (строка)
value -> (список)
Список интервалов времени
(структура)
Интервал времени в формате 24 часов
startTime -> (строка)
endTime -> (строка)
restrictedPeriods -> (структура помеченного объединения)
Настройка ограниченного периода
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:restrictedPeriodList.restrictedPeriodList -> (список)
Список ограниченных периодов
(структура)
Ограниченный период
name -> (строка)
startDate -> (строка)
endDate -> (строка)
email -> (структура)
Настройка временного интервала
openHours -> (структура помеченного объединения)
Настройка рабочего времени
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:dailyHours.dailyHours -> (массив)
Массив ежедневных часов
key -> (строка)
value -> (список)
Список интервалов времени
(структура)
Интервал времени в формате 24 часов
startTime -> (строка)
endTime -> (строка)
restrictedPeriods -> (структура помеченного объединения)
Настройка ограниченного периода
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:restrictedPeriodList.restrictedPeriodList -> (список)
Список ограниченных периодов
(структура)
Ограниченный период
name -> (строка)
startDate -> (строка)
endDate -> (строка)
communicationLimitsOverride -> (структура)
Настройка ограничений коммуникации
allChannelSubtypes -> (структура помеченного объединения)
Ограничения коммуникации
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:communicationLimitsList.communicationLimitsList -> (список)
Список ограничений коммуникации
(структура)
Предел коммуникации
maxCountPerRecipient -> (целое число)
frequency -> (целое число)
unit -> (строка)
tags -> (массив)
Массив тегов с ключом и значением.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.