обновить-тип-компонента

Описание

Обновляет информацию о типе компонента.

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

Синтаксис

  update-component-type
--workspace-id <value>
[--is-singleton | --no-is-singleton]
--component-type-id <value>
[--description <value>]
[--property-definitions <value>]
[--extends-from<value>]
[--functions <value>]
[--property-groups <value>]
[--component-type-name <value>]
[--composite-component-types <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 (строка)

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

--is-singleton | --no-is-singleton (логическое значение)

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

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

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

--description (строка)

Описание типа компонента.

--property-definitions (отображение)

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

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

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

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

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

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

type -> (строка)

Базовый тип данных.

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

Вложенный тип данных.

type -> (строка)

Базовый тип данных.

( … рекурсивно … )allowedValues -> (список)

Допустимые значения для данного типа данных.

(структура)

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

booleanValue -> (булево)

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

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

Значение с плавающей точкой.

integerValue -> (целое)

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

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

Значение длинного целого.

stringValue -> (строка)

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

listValue -> (список)

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

(структура)

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

booleanValue -> (булево)

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

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

Значение с плавающей точкой.

integerValue -> (целое)

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

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

Значение длинного целого.

stringValue -> (строка)

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

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

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

unitOfMeasure -> (строка)

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

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

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

targetComponentTypeId -> (строка)

Идентификатор целевого типа компонента, связанного с этой связью.

relationshipType -> (строка)

Тип связи.

allowedValues -> (список)

Допустимые значения для этого типа данных.

(структура)

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

booleanValue -> (булево)

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

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

Значение с плавающей точкой.

integerValue -> (целое)

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

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

Значение длинного целого.

stringValue -> (строка)

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

listValue -> (список)

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

(структура)

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

booleanValue -> (булево)

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

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

Значение с плавающей точкой.

integerValue -> (целое)

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

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

Значение длинного целого.

stringValue -> (строка)

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

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

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

unitOfMeasure -> (строка)

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

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

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

targetComponentTypeId -> (строка)

Идентификатор целевого типа компонента, связанного с этой связью.

relationshipType -> (строка)

Тип связи.

isRequiredInEntity -> (булево)

Булево значение, указывающее, является ли свойство обязательным.

isExternalId -> (булево)

Булево значение, указывающее, получен ли идентификатор свойства из внешнего хранилища данных.

isStoredExternally -> (булево)

Булево значение, указывающее, хранится ли свойство во внешнем хранилище.

isTimeSeries -> (булево)

Булево значение, указывающее, состоит ли свойство из временных рядов.

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

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

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

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

configuration -> (словарь)

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

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

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

displayName -> (строка)

Дружественное имя свойства.

Синтаксис JSON:

{"string": {
      "dataType": {
        "type": "RELATIONSHIP"|"STRING"|"LONG"|"BOOLEAN"|"INTEGER"|"DOUBLE"|"LIST"|"MAP",
        "nestedType": {
          "type": "RELATIONSHIP"|"STRING"|"LONG"|"BOOLEAN"|"INTEGER"|"DOUBLE"|"LIST"|"MAP",
          "nestedType": { ... recursive ... },
          "allowedValues": [
            {
              "booleanValue": true|false,
              "doubleValue": double,
              "integerValue": integer,
              "longValue": long,
              "stringValue": "string",
              "listValue": [
                {
                  "booleanValue": true|false,
                  "doubleValue": double,
                  "integerValue": integer,
                  "longValue": long,
                  "stringValue": "string",
                  "listValue": ,
                  "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"
            }
            ...
          ],
          "unitOfMeasure": "string",
          "relationship": {
            "targetComponentTypeId": "string",
            "relationshipType": "string"
          }
        },
        "allowedValues": [
          {
            "booleanValue": true|false,
            "doubleValue": double,
            "integerValue": integer,
            "longValue": long,
            "stringValue": "string",
            "listValue": [
              {
                "booleanValue": true|false,
                "doubleValue": double,
                "integerValue": integer,
                "longValue": long,
                "stringValue": "string",
                "listValue": ,
                "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"
          }
          ...
        ],
        "unitOfMeasure": "string",
        "relationship": {
          "targetComponentTypeId": "string",
          "relationshipType": "string"
        }
      },
      "isRequiredInEntity": true|false,
      "isExternalId": true|false,
      "isStoredExternally": true|false,
      "isTimeSeries": true|false,
      "defaultValue": {
        "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"
      },
      "configuration": {"string": "string"
        ...},
      "displayName": "string"
    }
  ...}

--extends-from (список)

Указывает тип компонента, который расширяет этот тип компонента.

(строка)

Синтаксис:

"string" "string" ...

--functions (словарь)

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

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

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

Тело запроса функции.

requiredProperties -> (список)

Необходимые свойства функции.

(строка)

scope -> (строка)

Область действия функции.

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

Коннектор данных.

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

Функция Lambda, связанная с этим коннектором данных.

arn -> (строка)

ARN функции Lambda.

isNative -> (булево)

Булево значение, указывающее, является ли коннектор данных встроенным в IoT TwinMaker.

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

KeyName1=requiredProperties=string,string,scope=string,implementedBy={lambda={arn=string},isNative=boolean},KeyName2=requiredProperties=string,string,scope=string,implementedBy={lambda={arn=string},isNative=boolean}

Синтаксис JSON:

{"string": {
      "requiredProperties": ["string", ...],
      "scope": "ENTITY"|"WORKSPACE",
      "implementedBy": {
        "lambda": {
          "arn": "string"
        },
        "isNative": true|false
      }
    }
  ...}

--property-groups (словарь)

Группы свойств.

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

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

groupType -> (строка)

Тип группы.

propertyNames -> (список)

Имена свойств.

(строка)

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

KeyName1=groupType=string,propertyNames=string,string,KeyName2=groupType=string,propertyNames=string,string

Синтаксис JSON:

{"string": {
      "groupType": "TABULAR",
      "propertyNames": ["string", ...]
    }
  ...}

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

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

--composite-component-types (словарь)

Это объект, который сопоставляет строки с compositeComponentTypes componentType. CompositeComponentType ссылается на componentTypeId.

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

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

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

componentTypeId -> (строка)

Это componentTypeId, на который ссылается compositeComponentType.

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

KeyName1=componentTypeId=string,KeyName2=componentTypeId=string

Синтаксис JSON:

{"string": {
      "componentTypeId": "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.

Вывод

workspaceId -> (строка)

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

arn -> (строка)

ARN типа компонента.

componentTypeId -> (строка)

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

state -> (строка)

Текущее состояние типа компонента.