Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

update-data-source

Описание

Обновляет существующий соединитель данных Amazon Q Business.

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

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

Синтаксис

  update-data-source
--application-id <value>
--index-id <value>
--data-source-id <value>
[--display-name <value>]
[--configuration <value>]
[--vpc-configuration <value>]
[--description <value>]
[--sync-schedule <value>]
[--role-arn <value>]
[--document-enrichment-configuration <value>]
[--media-extraction-configuration <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]

Параметры

--application-id (строка)

Идентификатор приложения Amazon Q Business, к которому прикреплён источник данных.

--index-id (строка)

Идентификатор индекса, прикреплённого к соединителю источника данных.

--data-source-id (строка)

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

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

Название соединителя источника данных.

--configuration (документ)

Предоставляет конфигурационную информацию для источника данных Amazon Q Business.

Синтаксис JSON:

{...}

--vpc-configuration (структура)

Предоставляет конфигурационную информацию для подключения к Amazon VPC (виртуальная частная облачная сеть).

subnetIds -> (список)

Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC, и они должны иметь исходящий доступ к интернету через устройство NAT.

(строка)

securityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешать Amazon Q Business подключиться к источнику данных.

(строка)

Сокращённый синтаксис:

subnetIds=string,string,securityGroupIds=string,string

Синтаксис JSON:

{
  "subnetIds": ["string", ...],
  "securityGroupIds": ["string", ...]
}

--description (строка)

Описание соединителя источника данных.

--sync-schedule (строка)

Выбранная частота обновления для вашего источника данных.

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

Amazon Resource Name (ARN) роли IAM с разрешениями на доступ к источнику данных и необходимым ресурсам.

--document-enrichment-configuration (структура)

Предоставляет конфигурационную информацию для изменения метаданных и содержимого документов во время процесса загрузки документов.

Для получения дополнительной информации см. HookConfiguration">Настройка пользовательского обогащения документов.

inlineConfigurations -> (список)

Конфигурационная информация для изменения атрибутов или полей метаданных и содержимого документов при загрузке документов в Amazon Q Business.

(структура)

Предоставляет конфигурационную информацию для применения базовой логики для изменения метаданных и содержимого документов при загрузке документов в Amazon Q Business.

Чтобы применить расширенную логику, выходящую за рамки базовой логики, см. ` HookConfiguration https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html`__ .

Для получения дополнительной информации см. HookConfiguration">Настройка пользовательского обогащения документов.

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

Условие, используемое для целевого атрибута документа или поля метаданных при загрузке документов в Amazon Q Business. Вы используете это с ` DocumentAttributeTarget https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html`__ для применения условия.

Например, вы можете создать целевое поле «Отдел» и предварительно заполнять в нём названия отделов, связанные с документами, на основании информации в поле «Source_URI». Установите условие, что если поле «Source_URI» содержит «financial» в значении URI, то предварительно заполните целевое поле «Отдел» целевым значением «Финансы» для документа.

Amazon Q Business не может создать целевое поле, если оно не было предварительно создано как поле индекса. После создания поля индекса вы можете создать поле метаданных документа, используя DocumentAttributeTarget . Amazon Q Business затем сопоставит созданное поле метаданных с вашим полем индекса.

key -> (строка)

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

Например, «Source_URI» может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанные с документами.

Amazon Q Business в настоящее время не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

operator -> (строка)

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

Например, «Source_URI» может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанные с документами.

Amazon Q Business в настоящее время не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

value -> (структура помеченного союза)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое)

Целое значение.

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

Дата, выраженная в формате ISO 8601.

Важно, чтобы часовой пояс был включен в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Целевой атрибут документа или поле метаданных, которое вы хотите изменить при загрузке документов в Amazon Q Business.

Например, вы можете удалить все идентификаторы клиентов, связанные с документами, хранящиеся в поле метаданных документа с именем «Customer_ID», установив ключевой параметр «Customer_ID» и флаг удаления на TRUE . Это удаляет все значения идентификатора клиента в поле «Customer_ID». Это очистит персональную идентификационную информацию из метаданных каждого документа.

Amazon Q Business не может создать целевое поле, если оно не было предварительно создано как поле индекса. После создания поля индекса вы можете создать поле метаданных документа, используя ` DocumentAttributeTarget https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html`__ . Amazon Q Business затем сопоставит созданный вами атрибут документа с полем индекса.

Вы также можете использовать это с ` DocumentAttributeCondition https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html`__ .

key -> (строка)

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

value -> (структура помеченного союза)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое)

Целое значение.

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

Дата, выраженная в формате ISO 8601.

Важно, чтобы часовой пояс был включен в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

attributeValueOperator -> (строка)

TRUE для удаления существующего целевого значения для указанного ключа целевого атрибута. Вы не можете создать целевое значение и установить это на TRUE .

documentContentOperator -> (строка)

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

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

Предоставляет конфигурационную информацию для вызова функции Lambda в Lambda для изменения метаданных и содержимого документов при загрузке документов в Amazon Q Business.

Вы можете настроить свою функцию Lambda, используя параметр PreExtractionHookConfiguration, если хотите применять расширенные изменения к исходным или необработанным документам.

Если вы хотите применять расширенные изменения к структурированным документам Amazon Q Business, вы должны настроить свою функцию Lambda, используя PostExtractionHookConfiguration .

Вы можете вызвать только одну функцию Lambda. Однако эта функция может вызывать другие необходимые функции.

Для получения дополнительной информации см. HookConfiguration">Настройка пользовательского обогащения документов.

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

Условие, используемое для вызова функции Lambda.

Например, вы можете указать условие, что если есть пустые значения даты и времени, то Amazon Q Business должен вызвать функцию, которая вставит текущую дату и время.

key -> (строка)

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

Например, «Source_URI» может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанные с документами.

Amazon Q Business в настоящее время не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

operator -> (строка)

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

Например, «Source_URI» может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанные с документами.

Amazon Q Business в настоящее время не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

value -> (структура помеченного союза)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое)

Целое значение.

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

Дата, выраженная в формате ISO 8601.

Важно, чтобы часовой пояс был включен в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

lambdaArn -> (строка)

Amazon Resource Name (ARN) функции Lambda во время загрузки. Для получения дополнительной информации см. Использование функций Lambda для обогащения документов Amazon Q Business.

s3BucketName -> (строка)

Хранит исходные, необработанные документы или структурированные, проанализированные документы до и после их изменения. Для получения дополнительной информации см. Контракты данных для функций Lambda.

roleArn -> (строка)

Amazon Resource Name (ARN) роли с разрешениями на выполнение PreExtractionHookConfiguration и PostExtractionHookConfiguration для изменения метаданных и содержимого документов во время процесса загрузки документов.

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

Предоставляет конфигурационную информацию для вызова функции Lambda в Lambda для изменения метаданных и содержимого документа при импорте документов в Amazon Q Business.

Вы можете настроить свою функцию Lambda с помощью параметра PreExtractionHookConfiguration, если хотите применить расширенные изменения к исходным или необработанным документам.

Если вы хотите применить расширенные изменения к структурированным документам Amazon Q Business, вы должны настроить свою функцию Lambda с помощью PostExtractionHookConfiguration.

Вы можете вызвать только одну функцию Lambda. Однако эта функция может вызывать другие необходимые функции.

Для получения дополнительной информации см. Раздел Пользовательское обогащение документов.

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

Условие, используемое для вызова функции Lambda.

Например, вы можете указать условие, при котором, если есть пустые значения даты и времени, Amazon Q Business должен вызвать функцию, которая вставляет текущую дату и время.

key -> (строка)

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

Например, ‘Source_URI’ может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанных с документами.

Amazon Q Business в настоящее время не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

operator -> (строка)

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

Например, ‘Source_URI’ может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанных с документами.

Amazon Q Business в настоящее время не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

value -> (структура помеченного объединения)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Целое значение типа long.

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

Дата, выраженная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

lambdaArn -> (строка)

Идентификатор ресурса Amazon (ARN) функции Lambda во время импорта. Для получения дополнительной информации см. Раздел Использование функций Lambda для обогащения документов Amazon Q Business.

s3BucketName -> (строка)

Хранит исходные, необработанные документы или структурированные, разобранные документы до и после их изменения. Для получения дополнительной информации см. Раздел Контракты данных для функций Lambda.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли с разрешениями на выполнение PreExtractionHookConfiguration и PostExtractionHookConfiguration для изменения метаданных и содержимого документа во время процесса импорта документа.

Синтаксис JSON:

{
  "inlineConfigurations": [
    {
      "condition": {
        "key": "string",
        "operator": "GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"EXISTS"|"NOT_EXISTS"|"BEGINS_WITH",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "target": {
        "key": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        },
        "attributeValueOperator": "DELETE"
      },
      "documentContentOperator": "DELETE"
    }
    ...
  ],
  "preExtractionHookConfiguration": {
    "invocationCondition": {
      "key": "string",
      "operator": "GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"EXISTS"|"NOT_EXISTS"|"BEGINS_WITH",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "lambdaArn": "string",
    "s3BucketName": "string",
    "roleArn": "string"
  },
  "postExtractionHookConfiguration": {
    "invocationCondition": {
      "key": "string",
      "operator": "GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"EXISTS"|"NOT_EXISTS"|"BEGINS_WITH",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "lambdaArn": "string",
    "s3BucketName": "string",
    "roleArn": "string"
  }
}

--media-extraction-configuration (структура)

Конфигурация для извлечения информации из медиа в документах для вашего источника данных.

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

Конфигурация для извлечения семантического смысла из изображений в документах. Для получения дополнительной информации см. Раздел Извлечение семантического смысла из изображений и визуальных элементов.

imageExtractionStatus -> (строка)

Укажите, нужно ли извлекать семантический смысл из изображений и визуальных элементов из документов.

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

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

audioExtractionStatus -> (строка)

Статус извлечения аудио (ENABLED или DISABLED) для обработки аудиосодержимого из файлов.

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

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

videoExtractionStatus -> (строка)

Статус извлечения видео (ENABLED или DISABLED) для обработки видеосодержимого из файлов.

Сокращенный синтаксис:

imageExtractionConfiguration={imageExtractionStatus=string},audioExtractionConfiguration={audioExtractionStatus=string},videoExtractionConfiguration={videoExtractionStatus=string}

Синтаксис JSON:

{
  "imageExtractionConfiguration": {
    "imageExtractionStatus": "ENABLED"|"DISABLED"
  },
  "audioExtractionConfiguration": {
    "audioExtractionStatus": "ENABLED"|"DISABLED"
  },
  "videoExtractionConfiguration": {
    "videoExtractionStatus": "ENABLED"|"DISABLED"
  }
}

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

Вывод

Нет

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

Spec-Zone.ru

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