Spec-Zone.ru › AWS CLI v2

[ aws . iotanalytics ]

update-pipeline

Описание

Обновляет настройки конвейера. Вы должны указать как channel, так и datastore активность, а также, необязательно, до 23 дополнительных активностей в массиве pipelineActivities.

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

Синтаксис

  update-pipeline
--pipeline-name <value>
--pipeline-activities <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]

Параметры

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

Имя конвейера для обновления.

--pipeline-activities (список)

Список объектов PipelineActivity. Активности выполняют преобразования ваших сообщений, такие как удаление, переименование или добавление атрибутов сообщений; фильтрацию сообщений на основе значений атрибутов; вызов ваших функций Lambda для расширенной обработки; или выполнение математических преобразований для нормализации данных устройств.

Список может содержать от 2 до 25 объектов PipelineActivity и должен содержать как channel, так и datastore активность. Каждый элемент списка должен содержать только одну активность. Например:

pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

(структура)

Активность, выполняющая преобразование сообщения.

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

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

name -> (строка)

Имя активности канала.

channelName -> (строка)

Имя канала, из которого обрабатываются сообщения.

next -> (строка)

Следующая активность в конвейере.

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

Выполняет функцию Lambda для модификации сообщения.

name -> (строка)

Имя активности lambda.

lambdaName -> (строка)

Имя функции Lambda, которая выполняется над сообщением.

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

Количество сообщений, передаваемых функции Lambda для обработки.

Функция Lambda должна быть способна обработать все эти сообщения в течение пяти минут, что является максимальным временем ожидания для функций Lambda.

next -> (строка)

Следующая активность в конвейере.

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

Указывает место хранения обработанных данных сообщения.

name -> (строка)

Имя активности хранилища данных.

datastoreName -> (строка)

Имя хранилища данных, в котором хранятся обработанные сообщения.

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

Добавляет другие атрибуты на основе существующих атрибутов в сообщении.

name -> (строка)

Имя активности addAttributes.

attributes -> (карта)

Список из 1 до 50 объектов AttributeNameMapping, которые сопоставляют существующий атрибут с новым.

Примечание

Существующие атрибуты остаются в сообщении, поэтому, если вы хотите удалить оригиналы, используйте RemoveAttributeActivity.

key -> (строка)

value -> (строка)

next -> (строка)

Следующая активность в конвейере.

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

Удаляет атрибуты из сообщения.

name -> (строка)

Имя активности removeAttributes.

attributes -> (список)

Список из 1 до 50 атрибутов для удаления из сообщения.

(строка)

next -> (строка)

Следующая активность в конвейере.

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

Используется для создания нового сообщения, используя только указанные атрибуты из исходного сообщения.

name -> (строка)

Имя активности selectAttributes.

attributes -> (список)

Список атрибутов для выбора из сообщения.

(строка)

next -> (строка)

Следующая активность в конвейере.

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

Фильтрует сообщение на основе его атрибутов.

name -> (строка)

Имя активности фильтра.

filter -> (строка)

Выражение, похожее на предложение SQL WHERE, которое должно возвращать булевое значение. Сообщения, удовлетворяющие условию, передаются следующей активности.

next -> (строка)

Следующая активность в конвейере.

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

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

name -> (строка)

Имя активности math.

attribute -> (строка)

Имя атрибута, содержащего результат математической операции.

math -> (строка)

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

next -> (строка)

Следующая активность в конвейере.

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

Добавляет данные из реестра устройств IoT в ваше сообщение.

name -> (строка)

Имя активности deviceRegistryEnrich.

attribute -> (строка)

Имя атрибута, который добавляется к сообщению.

thingName -> (строка)

Имя IoT устройства, чья информация реестра добавляется в сообщение.

roleArn -> (строка)

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

next -> (строка)

Следующая активность в конвейере.

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

Добавляет информацию из службы отслеживания состояния IoT устройства в сообщение.

name -> (строка)

Имя активности deviceShadowEnrich.

attribute -> (строка)

Имя атрибута, который добавляется к сообщению.

thingName -> (строка)

Имя IoT устройства, чья информация о состоянии добавляется в сообщение.

roleArn -> (строка)

ARN роли, которая позволяет получить доступ к состоянию устройства.

next -> (строка)

Следующая активность в конвейере.

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

channel={name=string,channelName=string,next=string},lambda={name=string,lambdaName=string,batchSize=integer,next=string},datastore={name=string,datastoreName=string},addAttributes={name=string,attributes={KeyName1=string,KeyName2=string},next=string},removeAttributes={name=string,attributes=[string,string],next=string},selectAttributes={name=string,attributes=[string,string],next=string},filter={name=string,filter=string,next=string},math={name=string,attribute=string,math=string,next=string},deviceRegistryEnrich={name=string,attribute=string,thingName=string,roleArn=string,next=string},deviceShadowEnrich={name=string,attribute=string,thingName=string,roleArn=string,next=string} ...

Синтаксис JSON:

[
  {
    "channel": {
      "name": "string",
      "channelName": "string",
      "next": "string"
    },
    "lambda": {
      "name": "string",
      "lambdaName": "string",
      "batchSize": integer,
      "next": "string"
    },
    "datastore": {
      "name": "string",
      "datastoreName": "string"
    },
    "addAttributes": {
      "name": "string",
      "attributes": {"string": "string"
        ...},
      "next": "string"
    },
    "removeAttributes": {
      "name": "string",
      "attributes": ["string", ...],
      "next": "string"
    },
    "selectAttributes": {
      "name": "string",
      "attributes": ["string", ...],
      "next": "string"
    },
    "filter": {
      "name": "string",
      "filter": "string",
      "next": "string"
    },
    "math": {
      "name": "string",
      "attribute": "string",
      "math": "string",
      "next": "string"
    },
    "deviceRegistryEnrich": {
      "name": "string",
      "attribute": "string",
      "thingName": "string",
      "roleArn": "string",
      "next": "string"
    },
    "deviceShadowEnrich": {
      "name": "string",
      "attribute": "string",
      "thingName": "string",
      "roleArn": "string",
      "next": "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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.

Для обновления конвейера

Следующий пример update-pipeline изменяет настройки указанного конвейера. Вы должны указать как канал, так и активность хранилища данных, а также, необязательно, до 23 дополнительных активностей в массиве pipelineActivities.

aws iotanalytics update-pipeline \
    --cli-input-json file://update-pipeline.json

Содержание файла update-pipeline.json:

{
    "pipelineName": "mypipeline",
    "pipelineActivities": [
        {
            "channel": {
                "name": "myChannelActivity",
                "channelName": "mychannel",
                "next": "myMathActivity"
            }
        },
        {
            "datastore": {
                "name": "myDatastoreActivity",
                "datastoreName": "mydatastore"
            }
        },
        {
            "math": {
                "name": "myMathActivity",
                "math": "(((temp - 32) * 5.0) / 9.0) + 273.15",
                "attribute": "tempK",
                "next": "myDatastoreActivity"
            }
        }
    ]
}

Эта команда не выводит ничего.

Для получения дополнительной информации см. UpdatePipeline в справке по API AWS IoT Analytics.

Вывод

Нет

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

Spec-Zone.ru

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