импорт-клиентского-брендинга

Описание

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

После импорта брендинга клиента стандартный опыт брендинга для указанного типа платформы заменяется импортированным опытом

Примечание

При импорте брендинга клиента необходимо указать как минимум один тип платформы.
Вы можете импортировать до 6 МБ данных с каждой операцией. Если ваш запрос превышает этот предел, вы можете импортировать брендинг клиента для различных типов платформ, используя отдельные запросы.
В каждом типе платформы параметры SupportEmail и SupportLink взаимоисключающие. Вы можете указать только один параметр для каждого типа платформы, но не оба.
Импортированные данные могут отобразиться в клиенте WorkSpaces в течение минуты.

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

Синопсис

  import-client-branding
--resource-id <value>
[--device-type-windows <value>]
[--device-type-osx <value>]
[--device-type-android <value>]
[--device-type-ios <value>]
[--device-type-linux <value>]
[--device-type-web <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 (строка)

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

--device-type-windows (структура)

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

Логотип -> (двоичные данные)

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

Email поддержки -> (строка)

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

Примечание

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

Ссылка на поддержку -> (строка)

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

Примечание

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

Ссылка на восстановление пароля -> (строка)

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

Сообщение входа -> (массив)

Сообщение входа. Указано как пара ключ-значение, где ключ — локаль, а значение — локализованное сообщение для этой локали. Поддерживается только ключ 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.

ключ -> (строка)

значение -> (строка)

Короткая форма записи:

Logo=blob,SupportEmail=string,SupportLink=string,ForgotPasswordLink=string,LoginMessage={KeyName1=string,KeyName2=string}

Формат JSON:

{
  "Logo": blob,
  "SupportEmail": "string",
  "SupportLink": "string",
  "ForgotPasswordLink": "string",
  "LoginMessage": {"string": "string"
    ...}
}

--device-type-osx (структура)

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

Логотип -> (двоичные данные)

Email поддержки -> (строка)

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

Примечание

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

Ссылка на поддержку -> (строка)

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

Примечание

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

Ссылка на восстановление пароля -> (строка)

Сообщение входа -> (массив)

ключ -> (строка)

значение -> (строка)

Короткая форма записи:

Logo=blob,SupportEmail=string,SupportLink=string,ForgotPasswordLink=string,LoginMessage={KeyName1=string,KeyName2=string}

Формат JSON:

{
  "Logo": blob,
  "SupportEmail": "string",
  "SupportLink": "string",
  "ForgotPasswordLink": "string",
  "LoginMessage": {"string": "string"
    ...}
}

--device-type-android (структура)

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

Логотип -> (двоичные данные)

Email поддержки -> (строка)

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

Примечание

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

Ссылка на поддержку -> (строка)

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

Примечание

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

Ссылка на восстановление пароля -> (строка)

Сообщение входа -> (массив)

ключ -> (строка)

значение -> (строка)

Короткая форма записи:

Logo=blob,SupportEmail=string,SupportLink=string,ForgotPasswordLink=string,LoginMessage={KeyName1=string,KeyName2=string}

Формат JSON:

{
  "Logo": blob,
  "SupportEmail": "string",
  "SupportLink": "string",
  "ForgotPasswordLink": "string",
  "LoginMessage": {"string": "string"
    ...}
}

--device-type-ios (структура)

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

Логотип -> (двоичные данные)

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

Логотип 2x -> (двоичные данные)

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

Примечание

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

Логотип 3x -> (двоичные данные)

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

Примечание

Email поддержки -> (строка)

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

Примечание

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

Ссылка на поддержку -> (строка)

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

Примечание

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

Ссылка на восстановление пароля -> (строка)

Сообщение входа -> (массив)

ключ -> (строка)

значение -> (строка)

Короткая форма записи:

Logo=blob,Logo2x=blob,Logo3x=blob,SupportEmail=string,SupportLink=string,ForgotPasswordLink=string,LoginMessage={KeyName1=string,KeyName2=string}

Формат JSON:

{
  "Logo": blob,
  "Logo2x": blob,
  "Logo3x": blob,
  "SupportEmail": "string",
  "SupportLink": "string",
  "ForgotPasswordLink": "string",
  "LoginMessage": {"string": "string"
    ...}
}

--device-type-linux (структура)

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

Логотип -> (двоичные данные)

Email поддержки -> (строка)

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

Примечание

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

Ссылка на поддержку -> (строка)

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

Примечание

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

Ссылка на восстановление пароля -> (строка)

Сообщение входа -> (массив)

ключ -> (строка)

значение -> (строка)

Короткая форма записи:

Logo=blob,SupportEmail=string,SupportLink=string,ForgotPasswordLink=string,LoginMessage={KeyName1=string,KeyName2=string}

Формат JSON:

{
  "Logo": blob,
  "SupportEmail": "string",
  "SupportLink": "string",
  "ForgotPasswordLink": "string",
  "LoginMessage": {"string": "string"
    ...}
}

--device-type-web (структура)

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

Логотип -> (blob)

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

SupportEmail -> (string)

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

Примечание

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

SupportLink -> (string)

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

Примечание

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

ForgotPasswordLink -> (string)

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

LoginMessage -> (map)

Сообщение входа. Указано в виде пары ключ-значение, где ключ — язык, а значение — локализованное сообщение для этого языка. Поддерживается только ключ 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 -> (string)

value -> (string)

Краткая синтаксическая запись:

Logo=blob,SupportEmail=string,SupportLink=string,ForgotPasswordLink=string,LoginMessage={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "Logo": blob,
  "SupportEmail": "string",
  "SupportLink": "string",
  "ForgotPasswordLink": "string",
  "LoginMessage": {"string": "string"
    ...}
}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команд и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладочную регистрацию.

--endpoint-url (string)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команд.

json
text
таблица
yaml
yaml-поток

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить вывод цвета.

включить
выключить
автоматически

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл-набор сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блобов. По умолчанию используется формат 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 (boolean)

Отключить вывод пагинатора CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода 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 -> (строка)

SupportEmail -> (строка)

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

Примечание

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

SupportLink -> (строка)

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

Примечание

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

ForgotPasswordLink -> (строка)

LoginMessage -> (карта)

key -> (строка)

value -> (строка)

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

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

LogoUrl -> (строка)

SupportEmail -> (строка)

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

Примечание

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

SupportLink -> (строка)

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

Примечание

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

ForgotPasswordLink -> (строка)

LoginMessage -> (карта)

key -> (строка)

value -> (строка)

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

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

LogoUrl -> (строка)

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

Logo2xUrl -> (строка)

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

Примечание

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

Logo3xUrl -> (строка)

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

Примечание

SupportEmail -> (строка)

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

Примечание

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

SupportLink -> (строка)

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

Примечание

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

ForgotPasswordLink -> (строка)

LoginMessage -> (карта)

key -> (строка)

value -> (строка)

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

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

LogoUrl -> (строка)

SupportEmail -> (строка)

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

Примечание

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

SupportLink -> (строка)

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

Примечание

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

ForgotPasswordLink -> (строка)

LoginMessage -> (карта)

key -> (строка)

value -> (строка)

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

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

LogoUrl -> (строка)

SupportEmail -> (строка)

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

Примечание

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

SupportLink -> (строка)

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

Примечание

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

ForgotPasswordLink -> (строка)

LoginMessage -> (карта)

key -> (строка)

value -> (строка)