[ aws . kinesisanalytics ]
добавить-источник-данных-справочника-приложения
Описание
Примечание
Данная документация предназначена для версии 1 API Amazon Kinesis Data Analytics, которая поддерживает только SQL-приложения. Версия 2 API поддерживает SQL и Java-приложения. Для получения дополнительной информации о версии 2 см. Документацию API V2 Amazon Kinesis Data Analytics.Добавляет источник данных справочника к существующему приложению.
Amazon Kinesis Analytics считывает данные справочника (то есть объект Amazon S3) и создает таблицу внутри приложения. В запросе вы предоставляете источник (имя корзины S3 и имя ключа объекта), имя создаваемой таблицы внутри приложения и необходимую информацию для отображения того, как данные в объекте Amazon S3 отображаются в столбцах результирующей таблицы приложения.
Для концептуальной информации см. Настройка ввода приложения. Для ограничений на источники данных, которые можно добавить в приложение, см. Пределы.
Для выполнения данной операции требуются разрешения на выполнение действия kinesisanalytics:AddApplicationOutput.
См. также: Документация AWS API
Синтаксис
add-application-reference-data-source
--application-name <value>
--current-application-version-id <value>
--reference-data-source <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]
Параметры
--current-application-version-id (строка)
--application-name (целое число)
ConcurrentModificationException.--reference-data-source (структура)
Источник данных справочника может быть объектом в вашей корзине Amazon S3. Amazon Kinesis Analytics считывает объект и копирует данные в создаваемую таблицу приложения. Вы предоставляете корзину S3, имя ключа объекта и создаваемую таблицу приложения. Вы также должны предоставить роль IAM с необходимыми разрешениями, которые Amazon Kinesis Analytics может принять для чтения объекта из вашей корзины S3 от вашего имени.
TableName -> (строка)
S3ReferenceDataSource -> (структура)
Идентифицирует корзину S3 и объект, содержащий данные справочника. Также идентифицирует роль IAM, которую Amazon Kinesis Analytics может принять, чтобы читать этот объект от вашего имени. Приложение Amazon Kinesis Analytics загружает данные справочника только один раз. Если данные изменяются, вы вызываете операцию UpdateApplication для запуска повторной загрузки данных в ваше приложение.
BucketARN -> (строка)
FileKey -> (строка)
ReferenceRoleARN -> (строка)
s3:GetObject для объекта и политику доверия, которая позволяет принципалу службы Amazon Kinesis Analytics принять эту роль.ReferenceSchema -> (структура)
Описывает формат данных в источнике потока и то, как каждый элемент данных отображается в соответствующих столбцах, созданных в потоке приложения.
RecordFormat -> (структура)
Устанавливает формат записей в источнике потока.
RecordFormatType -> (строка)
MappingParameters -> (структура)
При настройке входных данных приложения во время создания или обновления приложения предоставляет дополнительную информацию о сопоставлении, специфичную для формата записи (например, JSON, CSV или записей, разделяемых некоторым разделителем) в источнике потока.
JSONMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении при использовании JSON в качестве формата записи в источнике потока.
RecordRowPath -> (строка)
CSVMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении, когда формат записи использует разделители (например, CSV).
RecordRowDelimiter -> (строка)
RecordColumnDelimiter -> (строка)
RecordEncoding -> (строка)
RecordColumns -> (список)
Список объектов RecordColumn.
(структура)
Описывает отображение каждого элемента данных в источнике потока на соответствующий столбец в потоке приложения.
Также используется для описания формата источника данных справочника.
Name -> (строка)
Mapping -> (строка)
JSON.SqlType -> (строка)
Синтаксис JSON:
{
"TableName": "string",
"S3ReferenceDataSource": {
"BucketARN": "string",
"FileKey": "string",
"ReferenceRoleARN": "string"
},
"ReferenceSchema": {
"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
- текст
- таблица
- 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.