[ aws . amplifyuibuilder ]
Обновление формы
Описание
Обновляет существующую форму.
См. также: Документацию AWS API
Синтаксис
update-form
--app-id <value>
--environment-name <value>
--id <value>
[--client-token <value>]
--updated-form <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 (строка)
--environment-name (строка)
--id (строка)
--client-token (строка)
--updated-form (структура)
Запрос принимает следующие данные в формате JSON.
name -> (строка)
dataType -> (структура)
Тип источника данных для создания формы.
dataSourceType -> (строка)
dataTypeName -> (строка)
formActionType -> (строка)
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 -> (строка)
name -> (строка)
minValue -> (вещественное число)
maxValue -> (вещественное число)
step -> (вещественное число)
value -> (строка)
isArray -> (булево)
dataSourceType для формы является хранилищем данных.fileUploaderConfig -> (структура)
Конфигурация поля загрузчика файлов.
accessLevel -> (строка)
private, protected или public. Подробную информацию о разрешениях, связанных с каждым уровнем доступа, см. в разделе Уровни доступа к файлам в документации Amplify.acceptedFileTypes -> (список)
Типы файлов, разрешенные для загрузки с помощью загрузчика файлов. Укажите эту информацию в массиве строк, определяя допустимые расширения файлов.
(строка)
showThumbnails -> (булево)
true, чтобы отобразить предварительный просмотр изображения.isResumable -> (булево)
Разрешает приостановить и возобновить операцию загрузки файла. Значение по умолчанию — false.
Когда isResumable установлено в true, загрузчик файлов использует многочастную загрузку для разделения файлов на фрагменты перед загрузкой. Прогресс загрузки не непрерывный, потому что загрузчик файлов загружает фрагмент за фрагментом.
maxFileCount -> (целое число)
maxSize -> (целое число)
validations -> (список)
Проверки, которые необходимо выполнить для значения в поле.
(структура)
Описывает конфигурацию проверки для поля.
type -> (строка)
strValues -> (список)
Проверка для строкового значения.
(строка)
numValues -> (список)
Проверка для числового значения.
(целое число)
validationMessage -> (строка)
style -> (структура)
Конфигурация стиля формы.
horizontalGap -> (структура помеченного объединения)
Отступ для горизонтального разрыва.
Примечание
Это структура помеченного объединения. Должно быть установлено только одно из следующих верхнеуровневых ключей:tokenReference, value.tokenReference -> (строка)
value -> (строка)
verticalGap -> (структура помеченного объединения)
Отступ для вертикального разрыва.
Примечание
Это структура помеченного объединения. Должно быть установлено только одно из следующих верхнеуровневых ключей:tokenReference, value.tokenReference -> (строка)
value -> (строка)
outerPadding -> (структура помеченного объединения)
Размер внешнего отступа формы.
Примечание
Это структура помеченного объединения. Должно быть установлено только одно из следующих верхнеуровневых ключей:tokenReference, value.tokenReference -> (строка)
value -> (строка)
sectionalElements -> (массив)
Информация о конфигурации визуальных элементов помощника для формы. Эти элементы не связаны с какими-либо данными.
ключ -> (строка)
значение -> (структура)
Хранит конфигурационную информацию для визуального элемента помощника формы. Секционный элемент может быть заголовком, текстовым блоком или разделителем. Эти элементы статичны и не связаны с какими-либо данными.
тип -> (строка)
Heading, Text и Divider.позиция -> (структура помеченного объединения)
Указывает позицию текста в поле для секционного элемента Text.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих ключевых значений верхнего уровня:fixed, rightOf, below.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
текст -> (строка)
Text.уровень -> (целое число)
Heading. Допустимые значения — 1 | 2 | 3 | 4 | 5 | 6.ориентация -> (строка)
Divider. Допустимые значения — horizontal или vertical.исключено -> (булево значение)
версия схемы -> (строка)
кнопка действия -> (структура)
Объект FormCTA, хранящий конфигурацию кнопки действия для формы.
позиция -> (строка)
очистить -> (структура)
Отображает кнопку очистки.
исключено -> (булево значение)
подэлементы -> (строка)
позиция -> (структура помеченного объединения)
Позиция кнопки.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих ключевых значений верхнего уровня:fixed, rightOf, below.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
отмена -> (структура)
Отображает кнопку отмены.
исключено -> (булево значение)
подэлементы -> (строка)
позиция -> (структура помеченного объединения)
Позиция кнопки.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих ключевых значений верхнего уровня:fixed, rightOf, below.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
отправить -> (структура)
Отображает кнопку отправки.
исключено -> (булево значение)
подэлементы -> (строка)
позиция -> (структура помеченного объединения)
Позиция кнопки.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих ключевых значений верхнего уровня:fixed, rightOf, below.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
декоратор метки -> (строка)
Синтаксис JSON:
{
"name": "string",
"dataType": {
"dataSourceType": "DataStore"|"Custom",
"dataTypeName": "string"
},
"formActionType": "create"|"update",
"fields": {"string": {
"label": "string",
"position": {
"fixed": "first",
"rightOf": "string",
"below": "string"
},
"excluded": true|false,
"inputType": {
"type": "string",
"required": true|false,
"readOnly": true|false,
"placeholder": "string",
"defaultValue": "string",
"descriptiveText": "string",
"defaultChecked": true|false,
"defaultCountryCode": "string",
"valueMappings": {
"values": [
{
"displayValue": {
"value": "string",
"bindingProperties": {
"property": "string",
"field": "string"
},
"concat": [
{
"value": "string",
"bindingProperties": {
"property": "string",
"field": "string"
},
"concat": [
{ ... recursive ... }
...
]
}
...
]
},
"value": {
"value": "string",
"bindingProperties": {
"property": "string",
"field": "string"
},
"concat": [
{
"value": "string",
"bindingProperties": {
"property": "string",
"field": "string"
},
"concat": [
{ ... recursive ... }
...
]
}
...
]
}
}
...
],
"bindingProperties": {"string": {
"type": "string",
"bindingProperties": {
"model": "string"
}
}
...}
},
"name": "string",
"minValue": float,
"maxValue": float,
"step": float,
"value": "string",
"isArray": true|false,
"fileUploaderConfig": {
"accessLevel": "public"|"protected"|"private",
"acceptedFileTypes": ["string", ...],
"showThumbnails": true|false,
"isResumable": true|false,
"maxFileCount": integer,
"maxSize": integer
}
},
"validations": [
{
"type": "string",
"strValues": ["string", ...],
"numValues": [integer, ...],
"validationMessage": "string"
}
...
]
}
...},
"style": {
"horizontalGap": {
"tokenReference": "string",
"value": "string"
},
"verticalGap": {
"tokenReference": "string",
"value": "string"
},
"outerPadding": {
"tokenReference": "string",
"value": "string"
}
},
"sectionalElements": {"string": {
"type": "string",
"position": {
"fixed": "first",
"rightOf": "string",
"below": "string"
},
"text": "string",
"level": integer,
"orientation": "string",
"excluded": true|false
}
...},
"schemaVersion": "string",
"cta": {
"position": "top"|"bottom"|"top_and_bottom",
"clear": {
"excluded": true|false,
"children": "string",
"position": {
"fixed": "first",
"rightOf": "string",
"below": "string"
}
},
"cancel": {
"excluded": true|false,
"children": "string",
"position": {
"fixed": "first",
"rightOf": "string",
"below": "string"
}
},
"submit": {
"excluded": true|false,
"children": "string",
"position": {
"fixed": "first",
"rightOf": "string",
"below": "string"
}
}
},
"labelDecorator": "required"|"optional"|"none"
}
--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 (булево)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запрошение параметров ввода командной строки.
Вывод
entity -> (структура)
Описывает конфигурацию обновляемой формы.
appId -> (строка)
environmentName -> (строка)
id -> (строка)
name -> (строка)
formActionType -> (строка)
style -> (структура)
Хранит конфигурацию стиля формы.
horizontalGap -> (структура помеченных объединений)
Отступ для горизонтального промежутка.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:tokenReference, value.tokenReference -> (строка)
value -> (строка)
verticalGap -> (структура помеченных объединений)
Отступ для вертикального промежутка.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:tokenReference, value.tokenReference -> (строка)
value -> (строка)
outerPadding -> (структура помеченных объединений)
Размер внешнего отступа формы.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:tokenReference, value.tokenReference -> (строка)
value -> (строка)
dataType -> (структура)
Тип источника данных для создания формы.
dataSourceType -> (строка)
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 -> (строка)
name -> (строка)
minValue -> (число с плавающей точкой)
maxValue -> (число с плавающей точкой)
step -> (число с плавающей точкой)
value -> (строка)
isArray -> (булево)
dataSourceType для формы — Data Store.fileUploaderConfig -> (структура)
Конфигурация поля загрузчика файлов.
accessLevel -> (строка)
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.
