start-codegen-job

Описание

Запускает задачу генерации кода для указанного приложения Amplify и среды бэкенда.

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

Синтаксис

  start-codegen-job
--app-id <value>
--environment-name <value>
[--client-token <value>]
--codegen-job-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 (строка)

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

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

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

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

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

--codegen-job-to-create (структура)

Конфигурация ресурса задачи генерации кода.

renderConfig -> (структура помеченного союза)

Конфигурация генерации кода для задачи codegen.

Примечание

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

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

Имя объекта ReactStartCodegenJobData.

module -> (строка)

Тип JavaScript-модуля.

target -> (строка)

Спецификация ECMAScript для использования.

script -> (строка)

Тип файла для использования в JavaScript-проекте.

renderTypeDeclarations -> (логическое значение)

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

inlineSourceMap -> (логическое значение)

Указывает, следует ли задаче генерации кода отображать встроенные карты исходного кода.

apiConfiguration -> (структура помеченного союза)

Конфигурация API для задачи генерации кода.

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть установлен: graphQLConfig, dataStoreConfig, noApiConfig.

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

Конфигурация для приложения, использующего API GraphQL.

typesFilePath -> (строка)

Путь к файлу типов GraphQL, относительно каталога вывода компонента.

queriesFilePath -> (строка)

Путь к файлу запросов GraphQL, относительно каталога вывода компонента.

mutationsFilePath -> (строка)

Путь к файлу мутаций GraphQL, относительно каталога вывода компонента.

subscriptionsFilePath -> (строка)

Путь к файлу подписок GraphQL, относительно каталога вывода компонента.

fragmentsFilePath -> (строка)

Путь к файлу фрагментов GraphQL, относительно каталога вывода компонента.

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

Конфигурация для приложения, использующего API DataStore.

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

Конфигурация для приложения без используемых API.

dependencies -> (массив)

Список зависимых пакетов, которые могут потребоваться для работы кода проекта.

key -> (строка)

value -> (строка)

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

Схема данных для использования в задаче генерации кода.

dataSourceType -> (строка)

Тип источника данных для схемы. В настоящее время единственное допустимое значение — Amplify DataStore.

models -> (массив)

Имя CodegenGenericDataModel.

key -> (строка)

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

Описание модели в схеме общих данных.

fields -> (массив)

Поля в общей модели данных.

key -> (строка)

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

Описание поля в схеме общих данных.

dataType -> (строка)

Тип данных для общего поля данных.

dataTypeValue -> (строка)

Значение типа данных для общего поля данных.

required -> (логическое значение)

Указывает, является ли общее поле данных обязательным.

readOnly -> (логическое значение)

Указывает, является ли общее поле данных только для чтения.

isArray -> (логическое значение)

Указывает, является ли общее поле данных массивом.

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

Связь общей схемы данных.

type -> (строка)

Тип отношения данных.

relatedModelName -> (строка)

Имя связанной модели в отношении данных.

relatedModelFields -> (список)

Связанные поля модели в отношении данных.

(строка)

canUnlinkAssociatedModel -> (логическое значение)

Указывает, может ли отношение разорвать связь с ассоциированной моделью.

relatedJoinFieldName -> (строка)

Имя связанного поля соединения в отношении данных.

relatedJoinTableName -> (строка)

Имя связанной таблицы соединения в отношении данных.

belongsToFieldOnRelatedModel -> (строка)

Значение поля belongsTo в связанной модели данных.

associatedFields -> (список)

Ассоциированные поля отношения данных.

(строка)

isHasManyIndex -> (логическое значение)

Указывает, поддерживается ли директива @index для отношения данных hasMany.

isJoinTable -> (логическое значение)

Указывает, является ли общая модель данных таблицей соединения.

primaryKeys -> (список)

Первичные ключи общей модели данных.

(строка)

enums -> (массив)

Имя CodegenGenericDataEnum.

key -> (строка)

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

Описание перечислений в схеме общих данных.

values -> (список)

Список значений перечисления в схеме общих данных.

(строка)

nonModels -> (массив)

Имя CodegenGenericDataNonModel.

key -> (строка)

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

Описание немодели в схеме общих данных.

fields -> (массив)

Поля в немодели общей схемы данных.

key -> (строка)

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

Описание поля в схеме общих данных.

dataType -> (строка)

Тип данных для общего поля данных.

dataTypeValue -> (строка)

Значение типа данных для общего поля данных.

required -> (логическое значение)

Указывает, является ли общее поле данных обязательным.

readOnly -> (логическое значение)

Указывает, является ли общее поле данных только для чтения.

isArray -> (логическое значение)

Указывает, является ли общее поле данных массивом.

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

Связь общей схемы данных.

type -> (строка)

Тип отношения данных.

relatedModelName -> (строка)

Имя связанной модели в отношении данных.

relatedModelFields -> (список)

Связанные поля модели в отношении данных.

(строка)

canUnlinkAssociatedModel -> (логическое значение)

Указывает, может ли отношение разорвать связь с ассоциированной моделью.

relatedJoinFieldName -> (строка)

Имя связанного поля соединения в отношении данных.

relatedJoinTableName -> (строка)

Имя связанной таблицы соединения в отношении данных.

belongsToFieldOnRelatedModel -> (строка)

Значение поля belongsTo в связанной модели данных.

associatedFields -> (список)

Ассоциированные поля отношения данных.

(строка)

isHasManyIndex -> (логическое значение)

Указывает, поддерживается ли директива @index для отношения данных hasMany.

autoGenerateForms -> (логическое значение)

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

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

Флаги функций для задачи генерации кода.

isRelationshipSupported -> (логическое значение)

Указывает, поддерживает ли задача генерации кода отношения данных.

isNonModelSupported -> (логическое значение)

Указывает, поддерживает ли задача генерации кода немодели.

tags -> (массив)

Одна или несколько пар «ключ-значение» для использования при маркировке данных задачи генерации кода.

key -> (строка)

value -> (строка)

Синтаксис JSON:

{
  "renderConfig": {
    "react": {
      "module": "es2020"|"esnext",
      "target": "es2015"|"es2020",
      "script": "jsx"|"tsx"|"js",
      "renderTypeDeclarations": true|false,
      "inlineSourceMap": true|false,
      "apiConfiguration": {
        "graphQLConfig": {
          "typesFilePath": "string",
          "queriesFilePath": "string",
          "mutationsFilePath": "string",
          "subscriptionsFilePath": "string",
          "fragmentsFilePath": "string"
        },
        "dataStoreConfig": {

        },
        "noApiConfig": {

        }
      },
      "dependencies": {"string": "string"
        ...}
    }
  },
  "genericDataSchema": {
    "dataSourceType": "DataStore",
    "models": {"string": {
          "fields": {"string": {
                "dataType": "ID"|"String"|"Int"|"Float"|"AWSDate"|"AWSTime"|"AWSDateTime"|"AWSTimestamp"|"AWSEmail"|"AWSURL"|"AWSIPAddress"|"Boolean"|"AWSJSON"|"AWSPhone"|"Enum"|"Model"|"NonModel",
                "dataTypeValue": "string",
                "required": true|false,
                "readOnly": true|false,
                "isArray": true|false,
                "relationship": {
                  "type": "HAS_MANY"|"HAS_ONE"|"BELONGS_TO",
                  "relatedModelName": "string",
                  "relatedModelFields": ["string", ...],
                  "canUnlinkAssociatedModel": true|false,
                  "relatedJoinFieldName": "string",
                  "relatedJoinTableName": "string",
                  "belongsToFieldOnRelatedModel": "string",
                  "associatedFields": ["string", ...],
                  "isHasManyIndex": true|false
                }
              }
            ...},
          "isJoinTable": true|false,
          "primaryKeys": ["string", ...]
        }
      ...},
    "enums": {"string": {
          "values": ["string", ...]
        }
      ...},
    "nonModels": {"string": {
          "fields": {"string": {
                "dataType": "ID"|"String"|"Int"|"Float"|"AWSDate"|"AWSTime"|"AWSDateTime"|"AWSTimestamp"|"AWSEmail"|"AWSURL"|"AWSIPAddress"|"Boolean"|"AWSJSON"|"AWSPhone"|"Enum"|"Model"|"NonModel",
                "dataTypeValue": "string",
                "required": true|false,
                "readOnly": true|false,
                "isArray": true|false,
                "relationship": {
                  "type": "HAS_MANY"|"HAS_ONE"|"BELONGS_TO",
                  "relatedModelName": "string",
                  "relatedModelFields": ["string", ...],
                  "canUnlinkAssociatedModel": true|false,
                  "relatedJoinFieldName": "string",
                  "relatedJoinTableName": "string",
                  "belongsToFieldOnRelatedModel": "string",
                  "associatedFields": ["string", ...],
                  "isHasManyIndex": true|false
                }
              }
            ...}
        }
      ...}
  },
  "autoGenerateForms": true|false,
  "features": {
    "isRelationshipSupported": true|false,
    "isNonModelSupported": true|false
  },
  "tags": {"string": "string"
    ...}
}

--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 (boolean)

Включить отладочную регистрацию.

--endpoint-url (string)

Переопределить стандартный URL команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла аутентификации.

--region (string)

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

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Данные аутентификации не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться без блокировки и таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение равно 0, подключение к сокету будет выполняться без блокировки и таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который используется для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

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

Задача генерации кода для пользовательского интерфейса (UI), связанного с приложением Amplify.

id -> (строка)

Уникальный идентификатор задачи генерации кода.

appId -> (строка)

Идентификатор приложения Amplify, связанного с задачей генерации кода.

environmentName -> (строка)

Имя среды бэкенда, связанной с задачей генерации кода.

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

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

Примечание

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

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

Имя ReactStartCodegenJobData объекта.

module -> (строка)

Тип модуля JavaScript.

target -> (строка)

Спецификация ECMAScript для использования.

script -> (строка)

Тип файла для использования в проекте JavaScript.

renderTypeDeclarations -> (логическое значение)

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

inlineSourceMap -> (логическое значение)

Указывает, следует ли задаче генерации кода отображать встроенные карты исходного кода.

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

Конфигурация API для задачи генерации кода.

Примечание

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

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

Конфигурация для приложения, использующего GraphQL API.

typesFilePath -> (строка)

Путь к файлу типов GraphQL, относительно каталога вывода компонента.

queriesFilePath -> (строка)

Путь к файлу запросов GraphQL, относительно каталога вывода компонента.

mutationsFilePath -> (строка)

Путь к файлу мутаций GraphQL, относительно каталога вывода компонента.

subscriptionsFilePath -> (строка)

Путь к файлу подписок GraphQL, относительно каталога вывода компонента.

fragmentsFilePath -> (строка)

Путь к файлу фрагментов GraphQL, относительно каталога вывода компонента.

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

Конфигурация для приложения, использующего DataStore API.

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

Конфигурация для приложения без используемого API.

dependencies -> (карта)

Список пакетов зависимостей, которые могут потребоваться для работы проекта.

key -> (строка)

value -> (строка)

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

Описание схемы данных для задачи генерации кода.

dataSourceType -> (строка)

Тип источника данных для схемы. В настоящее время единственное допустимое значение — Amplify DataStore.

models -> (карта)

Имя CodegenGenericDataModel.

key -> (строка)

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

Описание модели в общей схеме данных.

fields -> (карта)

Поля в общей модели данных.

key -> (строка)

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

Описание поля в общей схеме данных.

dataType -> (строка)

Тип данных для общего поля данных.

dataTypeValue -> (строка)

Значение типа данных для общего поля данных.

required -> (логическое значение)

Указывает, является ли общее поле данных обязательным.

readOnly -> (логическое значение)

Указывает, является ли общее поле данных только для чтения.

isArray -> (логическое значение)

Указывает, является ли общее поле данных массивом.

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

Связь общей схемы данных.

type -> (строка)

Тип связи данных.

relatedModelName -> (строка)

Имя связанной модели в связи данных.

relatedModelFields -> (список)

Связанные поля модели в связи данных.

(строка)

canUnlinkAssociatedModel -> (логическое значение)

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

relatedJoinFieldName -> (строка)

Имя связанного поля соединения в связи данных.

relatedJoinTableName -> (строка)

Имя связанной таблицы соединения в связи данных.

belongsToFieldOnRelatedModel -> (строка)

Значение поля belongsTo в связанной модели данных.

associatedFields -> (список)

Связанные поля связи данных.

(строка)

isHasManyIndex -> (логическое значение)

Указывает, поддерживается ли директива @index для hasMany связи данных.

isJoinTable -> (логическое значение)

Указывает, является ли общая модель данных таблицей соединения.

primaryKeys -> (список)

Первичные ключи общей модели данных.

(строка)

enums -> (карта)

Имя CodegenGenericDataEnum.

key -> (строка)

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

Описание перечислений в общей схеме данных.

values -> (список)

Список значений перечислений в общей схеме данных.

(строка)

nonModels -> (карта)

Имя CodegenGenericDataNonModel.

key -> (строка)

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

Описание немодели в общей схеме данных.

fields -> (карта)

Поля в общей немодели схемы данных.

key -> (строка)

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

Описание поля в общей схеме данных.

dataType -> (строка)

Тип данных для общего поля данных.

dataTypeValue -> (строка)

Значение типа данных для общего поля данных.

required -> (логическое значение)

Указывает, является ли общее поле данных обязательным.

readOnly -> (логическое значение)

Указывает, является ли общее поле данных только для чтения.

isArray -> (логическое значение)

Указывает, является ли общее поле данных массивом.

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

Связь общей схемы данных.

type -> (строка)

Тип связи данных.

relatedModelName -> (строка)

Имя связанной модели в связи данных.

relatedModelFields -> (список)

Связанные поля модели в связи данных.

(строка)

canUnlinkAssociatedModel -> (логическое значение)

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

relatedJoinFieldName -> (строка)

Имя связанного поля соединения в связи данных.

relatedJoinTableName -> (строка)

Имя связанной таблицы соединения в связи данных.

belongsToFieldOnRelatedModel -> (строка)

Значение поля belongsTo в связанной модели данных.

associatedFields -> (список)

Связанные поля связи данных.

(строка)

isHasManyIndex -> (логическое значение)

Указывает, поддерживается ли директива @index для hasMany связи данных.

autoGenerateForms -> (логическое значение)

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

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

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

isRelationshipSupported -> (логическое значение)

Указывает, поддерживает ли задача генерации кода связи данных.

isNonModelSupported -> (логическое значение)

Указывает, поддерживает ли задача генерации кода немодели.

status -> (строка)

Статус задачи генерации кода.

statusMessage -> (строка)

Настраиваемое сообщение о статусе для задачи генерации кода.

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

CodegenJobAsset для использования в задаче генерации кода.

downloadUrl -> (строка)

URL для доступа к ресурсу.

tags -> (карта)

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

key -> (строка)

value -> (строка)

createdAt -> (временная метка)

Время создания задачи генерации кода.

modifiedAt -> (временная метка)

Время изменения задачи генерации кода.

dependencies -> (список)

Список пакетов зависимостей, которые могут потребоваться для работы проекта.

(структура)

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

name -> (строка)

Имя пакета зависимостей.

supportedVersion -> (строка)

Указывает версию поддерживаемого пакета зависимостей.

isSemVer -> (логическое значение)

Определяет, использует ли пакет зависимостей семантическую версионирование. Если значение равно true, это указывает на использование семантического версионирования пакетом зависимостей.

reason -> (строка)

Указывает причину включения пакета зависимостей в проект.

END_OF_DOCUMENT_MARKER