Spec-Zone.ru › AWS CLI v2

[ aws . entityresolution ]

get-matching-workflow

Описание

Возвращает MatchingWorkflow с заданным именем, если оно существует.

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

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

Синтаксис

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

Имя потока.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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 сгенерировал для MatchingWorkflow .

description -> (строка)

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

inputSourceConfig -> (список)

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

(структура)

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

inputSourceARN -> (строка)

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

schemaName -> (строка)

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

applyNormalization -> (булево)

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

outputSourceConfig -> (список)

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

(структура)

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

outputS3Path -> (строка)

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

KMSArn -> (строка)

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

output -> (список)

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

(структура)

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

name -> (строка)

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

hashed -> (булево)

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

applyNormalization -> (булево)

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

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

Объект, определяющий 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 -> (строка)

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

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

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

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

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

intermediateS3Path -> (строка)

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

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

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

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

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

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

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

incrementalRunType -> (строка)

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

roleArn -> (строка)

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

tags -> (карта)

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

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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