[ aws . amplifyuibuilder ]
создать-форму
Описание
Создаёт новую форму для приложения Amplify.
См. также: Документацию API AWS
Синтаксис
create-form
--app-id <value>
--environment-name <value>
[--client-token <value>]
--form-to-create <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 (строка)
--client-token (строка)
--form-to-create (структура)
Представляет конфигурацию создаваемой формы.
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 для формы — Data Store.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"
}
}
},
"tags": {"string": "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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить кли-пагинатор для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическую запрос параметров входных данных CLI.
Вывод
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.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
текст -> (строка)
Text.уровень -> (целое число)
Heading. Допустимые значения — 1 | 2 | 3 | 4 | 5 | 6.ориентация -> (строка)
Divider. Допустимые значения — horizontal или vertical.исключено -> (булево)
версияСхема -> (строка)
метки -> (карта)
Один или несколько пар «ключ-значение» для маркировки формы.
ключ -> (строка)
значение -> (строка)
кнопка -> (структура)
Хранит конфигурацию для элемента «Вызов к действию» формы.
позиция -> (строка)
очистить -> (структура)
Отображает кнопку «Очистить».
исключено -> (булево)
дети -> (строка)
позиция -> (структура помеченного объединения)
Положение кнопки.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:fixed, rightOf, below.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
отмена -> (структура)
Отображает кнопку «Отмена».
исключено -> (булево)
дети -> (строка)
позиция -> (структура помеченного объединения)
Положение кнопки.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:fixed, rightOf, below.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
отправить -> (структура)
Отображает кнопку «Отправить».
исключено -> (булево)
дети -> (строка)
позиция -> (структура помеченного объединения)
Положение кнопки.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:fixed, rightOf, below.fixed -> (строка)
rightOf -> (строка)
below -> (строка)
декораторМетки -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.