create-campaign

Описание

Создает кампанию для указанной учетной записи Amazon Connect. Данный API идемпотентен.

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

Синтаксис

  create-campaign
--name <value>
--connect-instance-id <value>
--channel-subtype-config <value>
[--source <value>]
[--connect-campaign-flow-arn <value>]
[--schedule <value>]
[--communication-time-config <value>]
[--communication-limits-override <value>]
[--tags <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]

Параметры

--name (строка)

--connect-instance-id (строка)

--channel-subtype-config (структура)

Синтаксис JSON:

{
  "telephony": {
    "capacity": double,
    "connectQueueId": "string",
    "outboundMode": {
      "progressive": {
        "bandwidthAllocation": double
      },
      "predictive": {
        "bandwidthAllocation": double
      },
      "agentless": {

      }
    },
    "defaultOutboundConfig": {
      "connectContactFlowId": "string",
      "connectSourcePhoneNumber": "string",
      "answerMachineDetectionConfig": {
        "enableAnswerMachineDetection": true|false,
        "awaitAnswerMachinePrompt": true|false
      }
    }
  },
  "sms": {
    "capacity": double,
    "outboundMode": {
      "agentless": {

      }
    },
    "defaultOutboundConfig": {
      "connectSourcePhoneNumberArn": "string",
      "wisdomTemplateArn": "string"
    }
  },
  "email": {
    "capacity": double,
    "outboundMode": {
      "agentless": {

      }
    },
    "defaultOutboundConfig": {
      "connectSourceEmailAddress": "string",
      "sourceEmailAddressDisplayName": "string",
      "wisdomTemplateArn": "string"
    }
  }
}

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

Сокращенный синтаксис:

customerProfilesSegmentArn=string,eventTrigger={customerProfilesDomainArn=string}

Синтаксис JSON:

{
  "customerProfilesSegmentArn": "string",
  "eventTrigger": {
    "customerProfilesDomainArn": "string"
  }
}

--connect-campaign-flow-arn (строка)

--schedule (структура)

Сокращенный синтаксис:

startTime=timestamp,endTime=timestamp,refreshFrequency=string

Синтаксис JSON:

{
  "startTime": timestamp,
  "endTime": timestamp,
  "refreshFrequency": "string"
}

--communication-time-config (структура)

Синтаксис JSON:

{
  "localTimeZoneConfig": {
    "defaultTimeZone": "string",
    "localTimeZoneDetection": ["ZIP_CODE"|"AREA_CODE", ...]
  },
  "telephony": {
    "openHours": {
      "dailyHours": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
            {
              "startTime": "string",
              "endTime": "string"
            }
            ...
          ]
        ...}
    },
    "restrictedPeriods": {
      "restrictedPeriodList": [
        {
          "name": "string",
          "startDate": "string",
          "endDate": "string"
        }
        ...
      ]
    }
  },
  "sms": {
    "openHours": {
      "dailyHours": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
            {
              "startTime": "string",
              "endTime": "string"
            }
            ...
          ]
        ...}
    },
    "restrictedPeriods": {
      "restrictedPeriodList": [
        {
          "name": "string",
          "startDate": "string",
          "endDate": "string"
        }
        ...
      ]
    }
  },
  "email": {
    "openHours": {
      "dailyHours": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
            {
              "startTime": "string",
              "endTime": "string"
            }
            ...
          ]
        ...}
    },
    "restrictedPeriods": {
      "restrictedPeriodList": [
        {
          "name": "string",
          "startDate": "string",
          "endDate": "string"
        }
        ...
      ]
    }
  }
}

--communication-limits-override (структура)

Синтаксис JSON:

{
  "allChannelSubtypes": {
    "communicationLimitsList": [
      {
        "maxCountPerRecipient": integer,
        "frequency": integer,
        "unit": "DAY"
      }
      ...
    ]
  }
}

--tags (отображение)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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.

Вывод

id -> (строка)

arn -> (строка)

tags -> (карта)