Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalytics ]

обновить-приложение

Описание

Примечание

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

Обновляет существующее приложение Amazon Kinesis Analytics. С помощью этого API вы можете обновить код приложения, конфигурацию ввода и конфигурацию вывода.

Обратите внимание, что Amazon Kinesis Analytics обновляет CurrentApplicationVersionId каждый раз при обновлении вашего приложения.

Для этого действия требуется разрешение на kinesisanalytics:UpdateApplication действие.

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

Синтаксис

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

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

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

Описывает обновления приложения.

InputUpdates -> (список)

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

(структура)

Описывает обновления конкретной конфигурации ввода (определяемой по InputId приложения).

InputId -> (строка)

Идентификатор ввода приложения, который необходимо обновить.

NamePrefixUpdate -> (строка)

Префикс имени потоков в приложении, которые Amazon Kinesis Analytics создает для указанного источника потоков.

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

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

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

Предоставляет информацию об обновлении InputLambdaProcessor.

ResourceARNUpdate -> (строка)

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

Примечание

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

RoleARNUpdate -> (строка)

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

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

Если источником потоков является поток Amazon Kinesis, предоставляет обновлённый ARN потока и ARN роли IAM.

ResourceARNUpdate -> (строка)

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

RoleARNUpdate -> (строка)

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

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

Если источником потоков является поток Amazon Kinesis Firehose, предоставляет обновленный ARN потока и ARN роли IAM.

ResourceARNUpdate -> (строка)

Amazon Resource Name (ARN) входного потока Amazon Kinesis Firehose для чтения.

RoleARNUpdate -> (строка)

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

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

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

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

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

RecordFormatType -> (строка)

Тип формата записей.

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

При настройке ввода приложения при создании или обновлении приложения предоставляет дополнительную информацию о сопоставлении, специфичную для формата записи (например, JSON, CSV или разделенные каким-либо разделителем поля записей) в источнике потоков.

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

Предоставляет дополнительную информацию о сопоставлении, когда формат записи в источнике потоков — JSON.

RecordRowPath -> (строка)

Путь к родительскому элементу верхнего уровня, содержащему записи.

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

Предоставляет дополнительную информацию о сопоставлении, когда формат записи использует разделители (например, CSV).

RecordRowDelimiter -> (строка)

Разделитель строк. Например, в формате CSV типичным разделителем строк является ‘n’.

RecordColumnDelimiter -> (строка)

Разделитель столбцов. Например, в формате CSV типичным разделителем столбцов является запятая (”,”).

RecordEncodingUpdate -> (строка)

Указывает кодировку записей в источнике потоков. Например, UTF-8.

RecordColumnUpdates -> (список)

Список объектов RecordColumn. Каждый объект описывает сопоставление элемента источника потоков с соответствующим столбцом в потоке приложения.

(структура)

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

Также используется для описания формата источника справочных данных.

Name -> (строка)

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

Mapping -> (строка)

Ссылка на элемент данных в входных данных потока или источнике справочных данных. Этот элемент требуется, если RecordFormatType — JSON.

SqlType -> (строка)

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

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

Описывает обновления параллелизма (количество потоков приложения, создаваемых Amazon Kinesis Analytics для указанного источника потоков).

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

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

ApplicationCodeUpdate -> (строка)

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

OutputUpdates -> (список)

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

(структура)

Описывает обновления конфигурации вывода, определенной по OutputId.

OutputId -> (строка)

Идентифицирует конкретную конфигурацию вывода, которую вы хотите обновить.

NameUpdate -> (строка)

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

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

Описывает поток Amazon Kinesis как пункт назначения вывода.

ResourceARNUpdate -> (строка)

Amazon Resource Name (ARN) потока Amazon Kinesis, куда вы хотите записать вывод.

RoleARNUpdate -> (строка)

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

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

Описывает поток Amazon Kinesis Firehose как пункт назначения вывода.

ResourceARNUpdate -> (строка)

Amazon Resource Name (ARN) потока Amazon Kinesis Firehose, в который нужно записать.

RoleARNUpdate -> (строка)

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

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

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

ResourceARNUpdate -> (строка)

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

Примечание

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

RoleARNUpdate -> (строка)

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

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

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

RecordFormatType -> (строка)

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

ReferenceDataSourceUpdates -> (список)

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

(структура)

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

ReferenceId -> (строка)

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

TableNameUpdate -> (строка)

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

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

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

BucketARNUpdate -> (строка)

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

FileKeyUpdate -> (строка)

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

ReferenceRoleARNUpdate -> (строка)

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

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

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

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

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

CloudWatchLoggingOptionUpdates -> (список)

Описывает обновления параметров ведения журнала CloudWatch для приложения.

(структура)

Описывает обновления параметров ведения журнала CloudWatch.

CloudWatchLoggingOptionId -> (строка)

Идентификатор параметра ведения журнала CloudWatch для обновления

LogStreamARNUpdate -> (строка)

ARN потока журналов CloudWatch для получения сообщений приложения.

RoleARNUpdate -> (строка)

ARN роли IAM для использования для отправки сообщений приложения. Обратите внимание: для записи сообщений приложения в CloudWatch роль IAM должна иметь разрешение PutLogEvents.

Синтаксис JSON:

{
  "InputUpdates": [
    {
      "InputId": "string",
      "NamePrefixUpdate": "string",
      "InputProcessingConfigurationUpdate": {
        "InputLambdaProcessorUpdate": {
          "ResourceARNUpdate": "string",
          "RoleARNUpdate": "string"
        }
      },
      "KinesisStreamsInputUpdate": {
        "ResourceARNUpdate": "string",
        "RoleARNUpdate": "string"
      },
      "KinesisFirehoseInputUpdate": {
        "ResourceARNUpdate": "string",
        "RoleARNUpdate": "string"
      },
      "InputSchemaUpdate": {
        "RecordFormatUpdate": {
          "RecordFormatType": "JSON"|"CSV",
          "MappingParameters": {
            "JSONMappingParameters": {
              "RecordRowPath": "string"
            },
            "CSVMappingParameters": {
              "RecordRowDelimiter": "string",
              "RecordColumnDelimiter": "string"
            }
          }
        },
        "RecordEncodingUpdate": "string",
        "RecordColumnUpdates": [
          {
            "Name": "string",
            "Mapping": "string",
            "SqlType": "string"
          }
          ...
        ]
      },
      "InputParallelismUpdate": {
        "CountUpdate": integer
      }
    }
    ...
  ],
  "ApplicationCodeUpdate": "string",
  "OutputUpdates": [
    {
      "OutputId": "string",
      "NameUpdate": "string",
      "KinesisStreamsOutputUpdate": {
        "ResourceARNUpdate": "string",
        "RoleARNUpdate": "string"
      },
      "KinesisFirehoseOutputUpdate": {
        "ResourceARNUpdate": "string",
        "RoleARNUpdate": "string"
      },
      "LambdaOutputUpdate": {
        "ResourceARNUpdate": "string",
        "RoleARNUpdate": "string"
      },
      "DestinationSchemaUpdate": {
        "RecordFormatType": "JSON"|"CSV"
      }
    }
    ...
  ],
  "ReferenceDataSourceUpdates": [
    {
      "ReferenceId": "string",
      "TableNameUpdate": "string",
      "S3ReferenceDataSourceUpdate": {
        "BucketARNUpdate": "string",
        "FileKeyUpdate": "string",
        "ReferenceRoleARNUpdate": "string"
      },
      "ReferenceSchemaUpdate": {
        "RecordFormat": {
          "RecordFormatType": "JSON"|"CSV",
          "MappingParameters": {
            "JSONMappingParameters": {
              "RecordRowPath": "string"
            },
            "CSVMappingParameters": {
              "RecordRowDelimiter": "string",
              "RecordColumnDelimiter": "string"
            }
          }
        },
        "RecordEncoding": "string",
        "RecordColumns": [
          {
            "Name": "string",
            "Mapping": "string",
            "SqlType": "string"
          }
          ...
        ]
      }
    }
    ...
  ],
  "CloudWatchLoggingOptionUpdates": [
    {
      "CloudWatchLoggingOptionId": "string",
      "LogStreamARNUpdate": "string",
      "RoleARNUpdate": "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.

Вывод

Нет

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

Spec-Zone.ru

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