Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

создать-источник-данных

Описание

Создаёт соединитель источника данных для приложения Amazon Q Business.

CreateDataSource это синхронная операция. Операция возвращает 200, если источник данных был успешно создан. В противном случае, возникает исключение.

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

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

Синтаксис

  create-data-source
--application-id <value>
--index-id <value>
--display-name <value>
--configuration <value>
[--vpc-configuration <value>]
[--description <value>]
[--tags <value>]
[--sync-schedule <value>]
[--role-arn <value>]
[--client-token <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 (строка)

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

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

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

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

Конфигурационная информация для подключения вашего хранилища данных к Amazon Q Business. Используйте этот параметр для предоставления JSON-схемы с конфигурационной информацией, специфичной для вашего соединителя источника данных.

Каждый источник данных имеет JSON-схему, предоставленную Amazon Q Business, которую вы должны использовать. Например, соединители Amazon S3 и Web Crawler требуют следующих JSON-схем:

  • JSON-схема Amazon S3
  • JSON-схема Web Crawler

Вы можете найти шаблоны конфигурации для вашего конкретного источника данных, выполнив следующие действия:

  • Перейдите на страницу Поддерживаемые соединители в руководстве пользователя Amazon Q Business и выберите нужный источник данных.
  • Затем, на странице конкретного соединителя источника данных, выберите Использование API. В этом разделе вы найдёте JSON-схему для вашего источника данных, включая описания параметров.

Синтаксис JSON:

{...}

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

Конфигурационная информация для Amazon VPC (виртуальной частной сети) для подключения к вашему источнику данных. Для получения дополнительной информации см. Использование Amazon VPC с соединителями Amazon Q Business.

subnetIds -> (список)

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

(строка)

securityGroupIds -> (список)

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

(строка)

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

subnetIds=string,string,securityGroupIds=string,string

Синтаксис JSON:

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

--description (строка)

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

--tags (список)

Список пар ключ-значение, которые идентифицируют или категоризируют соединитель источника данных. Вы также можете использовать теги для управления доступом к соединителю источника данных. Ключи и значения тегов могут состоять из букв, цифр, пробелов Unicode и следующих символов: _ . : / = + - @.

(структура)

Список пар ключ/значение, которые идентифицируют индекс, FAQ или источник данных. Ключи и значения тегов могут состоять из букв, цифр, пробелов Unicode и следующих символов: _ . : / = + - @.

key -> (строка)

Ключ тега. Ключи нечувствительны к регистру и должны быть уникальными для приложения Amazon Q Business или источника данных.

value -> (строка)

Значение, связанное с тегом. Значение может быть пустой строкой, но не может быть null.

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

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

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

Устанавливает частоту, с которой Amazon Q Business будет проверять документы в вашем хранилище данных и обновлять ваш индекс. Если вы не зададите расписание, Amazon Q Business не будет периодически обновлять индекс.

Укажите строку расписания в формате cron- или пустую строку, чтобы указать, что индекс обновляется по запросу. Вы не можете указать параметр Schedule, когда параметр Type установлен на значение CUSTOM. В противном случае вы получите исключение ValidationException.

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

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

--client-token (строка)

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

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

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

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

inlineConfigurations -> (список)

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

(структура)

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

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

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

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 (плюс 10 секунд) по центральноевропейскому времени.

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 (плюс 10 секунд) по центральноевропейскому времени.

attributeValueOperator -> (строка)

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

documentContentOperator -> (строка)

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

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

Предоставляет конфигурационную информацию для вызова функции 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 -> (целое число)

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

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 для изменения метаданных и содержимого документа во время процесса поглощения документа.

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 Resource Name (ARN) функции Lambda во время импорта. Дополнительную информацию см. в разделе Использование функций Lambda для обогащения документов Amazon Q Business.

s3BucketName -> (строка)

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

roleArn -> (строка)

Amazon Resource Name (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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Вывод

dataSourceId -> (строка)

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

dataSourceArn -> (строка)

Amazon Resource Name (ARN) источника данных в приложении Amazon Q Business.

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

Spec-Zone.ru

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