[ aws . cognito-idp ]
describe-managed-login-branding-by-client
Описание
По заданному идентификатору клиента приложения пула пользователей возвращает подробную информацию о стиле, назначенном клиенту приложения.
См. также: Документацию API AWS
describe-managed-login-branding-by-client использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.
Синтаксис
describe-managed-login-branding-by-client
--user-pool-id <value>
--client-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 (строка)
--client-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 (строка)
Используемый регион. Переопределяет настройки config/env.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить вывод цвета.
- on
- off
- auto
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Набор сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.
--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 (логическое значение)
Отключить страницу-паджинатор AWS CLI для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров входных данных CLI.
Вывод
ManagedLoginBranding -> (структура)
Подробности запрошенного стиля брендирования.
ManagedLoginBrandingId -> (строка)
UserPoolId -> (строка)
UseCognitoProvidedValues -> (логическое значение)
При значении true применяет параметры стиля брендирования по умолчанию. Этот параметр возвращает параметры стиля по умолчанию, управляемые Amazon Cognito. Вы можете изменить их позже в дизайнере брендирования.
При указании true для этого параметра, также необходимо опустить значения для Settings и Assets в запросе.
Settings -> (документ)
Document, со настройками, которые вы хотите применить к вашему стилю.Assets -> (список)
Массив файлов изображений, которые вы хотите применить к ролям, таким как фоны, логотипы и значки. Каждый объект также должен указать, для тёмной, светлой или адаптивной к браузеру темы.
(структура)
Файл изображения из управляемого стиля брендирования входа в пуле пользователей.
Category -> (строка)
ColorMode -> (строка)
Extension -> (строка)
Bytes -> (двоичные данные)
ResourceId -> (строка)
CreationDate -> (метка времени)
Date.LastModifiedDate -> (метка времени)
Date.
© Copyright 2025, Amazon Web Services. Created using Sphinx.