Spec-Zone.ru › AWS CLI v2

[ aws . amplifyuibuilder ]

get-form

Описание

Возвращает существующую форму для приложения Amplify.

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

Синтаксис

  get-form
--app-id <value>
--environment-name <value>
--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]

Параметры

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

Уникальный идентификатор приложения Amplify.

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

Имя среды бэкенда, которая является частью приложения Amplify.

--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
  • таблица
  • 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.

Вывод

форма -> (структура)

Представляет параметры конфигурации формы.

appId -> (строка)

Уникальный идентификатор приложения Amplify, связанного с формой.

environmentName -> (строка)

Имя среды бэкэнда, являющейся частью приложения Amplify.

id -> (строка)

Уникальный идентификатор формы.

name -> (строка)

Название формы.

formActionType -> (строка)

Операция, выполняемая над указанной формой.

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

Хранит конфигурацию стиля формы.

horizontalGap -> (структура помеченных объединений)

Отступ для горизонтального зазора.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: tokenReference, value.

tokenReference -> (строка)

Ссылка на дизайн-токен для привязки свойств стиля формы к существующей теме.

value -> (строка)

Значение параметра стиля.

verticalGap -> (структура помеченных объединений)

Отступ для вертикального зазора.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: tokenReference, value.

tokenReference -> (строка)

Ссылка на дизайн-токен для привязки свойств стиля формы к существующей теме.

value -> (строка)

Значение параметра стиля.

outerPadding -> (структура помеченных объединений)

Размер внешнего отступа формы.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: tokenReference, value.

tokenReference -> (строка)

Ссылка на дизайн-токен для привязки свойств стиля формы к существующей теме.

value -> (строка)

Значение параметра стиля.

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

Тип источника данных для создания формы.

dataSourceType -> (строка)

Тип источника данных: модель Amplify DataStore или пользовательский тип данных.

dataTypeName -> (строка)

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

fields -> (массив)

Хранит информацию о полях формы.

key -> (строка)

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

Описание конфигурации поля в таблице.

label -> (строка)

Метка поля.

position -> (структура помеченных объединений)

Указывает позицию поля.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: fixed, rightOf, below.

fixed -> (строка)

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

rightOf -> (строка)

Позиция поля справа от поля, указанного строкой.

below -> (строка)

Позиция поля ниже поля, указанного строкой.

excluded -> (булево)

Указывает, нужно ли скрывать поле.

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

Описание конфигурации для значения по умолчанию, отображаемого для поля.

type -> (строка)

Тип ввода для поля.

required -> (булево)

Определяет поле, требующее ввода.

readOnly -> (булево)

Определяет поле только для чтения.

placeholder -> (строка)

Текст, отображаемый в качестве подсказки для поля.

defaultValue -> (строка)

Значение по умолчанию для поля.

descriptiveText -> (строка)

Текст для описания поля.

defaultChecked -> (булево)

Указывает, имеет ли поле значение по умолчанию.

defaultCountryCode -> (строка)

Код страны по умолчанию для номера телефона.

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

Информация для настройки полей ввода данными во время выполнения.

values -> (список)

Значения и пары отображаемых значений.

(структура)

Связывает сложный объект с отображаемым значением. Используйте ValueMapping для хранения способа отображения сложных объектов.

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

Значение для отображения сложного объекта.

value -> (строка)

Значение для присвоения полю ввода.

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

Информация для привязки полей к данным во время выполнения.

property -> (строка)

Свойство формы для привязки к полю данных.

field -> (строка)

Поле данных для привязки свойства.

concat -> (список)

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

(структура)

Описывает конфигурацию поля ввода в форме. Используйте FormInputValueProperty для указания значений, которые следует отображать или привязывать по умолчанию.

value -> (строка)

Значение для присвоения полю ввода.

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

Информация для привязки полей к данным во время выполнения.

property -> (строка)

Свойство формы для привязки к полю данных.

field -> (строка)

Поле данных для привязки свойства.

concat -> (список)

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

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

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

Сложный объект.

value -> (строка)

Значение для присвоения полю ввода.

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

Информация для привязки полей к данным во время выполнения.

property -> (строка)

Свойство формы для привязки к полю данных.

field -> (строка)

Поле данных для привязки свойства.

concat -> (список)

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

(структура)

Описывает конфигурацию поля ввода в форме. Используйте FormInputValueProperty для указания значений, которые следует отображать или привязывать по умолчанию.

value -> (строка)

Значение для присвоения полю ввода.

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

Информация для привязки полей к данным во время выполнения.

property -> (строка)

Свойство формы для привязки к полю данных.

field -> (строка)

Поле данных для привязки свойства.

concat -> (список)

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

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

bindingProperties -> (массив)

Информация для привязки полей к данным во время выполнения.

key -> (строка)

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

Представляет конфигурацию привязки данных для полей ввода формы во время выполнения. Вы можете использовать FormInputBindingPropertiesValue для добавления открытых свойств в форму, чтобы разрешить ввод различных значений при повторном использовании формы в разных местах приложения.

type -> (строка)

Тип свойства.

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

Описание свойств для настройки с данными во время выполнения.

model -> (строка)

Модель Amplify DataStore.

name -> (строка)

Название поля.

minValue -> (вещественное число)

Минимальное значение для отображения поля.

maxValue -> (вещественное число)

Максимальное значение для отображения поля.

step -> (вещественное число)

Шаг инкремента для числового значения в поле.

value -> (строка)

Значение поля.

isArray -> (булево)

Указывает, нужно ли отображать поле как массив. Это свойство игнорируется, если dataSourceType для формы является хранилищем данных.

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

Конфигурация поля загрузчика файлов.

accessLevel -> (строка)

Уровень доступа, назначаемый загруженным файлам в ведре Amazon S3, где они хранятся. Допустимые значения для этого свойства — private , protected или public . Дополнительную информацию о разрешениях, связанных с каждым уровнем доступа, см. в разделе Уровни доступа к файлам в документации Amplify.

acceptedFileTypes -> (список)

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

(строка)

showThumbnails -> (булево)

Определяет, нужно ли отображать или скрывать предварительный просмотр изображения после выбора файла для загрузки. Значение по умолчанию — true для отображения предварительного просмотра изображения.

isResumable -> (булево)

Позволяет приостановить и продолжить операцию загрузки файла. Значение по умолчанию — false .

Когда isResumable установлено в значение true , загрузчик файлов использует многочастную загрузку для разделения файлов на части перед загрузкой. Прогресс загрузки не является непрерывным, поскольку загрузчик файлов загружает части по одной.

maxFileCount -> (целое число)

Указывает максимальное количество файлов, которые можно выбрать для загрузки. Значение по умолчанию — неограниченное количество файлов.

maxSize -> (целое число)

Максимальный размер файла в байтах, который примет загрузчик файлов. Значение по умолчанию — неограниченный размер файла.

validations -> (список)

Проверки, выполняемые для значения в поле.

(структура)

Описывает конфигурацию проверки для поля.

type -> (строка)

Проверка, выполняемая для типа объекта.

strValues -> (список)

Проверка, выполняемая для строкового значения.

(строка)

numValues -> (список)

Проверка, выполняемая для числового значения.

(целое число)

validationMessage -> (строка)

Сообщение проверки для отображения.

sectionalElements -> (массив)

Хранит визуальные вспомогательные элементы формы, не связанные с данными.

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

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

Хранит конфигурационную информацию для визуального вспомогательного элемента формы. Секционный элемент может быть заголовком, текстовым блоком или разделителем. Эти элементы статичны и не связаны с какими-либо данными.

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

Тип секционного элемента. Допустимые значения — Heading, Text и Divider.

положение -> (структура помеченного объединения)

Указывает положение текста в поле для секционного элемента Text.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: fixed, rightOf, below.

фиксированное -> (строка)

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

справаОт -> (строка)

Положение поля справа от поля, указанного строкой.

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

Положение поля ниже поля, указанного строкой.

текст -> (строка)

Текст для секционного элемента Text.

уровень -> (целое число)

Указывает размер шрифта для секционного элемента Heading. Допустимые значения — 1 | 2 | 3 | 4 | 5 | 6.

ориентация -> (строка)

Указывает ориентацию для секционного элемента Divider. Допустимые значения — horizontal или vertical.

исключено -> (булево)

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

версияСхемы -> (строка)

Версия схемы формы при импорте.

метки -> (карта)

Один или несколько пар ключ-значение для маркировки формы.

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

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

кнопкаДействия -> (структура)

Хранит конфигурацию действия для формы.

положение -> (строка)

Положение кнопки.

очистить -> (структура)

Отображает кнопку «Очистить».

исключено -> (булево)

Указывает, отображается ли кнопка на форме.

дочерниеЭлементы -> (строка)

Описание свойств кнопки.

положение -> (структура помеченного объединения)

Положение кнопки.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: fixed, rightOf, below.

фиксированное -> (строка)

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

справаОт -> (строка)

Положение поля справа от поля, указанного строкой.

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

Положение поля ниже поля, указанного строкой.

отмена -> (структура)

Отображает кнопку «Отмена».

исключено -> (булево)

Указывает, отображается ли кнопка на форме.

дочерниеЭлементы -> (строка)

Описание свойств кнопки.

положение -> (структура помеченного объединения)

Положение кнопки.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: fixed, rightOf, below.

фиксированное -> (строка)

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

справаОт -> (строка)

Положение поля справа от поля, указанного строкой.

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

Положение поля ниже поля, указанного строкой.

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

Отображает кнопку «Отправить».

исключено -> (булево)

Указывает, отображается ли кнопка на форме.

дочерниеЭлементы -> (строка)

Описание свойств кнопки.

положение -> (структура помеченного объединения)

Положение кнопки.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: fixed, rightOf, below.

фиксированное -> (строка)

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

справаОт -> (строка)

Положение поля справа от поля, указанного строкой.

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

Положение поля ниже поля, указанного строкой.

декораторМетки -> (строка)

Указывает значок или декорацию для отображения на форме.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API