update-domain

Описание

Обновляет свойства домена, включая создание или выбор очереди обработки сообщений с истекшим сроком действия или ключа шифрования.

После создания домена его имя изменить нельзя.

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

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

Чтобы добавить или удалить теги существующего домена, см. TagResource /UntagResource.

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

Синтаксис

  update-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 dead letter queue), используемой для отчётов об ошибках, связанных с загрузкой данных из сторонних приложений. Если указана пустая строка, любое существующее значение будет очищено. Необходимо настроить политику для операции SendMessage на очереди DeadLetterQueue, чтобы Amazon Connect Customer Profiles мог отправлять сообщения в DeadLetterQueue.

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

Процесс сопоставления дублирующих профилей. Если Matching = true, Amazon Connect Customer Profiles запускает еженедельный пакетный процесс под названием Identity Resolution Job. Если вы не укажете дату и время для запуска Identity Resolution Job, по умолчанию он запускается каждую субботу в 00: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 prevention of cross-service confused deputy.

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
текст
таблица
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.

Вывод

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 -> (строка)

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

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

Примечание

Необходимо предоставить сервисному принципалу Customer Profiles разрешение на запись в ваше ведро S3. В противном случае вы получите исключение в ответе API. Пример политики см. в документе Amazon Connect Customer Profiles cross-service confused deputy prevention.

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

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

S3BucketName -> (строка)

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

S3KeyName -> (строка)

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

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

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

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

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

Tags -> (карта)

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

key -> (строка)

value -> (строка)

END_OF_DOCUMENT_MARKER