Spec-Zone.ru › AWS CLI v2

[ aws . iottwinmaker ]

batch-put-property-values

Описание

Устанавливает значения для нескольких свойств временных рядов.

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

Синтаксис

  batch-put-property-values
--workspace-id <value>
--entries <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]

Параметры

--workspace-id (строка)

Идентификатор рабочей области, содержащей свойства для установки.

--entries (список)

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

(структура)

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

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

Объект, содержащий информацию об сущности, имеющей свойство.

componentName -> (строка)

Имя компонента.

componentPath -> (строка)

Эта строка указывает путь к составному компоненту, начиная с верхнего уровня компонента.

externalIdProperty -> (карта)

Сопоставление внешних идентификаторов с именами свойств. Внешние идентификаторы однозначно идентифицируют свойства из внешних хранилищ данных.

key -> (строка)

value -> (строка)

entityId -> (строка)

Идентификатор сущности.

propertyName -> (строка)

Имя свойства.

propertyValues -> (список)

Список объектов, описывающих значения свойств временных рядов.

(структура)

Объект, содержащий информацию о значении для свойства временного ряда.

timestamp -> (временная метка)

Временная метка значения для свойства временного ряда.

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

Объект, описывающий значение для свойства временного ряда.

booleanValue -> (булево)

Булево значение.

doubleValue -> (двойное)

Двойное значение.

integerValue -> (целое)

Целое значение.

longValue -> (длинное целое)

Длинное целое значение.

stringValue -> (строка)

Строковое значение.

listValue -> (список)

Список нескольких значений.

(структура)

Объект, описывающий значение для свойства.

booleanValue -> (булево)

Булево значение.

doubleValue -> (двойное)

Двойное значение.

integerValue -> (целое)

Целое значение.

longValue -> (длинное целое)

Длинное целое значение.

stringValue -> (строка)

Строковое значение.

listValue -> (список)

Список нескольких значений.

(… рекурсивно …)

mapValue -> (карта)

Объект, сопоставляющий строки с несколькими DataValue объектами.

key -> (строка)

(… рекурсивно …)

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

Значение, связывающее компонент с другим компонентом.

targetEntityId -> (строка)

Идентификатор целевой сущности, связанной с этим значением связи.

targetComponentName -> (строка)

Имя целевого компонента, связанного со значением связи.

expression -> (строка)

Выражение, которое генерирует значение.

mapValue -> (карта)

Объект, сопоставляющий строки с несколькими DataValue объектами.

key -> (строка)

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

Объект, описывающий значение для свойства.

booleanValue -> (булево)

Булево значение.

doubleValue -> (двойное)

Двойное значение.

integerValue -> (целое)

Целое значение.

longValue -> (длинное целое)

Длинное целое значение.

stringValue -> (строка)

Строковое значение.

listValue -> (список)

Список нескольких значений.

(… рекурсивно …)

mapValue -> (карта)

Объект, сопоставляющий строки с несколькими DataValue объектами.

key -> (строка)

(… рекурсивно …)

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

Значение, связывающее компонент с другим компонентом.

targetEntityId -> (строка)

Идентификатор целевой сущности, связанной с этим значением связи.

targetComponentName -> (строка)

Имя целевого компонента, связанного со значением связи.

expression -> (строка)

Выражение, которое генерирует значение.

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

Значение, связывающее компонент с другим компонентом.

targetEntityId -> (строка)

Идентификатор целевой сущности, связанной с этим значением связи.

targetComponentName -> (строка)

Имя целевого компонента, связанного со значением связи.

expression -> (строка)

Выражение, которое генерирует значение.

time -> (строка)

ISO8601 DateTime значения для свойства временного ряда.

Время, когда было записано значение свойства, в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm] .

  • [YYYY] : год
  • [MM] : месяц
  • [DD] : день
  • [hh] : час
  • [mm] : минута
  • [ss] : секунда
  • [.SSSSSSSSS] : дополнительная точность, где приоритет сохраняется. Например: [.573123] равно 573123000 наносекундам.
  • Z : по умолчанию часовой пояс UTC
  • ± HH:mm : смещение часового пояса в часах и минутах.
Обязательные подполя : YYYY-MM-DDThh:mm:ss и [Z/±HH:mm]

Синтаксис JSON:

[
  {
    "entityPropertyReference": {
      "componentName": "string",
      "componentPath": "string",
      "externalIdProperty": {"string": "string"
        ...},
      "entityId": "string",
      "propertyName": "string"
    },
    "propertyValues": [
      {
        "timestamp": timestamp,
        "value": {
          "booleanValue": true|false,
          "doubleValue": double,
          "integerValue": integer,
          "longValue": long,
          "stringValue": "string",
          "listValue": [
            {
              "booleanValue": true|false,
              "doubleValue": double,
              "integerValue": integer,
              "longValue": long,
              "stringValue": "string",
              "listValue": [
                { ... recursive ... }
                ...
              ],
              "mapValue": {"string": { ... recursive ... }
                ...},
              "relationshipValue": {
                "targetEntityId": "string",
                "targetComponentName": "string"
              },
              "expression": "string"
            }
            ...
          ],
          "mapValue": {"string": {
                "booleanValue": true|false,
                "doubleValue": double,
                "integerValue": integer,
                "longValue": long,
                "stringValue": "string",
                "listValue": [
                  { ... recursive ... }
                  ...
                ],
                "mapValue": {"string": { ... recursive ... }
                  ...},
                "relationshipValue": {
                  "targetEntityId": "string",
                  "targetComponentName": "string"
                },
                "expression": "string"
              }
            ...},
          "relationshipValue": {
            "targetEntityId": "string",
            "targetComponentName": "string"
          },
          "expression": "string"
        },
        "time": "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-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

errorEntries -> (список)

Записи, которые вызвали ошибки при выполнении операции пакетного сохранения.

(структура)

Объект, содержащий информацию об ошибках, возвращённых действием BatchPutProperty.

errors -> (список)

Список объектов, содержащих информацию об ошибках, возвращённых действием BatchPutProperty.

(структура)

Ошибка, возвращённая действием BatchPutProperty.

errorCode -> (строка)

Код ошибки.

errorMessage -> (строка)

Сообщение об ошибке.

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

Объект, содержащий информацию об ошибках, возвращённых действием BatchPutProperty.

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

Объект, содержащий информацию об сущности, у которой есть свойство.

componentName -> (строка)

Имя компонента.

componentPath -> (строка)

Эта строка задаёт путь к составному компоненту, начиная с верхнего уровня компонента.

externalIdProperty -> (карта)

Сопоставление внешних идентификаторов с именами свойств. Внешние идентификаторы однозначно идентифицируют свойства из внешних хранилищ данных.

key -> (строка)

value -> (строка)

entityId -> (строка)

Идентификатор сущности.

propertyName -> (строка)

Имя свойства.

propertyValues -> (список)

Список объектов, определяющих значения свойств временного ряда.

(структура)

Объект, содержащий информацию о значении свойства временного ряда.

timestamp -> (временная метка)

Временная метка значения свойства временного ряда.

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

Объект, определяющий значение свойства временного ряда.

booleanValue -> (булево)

Булево значение.

doubleValue -> (двойное)

Двойное значение.

integerValue -> (целое)

Целое значение.

longValue -> (длинное целое)

Длинное целое значение.

stringValue -> (строка)

Строковое значение.

listValue -> (список)

Список нескольких значений.

(структура)

Объект, определяющий значение свойства.

booleanValue -> (булево)

Булево значение.

doubleValue -> (двойное)

Двойное значение.

integerValue -> (целое)

Целое значение.

longValue -> (длинное целое)

Длинное целое значение.

stringValue -> (строка)

Строковое значение.

listValue -> (список)

Список нескольких значений.

(… рекурсивно …)

mapValue -> (карта)

Объект, сопоставляющий строки с несколькими объектами DataValue.

key -> (строка)

(… рекурсивно …)

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

Значение, связывающее компонент с другим компонентом.

targetEntityId -> (строка)

Идентификатор целевой сущности, связанной с этим значением связи.

targetComponentName -> (строка)

Имя целевого компонента, связанного со значением связи.

expression -> (строка)

Выражение, которое генерирует значение.

mapValue -> (карта)

Объект, сопоставляющий строки с несколькими объектами DataValue.

key -> (строка)

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

Объект, определяющий значение свойства.

booleanValue -> (булево)

Булево значение.

doubleValue -> (двойное)

Двойное значение.

integerValue -> (целое)

Целое значение.

longValue -> (длинное целое)

Длинное целое значение.

stringValue -> (строка)

Строковое значение.

listValue -> (список)

Список нескольких значений.

(… рекурсивно …)

mapValue -> (карта)

Объект, сопоставляющий строки с несколькими объектами DataValue.

key -> (строка)

(… рекурсивно …)

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

Значение, связывающее компонент с другим компонентом.

targetEntityId -> (строка)

Идентификатор целевой сущности, связанной с этим значением связи.

targetComponentName -> (строка)

Имя целевого компонента, связанного со значением связи.

expression -> (строка)

Выражение, которое генерирует значение.

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

Значение, связывающее компонент с другим компонентом.

targetEntityId -> (строка)

Идентификатор целевой сущности, связанной с этим значением связи.

targetComponentName -> (строка)

Имя целевого компонента, связанного со значением связи.

expression -> (строка)

Выражение, которое генерирует значение.

time -> (строка)

ISO8601 DateTime значения свойства временного ряда.

Время, когда было записано значение свойства, в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm] .

  • [YYYY] : год
  • [MM] : месяц
  • [DD] : день
  • [hh] : час
  • [mm] : минута
  • [ss] : секунда
  • [.SSSSSSSSS] : дополнительная точность, где сохраняется приоритет. Например: [.573123] равно 573123000 наносекундам.
  • Z : по умолчанию часовой пояс UTC
  • ± HH:mm : смещение часового пояса в часах и минутах.
Необходимые подполя : YYYY-MM-DDThh:mm:ss и [Z/±HH:mm]

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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