Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

describe-managed-login-branding

Описание

Принимая ID стиля оформления управляемого входа, возвращает подробную информацию о стиле.

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

describe-managed-login-branding использует значения типа документа. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для ввода команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  describe-managed-login-branding
--user-pool-id <value>
--managed-login-branding-id <value>
[--return-merged-resources | --no-return-merged-resources]
[--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]

Параметры

--user-pool-id (строка)

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

--managed-login-branding-id (строка)

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

--return-merged-resources | --no-return-merged-resources (булево)

При значении true, возвращает значения параметров оформления, которые не изменены со стандартных значений Amazon Cognito. При значении false или при отсутствии этого параметра возвращает только значения, которые вы настраивали в вашем стиле оформления.

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

Вывод

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

Подробности запрошенного стиля оформления.

ManagedLoginBrandingId -> (строка)

ID стиля оформления управляемого входа.

UserPoolId -> (строка)

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

UseCognitoProvidedValues -> (булево)

При значении true применяются стандартные параметры стиля оформления. Этот параметр возвращает параметры стандартного стиля, управляемые Amazon Cognito. Вы можете изменить их позже в дизайнере оформления.

При указании true для этого параметра, необходимо также опустить значения для Settings и Assets в запросе.

Settings -> (документ)

JSON-файл, закодированный как Document тип, со настройками, которые вы хотите применить к стилю.

Assets -> (список)

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

(структура)

Файл изображения из стиля оформления управляемого входа в пользовательском пуле.

Category -> (строка)

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

ColorMode -> (строка)

Целевая тема отображения актива: светлая, темная или адаптивная для браузера. Например, Amazon Cognito отображает изображение темной темы только при темной теме браузера или приложения, но отображает адаптивный файл во всех контекстах.

Extension -> (строка)

Тип файла изображения.

Bytes -> (двоичные данные)

Файл изображения в кодировке Base64.

ResourceId -> (строка)

ID актива.

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

Дата и время создания элемента. Amazon Cognito возвращает эту временную метку в формате временной метки Unix. Ваш SDK может отображать результат в удобочитаемом формате, например, ISO 8601 или Java Date объект.

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

Дата и время изменения элемента. Amazon Cognito возвращает эту временную метку в формате временной метки Unix. Ваш SDK может отображать результат в удобочитаемом формате, например, ISO 8601 или Java Date объект.

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

Spec-Zone.ru

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