Spec-Zone.ru › AWS CLI v2

[ aws . iottwinmaker ]

get-property-value-history

Описание

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

Вы должны указать значение для workspaceId . Для запросов, специфичных для сущности, укажите значения для componentName и entityId . Для межсущностных запросов укажите значение для componentTypeId .

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

Синтаксис

  get-property-value-history
--workspace-id <value>
[--entity-id <value>]
[--component-name <value>]
[--component-path <value>]
[--component-type-id <value>]
--selected-properties <value>
[--property-filters <value>]
[--start-date-time <value>]
[--end-date-time <value>]
[--interpolation <value>]
[--next-token <value>]
[--max-results <value>]
[--order-by-time <value>]
[--start-time <value>]
[--end-time <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 (строка)

Идентификатор рабочей области.

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

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

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

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

--component-path (строка)

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

--component-type-id (строка)

Идентификатор типа компонента.

--selected-properties (список)

Список свойств, истории значений которых запрашивает запрос.

(строка)

Синтаксис:

"string" "string" ...

--property-filters (список)

Список объектов, фильтрующих запрос истории значений свойства.

(структура)

Объект, фильтрующий элементы, возвращаемые запросом к свойству.

propertyName -> (строка)

Имя свойства, связанное с этим фильтром свойства.

operator -> (строка)

Оператор, связанный с этим фильтром свойства.

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

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

Синтаксис JSON:

[
  {
    "propertyName": "string",
    "operator": "string",
    "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"
    }
  }
  ...
]

--start-date-time (метка времени)

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

--end-date-time (метка времени)

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

--interpolation (структура)

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

interpolationType -> (строка)

Тип интерполяции.

intervalInSeconds -> (длинное целое число)

Интервал интерполяции во времени в секундах.

Краткая форма синтаксиса:

interpolationType=string,intervalInSeconds=long

Синтаксис JSON:

{
  "interpolationType": "LINEAR",
  "intervalInSeconds": long
}

--next-token (строка)

Строка, указывающая следующую страницу результатов.

--max-results (целое число)

Максимальное количество результатов, возвращаемых за один раз. По умолчанию 25.

Допустимый диапазон: Минимальное значение 1. Максимальное значение 250.

--order-by-time (строка)

Направление времени для использования в порядке результатов.

Возможные значения:

  • ASCENDING
  • DESCENDING

--start-time (строка)

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

Для получения дополнительной информации о формате ISO8601 DateTime см. тип данных PropertyValue.

--end-time (строка)

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

Для получения дополнительной информации о формате ISO8601 DateTime см. тип данных PropertyValue.

--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.

Вывод

propertyValues -> (список)

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

(структура)

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

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

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

componentName -> (строка)

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

componentPath -> (строка)

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

externalIdProperty -> (отображение)

Отображение внешних идентификаторов к именам свойств. Внешние идентификаторы уникально идентифицируют свойства из внешних хранилищ данных.

ключ -> (строка)

значение -> (строка)

entityId -> (строка)

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

propertyName -> (строка)

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

values -> (список)

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

(структура)

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

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

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

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

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

booleanValue -> (булево)

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

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

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

integerValue -> (целое)

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

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

Значение типа long.

stringValue -> (строка)

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

listValue -> (список)

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

(структура)

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

booleanValue -> (булево)

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

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

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

integerValue -> (целое)

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

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

Значение типа long.

stringValue -> (строка)

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

listValue -> (список)

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

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

mapValue -> (отображение)

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

ключ -> (строка)

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

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

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

targetEntityId -> (строка)

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

targetComponentName -> (строка)

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

expression -> (строка)

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

mapValue -> (отображение)

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

ключ -> (строка)

значение -> (структура)

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

booleanValue -> (булево)

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

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

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

integerValue -> (целое)

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

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

Значение типа long.

stringValue -> (строка)

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

listValue -> (список)

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

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

mapValue -> (отображение)

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

ключ -> (строка)

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

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

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

targetEntityId -> (строка)

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

targetComponentName -> (строка)

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

expression -> (строка)

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

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

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

targetEntityId -> (строка)

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

targetComponentName -> (строка)

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

expression -> (строка)

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

time -> (строка)

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

Время, когда значение свойства было записано в формате ISO 8601: ГГГГ-ММ-ДДТчч:мм:сс[.SSSSSSSSS][Z/±ЧЧ:мм] .

  • [ГГГГ] : год
  • [ММ] : месяц
  • [ДД] : день
  • [чч] : час
  • [мм] : минута
  • [сс] : секунда
  • [.SSSSSSSSS] : дополнительная точность, где приоритет сохраняется. Например: [.573123] равно 573123000 наносекундам.
  • Z : по умолчанию часовой пояс UTC
  • ± ЧЧ:мм : смещение часового пояса в часах и минутах.
Обязательные подполя : ГГГГ-ММ-ДДТчч:мм:сс и [Z/±ЧЧ:мм]

nextToken -> (строка)

Строка, определяющая следующую страницу результатов.

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

Spec-Zone.ru

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