Spec-Zone.ru › AWS CLI v2

[ aws . entityresolution ]

create-id-namespace

Описание

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

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

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

Синтаксис

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

Параметры

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

Имя пространства имён ID.

--description (строка)

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

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

Определяет свойства IdMappingWorflow, где это 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 -> (документ)

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

Синтаксис 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": {...}
    }
  }
  ...
]

--type (строка)

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

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

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

Возможные значения:

  • SOURCE
  • TARGET

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

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

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

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

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

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

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

tags -> (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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