Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalytics ]

add-application-input

Описание

Примечание

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

Добавляет источник потоковой передачи в ваше приложение Amazon Kinesis. Для концептуальной информации см. Настройка входных данных приложения.

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

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

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

См. также: Документация 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 (строка)

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

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

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

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

Входные данные для добавления.

NamePrefix -> (строка)

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

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

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

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

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

ResourceARN -> (строка)

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

Примечание

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

RoleARN -> (строка)

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

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

Если источником потоковой передачи является поток Amazon Kinesis, идентифицирует Amazon Resource Name (ARN) потока и роль IAM, которая позволяет Amazon Kinesis Analytics получить доступ к потоку от вашего имени.

Примечание: Требуется либо KinesisStreamsInput, либо KinesisFirehoseInput.

ResourceARN -> (строка)

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

RoleARN -> (строка)

ARN роли IAM, которую Amazon Kinesis Analytics может принять, чтобы получить доступ к потоку от вашего имени. Вы должны предоставить необходимые разрешения этой роли.

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

Если источником потоковой передачи является поток доставки Amazon Kinesis Firehose, идентифицирует ARN потока доставки и роль IAM, которая позволяет Amazon Kinesis Analytics получить доступ к потоку от вашего имени.

Примечание: Требуется либо KinesisStreamsInput, либо KinesisFirehoseInput.

ResourceARN -> (строка)

ARN входного потока доставки.

RoleARN -> (строка)

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

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

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

Данные из вашего источника направляются в эти входные потоки приложения.

(см. Настройка входных данных приложения.)

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

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

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

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

Синтаксис JSON:

{
  "NamePrefix": "string",
  "InputProcessingConfiguration": {
    "InputLambdaProcessor": {
      "ResourceARN": "string",
      "RoleARN": "string"
    }
  },
  "KinesisStreamsInput": {
    "ResourceARN": "string",
    "RoleARN": "string"
  },
  "KinesisFirehoseInput": {
    "ResourceARN": "string",
    "RoleARN": "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
  • таблица
  • 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.

Вывод

Нет

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

Spec-Zone.ru

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