Spec-Zone.ru › AWS CLI v2

[ aws . amplifybackend ]

get-backend-auth

Описание

Получение данных аутентификации бэкэнда.

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

Синтаксис

  get-backend-auth
--app-id <value>
--backend-environment-name <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-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
  • 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.

Вывод

AppId -> (строка)

Идентификатор приложения.

BackendEnvironmentName -> (строка)

Имя среды бэкэнда.

Ошибка -> (строка)

Если запрос не удался, возвращается эта ошибка.

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

Настройка ресурсов для запросов авторизации к бэкенду вашего проекта Amplify.

AuthResources -> (строка)

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

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

Описание настроек авторизации для пула идентификаторов Amazon Cognito, предоставленного в рамках вашего ресурса авторизации в проекте Amplify.

IdentityPoolName -> (строка)

Имя пула идентификаторов Amazon Cognito, используемого для авторизации.

UnauthenticatedLogin -> (булево)

Устанавливается в true или false в зависимости от того, хотите ли вы включить гостевую авторизацию в ваше приложение Amplify.

Сервис -> (строка)

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

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

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

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

(УСТАРЕЛО) Описывает политику восстановления пароля для вашего пула пользователей Amazon Cognito, настроенного в рамках вашего проекта Amplify.

DeliveryMethod -> (строка)

(УСТАРЕЛО) Описывает режим, который нужно использовать (SMS или электронную почту), для отправки сообщений пользователям приложения, которые хотят восстановить свой пароль.

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

(УСТАРЕЛО) Настройки электронного письма, отправляемого, когда пользователь приложения забывает свой пароль.

EmailMessage -> (строка)

Содержание сообщения электронной почты.

EmailSubject -> (строка)

Содержание строки темы сообщения электронной почты.

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

(УСТАРЕЛО) Настройки SMS-сообщения, отправляемого, когда пользователь приложения забывает свой пароль.

SmsMessage -> (строка)

Содержание SMS-сообщения.

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

Описание того, нужно ли применять политики многофакторной аутентификации для вашего пула пользователей Amazon Cognito, настроенного в рамках вашего проекта Amplify.

MFAMode -> (строка)

Описание того, должна ли MFA быть [ВКЛ, ВЫКЛ или НЕОБЯЗАТЕЛЬНО] для аутентификации в вашем проекте Amplify.

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

Описание настроек и методов, которые могут использовать пользователи вашего приложения Amplify для использования MFA.

MfaTypes -> (список)

Поддерживаемые типы MFA.

(строка)

SmsMessage -> (строка)

Текст SMS-сообщения.

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

Описание политики и правил OAuth для вашего пула пользователей Amazon Cognito, настроенного в рамках вашего проекта Amplify.

DomainPrefix -> (строка)

Префикс домена вашего приложения Amplify.

OAuthGrantType -> (строка)

Тип OAuth-разрешения, который вы используете, чтобы позволить пользователям приложения аутентифицироваться из вашего приложения Amplify.

OAuthScopes -> (список)

Список потоков OAuth, используемых для разрешения пользователям приложения аутентифицироваться из вашего приложения Amplify.

(строка)

RedirectSignInURIs -> (список)

Перенаправляемый URI для входа в ваше приложение Amplify.

(строка)

RedirectSignOutURIs -> (список)

Перенаправляемые URL, которые OAuth использует, когда пользователь выходит из приложения Amplify.

(строка)

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

Настройки для использования социальных поставщиков для доступа к вашему приложению Amplify.

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

Описание конфигураций третьих социальных поставщиков для разрешения пользователям приложения входить в систему с помощью OAuth.

ClientId -> (строка)

Описание client_id, которое можно получить у поставщика социальных сетей третьей стороны.

ClientSecret -> (строка)

Описание client_secret, которое можно получить у поставщиков социальных сетей третьей стороны.

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

Описание конфигураций третьих социальных поставщиков для разрешения пользователям приложения входить в систему с помощью OAuth.

ClientId -> (строка)

Описание client_id, которое можно получить у поставщика социальных сетей третьей стороны.

ClientSecret -> (строка)

Описание client_secret, которое можно получить у поставщиков социальных сетей третьей стороны.

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

Описание конфигураций третьих социальных поставщиков для разрешения пользователям приложения входить в систему с помощью OAuth.

ClientId -> (строка)

Описание client_id, которое можно получить у поставщика социальных сетей третьей стороны.

ClientSecret -> (строка)

Описание client_secret, которое можно получить у поставщиков социальных сетей третьей стороны.

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

Описание конфигураций Apple для разрешения пользователям приложения входить в систему с помощью OAuth.

ClientId -> (строка)

Описание client_id (также называемого Services ID), который поступает от Apple.

KeyId -> (строка)

Описание key_id, который поступает от Apple.

PrivateKey -> (строка)

Описание private_key, который поступает от Apple.

TeamId -> (строка)

Описание team_id, который поступает от Apple.

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

Описание политики паролей для вашего пула пользователей Amazon Cognito, настроенного в рамках вашего проекта Amplify.

AdditionalConstraints -> (список)

Дополнительные ограничения для пароля, используемого для доступа к бэкенду вашего проекта Amplify.

(строка)

MinimumLength -> (вещественное)

Минимальная длина пароля для доступа к бэкенду вашего проекта Amplify.

RequiredSignUpAttributes -> (список)

Необходимые атрибуты для регистрации новых пользователей в пуле.

(строка)

SignInMethod -> (строка)

Описывает методы входа, используемые пользователями приложения Amplify для входа в систему с помощью пула пользователей Amazon Cognito, настроенного в рамках вашего проекта Amplify.

UserPoolName -> (строка)

Название пула пользователей Amazon Cognito.

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

Описание сообщения о подтверждении электронной почты или SMS для вашего пула пользователей Amazon Cognito, настроенного в рамках вашего проекта Amplify.

DeliveryMethod -> (строка)

Тип сообщения подтверждения, которое нужно отправить.

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

Настройки сообщения электронной почты.

EmailMessage -> (строка)

Содержание сообщения электронной почты.

EmailSubject -> (строка)

Содержание строки темы сообщения электронной почты.

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

Настройки SMS-сообщения.

SmsMessage -> (строка)

Содержание SMS-сообщения.

ResourceName -> (строка)

Имя этого ресурса.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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