create-domain

Описание

Создает домен, который является контейнером для всех данных клиента, таких как атрибуты профиля клиента, типы объектов, ключи профиля и ключи шифрования. Вы можете создать несколько доменов, и каждый домен может иметь несколько интеграций сторонних производителей.

Каждый экземпляр Amazon Connect может быть связан только с одним доменом. Несколько экземпляров Amazon Connect могут быть связаны с одним доменом.

Используйте этот API или UpdateDomain для включения идентификации личности: установите Matching в значение true.

Чтобы предотвратить межсервисную имитацию при вызове этого API, см. Предотвращение межсервисной имитации confused deputy для примеров политик, которые следует применить.

Примечание

Невозможно напрямую связать домен Customer Profiles с экземпляром Amazon Connect из API. Если вы хотите создать домен и связать домен Customer Profiles, воспользуйтесь веб-сайтом администратора Amazon Connect. Дополнительную информацию см. в разделе Включить Customer Profiles.

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

Синопсис

  create-domain
--domain-name <value>
--default-expiration-days <value>
[--default-encryption-key <value>]
[--dead-letter-queue-url <value>]
[--matching <value>]
[--rule-based-matching <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]

Параметры

--domain-name (строка)

Уникальное имя домена.

--default-expiration-days (целое число)

Установленное по умолчанию число дней до истечения срока действия данных в домене.

--default-encryption-key (строка)

Ключ шифрования по умолчанию, управляемый AWS, используется, когда не указан конкретный тип ключа шифрования. Он используется для шифрования всех данных перед их размещением в постоянном или полупостоянном хранилище.

--dead-letter-queue-url (строка)

URL очереди сообщений SQS для обработки ошибок при получении данных из сторонних приложений. Необходимо задать политику на очереди DeadLetterQueue для операции SendMessage, чтобы Amazon Connect Customer Profiles могли отправлять сообщения в DeadLetterQueue.

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

Процесс сопоставления дублирующих профилей. Если Matching = true, Amazon Connect Customer Profiles запускает еженедельный пакетный процесс под названием Identity Resolution Job. Если вы не укажете дату и время запуска Identity Resolution Job, по умолчанию он запускается каждую субботу в 12:00 по UTC, чтобы обнаруживать дублирующиеся профили в ваших доменах.

После завершения Identity Resolution Job используйте API GetMatches для возврата и проверки результатов. Или, если вы настроили ExportingConfig в MatchingRequest, вы можете загрузить результаты из S3.

Enabled -> (булево)

Флаг, который включает процесс сопоставления дублирующих профилей.

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

День и время запуска Identity Resolution Job каждую неделю.

DayOfTheWeek -> (строка)

День недели, когда должен запускаться Identity Resolution Job.

Time -> (строка)

Время запуска Identity Resolution Job каждую неделю.

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

Конфигурационная информация о процессе автоматического слияния.

Enabled -> (булево)

Флаг, который включает автоматическое слияние дублирующих профилей.

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

Список сопоставляемых атрибутов, которые представляют критерии сопоставления. Если два профиля соответствуют хотя бы одному из требований в списке сопоставляемых атрибутов, они будут объединены.

MatchingAttributesList -> (список)

Список критериев сопоставления.

(список)

(строка)

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

Как процесс автоматического слияния должен разрешать конфликты между различными профилями. Например, если профиль A и профиль B имеют одинаковые FirstName и LastName (и это критерии сопоставления), какой EmailAddress следует использовать?

ConflictResolvingModel -> (строка)

Как процесс автоматического слияния должен разрешать конфликты между различными профилями.

RECENCY: Использует данные, которые были обновлены последними.
SOURCE: Использует данные из определенного источника. Например, если компания была приобретена или два отдела слились, используются данные из указанного источника. Если два дублирующих профиля из одного источника, то RECENCY используется снова.

SourceName -> (строка)

Имя ObjectType, которое используется для разрешения конфликтов при слиянии профилей, когда выбран SOURCE в качестве ConflictResolvingModel.

MinAllowedConfidenceScoreForMerging -> (двойное)

Число от 0 до 1, представляющее минимальный балл уверенности, необходимый для слияния профилей в группе совпадений во время процесса автоматического слияния. Более высокий балл означает более высокую требуемую схожесть для слияния профилей.

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

Конфигурационная информация для экспорта результатов Identity Resolution, например, в ведро S3.

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

Расположение S3, куда Identity Resolution Jobs записывают файлы результатов.

S3BucketName -> (строка)

Имя ведра S3, куда Identity Resolution Jobs записывают файлы результатов.

S3KeyName -> (строка)

Имя ключа S3 расположения, куда Identity Resolution Jobs записывают файлы результатов.

Синтаксис JSON:

{
  "Enabled": true|false,
  "JobSchedule": {
    "DayOfTheWeek": "SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY",
    "Time": "string"
  },
  "AutoMerging": {
    "Enabled": true|false,
    "Consolidation": {
      "MatchingAttributesList": [
        ["string", ...]
        ...
      ]
    },
    "ConflictResolution": {
      "ConflictResolvingModel": "RECENCY"|"SOURCE",
      "SourceName": "string"
    },
    "MinAllowedConfidenceScoreForMerging": double
  },
  "ExportingConfig": {
    "S3Exporting": {
      "S3BucketName": "string",
      "S3KeyName": "string"
    }
  }
}

--rule-based-matching (структура)

Процесс сопоставления дублирующих профилей с использованием сопоставления по правилам. Если RuleBasedMatching = true, Amazon Connect Customer Profiles начнёт сопоставлять и объединять ваши профили в соответствии с вашей конфигурацией в RuleBasedMatchingRequest. Вы можете использовать API ListRuleBasedMatches и GetSimilarProfiles для возврата и проверки результатов. Кроме того, если вы настроили ExportingConfig в RuleBasedMatchingRequest, вы можете загрузить результаты из S3.

Enabled -> (булево)

Флаг, который включает процесс сопоставления дублирующих профилей по правилам.

MatchingRules -> (список)

Настраивает, как процесс сопоставления по правилам должен сопоставлять профили. Вы можете иметь до 15 MatchingRule в MatchingRules.

(структура)

Указывает, как процесс сопоставления по правилам должен сопоставлять профили. Вы можете выбрать следующие атрибуты для построения правила сопоставления:

AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Любые настроенные атрибуты профиля, начинающиеся с Attributes

Rule -> (список)

Один уровень правил MatchRules. Настраивает, как процесс сопоставления по правилам должен сопоставлять профили.

(строка)

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

MatchingRule

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

Указывает максимальный разрешенный уровень правил.

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

Настраивает информацию о AttributeTypesSelector, где процесс сопоставления по правилам использует для сопоставления профилей.

AttributeMatchingModel -> (строка)

Настраивает AttributeMatchingModel, вы можете выбрать ONE_TO_ONE или MANY_TO_MANY.

Address -> (список)

Тип Address. Вы можете выбрать Address, BusinessAddress, MaillingAddress и ShippingAddress.

Вы можете использовать тип Address только в MatchingRule. Например, если вы хотите сопоставить профили на основе BusinessAddress.City или MaillingAddress.City, вам нужно выбрать BusinessAddress и MaillingAddress для представления типа Address и указать Address.City в правиле сопоставления.

(строка)

PhoneNumber -> (список)

Тип PhoneNumber. Вы можете выбрать PhoneNumber, HomePhoneNumber и MobilePhoneNumber.

Вы можете использовать тип PhoneNumber только в MatchingRule. Например, если вы хотите сопоставить профиль по Phone или HomePhone, вам нужно выбрать Phone и HomePhone для представления типа PhoneNumber и указать только PhoneNumber в правиле сопоставления.

(строка)

EmailAddress -> (список)

Тип Email. Вы можете выбрать EmailAddress, BusinessEmailAddress и PersonalEmailAddress.

Вы можете использовать тип EmailAddress только в MatchingRule. Например, если вы хотите сопоставить профиль по PersonalEmailAddress или BusinessEmailAddress, вам нужно выбрать PersonalEmailAddress и BusinessEmailAddress для представления типа EmailAddress и указать только EmailAddress в правиле сопоставления.

(строка)

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

Как процесс автоматического слияния должен разрешать конфликты между различными профилями.

ConflictResolvingModel -> (строка)

Как процесс автоматического слияния должен разрешать конфликты между различными профилями.

RECENCY: Использует данные, которые были обновлены последними.
SOURCE: Использует данные из определенного источника. Например, если компания была приобретена или два отдела слились, используются данные из указанного источника. Если два дублирующих профиля из одного источника, то RECENCY используется снова.

SourceName -> (строка)

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

Конфигурационная информация о ведре S3, куда Identity Resolution Jobs записывают файлы результатов.

Примечание

Необходимо предоставить принципалу службы Customer Profiles разрешение на запись в ваше ведро S3. В противном случае вы получите исключение в ответе API. Пример политики см. в разделе Amazon Connect Customer Profiles — предотвращение ошибок двойного доверия между службами.

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

Расположение S3, куда Identity Resolution Jobs записывают файлы результатов.

S3BucketName -> (строка)

Имя ведра S3, куда Identity Resolution Jobs записывают файлы результатов.

S3KeyName -> (строка)

Имя ключа S3 расположения, куда Identity Resolution Jobs записывают файлы результатов.

Синтаксис JSON:

{
  "Enabled": true|false,
  "MatchingRules": [
    {
      "Rule": ["string", ...]
    }
    ...
  ],
  "MaxAllowedRuleLevelForMerging": integer,
  "MaxAllowedRuleLevelForMatching": integer,
  "AttributeTypesSelector": {
    "AttributeMatchingModel": "ONE_TO_ONE"|"MANY_TO_MANY",
    "Address": ["string", ...],
    "PhoneNumber": ["string", ...],
    "EmailAddress": ["string", ...]
  },
  "ConflictResolution": {
    "ConflictResolvingModel": "RECENCY"|"SOURCE",
    "SourceName": "string"
  },
  "ExportingConfig": {
    "S3Exporting": {
      "S3BucketName": "string",
      "S3KeyName": "string"
    }
  }
}

--tags (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

Упрощённый синтаксис:

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

Вывод

DomainName -> (строка)

Уникальное имя домена.

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

Установленное количество дней, по истечении которых данные в домене истекают.

DefaultEncryptionKey -> (строка)

Ключ шифрования по умолчанию, управляемый AWS, используется, когда не указан конкретный ключ шифрования. Он используется для шифрования всех данных перед размещением их в постоянном или полупостоянном хранилище.

DeadLetterQueueUrl -> (строка)

URL очереди сообщений о событиях с ошибками (SQS) для отчетов об ошибках, связанных с загрузкой данных из сторонних приложений.

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

Процесс сопоставления дублирующих профилей. Если Matching = true, Amazon Connect Customer Profiles запускает еженедельный пакетный процесс под названием «Задание сопоставления идентичностей». Если вы не задаете дату и время запуска Задания сопоставления идентичностей, по умолчанию оно запускается каждую субботу в 00:00 UTC для обнаружения дублирующих профилей в ваших доменах.

После завершения Задания сопоставления идентичностей используйте API GetMatches для возвращения и проверки результатов. Либо, если вы настроили ExportingConfig в MatchingRequest, вы можете загрузить результаты из S3.

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

Флаг, включающий процесс сопоставления дублирующих профилей.

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

День и время запуска Задания сопоставления идентичностей каждую неделю.

DayOfTheWeek -> (строка)

День недели, когда должно выполняться Задание сопоставления идентичностей.

Time -> (строка)

Время, когда должно выполняться Задание сопоставления идентичностей.

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

Конфигурационная информация о процессе автоматического слияния.

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

Флаг, включающий автоматическое слияние дублирующих профилей.

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

Список сопоставляемых атрибутов, представляющих критерии сопоставления. Если два профиля соответствуют хотя бы одному требованию в списке сопоставляемых атрибутов, они будут объединены.

MatchingAttributesList -> (список)

Список критериев сопоставления.

(список)

(строка)

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

Как процесс автоматического слияния должен разрешать конфликты между различными профилями. Например, если у профиля A и профиля B одинаковые FirstName и LastName (и это критерии сопоставления), какой EmailAddress следует использовать?

ConflictResolvingModel -> (строка)

Как процесс автоматического слияния должен разрешать конфликты между различными профилями.

RECENCY: Использует данные, которые были обновлены наиболее недавно.
SOURCE: Использует данные из определенного источника. Например, если компания была приобретена или два отдела слились, используются данные из указанного источника. Если два дублирующих профиля из одного источника, то RECENCY используется повторно.

SourceName -> (строка)

Имя ObjectType, используемое для разрешения конфликтов при слиянии профилей при выборе SOURCE в качестве ConflictResolvingModel.

MinAllowedConfidenceScoreForMerging -> (двойное)

Число от 0 до 1, представляющее минимальный балл уверенности, необходимый для слияния профилей в группе сопоставления во время процесса автоматического слияния. Более высокий балл означает более высокую степень сходства, необходимую для слияния профилей.

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

Конфигурационная информация для экспорта результатов сопоставления идентичностей, например, в ведро S3.

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

Расположение S3, куда задания сопоставления идентичностей записывают файлы результатов.

S3BucketName -> (строка)

Имя ведра S3, куда задания сопоставления идентичностей записывают файлы результатов.

S3KeyName -> (строка)

Имя ключа S3 расположения, куда задания сопоставления идентичностей записывают файлы результатов.

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

Процесс сопоставления дублирующих профилей с помощью правила-ориентированного сопоставления. Если RuleBasedMatching = true, Amazon Connect Customer Profiles начнет сопоставлять и объединять ваши профили в соответствии с вашей конфигурацией в RuleBasedMatchingRequest. Вы можете использовать API ListRuleBasedMatches и GetSimilarProfiles для возвращения и проверки результатов. Кроме того, если вы настроили ExportingConfig в RuleBasedMatchingRequest, вы можете загрузить результаты из S3.

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

Флаг, включающий процесс правило-ориентированного сопоставления дублирующих профилей.

MatchingRules -> (список)

Настраивает, как процесс правило-ориентированного сопоставления должен сопоставлять профили. Вы можете иметь до 15 MatchingRule в MatchingRules.

(структура)

Указывает, как процесс правило-ориентированного сопоставления должен сопоставлять профили. Вы можете выбрать следующие атрибуты для построения правила сопоставления:

AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Любые настраиваемые атрибуты профиля, начинающиеся с Attributes

Rule -> (список)

Один уровень правил MatchRules. Настраивает, как процесс правило-ориентированного сопоставления должен сопоставлять профили.

(строка)

Status -> (строка)

PENDING

Первый статус после настройки правила правило-ориентированного сопоставления. Если это существующий домен, правило-ориентированное сопоставление идентичностей ожидает один час перед созданием правила сопоставления. Если это новый домен, система пропустит этап PENDING.

IN_PROGRESS

Система создает правило правило-ориентированного сопоставления. На этом статусе система оценивает существующие данные, и вы больше не можете изменить конфигурацию правило-ориентированного сопоставления.

ACTIVE

Правило готово к использованию. Вы можете изменить правило через день после того, как статус станет ACTIVE.

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

MatchingRule

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

Указывает максимальный разрешенный уровень правил.

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

Настраивает информацию о AttributeTypesSelector, где правило-ориентированное сопоставление идентичностей использует для сопоставления профилей.

AttributeMatchingModel -> (строка)

Настраивает AttributeMatchingModel, вы можете выбрать ONE_TO_ONE или MANY_TO_MANY.

Address -> (список)

Тип Address. Вы можете выбрать Address, BusinessAddress, MaillingAddress и ShippingAddress.

Вы можете использовать тип Address только в MatchingRule. Например, если вы хотите сопоставить профиль на основе BusinessAddress.City или MaillingAddress.City, вам нужно выбрать BusinessAddress и MaillingAddress для представления типа Address и указать Address.City в правиле сопоставления.

(строка)

PhoneNumber -> (список)

Тип PhoneNumber. Вы можете выбрать PhoneNumber, HomePhoneNumber и MobilePhoneNumber.

Вы можете использовать тип PhoneNumber только в MatchingRule. Например, если вы хотите сопоставить профиль по Phone или HomePhone, вам нужно выбрать Phone и HomePhone, чтобы представить тип PhoneNumber, и указать только PhoneNumber в правиле сопоставления.

(строка)

EmailAddress -> (список)

Тип Email. Вы можете выбрать EmailAddress, BusinessEmailAddress и PersonalEmailAddress.

Вы можете использовать тип EmailAddress только в MatchingRule. Например, если вы хотите сопоставить профиль по PersonalEmailAddress или BusinessEmailAddress, вам нужно выбрать PersonalEmailAddress и BusinessEmailAddress, чтобы представить тип EmailAddress, и указать только EmailAddress в правиле сопоставления.

(строка)

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

Как процесс автоматического слияния должен разрешать конфликты между различными профилями.

ConflictResolvingModel -> (строка)

Как процесс автоматического слияния должен разрешать конфликты между различными профилями.

RECENCY: Использует данные, которые были обновлены наиболее недавно.
SOURCE: Использует данные из определенного источника. Например, если компания была приобретена или два отдела слились, используются данные из указанного источника. Если два дублирующих профиля из одного источника, то RECENCY используется повторно.

SourceName -> (строка)

Имя ObjectType, используемое для разрешения конфликтов при слиянии профилей, когда выбран SOURCE в качестве ConflictResolvingModel.

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

Конфигурационная информация о ведре S3, куда задания сопоставления идентичностей записывают файлы результатов.

Примечание

Вам необходимо предоставить принципалу службы Customer Profiles право записи в ваше ведро S3. В противном случае вы получите исключение в ответе API. Пример политики см. в разделе предотвращение конфликтных ситуаций с несколькими службами в Amazon Connect Customer Profiles.

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

Расположение S3, куда задания сопоставления идентичностей записывают файлы результатов.

S3BucketName -> (строка)

Имя ведра S3, куда задания сопоставления идентичностей записывают файлы результатов.

S3KeyName -> (строка)

Имя ключа S3 расположения, куда задания сопоставления идентичностей записывают файлы результатов.

CreatedAt -> (отметка времени)

Отметка времени создания домена.

LastUpdatedAt -> (отметка времени)

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

Tags -> (карта)

Теги, используемые для организации, отслеживания или управления доступом к данному ресурсу.

key -> (строка)

value -> (строка)