Spec-Zone.ru › AWS CLI v2

[ aws . entityresolution ]

обновить-поток-сопоставления

Описание

Обновляет существующий MatchingWorkflow. Этот метод идентичен CreateMatchingWorkflow, за исключением того, что он использует HTTP-PUT-запрос вместо POST-запроса, и MatchingWorkflow должен уже существовать для успешного выполнения метода.

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

update-matching-workflow использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  update-matching-workflow
--workflow-name <value>
[--description <value>]
--input-source-config <value>
--output-source-config <value>
--resolution-techniques <value>
[--incremental-run-config <value>]
--role-arn <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]

Опции

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

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

--description (строка)

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

--input-source-config (список)

Список объектов InputSource, имеющих поля InputSourceARN и SchemaName.

(структура)

Объект, содержащий InputSourceARN, SchemaName и ApplyNormalization.

inputSourceARN -> (строка)

Amazon Resource Name (ARN) таблицы Glue для таблицы входных данных.

schemaName -> (строка)

Имя схемы, которую нужно получить.

applyNormalization -> (булево значение)

Нормализует атрибуты, определённые в схеме, в входных данных. Например, если атрибут имеет AttributeType значение PHONE_NUMBER, а данные в входной таблице имеют формат 1234567890, Entity Resolution нормализует это поле в выводе до (123)-456-7890.

Краткая синтаксическая запись:

inputSourceARN=string,schemaName=string,applyNormalization=boolean ...

Синтаксис JSON:

[
  {
    "inputSourceARN": "string",
    "schemaName": "string",
    "applyNormalization": true|false
  }
  ...
]

--output-source-config (список)

Список объектов OutputSource, каждый из которых содержит поля OutputS3Path, ApplyNormalization и Output.

(структура)

Список объектов OutputAttribute, каждый из которых имеет поля Name и Hashed. Каждый из этих объектов выбирает столбец для включения в выходную таблицу и то, следует ли хешировать значения столбца.

outputS3Path -> (строка)

Путь S3, в который Entity Resolution запишет выходную таблицу.

KMSArn -> (строка)

ARN-ссылка KMS клиента для шифрования в состоянии покоя. Если не указано, система использует управляемый KMS-ключ Entity Resolution.

output -> (список)

Список объектов OutputAttribute, каждый из которых имеет поля Name и Hashed. Каждый из этих объектов выбирает столбец для включения в выходную таблицу и то, следует ли хешировать значения столбца.

(структура)

Список объектов OutputAttribute, каждый из которых имеет поля Name и Hashed. Каждый из этих объектов выбирает столбец для включения в выходную таблицу и то, следует ли хешировать значения столбца.

name -> (строка)

Имя столбца, который будет записан в выходные данные. Это должно быть имя InputField в схеме сопоставления.

hashed -> (булево значение)

Включает возможность хеширования значений столбца в выводе.

applyNormalization -> (булево значение)

Нормализует атрибуты, определённые в схеме, в входных данных. Например, если атрибут имеет AttributeType значение PHONE_NUMBER, а данные в входной таблице имеют формат 1234567890, Entity Resolution нормализует это поле в выводе до (123)-456-7890.

Краткая синтаксическая запись:

outputS3Path=string,KMSArn=string,output=[{name=string,hashed=boolean},{name=string,hashed=boolean}],applyNormalization=boolean ...

Синтаксис JSON:

[
  {
    "outputS3Path": "string",
    "KMSArn": "string",
    "output": [
      {
        "name": "string",
        "hashed": true|false
      }
      ...
    ],
    "applyNormalization": true|false
  }
  ...
]

--resolution-techniques (структура)

Объект, определяющий resolutionType и ruleBasedProperties.

resolutionType -> (строка)

Тип сопоставления. Существует три типа сопоставления: RULE_MATCHING, ML_MATCHING и PROVIDER.

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

Объект, определяющий список правил сопоставления для выполнения и имеющий поле Rules, которое является списком объектов правил.

rules -> (список)

Список объектов Rule, каждый из которых имеет поля RuleName и MatchingKeys.

(структура)

Объект, содержащий RuleName и MatchingKeys.

ruleName -> (строка)

Имя правила сопоставления.

matchingKeys -> (список)

Список MatchingKeys. MatchingKeys должны быть определены в SchemaMapping. Две записи считаются совпадающими по этому правилу, если все MatchingKeys совпадают.

(строка)

attributeMatchingModel -> (строка)

Тип сравнения. Вы можете выбрать ONE_TO_ONE или MANY_TO_MANY в качестве attributeMatchingModel.

Если вы выберете MANY_TO_MANY, система может сопоставлять атрибуты по подтипам типа атрибута. Например, если значение поля Email профиля A и значение поля BusinessEmail профиля B совпадают, два профиля сопоставлены по типу атрибута Email.

Если вы выберете ONE_TO_ONE, система может сопоставлять атрибуты только в том случае, если подтипы являются точным совпадением. Например, для типа атрибута Email система будет считать его совпадением только в том случае, если значение поля Email профиля A совпадает со значением поля Email профиля B.

matchPurpose -> (строка)

Указатель, генерировать ли идентификаторы и индексировать данные.

Если вы выберете IDENTIFIER_GENERATION, процесс генерирует идентификаторы и индексирует данные.

Если вы выберете INDEXING, процесс индексирует данные без генерации идентификаторов.

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

Свойства службы поставщика.

providerServiceArn -> (строка)

ARN службы поставщика.

providerConfiguration -> (документ)

Необходимые поля конфигурации для использования с поставщиком услуг.

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

Расположение Amazon S3, которое временно хранит ваши данные во время обработки. Ваша информация не будет сохранена постоянно.

intermediateS3Path -> (строка)

Расположение Amazon S3 (ведро и префикс). Например: s3://provider_bucket/DOC-EXAMPLE-BUCKET

Синтаксис JSON:

{
  "resolutionType": "RULE_MATCHING"|"ML_MATCHING"|"PROVIDER",
  "ruleBasedProperties": {
    "rules": [
      {
        "ruleName": "string",
        "matchingKeys": ["string", ...]
      }
      ...
    ],
    "attributeMatchingModel": "ONE_TO_ONE"|"MANY_TO_MANY",
    "matchPurpose": "IDENTIFIER_GENERATION"|"INDEXING"
  },
  "providerProperties": {
    "providerServiceArn": "string",
    "providerConfiguration": {...},
    "intermediateSourceConfiguration": {
      "intermediateS3Path": "string"
    }
  }
}

--incremental-run-config (структура)

Объект, определяющий тип инкрементного запуска и имеющий только поле incrementalRunType.

incrementalRunType -> (строка)

Тип инкрементного запуска. Он принимает только одно значение: IMMEDIATE.

Краткая синтаксическая запись:

incrementalRunType=string

Синтаксис JSON:

{
  "incrementalRunType": "IMMEDIATE"
}

--role-arn (строка)

Amazon Resource Name (ARN) роли IAM. Entity Resolution принимает на себя эту роль, чтобы создавать ресурсы от вашего имени в рамках выполнения потока.

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатом корневого центра, используемый при проверке SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаут. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для бинарных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

workflowName -> (string)

Имя потока работ.

description -> (string)

Описание потока работ.

inputSourceConfig -> (list)

Список InputSource объектов, имеющих поля InputSourceARN и SchemaName .

(структура)

Объект, содержащий InputSourceARN , SchemaName и ApplyNormalization .

inputSourceARN -> (string)

Amazon Resource Name (ARN) таблицы Glue в качестве источника входных данных.

schemaName -> (string)

Имя схемы для извлечения.

applyNormalization -> (boolean)

Нормализует атрибуты, определённые в схеме, во входных данных. Например, если атрибут имеет AttributeType значение PHONE_NUMBER , а данные во входной таблице имеют формат 1234567890, Entity Resolution нормализует это поле в выводе до (123)-456-7890.

outputSourceConfig -> (list)

Список OutputSource объектов, каждый из которых содержит поля OutputS3Path , ApplyNormalization и Output .

(структура)

Список OutputAttribute объектов, каждый из которых имеет поля Name и Hashed . Каждый из этих объектов выбирает столбец для включения в выходную таблицу и указывает, должны ли значения столбца быть хешированы.

outputS3Path -> (string)

Путь S3, в который Entity Resolution запишет выходную таблицу.

KMSArn -> (string)

ARN KMS-ключа клиента для шифрования в состоянии покоя. Если не указано, система будет использовать управляемый KMS-ключ Entity Resolution.

output -> (list)

Список OutputAttribute объектов, каждый из которых имеет поля Name и Hashed . Каждый из этих объектов выбирает столбец для включения в выходную таблицу и указывает, должны ли значения столбца быть хешированы.

(структура)

Список OutputAttribute объектов, каждый из которых имеет поля Name и Hashed . Каждый из этих объектов выбирает столбец для включения в выходную таблицу и указывает, должны ли значения столбца быть хешированы.

name -> (string)

Имя столбца для записи в выходные данные. Это должно быть имя InputField в отображении схемы.

hashed -> (boolean)

Включает возможность хеширования значений столбца в выводе.

applyNormalization -> (boolean)

Нормализует атрибуты, определённые в схеме, во входных данных. Например, если атрибут имеет AttributeType значение PHONE_NUMBER , а данные во входной таблице имеют формат 1234567890, Entity Resolution нормализует это поле в выводе до (123)-456-7890.

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

Объект, определяющий resolutionType и ruleBasedProperties

resolutionType -> (string)

Тип сопоставления. Существует три типа сопоставления: RULE_MATCHING , ML_MATCHING и PROVIDER .

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

Объект, определяющий список правил сопоставления для выполнения и имеющий поле Rules , которое является списком объектов правил.

rules -> (list)

Список Rule объектов, каждый из которых имеет поля RuleName и MatchingKeys .

(структура)

Объект, содержащий RuleName и MatchingKeys .

ruleName -> (string)

Имя правила сопоставления.

matchingKeys -> (list)

Список MatchingKeys . MatchingKeys должны быть определены в SchemaMapping . Два записей считаются совпадающими в соответствии с этим правилом, если все MatchingKeys совпадают.

(строка)

attributeMatchingModel -> (string)

Тип сравнения. Вы можете выбрать ONE_TO_ONE или MANY_TO_MANY в качестве attributeMatchingModel .

Если вы выбираете MANY_TO_MANY , система может сопоставлять атрибуты по всем подтипам типа атрибута. Например, если значение поля Email Профиля A и значение поля BusinessEmail Профиля B совпадают, то два профиля сопоставлены по типу атрибута Email .

Если вы выбираете ONE_TO_ONE , система может сопоставлять атрибуты только в том случае, если подтипы точно совпадают. Например, для типа атрибута Email , система будет считать это совпадением только в том случае, если значение поля Email Профиля A совпадает со значением поля Email Профиля B.

matchPurpose -> (string)

Показатель того, генерировать ли идентификаторы и индексировать ли данные.

Если вы выбираете IDENTIFIER_GENERATION , процесс генерирует идентификаторы и индексирует данные.

Если вы выбираете INDEXING , процесс индексирует данные без генерации идентификаторов.

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

Свойства службы провайдера.

providerServiceArn -> (string)

ARN службы провайдера.

providerConfiguration -> (документ)

Необходимые поля конфигурации для использования с сервисом провайдера.

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

Расположение Amazon S3, временно хранящее ваши данные во время обработки. Ваша информация не будет сохранена постоянно.

intermediateS3Path -> (string)

Расположение в Amazon S3 (ведро и префикс). Например: s3://provider_bucket/DOC-EXAMPLE-BUCKET

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

Объект, определяющий тип инкрементального выполнения и имеющий только поле incrementalRunType .

incrementalRunType -> (string)

Тип инкрементального выполнения. Принимает только одно значение: IMMEDIATE .

roleArn -> (string)

Amazon Resource Name (ARN) роли IAM. Entity Resolution принимает эту роль для создания ресурсов от вашего имени в рамках выполнения потока работ.

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

Spec-Zone.ru

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