Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalyticsv2 ]

добавить источник данных ссылок для приложения

Описание

Добавляет источник данных ссылок к существующему приложению Kinesis Data Analytics, основанному на SQL.

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

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

Синтаксис

  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]

Параметры

--application-name (строка)

Имя существующего приложения.

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

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

--reference-data-source (структура)

Источник данных ссылок может быть объектом в вашем ведре Amazon S3. Kinesis Data Analytics считывает объект и копирует данные в таблицу приложения, которая создается. Вы предоставляете ведро S3, имя ключа объекта и создаваемую таблицу приложения.

TableName -> (строка)

Имя таблицы приложения, которую нужно создать.

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

Определяет ведро S3 и объект, содержащие данные ссылок. Приложение Kinesis Data Analytics на основе SQL загружает данные ссылок только один раз. Если данные меняются, вы вызываете операцию UpdateApplication, чтобы инициировать перезагрузку данных в ваше приложение.

BucketARN -> (строка)

Идентификатор ресурса Amazon (ARN) ведра S3.

FileKey -> (строка)

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

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

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

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:

{
  "TableName": "string",
  "S3ReferenceDataSource": {
    "BucketARN": "string",
    "FileKey": "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.

Вывод

ApplicationARN -> (строка)

Идентификатор ресурса Amazon (ARN) приложения.

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

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

ReferenceDataSourceDescriptions -> (список)

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

(структура)

Для приложения Kinesis Data Analytics на основе SQL описывает источник референц-данных, настроенный для приложения.

ReferenceId -> (строка)

Идентификатор источника референц-данных. Это идентификатор, назначенный Kinesis Data Analytics при добавлении источника референц-данных в приложение с помощью операции CreateApplication или UpdateApplication.

TableName -> (строка)

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

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

Предоставляет имя ведра Amazon S3 и имя ключа объекта, содержащего референц-данные.

BucketARN -> (строка)

Идентификатор ресурса Amazon (ARN) ведра S3.

FileKey -> (строка)

Имя ключа объекта Amazon S3.

ReferenceRoleARN -> (строка)

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

Примечание

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

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

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

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

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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