Spec-Zone.ru › AWS CLI v2

[ aws . workspaces ]

describe-client-branding

Описание

Описывает указанную настройку внешнего вида клиента. Настройка внешнего вида клиента позволяет настраивать страницу входа для различных типов устройств для ваших пользователей. Вы можете добавить логотип вашей компании, адрес электронной почты службы поддержки, ссылку на страницу службы поддержки, ссылку на сброс пароля и пользовательское сообщение для пользователей, пытающихся войти в систему.

Примечание

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

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

Синтаксис

  describe-client-branding
--resource-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]

Параметры

--resource-id (строка)

Идентификатор каталога WorkSpace, для которого требуется просмотреть информацию о брендинге клиента.

--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-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

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

Информация о брендинге для устройств Windows.

LogoUrl -> (строка)

Логотип. Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

SupportEmail -> (строка)

Электронная почта поддержки. Электронный адрес службы поддержки клиентов компании.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию используется электронная почта workspaces-feedback@amazon.com .

SupportLink -> (строка)

Ссылка поддержки. Ссылка на страницу поддержки клиентов компании для их WorkSpace.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию ссылка поддержки — workspaces-feedback@amazon.com .

ForgotPasswordLink -> (строка)

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

LoginMessage -> (массив)

Сообщение входа в систему. Указывается в виде пары «ключ-значение», где ключ — язык, а значение — локализованное сообщение для этого языка. Поддерживается только ключ en_US. Поддерживаемые теги HTML включают в себя следующие: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

key -> (строка)

value -> (строка)

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

Информация о брендинге для устройств macOS.

LogoUrl -> (строка)

Логотип. Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

SupportEmail -> (строка)

Электронная почта поддержки. Электронный адрес службы поддержки клиентов компании.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию используется электронная почта workspaces-feedback@amazon.com .

SupportLink -> (строка)

Ссылка поддержки. Ссылка на страницу поддержки клиентов компании для их WorkSpace.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию ссылка поддержки — workspaces-feedback@amazon.com .

ForgotPasswordLink -> (строка)

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

LoginMessage -> (массив)

Сообщение входа в систему. Указывается в виде пары «ключ-значение», где ключ — язык, а значение — локализованное сообщение для этого языка. Поддерживается только ключ en_US. Поддерживаемые теги HTML включают в себя следующие: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

key -> (строка)

value -> (строка)

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

Информация о брендинге для устройств Android.

LogoUrl -> (строка)

Логотип. Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

SupportEmail -> (строка)

Электронная почта поддержки. Электронный адрес службы поддержки клиентов компании.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию используется электронная почта workspaces-feedback@amazon.com .

SupportLink -> (строка)

Ссылка поддержки. Ссылка на страницу поддержки клиентов компании для их WorkSpace.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию ссылка поддержки — workspaces-feedback@amazon.com .

ForgotPasswordLink -> (строка)

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

LoginMessage -> (массив)

Сообщение входа в систему. Указывается в виде пары «ключ-значение», где ключ — язык, а значение — локализованное сообщение для этого языка. Поддерживается только ключ en_US. Поддерживаемые теги HTML включают в себя следующие: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

key -> (строка)

value -> (строка)

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

Информация о брендинге для устройств iOS.

LogoUrl -> (строка)

Логотип. Это отображение стандартного разрешения с плотностью пикселей 1:1 (или @1x), где один пиксель равен одному пункту. Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

Logo2xUrl -> (строка)

Версия логотипа @2x. Это отображение более высокого разрешения с коэффициентом масштабирования 2,0 (или @2x). Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

Примечание

Дополнительную информацию о размерах и разрешении изображений iOS см. в разделе «Размеры и разрешение изображений» в руководстве Apple по пользовательскому интерфейсу.

Logo3xUrl -> (строка)

Версия логотипа @3x. Это отображение более высокого разрешения с коэффициентом масштабирования 3,0 (или @3x). Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

Примечание

Дополнительную информацию о размерах и разрешении изображений iOS см. в разделе «Размеры и разрешение изображений» в руководстве Apple по пользовательскому интерфейсу.

SupportEmail -> (строка)

Электронная почта поддержки. Электронный адрес службы поддержки клиентов компании.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию используется электронная почта workspaces-feedback@amazon.com .

SupportLink -> (строка)

Ссылка поддержки. Ссылка на страницу поддержки клиентов компании для их WorkSpace.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию ссылка поддержки — workspaces-feedback@amazon.com .

ForgotPasswordLink -> (строка)

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

LoginMessage -> (массив)

Сообщение входа в систему. Указывается в виде пары «ключ-значение», где ключ — язык, а значение — локализованное сообщение для этого языка. Поддерживается только ключ en_US. Поддерживаемые теги HTML включают в себя следующие: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

key -> (строка)

value -> (строка)

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

Информация о брендинге для устройств Linux.

LogoUrl -> (строка)

Логотип. Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

SupportEmail -> (строка)

Электронная почта поддержки. Электронный адрес службы поддержки клиентов компании.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию используется электронная почта workspaces-feedback@amazon.com .

SupportLink -> (строка)

Ссылка поддержки. Ссылка на страницу поддержки клиентов компании для их WorkSpace.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию ссылка поддержки — workspaces-feedback@amazon.com .

ForgotPasswordLink -> (строка)

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

LoginMessage -> (массив)

Сообщение входа в систему. Указывается в виде пары «ключ-значение», где ключ — язык, а значение — локализованное сообщение для этого языка. Поддерживается только ключ en_US. Поддерживаемые теги HTML включают в себя следующие: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

key -> (строка)

value -> (строка)

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

Информация о брендинге для доступа через веб.

LogoUrl -> (строка)

Логотип. Единственный поддерживаемый формат изображения — двоичный объект данных, преобразованный из файла .png.

SupportEmail -> (строка)

Электронная почта поддержки. Электронный адрес службы поддержки клиентов компании.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию используется электронная почта workspaces-feedback@amazon.com .

SupportLink -> (строка)

Ссылка поддержки. Ссылка на страницу поддержки клиентов компании для их WorkSpace.

Примечание

  • В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать один параметр для каждого типа платформы, но не оба.
  • По умолчанию ссылка поддержки — workspaces-feedback@amazon.com .

ForgotPasswordLink -> (строка)

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

LoginMessage -> (массив)

Сообщение входа в систему. Указывается в виде пары «ключ-значение», где ключ — язык, а значение — локализованное сообщение для этого языка. Поддерживается только ключ en_US. Поддерживаемые теги HTML включают в себя следующие: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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