get-component-type

Описание

Получает информацию о типе компонента.

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

Синтаксис

  get-component-type
--workspace-id <value>
--component-type-id <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 (строка)

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

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

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

--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
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки из конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

on
off
auto

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок 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.

Вывод

workspaceId -> (строка)

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

isSingleton -> (логическое)

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

componentTypeId -> (строка)

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

description -> (строка)

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

propertyDefinitions -> (карта)

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

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

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

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

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

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

тип -> (строка)

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

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

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

тип -> (строка)

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

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

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

(структура)

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

booleanValue -> (логическое)

Логическое значение.

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

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

integerValue -> (целое)

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

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

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

stringValue -> (строка)

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

listValue -> (список)

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

(структура)

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

booleanValue -> (логическое)

Логическое значение.

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

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

integerValue -> (целое)

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

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

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

stringValue -> (строка)

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

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

Выражение, производящее значение.

unitOfMeasure -> (строка)

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

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

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

targetComponentTypeId -> (строка)

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

relationshipType -> (строка)

Тип отношения.

allowedValues -> (список)

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

(структура)

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

booleanValue -> (логическое)

Логическое значение.

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

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

integerValue -> (целое)

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

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

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

stringValue -> (строка)

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

listValue -> (список)

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

(структура)

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

booleanValue -> (логическое)

Логическое значение.

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

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

integerValue -> (целое)

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

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

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

stringValue -> (строка)

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

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

Выражение, производящее значение.

unitOfMeasure -> (строка)

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

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

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

targetComponentTypeId -> (строка)

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

relationshipType -> (строка)

Тип отношения.

isTimeSeries -> (логическое)

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

isRequiredInEntity -> (логическое)

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

isExternalId -> (логическое)

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

isStoredExternally -> (логическое)

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

isImported -> (логическое)

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

isFinal -> (логическое)

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

isInherited -> (логическое)

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

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

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

booleanValue -> (boolean)

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

doubleValue -> (double)

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

integerValue -> (integer)

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

longValue -> (long)

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

stringValue -> (string)

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

listValue -> (list)

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

(структура)

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

booleanValue -> (boolean)

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

doubleValue -> (double)

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

integerValue -> (integer)

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

longValue -> (long)

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

stringValue -> (string)

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

listValue -> (list)

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

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

mapValue -> (map)

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

key -> (string)

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

relationshipValue -> (structure)

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

targetEntityId -> (string)

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

targetComponentName -> (string)

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

expression -> (string)

Выражение, производящее значение.

mapValue -> (map)

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

key -> (string)

value -> (structure)

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

booleanValue -> (boolean)

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

doubleValue -> (double)

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

integerValue -> (integer)

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

longValue -> (long)

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

stringValue -> (string)

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

listValue -> (list)

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

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

mapValue -> (map)

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

key -> (string)

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

relationshipValue -> (structure)

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

targetEntityId -> (string)

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

targetComponentName -> (string)

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

expression -> (string)

Выражение, производящее значение.

relationshipValue -> (structure)

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

targetEntityId -> (string)

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

targetComponentName -> (string)

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

expression -> (string)

Выражение, производящее значение.

configuration -> (map)

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

key -> (string)

value -> (string)

displayName -> (string)

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

extendsFrom -> (list)

Имя родительского типа компонента, от которого расширяется данный тип компонента.

(string)

functions -> (map)

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

key -> (string)

value -> (structure)

Функция ответа.

requiredProperties -> (list)

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

(string)

scope -> (string)

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

implementedBy -> (structure)

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

lambda -> (structure)

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

arn -> (string)

ARN функции Lambda.

isNative -> (boolean)

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

isInherited -> (boolean)

Указывает, унаследована ли эта функция.

creationDateTime -> (timestamp)

Дата и время создания типа компонента.

updateDateTime -> (timestamp)

Дата и время последнего обновления компонента.

arn -> (string)

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

isAbstract -> (boolean)

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

isSchemaInitialized -> (boolean)

Булево значение, указывающее, имеет ли тип компонента инициализатор схемы и был ли он выполнен.

status -> (structure)

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

state -> (string)

Текущее состояние сущности, компонента, типа компонента или рабочей области.

error -> (structure)

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

code -> (string)

Код ошибки.

message -> (string)

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

propertyGroups -> (map)

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

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

key -> (string)

value -> (structure)

Ответ группы свойств

groupType -> (string)

Типы групп.

propertyNames -> (list)

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

(string)

isInherited -> (boolean)

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

syncSource -> (string)

syncSource задания SyncJob, если эта сущность была создана заданием SyncJob.

componentTypeName -> (string)

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

compositeComponentTypes -> (map)

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

key -> (string)

value -> (structure)

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

componentTypeId -> (string)

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

isInherited -> (boolean)

Этот булево переменная указывает, унаследована ли данная compositeComponentType от родителя.