get-entity

Описание

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

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

Синтаксис

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

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

--entity-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
текст
таблица
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.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Вывод

entityId -> (строка)

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

entityName -> (строка)

Название сущности.

arn -> (строка)

ARN сущности.

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

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

state -> (строка)

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

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

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

code -> (строка)

Код ошибки.

message -> (строка)

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

workspaceId -> (строка)

Идентификатор рабочего пространства.

description -> (строка)

Описание сущности.

components -> (карта)

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

key -> (строка)

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

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

componentName -> (строка)

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

description -> (строка)

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

componentTypeId -> (строка)

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

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

Статус типа компонента.

state -> (строка)

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

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

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

code -> (строка)

Код ошибки.

message -> (строка)

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

definedIn -> (строка)

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

properties -> (карта)

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

key -> (строка)

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

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

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

Тип связи.

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)

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

value -> (structure)

Значение свойства.

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)

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

areAllPropertyValuesReturned -> (boolean)

Флаг, указывающий, возвращаются ли все значения свойства типа список или карта в ответе API. Максимальное количество значений на свойство, возвращаемых в ответе, составляет 50.

propertyGroups -> (map)

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

key -> (string)

value -> (structure)

Ответ группы свойств компонента.

groupType -> (string)

Тип группы.

propertyNames -> (list)

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

(string)

isInherited -> (boolean)

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

syncSource -> (string)

syncSource задачи синхронизации, если эта сущность была создана задачей синхронизации.

areAllPropertiesReturned -> (boolean)

Флаг, указывающий, возвращаются ли все свойства компонента в ответе API. Максимальное количество возвращаемых свойств составляет 800.

compositeComponents -> (map)

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

key -> (string)

value -> (structure)

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

componentName -> (string)

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

componentTypeId -> (string)

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

definedIn -> (string)

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

description -> (string)

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

propertyGroups -> (map)

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

key -> (string)

value -> (structure)

Ответ группы свойств компонента.

groupType -> (string)

Тип группы.

propertyNames -> (list)

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

(string)

isInherited -> (boolean)

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

status -> (structure)

Статус типа компонента.

state -> (string)

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

error -> (structure)

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

code -> (string)

Код ошибки.

message -> (string)

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

syncSource -> (string)

syncSource задачи синхронизации, если эта сущность была создана задачей синхронизации.

componentPath -> (string)

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

areAllCompositeComponentsReturned -> (boolean)

Флаг, указывающий, возвращаются ли все compositeComponents в ответе API.

parentEntityId -> (string)

Идентификатор родительской сущности для этой сущности.

hasChildEntities -> (boolean)

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

creationDateTime -> (timestamp)

Дата и время создания сущности.

updateDateTime -> (timestamp)

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

syncSource -> (string)

syncSource задачи синхронизации, если эта сущность была создана задачей синхронизации.

areAllComponentsReturned -> (boolean)

Этот флаг показывает, возвращаются ли все компоненты в ответе API. Максимальное количество возвращаемых компонентов — 30.