Spec-Zone.ru › AWS CLI v2

[ aws . entityresolution ]

обновление-потока-сопоставления-идентификаторов

Описание

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

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

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

Синтаксис

  update-id-mapping-workflow
--workflow-name <value>
[--description <value>]
--input-source-config <value>
[--output-source-config <value>]
--id-mapping-techniques <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 и Type.

inputSourceARN -> (строка)

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

schemaName -> (строка)

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

type -> (строка)

Тип пространства имён идентификаторов. Существуют два типа: SOURCE и TARGET.

SOURCE содержит настройки для данных sourceId, которые будут обработаны в потоке сопоставления идентификаторов.

TARGET содержит конфигурацию targetId, к которой будут разрешаться все sourceIds.

Краткая форма:

inputSourceARN=string,schemaName=string,type=string ...

Синтаксис JSON:

[
  {
    "inputSourceARN": "string",
    "schemaName": "string",
    "type": "SOURCE"|"TARGET"
  }
  ...
]

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

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

(структура)

Источник вывода для потока сопоставления идентификаторов.

outputS3Path -> (строка)

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

KMSArn -> (строка)

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

Краткая форма:

outputS3Path=string,KMSArn=string ...

Синтаксис JSON:

[
  {
    "outputS3Path": "string",
    "KMSArn": "string"
  }
  ...
]

--id-mapping-techniques (структура)

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

idMappingType -> (строка)

Тип сопоставления идентификаторов.

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

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

rules -> (список)

Правила, которые можно использовать для сопоставления идентификаторов.

(структура)

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

ruleName -> (строка)

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

matchingKeys -> (список)

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

(строка)

ruleDefinitionType -> (строка)

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

attributeMatchingModel -> (строка)

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

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

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

recordMatchingModel -> (строка)

Тип сопоставляемых записей, которые разрешены в потоке сопоставления идентификаторов.

Если значение установлено на ONE_SOURCE_TO_ONE_TARGET, только одна запись в источнике может быть сопоставлена с одной записью в получателе.

Если значение установлено на MANY_SOURCE_TO_ONE_TARGET, несколько записей в источнике могут быть сопоставлены с одной записью в получателе.

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

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

providerServiceArn -> (строка)

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

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

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

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

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

intermediateS3Path -> (строка)

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

Синтаксис JSON:

{
  "idMappingType": "PROVIDER"|"RULE_BASED",
  "ruleBasedProperties": {
    "rules": [
      {
        "ruleName": "string",
        "matchingKeys": ["string", ...]
      }
      ...
    ],
    "ruleDefinitionType": "SOURCE"|"TARGET",
    "attributeMatchingModel": "ONE_TO_ONE"|"MANY_TO_MANY",
    "recordMatchingModel": "ONE_SOURCE_TO_ONE_TARGET"|"MANY_SOURCE_TO_ONE_TARGET"
  },
  "providerProperties": {
    "providerServiceArn": "string",
    "providerConfiguration": {...},
    "intermediateSourceConfiguration": {
      "intermediateS3Path": "string"
    }
  }
}

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

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

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

workflowName -> (строка)

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

workflowArn -> (строка)

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

description -> (строка)

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

inputSourceConfig -> (список)

Список объектов InputSource, содержащих поля InputSourceARN и SchemaName.

(структура)

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

inputSourceARN -> (строка)

Amazon Resource Name (ARN) таблицы Glue или соответствующий ARN потока работ для входной таблицы.

schemaName -> (строка)

Имя схемы, подлежащей извлечению.

type -> (строка)

Тип пространства имен идентификаторов. Существуют два типа: SOURCE и TARGET.

SOURCE содержит настройки для данных sourceId, которые будут обработаны в потоке работ сопоставления идентификаторов.

TARGET содержит настройки targetId, к которым все sourceIds будут сведены.

outputSourceConfig -> (список)

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

(структура)

Источник вывода для потока работ сопоставления идентификаторов.

outputS3Path -> (строка)

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

KMSArn -> (строка)

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

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

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

idMappingType -> (строка)

Тип сопоставления идентификаторов.

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

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

rules -> (список)

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

(структура)

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

ruleName -> (строка)

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

matchingKeys -> (список)

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

(строка)

ruleDefinitionType -> (строка)

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

attributeMatchingModel -> (строка)

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

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

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

recordMatchingModel -> (строка)

Тип сопоставляемых записей, которые разрешены в потоке работ сопоставления идентификаторов.

Если значение установлено в ONE_SOURCE_TO_ONE_TARGET, только одна запись в источнике может быть сопоставлена с одной записью в целевом.

Если значение установлено в MANY_SOURCE_TO_ONE_TARGET, несколько записей в источнике могут быть сопоставлены с одной записью в целевом.

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

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

providerServiceArn -> (строка)

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

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

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

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

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

intermediateS3Path -> (строка)

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

roleArn -> (строка)

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

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

Spec-Zone.ru

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