Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalytics ]

discover-input-schema

Описание

Примечание

Данная документация относится к версии 1 API Amazon Kinesis Data Analytics, которая поддерживает только SQL-приложения. Версия 2 API поддерживает SQL и Java-приложения. Более подробную информацию о версии 2 см. в Документации API Amazon Kinesis Data Analytics V2 .

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

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

Для выполнения этой операции требуется разрешение на выполнение действия kinesisanalytics:DiscoverInputSchema.

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

Синтаксис

  discover-input-schema
[--resource-arn <value>]
[--role-arn <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 (ARN) источника потоковой передачи.

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

ARN роли IAM, которую Amazon Kinesis Analytics может принять для доступа к потоку от вашего имени.

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

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

InputStartingPosition -> (строка)

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

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

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

InputStartingPosition=string

Синтаксис JSON:

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

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

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

RoleARN -> (строка)

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

BucketARN -> (строка)

ARN корзины S3, содержащей данные.

FileKey -> (строка)

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

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

RoleARN=string,BucketARN=string,FileKey=string

Синтаксис JSON:

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

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

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

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

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

ResourceARN -> (строка)

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

Примечание

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

RoleARN -> (строка)

ARN роли IAM, используемой для доступа к функции AWS Lambda.

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

InputLambdaProcessor={ResourceARN=string,RoleARN=string}

Синтаксис JSON:

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

(структура)

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

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

Name -> (строка)

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

Mapping -> (строка)

Ссылка на элемент данных в входных данных потоковой передачи или источнике справочных данных. Этот элемент обязателен, если RecordFormatType — JSON .

SqlType -> (строка)

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

ParsedInputRecords -> (список)

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

(список)

(строка)

ProcessedInputRecords -> (список)

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

(строка)

RawInputRecords -> (список)

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

(строка)

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

Spec-Zone.ru

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