Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalyticsv2 ]

discover-input-schema

Описание

Определяет схему для приложения Kinesis Data Analytics на основе SQL, анализируя образцы записей в указанном источнике потоковой передачи (потоке данных Kinesis или потоке доставки Amazon Kinesis Data Firehose) или объекте Amazon S3. В ответе операция возвращает выведенную схему и также образцы записей, которые операция использовала для вывода схемы.

Вы можете использовать полученную схему при настройке источника потоковой передачи для вашего приложения. При создании приложения с помощью консоли Kinesis Data Analytics, консоль использует эту операцию для вывода схемы и отображения её в пользовательском интерфейсе консоли.

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

Синтаксис

  discover-input-schema
[--resource-arn <value>]
--service-execution-role <value>
[--input-starting-position-configuration <value>]
[--s3-configuration <value>]
[--input-processing-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]

Параметры

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

Amazon Resource Name (ARN) источника потоковой передачи.

--service-execution-role (строка)

ARN роли, используемой для доступа к источнику потоковой передачи.

--input-starting-position-configuration (структура)

Точка, в которой Kinesis Data Analytics должен начать чтение записей из указанного источника потоковой передачи для целей обнаружения.

InputStartingPosition -> (строка)

Начальная позиция в потоке.

  • NOW - Начать чтение сразу после последней записи в потоке и начать с отметки времени запроса, выданного клиентом.
  • TRIM_HORIZON - Начать чтение с последней не обрезаной записи в потоке, которая является самой старой записью, доступной в потоке. Этот параметр недоступен для потока доставки Amazon Kinesis Data Firehose.
  • LAST_STOPPED_POINT - Возобновить чтение с точки, где приложение в последний раз остановилось.

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

InputStartingPosition=string

Синтаксис JSON:

{
  "InputStartingPosition": "NOW"|"TRIM_HORIZON"|"LAST_STOPPED_POINT"
}

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

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

BucketARN -> (строка)

ARN ведра S3, содержащего данные.

FileKey -> (строка)

Имя объекта, содержащего данные.

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

BucketARN=string,FileKey=string

Синтаксис JSON:

{
  "BucketARN": "string",
  "FileKey": "string"
}

--input-processing-configuration (структура)

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

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

InputLambdaProcessor, используемый для предварительной обработки записей в потоке перед обработкой кодом вашего приложения.

ResourceARN -> (строка)

ARN функции Amazon Lambda, которая обрабатывает записи в потоке.

Примечание

Чтобы указать более раннюю версию функции Lambda, чем последнюю, включите версию функции Lambda в ARN функции Lambda. Дополнительную информацию о Lambda ARN см. в разделе Примеры ARN: Amazon Lambda

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

InputLambdaProcessor={ResourceARN=string}

Синтаксис JSON:

{
  "InputLambdaProcessor": {
    "ResourceARN": "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.

Вывод

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

Схема, выведенная из источника потоковой передачи. Она определяет формат данных в источнике потоковой передачи и то, как каждый элемент данных сопоставляется с соответствующими столбцами в потоке приложения, который вы можете создать.

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

Определяет формат записей в источнике потоковой передачи.

RecordFormatType -> (строка)

Тип формата записей.

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

При конфигурировании входных данных приложения при создании или обновлении приложения предоставляет дополнительную информацию о сопоставлении, специфичную для формата записей (таких как JSON, CSV или полей записей, разделенных разделителями) в источнике потоковой передачи.

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

Предоставляет дополнительную информацию о сопоставлении, когда формат записей - JSON в источнике потоковой передачи.

RecordRowPath -> (строка)

Путь к родительскому элементу верхнего уровня, содержащему записи.

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

Предоставляет дополнительную информацию о сопоставлении, когда формат записей использует разделители (например, CSV).

RecordRowDelimiter -> (строка)

Разделитель строк. Например, в формате CSV ‘n’ является типичным разделителем строк.

RecordColumnDelimiter -> (строка)

Разделитель столбцов. Например, в формате CSV запятая (“,”) является типичным разделителем столбцов.

RecordEncoding -> (строка)

Указывает кодировку записей в источнике потоковой передачи. Например, UTF-8.

RecordColumns -> (список)

Список RecordColumn объектов.

(структура)

Для приложения Kinesis Data Analytics на основе SQL описывает сопоставление каждого элемента данных в источнике потоковой передачи с соответствующим столбцом в потоке приложения.

Также используется для описания формата источника данных справок.

Name -> (строка)

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

Mapping -> (строка)

Ссылка на элемент данных в входных данных потока или источнике данных справок.

SqlType -> (строка)

Тип столбца, созданного в потоке ввода приложения или таблице справок.

ParsedInputRecords -> (список)

Массив элементов, где каждый элемент соответствует строке в записи потока (запись потока может содержать более одной строки).

(список)

(строка)

ProcessedInputRecords -> (список)

Данные потока, изменённые процессором, указанным в параметре InputProcessingConfiguration.

(строка)

RawInputRecords -> (список)

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

(строка)

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

Spec-Zone.ru

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