[ aws . amplifybackend ]
удаление-бэкэнд-api
Описание
Удаляет существующий ресурс бэкэнд API.
См. также: Документацию API AWS
Синтаксис
delete-backend-api
--app-id <value>
--backend-environment-name <value>
[--resource-config <value>]
--resource-name <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 (строка)
--backend-environment-name (строка)
--resource-config (структура)
Определяет конфигурацию ресурса для модели данных в вашем проекте Amplify.
AdditionalAuthTypes -> (список)
Дополнительные методы аутентификации, используемые для взаимодействия с вашими моделями данных.
(структура)
Описывает типы аутентификации для ваших настроенных моделей данных.
Mode -> (строка)
Settings -> (структура)
Описывает параметры для режима аутентификации.
CognitoUserPoolId -> (строка)
Description -> (строка)
ExpirationTime -> (двойное число)
OpenIDAuthTTL -> (строка)
OpenIDClientId -> (строка)
OpenIDIatTTL -> (строка)
OpenIDIssueURL -> (строка)
OpenIDProviderName -> (строка)
ApiName -> (строка)
ConflictResolution -> (структура)
Стратегия разрешения конфликтов для ваших данных, хранящихся в моделях данных.
ResolutionStrategy -> (строка)
DefaultAuthType -> (структура)
Тип аутентификации по умолчанию для взаимодействия с настроенными моделями данных в вашем проекте Amplify.
Mode -> (строка)
Settings -> (структура)
Описывает параметры для режима аутентификации.
CognitoUserPoolId -> (строка)
Description -> (строка)
ExpirationTime -> (двойное число)
OpenIDAuthTTL -> (строка)
OpenIDClientId -> (строка)
OpenIDIatTTL -> (строка)
OpenIDIssueURL -> (строка)
OpenIDProviderName -> (строка)
Service -> (строка)
TransformSchema -> (строка)
Синтаксис JSON:
{
"AdditionalAuthTypes": [
{
"Mode": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
"Settings": {
"CognitoUserPoolId": "string",
"Description": "string",
"ExpirationTime": double,
"OpenIDAuthTTL": "string",
"OpenIDClientId": "string",
"OpenIDIatTTL": "string",
"OpenIDIssueURL": "string",
"OpenIDProviderName": "string"
}
}
...
],
"ApiName": "string",
"ConflictResolution": {
"ResolutionStrategy": "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"
},
"DefaultAuthType": {
"Mode": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
"Settings": {
"CognitoUserPoolId": "string",
"Description": "string",
"ExpirationTime": double,
"OpenIDAuthTTL": "string",
"OpenIDClientId": "string",
"OpenIDIatTTL": "string",
"OpenIDIssueURL": "string",
"OpenIDProviderName": "string"
}
},
"Service": "string",
"TransformSchema": "string"
}
--resource-name (строка)
--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 (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
AppId -> (строка)
BackendEnvironmentName -> (строка)
Error -> (строка)
JobId -> (строка)
Operation -> (строка)
Status -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.