Spec-Zone.ru › AWS CLI v2

[ aws . entityresolution ]

create-id-mapping-workflow

Описание

Создаёт объект IdMappingWorkflow, который хранит конфигурацию задачи обработки данных, которая должна быть запущена. Каждый IdMappingWorkflow должен иметь уникальное имя рабочей области. Для изменения существующей рабочей области используйте API UpdateIdMappingWorkflow.

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

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

Синтаксис

  create-id-mapping-workflow
--workflow-name <value>
[--description <value>]
--input-source-config <value>
[--output-source-config <value>]
--id-mapping-techniques <value>
[--role-arn <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]

Параметры

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

Имя рабочей области. Не может быть нескольких IdMappingWorkflows с одинаковым именем.

--description (строка)

Описание рабочей области.

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

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

(структура)

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

inputSourceARN -> (строка)

Amazon Resource Name (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 (список)

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

(структура)

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

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 принимает эту роль, чтобы создавать ресурсы от вашего имени в рамках выполнения рабочей области.

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

workflowName -> (строка)

Название потока.

workflowArn -> (строка)

Идентификатор ресурса Amazon (ARN), сгенерированный Entity Resolution для IDMappingWorkflow .

description -> (строка)

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

inputSourceConfig -> (список)

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

(структура)

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

inputSourceARN -> (строка)

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

schemaName -> (строка)

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

type -> (строка)

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

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

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

outputSourceConfig -> (список)

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

(структура)

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

outputS3Path -> (строка)

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

KMSArn -> (строка)

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

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

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

idMappingType -> (строка)

Тип сопоставления ID.

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

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

rules -> (список)

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

(структура)

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

ruleName -> (строка)

Название правила сопоставления.

matchingKeys -> (список)

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

(строка)

ruleDefinitionType -> (строка)

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

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

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

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

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

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

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

providerServiceArn -> (строка)

Идентификатор ресурса Amazon (ARN) службы поставщика.

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

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

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

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

intermediateS3Path -> (строка)

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

roleArn -> (строка)

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

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

Spec-Zone.ru

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