Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalyticsv2 ]

добавить-выходное-приложение

Описание

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

Если вы хотите, чтобы Kinesis Data Analytics доставлял данные из потока внутри приложения во внешнее назначение (например, в поток данных Kinesis, поток доставки данных Kinesis Data Firehose или функцию Amazon Lambda), вы добавляете соответствующую конфигурацию в свое приложение с помощью данной операции. Вы можете настроить один или несколько выходов для своего приложения. Каждая конфигурация выхода сопоставляет поток внутри приложения и внешнее назначение.

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

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

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

Синтаксис

  add-application-output
--application-name <value>
--current-application-version-id <value>
--application-output <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 (целое число)

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

--application-output (структура)

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

Name -> (строка)

Имя потока внутри приложения.

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

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

ResourceARN -> (строка)

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

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

Определяет поток доставки данных Kinesis Data Firehose как назначение.

ResourceARN -> (строка)

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

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

Определяет функцию Amazon Lambda как назначение.

ResourceARN -> (строка)

Amazon Resource Name (ARN) целевой функции Lambda для записи.

Примечание

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

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

Описывает формат данных при записи записей в назначение.

RecordFormatType -> (строка)

Указывает формат записей в выходном потоке.

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

Name=string,KinesisStreamsOutput={ResourceARN=string},KinesisFirehoseOutput={ResourceARN=string},LambdaOutput={ResourceARN=string},DestinationSchema={RecordFormatType=string}

Синтаксис JSON:

{
  "Name": "string",
  "KinesisStreamsOutput": {
    "ResourceARN": "string"
  },
  "KinesisFirehoseOutput": {
    "ResourceARN": "string"
  },
  "LambdaOutput": {
    "ResourceARN": "string"
  },
  "DestinationSchema": {
    "RecordFormatType": "JSON"|"CSV"
  }
}

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

Обновленный идентификатор версии приложения. Kinesis Data Analytics увеличивает этот идентификатор при обновлении приложения.

OutputDescriptions -> (список)

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

(структура)

Для приложения Kinesis Data Analytics, основанного на SQL, описывает конфигурацию выхода приложения, которая включает имя потока внутри приложения и назначение, в которое записываются данные потока. Назначение может быть потоком данных Kinesis или потоком доставки данных Kinesis Data Firehose.

OutputId -> (строка)

Уникальный идентификатор конфигурации выхода.

Name -> (строка)

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

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

Описывает поток данных Kinesis, настроенный как назначение, куда записывается выход.

ResourceARN -> (строка)

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

RoleARN -> (строка)

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

Примечание

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

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

Описывает поток доставки данных Kinesis Data Firehose, настроенный как назначение, куда записывается выход.

ResourceARN -> (строка)

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

RoleARN -> (строка)

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

Примечание

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

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

Описывает функцию Lambda, настроенную как назначение, куда записывается выход.

ResourceARN -> (строка)

Amazon Resource Name (ARN) целевой функции Lambda.

RoleARN -> (строка)

ARN роли IAM, которую Kinesis Data Analytics может принять, чтобы записать в целевую функцию.

Примечание

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

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

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

RecordFormatType -> (строка)

Указывает формат записей в выходном потоке.

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

Spec-Zone.ru

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