[ aws . iottwinmaker ]
создать-сущность
Описание
Создает сущность.
См. также: Документацию API AWS
Синтаксис
create-entity
--workspace-id <value>
[--entity-id <value>]
--entity-name <value>
[--description <value>]
[--components <value>]
[--composite-components <value>]
[--parent-entity-id <value>]
[--tags <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 (строка)
--entity-name (строка)
--description (строка)
--components (словарь)
Объект, сопоставляющий строки с компонентами в сущности. Каждая строка в отображении должна быть уникальной для этого объекта.
ключ -> (строка)
значение -> (структура)
Объект, устанавливающий информацию о типе компонента для запроса создания или обновления.
описание -> (строка)
componentTypeId -> (строка)
свойства -> (словарь)
Объект, сопоставляющий строки с свойствами, которые необходимо установить в типе компонента. Каждая строка в отображении должна быть уникальной для этого объекта.
ключ -> (строка)
значение -> (структура)
Объект, задающий информацию о свойстве.
definition -> (структура)
Объект, определяющий информацию о свойстве.
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 -> (строка)
значение -> (структура)
Значение свойства.
booleanValue -> (булево)
doubleValue -> (двойное)
integerValue -> (целое)
longValue -> (длинное)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(структура)
Объект, определяющий значение для свойства.
booleanValue -> (булево)
doubleValue -> (двойное)
integerValue -> (целое)
longValue -> (длинное)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(… рекурсивно …)
mapValue -> (карта)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
(… рекурсивно …)
relationshipValue -> (структура)
Значение, которое связывает компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
mapValue -> (карта)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
значение -> (структура)
Объект, определяющий значение для свойства.
booleanValue -> (булево)
doubleValue -> (двойное)
integerValue -> (целое)
longValue -> (длинное)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(… рекурсивно …)
mapValue -> (карта)
Объект, сопоставляющий строки с несколькими DataValue объектами.
ключ -> (строка)
(… рекурсивно …)
relationshipValue -> (структура)
Значение, которое связывает компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
relationshipValue -> (структура)
Значение, которое связывает компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
updateType -> (строка)
propertyGroups -> (карта)
Группы свойств.
ключ -> (строка)
значение -> (структура)
Запрос группы свойств компонента.
groupType -> (строка)
propertyNames -> (список)
Имена свойств.
(строка)
updateType -> (строка)
Синтаксис JSON:
{"string": {
"description": "string",
"componentTypeId": "string",
"properties": {"string": {
"definition": {
"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"
},
"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"
},
"updateType": "UPDATE"|"DELETE"|"CREATE"|"RESET_VALUE"
}
...},
"propertyGroups": {"string": {
"groupType": "TABULAR",
"propertyNames": ["string", ...],
"updateType": "UPDATE"|"DELETE"|"CREATE"
}
...}
}
...}
--composite-components (карта)
Это объект, который сопоставляет строки с compositeComponent обновлениями в запросе. Каждый ключ карты представляет componentPath compositeComponent .
ключ -> (строка)
значение -> (структура)
Объект, устанавливающий информацию о запросе обновления составного компонента.
description -> (строка)
properties -> (карта)
Это объект, который сопоставляет строки с свойствами для установки в типе компонента. Каждая строка в сопоставлении должна быть уникальной для этого объекта.
ключ -> (строка)
значение -> (структура)
Объект, устанавливающий информацию о свойстве.
definition -> (структура)
Объект, определяющий информацию о свойстве.
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 -> (строка)
значение -> (структура)
Значение свойства.
booleanValue -> (булево)
doubleValue -> (double)
integerValue -> (целое)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(структура)
Объект, определяющий значение свойства.
booleanValue -> (булево)
doubleValue -> (double)
integerValue -> (целое)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(… рекурсивно …)
mapValue -> (отображение)
Объект, отображающий строки на несколько объектов DataValue.
ключ -> (строка)
(… рекурсивно …)
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
mapValue -> (отображение)
Объект, отображающий строки на несколько объектов DataValue.
ключ -> (строка)
значение -> (структура)
Объект, определяющий значение свойства.
booleanValue -> (булево)
doubleValue -> (double)
integerValue -> (целое)
longValue -> (long)
stringValue -> (строка)
listValue -> (список)
Список нескольких значений.
(… рекурсивно …)
mapValue -> (отображение)
Объект, отображающий строки на несколько объектов DataValue.
ключ -> (строка)
(… рекурсивно …)
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
relationshipValue -> (структура)
Значение, связывающее компонент с другим компонентом.
targetEntityId -> (строка)
targetComponentName -> (строка)
expression -> (строка)
updateType -> (строка)
propertyGroups -> (отображение)
Группы свойств.
ключ -> (строка)
значение -> (структура)
Запрос группы свойств компонента.
groupType -> (строка)
propertyNames -> (список)
Имена свойств.
(строка)
updateType -> (строка)
Синтаксис JSON:
{"string": {
"description": "string",
"properties": {"string": {
"definition": {
"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"
},
"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"
},
"updateType": "UPDATE"|"DELETE"|"CREATE"|"RESET_VALUE"
}
...},
"propertyGroups": {"string": {
"groupType": "TABULAR",
"propertyNames": ["string", ...],
"updateType": "UPDATE"|"DELETE"|"CREATE"
}
...}
}
...}
--parent-entity-id (строка)
--tags (отображение)
Метаданные, которые вы можете использовать для управления сущностью.
ключ -> (строка)
значение -> (строка)
Краткая запись синтаксиса:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "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
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- включено
- выключено
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификата CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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 для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров входных данных CLI.
Вывод
entityId -> (строка)
arn -> (строка)
creationDateTime -> (метка времени)
state -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
