AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon WorkSpaces ImportClientBranding API operation.

Syntax

Import-WKSClientBranding
-ResourceId <String>
-DeviceTypeAndroid_ForgotPasswordLink <String>
-DeviceTypeIos_ForgotPasswordLink <String>
-DeviceTypeLinux_ForgotPasswordLink <String>
-DeviceTypeOsx_ForgotPasswordLink <String>
-DeviceTypeWeb_ForgotPasswordLink <String>
-DeviceTypeWindows_ForgotPasswordLink <String>
-DeviceTypeAndroid_LoginMessage <Hashtable>
-DeviceTypeIos_LoginMessage <Hashtable>
-DeviceTypeLinux_LoginMessage <Hashtable>
-DeviceTypeOsx_LoginMessage <Hashtable>
-DeviceTypeWeb_LoginMessage <Hashtable>
-DeviceTypeWindows_LoginMessage <Hashtable>
-DeviceTypeAndroid_Logo <Byte[]>
-DeviceTypeIos_Logo <Byte[]>
-DeviceTypeLinux_Logo <Byte[]>
-DeviceTypeOsx_Logo <Byte[]>
-DeviceTypeWeb_Logo <Byte[]>
-DeviceTypeWindows_Logo <Byte[]>
-DeviceTypeIos_Logo2x <Byte[]>
-DeviceTypeIos_Logo3x <Byte[]>
-DeviceTypeAndroid_SupportEmail <String>
-DeviceTypeIos_SupportEmail <String>
-DeviceTypeLinux_SupportEmail <String>
-DeviceTypeOsx_SupportEmail <String>
-DeviceTypeWeb_SupportEmail <String>
-DeviceTypeWindows_SupportEmail <String>
-DeviceTypeAndroid_SupportLink <String>
-DeviceTypeIos_SupportLink <String>
-DeviceTypeLinux_SupportLink <String>
-DeviceTypeOsx_SupportLink <String>
-DeviceTypeWeb_SupportLink <String>
-DeviceTypeWindows_SupportLink <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonWorkSpacesConfig>

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

Parameters

-ClientConfig <AmazonWorkSpacesConfig>
Amazon.PowerShell.Cmdlets.WKS.AmazonWorkSpacesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeAndroid_ForgotPasswordLink <String>
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeAndroid_LoginMessage <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeAndroid_Logo <Byte[]>
The logo. The only image format accepted is a binary data object that is converted from a .png file.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeAndroid_SupportEmail <String>
The support email. The company's customer support email address.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeAndroid_SupportLink <String>
The support link. The link for the company's customer support page for their WorkSpace.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeIos_ForgotPasswordLink <String>
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeIos_LoginMessage <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeIos_Logo <Byte[]>
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.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeIos_Logo2x <Byte[]>
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. For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeIos_Logo3x <Byte[]>
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. For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeIos_SupportEmail <String>
The support email. The company's customer support email address.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeIos_SupportLink <String>
The support link. The link for the company's customer support page for their WorkSpace.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeLinux_ForgotPasswordLink <String>
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeLinux_LoginMessage <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeLinux_Logo <Byte[]>
The logo. The only image format accepted is a binary data object that is converted from a .png file.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeLinux_SupportEmail <String>
The support email. The company's customer support email address.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeLinux_SupportLink <String>
The support link. The link for the company's customer support page for their WorkSpace.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeOsx_ForgotPasswordLink <String>
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeOsx_LoginMessage <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeOsx_Logo <Byte[]>
The logo. The only image format accepted is a binary data object that is converted from a .png file.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeOsx_SupportEmail <String>
The support email. The company's customer support email address.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeOsx_SupportLink <String>
The support link. The link for the company's customer support page for their WorkSpace.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWeb_ForgotPasswordLink <String>
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWeb_LoginMessage <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWeb_Logo <Byte[]>
The logo. The only image format accepted is a binary data object that is converted from a .png file.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWeb_SupportEmail <String>
The support email. The company's customer support email address.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWeb_SupportLink <String>
The support link. The link for the company's customer support page for their WorkSpace.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWindows_ForgotPasswordLink <String>
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWindows_LoginMessage <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWindows_Logo <Byte[]>
The logo. The only image format accepted is a binary data object that is converted from a .png file.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWindows_SupportEmail <String>
The support email. The company's customer support email address.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTypeWindows_SupportLink <String>
The support link. The link for the company's customer support page for their WorkSpace.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceId <String>
The directory identifier of the WorkSpace for which you want to import client branding.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpaces.Model.ImportClientBrandingResponse). Specifying the name of a property of type Amazon.WorkSpaces.Model.ImportClientBrandingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.WorkSpaces.Model.ImportClientBrandingResponse
This cmdlet returns an Amazon.WorkSpaces.Model.ImportClientBrandingResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Administration Guide
Developer Guide
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z