list-properties

Описание

Этот API перечисляет свойства компонента.

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

Синтаксис

  list-properties
--workspace-id <value>
[--component-name <value>]
[--component-path <value>]
--entity-id <value>
[--max-results <value>]
[--next-token <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 (строка)

ID рабочего пространства.

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

Имя компонента, свойства которого возвращает операция.

--component-path (строка)

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

--entity-id (строка)

ID сущности, метаданные (компонент/свойства) которой возвращает операция.

--max-results (целое число)

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

--next-token (строка)

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

--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.

Вывод

propertySummaries -> (список)

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

(структура)

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

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)

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

propertyName -> (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.

nextToken -> (string)

Строка, которая указывает следующую страницу результатов свойств.