Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalyticsv2 ]

add-application-input

Описание

Добавляет потоковый источник в ваше приложение Kinesis Data Analytics на основе SQL.

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

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

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

Синтаксис

  add-application-input
--application-name <value>
--current-application-version-id <value>
--input <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-name (строка)

Имя вашего существующего приложения, к которому вы хотите добавить потоковый источник.

--current-application-version-id (целое число)

Текущая версия вашего приложения. Вы должны предоставить ApplicationVersionID или ConditionalToken. Вы можете использовать операцию DescribeApplication для поиска текущей версии приложения.

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

Добавляемый источник.

NamePrefix -> (строка)

Префикс имени для использования при создании потока в приложении. Предположим, что вы указываете префикс «MyInApplicationStream». Kinesis Data Analytics создает один или несколько потоков в приложении с именами «MyInApplicationStream_001», «MyInApplicationStream_002» и так далее (в соответствии с количеством InputParallelism, которое вы указали).

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

InputProcessingConfiguration для источника. Обработчик входных данных преобразует записи по мере их получения из потока, прежде чем будет выполнен SQL-код приложения. В настоящее время доступна только конфигурация обработки входных данных InputLambdaProcessor .

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

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

ResourceARN -> (строка)

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

Примечание

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

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

Если потоковый источник — это поток Amazon Kinesis, идентифицирует Amazon Resource Name (ARN) потока.

ResourceARN -> (строка)

ARN входного потока Kinesis data stream для чтения.

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

Если потоковый источник — это поток доставки Amazon Kinesis Data Firehose, идентифицирует ARN потока доставки.

ResourceARN -> (строка)

Amazon Resource Name (ARN) потока доставки.

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

Описывает количество потоков в приложении для создания.

Count -> (целое число)

Количество потоков в приложении для создания.

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 -> (строка)

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

Синтаксис JSON:

{
  "NamePrefix": "string",
  "InputProcessingConfiguration": {
    "InputLambdaProcessor": {
      "ResourceARN": "string"
    }
  },
  "KinesisStreamsInput": {
    "ResourceARN": "string"
  },
  "KinesisFirehoseInput": {
    "ResourceARN": "string"
  },
  "InputParallelism": {
    "Count": integer
  },
  "InputSchema": {
    "RecordFormat": {
      "RecordFormatType": "JSON"|"CSV",
      "MappingParameters": {
        "JSONMappingParameters": {
          "RecordRowPath": "string"
        },
        "CSVMappingParameters": {
          "RecordRowDelimiter": "string",
          "RecordColumnDelimiter": "string"
        }
      }
    },
    "RecordEncoding": "string",
    "RecordColumns": [
      {
        "Name": "string",
        "Mapping": "string",
        "SqlType": "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Использовать определенный регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

ApplicationARN -> (строка)

Amazon Resource Name (ARN) приложения.

ApplicationVersionId -> (целое число)

Предоставляет текущую версию приложения.

InputDescriptions -> (список)

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

(структура)

Описывает конфигурацию входных данных для приложения Kinesis Data Analytics на основе SQL.

InputId -> (строка)

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

NamePrefix -> (строка)

Префикс имени внутри приложения.

InAppStreamNames -> (список)

Возвращает имена потоков внутри приложения, сопоставленные с источником потока.

(строка)

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

Описание препроцессора, который выполняется над записями в этом входе перед запуском кода приложения.

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

Предоставляет конфигурационную информацию о связанном InputLambdaProcessorDescription

ResourceARN -> (строка)

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

Примечание

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

RoleARN -> (строка)

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

Примечание

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

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

Если поток данных Kinesis настроен как источник потока, предоставляет Amazon Resource Name (ARN) потока данных Kinesis.

ResourceARN -> (строка)

Amazon Resource Name (ARN) потока данных Kinesis.

RoleARN -> (строка)

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

Примечание

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

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

Если поток доставки Kinesis Data Firehose настроен как источник потока, предоставляет ARN потока доставки.

ResourceARN -> (строка)

Amazon Resource Name (ARN) потока доставки.

RoleARN -> (строка)

ARN роли IAM, которую Kinesis Data Analytics использует для доступа к потоку.

Примечание

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

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 -> (строка)

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

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

Описывает настроенную параллельность (количество потоков внутри приложения, сопоставленных с источником потока).

Count -> (целое число)

Количество потоков внутри приложения, которые нужно создать.

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

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

InputStartingPosition -> (строка)

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

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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