Spec-Zone.ru › AWS CLI v2

[ aws . amplifyuibuilder ]

get-codegen-job

Описание

Возвращает существующую задачу генерации кода.

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

Синтаксис

  get-codegen-job
--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла ваших учётных данных.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Вывод

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

Параметры конфигурации задачи генерации кода.

id -> (строка)

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

appId -> (строка)

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

environmentName -> (строка)

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

renderConfig -> (структура с тегами)

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

Примечание

Это структура с тегами. Только один из следующих ключей верхнего уровня может быть задан: 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 -> (структура)

Конфигурация приложения, использующего 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 -> (булево)

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

status -> (строка)

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

statusMessage -> (строка)

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

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

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

downloadUrl -> (строка)

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

tags -> (отображение)

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

key -> (строка)

value -> (строка)

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

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

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

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

dependencies -> (список)

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

(структура)

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

name -> (строка)

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

supportedVersion -> (строка)

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

isSemVer -> (булево)

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

reason -> (строка)

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

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

Spec-Zone.ru

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