AWS CLI Command Reference

[ aws . workspaces ]

import-client-branding

Description

Imports client branding. Client branding allows you to customize your WorkSpace’s client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

Note

  • You must specify at least one platform type when importing client branding.

  • You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.

  • Imported data can take up to a minute to appear in the WorkSpaces client.

See also: AWS API Documentation

Synopsis

  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]

Options

--resource-id (string)

The directory identifier of the WorkSpace for which you want to import client branding.

--device-type-windows (structure)

The branding information to import for Windows devices.

Logo -> (blob)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

Shorthand Syntax:

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

JSON Syntax:

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

--device-type-osx (structure)

The branding information to import for macOS devices.

Logo -> (blob)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

Shorthand Syntax:

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

JSON Syntax:

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

--device-type-android (structure)

The branding information to import for Android devices.

Logo -> (blob)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

Shorthand Syntax:

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

JSON Syntax:

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

--device-type-ios (structure)

The branding information to import for iOS devices.

Logo -> (blob)

The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.

Logo2x -> (blob)

The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

Note

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .

Logo3x -> (blob)

The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.

Note

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

Shorthand Syntax:

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

JSON Syntax:

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

--device-type-linux (structure)

The branding information to import for Linux devices.

Logo -> (blob)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

Shorthand Syntax:

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

JSON Syntax:

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

--device-type-web (structure)

The branding information to import for web access.

Logo -> (blob)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

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

Disable automatically prompt for CLI input parameters.

Output

DeviceTypeWindows -> (structure)

The branding information configured for Windows devices.

LogoUrl -> (string)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

DeviceTypeOsx -> (structure)

The branding information configured for macOS devices.

LogoUrl -> (string)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

DeviceTypeAndroid -> (structure)

The branding information configured for Android devices.

LogoUrl -> (string)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

DeviceTypeIos -> (structure)

The branding information configured for iOS devices.

LogoUrl -> (string)

The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.

Logo2xUrl -> (string)

The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

Note

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .

Logo3xUrl -> (string)

The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.

Note

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

DeviceTypeLinux -> (structure)

The branding information configured for Linux devices.

LogoUrl -> (string)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

DeviceTypeWeb -> (structure)

The branding information configured for web access.

LogoUrl -> (string)

The logo. The only image format accepted is a binary data object that is converted from a .png file.

SupportEmail -> (string)

The support email. The company’s customer support email address.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com .

SupportLink -> (string)

The support link. The link for the company’s customer support page for their WorkSpace.

Note

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com .

ForgotPasswordLink -> (string)

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

LoginMessage -> (map)

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: 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)

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