[ aws . amplifyuibuilder ]
export-forms
Описание
Экспортирует конфигурации форм в код, готовый к интеграции в приложение Amplify.
См. также: Документацию API AWS
export-forms — это операция с постраничной передачей данных. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить постраничную передачу данных, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей данных, аргумент --query должен извлекать данные из результатов следующих выражений запроса: entities
Синтаксис
export-forms
--app-id <value>
--environment-name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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 (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, заданному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет интерпретироваться буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания начальной точки постраничной передачи данных. Это значение NextToken из ранее усечённого ответа.
Примеры использования см. в разделе «Постраничная передача данных» в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную передачу данных, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.
Примеры использования см. в разделе «Постраничная передача данных» в Руководстве пользователя AWS Command Line Interface.
--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 (строка)
Регион для использования. Переопределяет настройки config/env.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- авто
--no-sign-request (логическое значение)
Не подписывать запросы. Данные авторизации не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Обрабатываемый набор сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки config/env.
--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.
Выходные данные
entities -> (список)
Представляет конфигурацию экспортируемых форм.
(структура)
Содержит параметры конфигурации элемента пользовательского интерфейса (UI) приложения Amplify. Форма — это компонент, который можно добавить в проект, указав источник данных в качестве стандартной конфигурации для формы.
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.