[ aws . iottwinmaker ]
get-property-value
Описание
Получает значения свойств для компонента, типа компонента, сущности или рабочей области.
Вы должны указать значение для componentName , componentTypeId , entityId или workspaceId.
См. также: Документация AWS API
Синтаксис
get-property-value
[--component-name <value>]
[--component-path <value>]
[--component-type-id <value>]
[--entity-id <value>]
--selected-properties <value>
--workspace-id <value>
[--max-results <value>]
[--next-token <value>]
[--property-group-name <value>]
[--tabular-conditions <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]
Параметры
--component-name (строка)
--component-path (строка)
--component-type-id (строка)
--entity-id (строка)
--selected-properties (список)
Свойства, значения которых возвращает операция.
(строка)
Синтаксис:
"string" "string" ...
--workspace-id (строка)
--max-results (целое число)
Максимальное количество результатов, возвращаемых за один раз. По умолчанию 25.
Допустимый диапазон: минимальное значение 1, максимальное 250.
--next-token (строка)
--property-group-name (строка)
--tabular-conditions (структура)
Условные данные в табличной форме.
orderBy -> (список)
Критерии фильтрации для сортировки вывода. Может сортироваться по возрастанию или убыванию.
(структура)
Критерии фильтрации для сортировки возвращаемых данных. Может сортироваться по возрастанию или убыванию.
order -> (строка)
propertyName -> (строка)
propertyFilters -> (список)
Можно фильтровать запрос с использованием различных логических операторов и формата ключ-значение. Например:
{"key": "serverType", "value": "webServer"}(структура)
Объект, фильтрующий элементы, возвращаемые запросом к свойству.
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 Синтаксис:
{
"orderBy": [
{
"order": "ASCENDING"|"DESCENDING",
"propertyName": "string"
}
...
],
"propertyFilters": [
{
"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"
}
}
...
]
}
--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 -> (map)
Объект, сопоставляющий строки с свойствами и последними значениями свойств в ответе. Каждая строка в этом отображении должна быть уникальной для данного объекта.
ключ -> (строка)
значение -> (структура)
Последнее значение свойства.
propertyReference -> (структура)
Объект, определяющий информацию о свойстве.
componentName -> (строка)
componentPath -> (строка)
externalIdProperty -> (map)
Отображение внешних идентификаторов к именам свойств. Внешние идентификаторы однозначно идентифицируют свойства из внешних хранилищ данных.
ключ -> (строка)
значение -> (строка)
entityId -> (строка)
propertyName -> (строка)
propertyValue -> (структура)
Значение свойства.
booleanValue -> (boolean)
doubleValue -> (double)
integerValue -> (integer)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(структура)
Объект, определяющий значение для свойства.
booleanValue -> (boolean)
doubleValue -> (double)
integerValue -> (integer)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
( … рекурсивно … )
mapValue -> (map)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
( … рекурсивно … )
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
mapValue -> (map)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
значение -> (структура)
Объект, определяющий значение для свойства.
booleanValue -> (boolean)
doubleValue -> (double)
integerValue -> (integer)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
( … рекурсивно … )
mapValue -> (map)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
( … рекурсивно … )
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
nextToken -> (строка)
tabularPropertyValues -> (список)
Таблица значений свойств.
(список)
(map)
ключ -> (строка)
значение -> (структура)
Объект, определяющий значение для свойства.
booleanValue -> (boolean)
doubleValue -> (double)
integerValue -> (integer)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(структура)
Объект, определяющий значение для свойства.
booleanValue -> (boolean)
doubleValue -> (double)
integerValue -> (integer)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
( … рекурсивно … )
mapValue -> (map)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
( … рекурсивно … )
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
mapValue -> (map)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
значение -> (структура)
Объект, определяющий значение для свойства.
booleanValue -> (boolean)
doubleValue -> (double)
integerValue -> (integer)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
( … рекурсивно … )
mapValue -> (map)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
( … рекурсивно … )
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.