[ aws . customer-profiles ]
get-matches
Описание
Перед вызовом этого API используйте CreateDomain или UpdateDomain для включения разрешения идентификации: установите Matching в значение true.
GetMatches возвращает потенциально совпадающие профили, основанные на результатах последнего выполнения процесса машинного обучения.
Предупреждение
Процесс сопоставления дублирующих профилей. Если Matching = true, Amazon Connect Customer Profiles запускает еженедельный пакетный процесс под названием Identity Resolution Job. Если вы не укажете дату и время запуска Identity Resolution Job, по умолчанию он запускается каждую субботу в 00:00 UTC для обнаружения дублирующих профилей в ваших доменных зонах.
После завершения Identity Resolution Job используйте API GetMatches для возврата и проверки результатов. Или, если вы настроили ExportingConfig в MatchingRequest, вы можете загрузить результаты из S3.
Amazon Connect использует следующие атрибуты профиля для идентификации совпадений:
- PhoneNumber
- HomePhoneNumber
- BusinessPhoneNumber
- MobilePhoneNumber
- EmailAddress
- PersonalEmailAddress
- BusinessEmailAddress
- FullName
Например, два или более профилей — с ошибками в написании, такими как John Doe и Jhn Doe, или разными регистрами адресов электронной почты, такими как JOHN_DOE@ANYCOMPANY.COM и johndoe@anycompany.com, или разными форматами телефонных номеров, такими как 555-010-0000 и +1-555-010-0000 — могут быть определены как принадлежащие одному клиенту John Doe и объединены в единый профиль.
См. также: Документация AWS API
Синтаксис
get-matches
[--next-token <value>]
[--max-results <value>]
--domain-name <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]
Параметры
--next-token (строка)
--max-results (целое число)
--domain-name (строка)
--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.
Вывод
NextToken -> (строка)
MatchGenerationDate -> (метка времени)
PotentialMatches -> (целое число)
Matches -> (список)
Список сопоставленных профилей для данного экземпляра.
(структура)
Объект группы Match.
MatchId -> (строка)
ProfileIds -> (список)
Список идентификаторов профилей, которые совпадают.
(строка)
ConfidenceScore -> (двойное значение)
© Copyright 2025, Amazon Web Services. Created using Sphinx.