Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

получить-задание-распознавания-идентичности

Описание

Возвращает информацию о задании распознавания идентичности в определённом домене.

Задачи распознавания идентичности создаются с помощью консоли администрирования Amazon Connect. Дополнительную информацию см. в разделе Использование распознавания идентичности для объединения похожих профилей.

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

Синтаксис

  get-identity-resolution-job
--domain-name <value>
--job-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]

Параметры

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

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

--job-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
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, 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 -> (строка)

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

JobId -> (строка)

Уникальный идентификатор задания распознавания идентичности.

Status -> (строка)

Статус задания распознавания идентичности.

  • PENDING : Задание распознавания идентичности запланировано, но ещё не начато. Если вы отключите функцию распознавания идентичности в своём домене, задачи в состоянии PENDING будут удалены.
  • PREPROCESSING : Задание распознавания идентичности загружает ваши данные.
  • FIND_MATCHING : Задание распознавания идентичности использует модель машинного обучения для определения профилей, принадлежащих одной группе соответствия.
  • MERGING : Задание распознавания идентичности объединяет дублирующие профили.
  • COMPLETED : Задание распознавания идентичности успешно завершено.
  • PARTIAL_SUCCESS : Возникла системная ошибка, и не все данные объединены. Задание распознавания идентичности записывает сообщение, указывающее причину проблемы.
  • FAILED : Задание распознавания идентичности не объединило никаких данных. Оно записывает сообщение, указывающее причину проблемы.

Message -> (строка)

Сообщения об ошибках, которые генерируются при выполнении задания распознавания идентичности.

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

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

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

Метка времени завершения задания распознавания идентичности.

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

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

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

Метка времени истечения срока действия задания распознавания идентичности.

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

Параметры конфигурации для автоматического объединения профилей.

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

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

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

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

MatchingAttributesList -> (список)

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

(список)

(строка)

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

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

ConflictResolvingModel -> (строка)

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

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

SourceName -> (строка)

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

MinAllowedConfidenceScoreForMerging -> (двойное число)

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

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

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

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

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

S3BucketName -> (строка)

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

S3KeyName -> (строка)

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

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

Статистика задания распознавания идентичности.

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

Количество проверенных профилей.

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

Количество найденных соответствий.

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

Количество завершённых объединений.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API