Spec-Zone.ru › AWS CLI v2

[ aws . entityresolution ]

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

Описание

Обновляет существующее пространство имен идентификаторов.

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

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

Синтаксис

  update-id-namespace
--id-namespace-name <value>
[--description <value>]
[--input-source-config <value>]
[--id-mapping-workflow-properties <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]

Опции

--id-namespace-name (строка)

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

--description (строка)

Описание пространства имен идентификаторов.

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

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

(структура)

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

inputSourceARN -> (строка)

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

schemaName -> (строка)

Имя схемы.

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

inputSourceARN=string,schemaName=string ...

Синтаксис JSON:

[
  {
    "inputSourceARN": "string",
    "schemaName": "string"
  }
  ...
]

--id-mapping-workflow-properties (список)

Определяет свойства IdMappingWorkflow, где это IdNamespace может использоваться как Source или Target.

(структура)

Объект, содержащий IdMappingType, ProviderProperties и RuleBasedProperties.

idMappingType -> (строка)

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

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

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

rules -> (список)

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

(структура)

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

ruleName -> (строка)

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

matchingKeys -> (список)

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

(строка)

ruleDefinitionTypes -> (список)

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

(строка)

attributeMatchingModel -> (строка)

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

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

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

recordMatchingModels -> (список)

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

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

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

(строка)

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

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

providerServiceArn -> (строка)

Amazon Resource Name (ARN) службы поставщика.

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

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

Синтаксис JSON:

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

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

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

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

Вывод

idNamespaceName -> (строка)

Название пространства имён ID.

idNamespaceArn -> (строка)

Amazon Resource Name (ARN) пространства имён ID.

description -> (строка)

Описание пространства имён ID.

inputSourceConfig -> (список)

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

(структура)

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

inputSourceARN -> (строка)

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

schemaName -> (строка)

Название схемы.

idMappingWorkflowProperties -> (список)

Определяет свойства IdMappingWorkflow, где это IdNamespace может использоваться как Source или как Target.

(структура)

Объект, содержащий IdMappingType, ProviderProperties и RuleBasedProperties.

idMappingType -> (строка)

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

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

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

rules -> (список)

Правила для пространства имён ID.

(структура)

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

ruleName -> (строка)

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

matchingKeys -> (список)

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

(строка)

ruleDefinitionTypes -> (список)

Наборы правил, которые можно использовать в рабочем процессе сопоставления 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.

recordMatchingModels -> (список)

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

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

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

(строка)

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

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

providerServiceArn -> (строка)

Amazon Resource Name (ARN) службы поставщика.

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

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

type -> (строка)

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

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

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

roleArn -> (строка)

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

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

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

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

Маркер времени последнего обновления пространства имён ID.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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