Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

получение-источника-данных

Описание

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

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

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

Синтаксис

  get-data-source
--application-id <value>
--index-id <value>
--data-source-id <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 (строка)

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

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

Вывод

applicationId -> (строка)

Идентификатор приложения Amazon Q Business.

indexId -> (строка)

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

dataSourceId -> (строка)

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

dataSourceArn -> (строка)

Amazon Resource Name (ARN) источника данных.

displayName -> (строка)

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

type -> (строка)

Тип соединителя источника данных. Например, S3.

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

Подробности о том, как настроен соединитель источника данных.

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

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

subnetIds -> (список)

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

(строка)

securityGroupIds -> (список)

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

(строка)

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

Временная метка Unix, когда был создан соединитель источника данных.

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

Временная метка Unix, когда соединитель источника данных был в последний раз обновлен.

description -> (строка)

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

status -> (строка)

Текущий статус соединителя источника данных. Когда значение поля Status равно FAILED, поле ErrorMessage содержит описание ошибки, которая привела к сбою соединителя источника данных.

syncSchedule -> (строка)

Расписание для обновления индекса Amazon Q Business.

roleArn -> (строка)

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

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

Когда значение поля Status равно FAILED, поле ErrorMessage содержит описание ошибки, которая привела к сбою соединителя источника данных.

errorMessage -> (строка)

Сообщение, объясняющее ошибку запроса Amazon Q Business.

errorCode -> (строка)

Код, связанный с ошибкой запроса Amazon Q Business.

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

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

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

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 -> (целое число)

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

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 -> (целое число)

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

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

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 -> (целое число)

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

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

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

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

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

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

imageExtractionStatus -> (строка)

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

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

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

audioExtractionStatus -> (строка)

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

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

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

videoExtractionStatus -> (строка)

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

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

Spec-Zone.ru

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