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 Q Connect CreateMessageTemplate API operation.

Syntax

New-QCMessageTemplate
-KnowledgeBaseId <String>
-CustomerProfileAttributes_AccountNumber <String>
-Adm_Action <PushMessageAction>
-Apns_Action <PushMessageAction>
-Baidu_Action <PushMessageAction>
-Fcm_Action <PushMessageAction>
-CustomerProfileAttributes_AdditionalInformation <String>
-CustomerEndpoint_Address <String>
-SystemEndpoint_Address <String>
-CustomerProfileAttributes_Address1 <String>
-CustomerProfileAttributes_Address2 <String>
-CustomerProfileAttributes_Address3 <String>
-CustomerProfileAttributes_Address4 <String>
-CustomerProfileAttributes_BillingAddress1 <String>
-CustomerProfileAttributes_BillingAddress2 <String>
-CustomerProfileAttributes_BillingAddress3 <String>
-CustomerProfileAttributes_BillingAddress4 <String>
-CustomerProfileAttributes_BillingCity <String>
-CustomerProfileAttributes_BillingCountry <String>
-CustomerProfileAttributes_BillingCounty <String>
-CustomerProfileAttributes_BillingPostalCode <String>
-CustomerProfileAttributes_BillingProvince <String>
-CustomerProfileAttributes_BillingState <String>
-CustomerProfileAttributes_BirthDate <String>
-WhatsApp_BusinessAccountId <String>
-CustomerProfileAttributes_BusinessEmailAddress <String>
-CustomerProfileAttributes_BusinessName <String>
-CustomerProfileAttributes_BusinessPhoneNumber <String>
-ChannelSubtype <ChannelSubtype>
-CustomerProfileAttributes_City <String>
-WhatsApp_Component <String[]>
-Html_Content <String>
-Content_Email_Body_PlainText_Content <String>
-Content_Push_Adm_Body_Content <String>
-Content_Push_Adm_RawContent_Content <String>
-Content_Push_Apns_Body_Content <String>
-Content_Push_Apns_RawContent_Content <String>
-Content_Push_Baidu_Body_Content <String>
-Content_Push_Baidu_RawContent_Content <String>
-Content_Push_Fcm_Body_Content <String>
-Content_Push_Fcm_RawContent_Content <String>
-Content_Sms_Body_PlainText_Content <String>
-CustomerProfileAttributes_Country <String>
-CustomerProfileAttributes_County <String>
-GroupingConfiguration_Criterion <String>
-CustomerProfileAttributes_Custom <Hashtable>
-DefaultAttributes_CustomAttribute <Hashtable>
-WhatsApp_Data <String>
-Description <String>
-CustomerProfileAttributes_EmailAddress <String>
-AgentAttributes_FirstName <String>
-CustomerProfileAttributes_FirstName <String>
-CustomerProfileAttributes_Gender <String>
-Email_Header <EmailHeader[]>
-CustomerProfileAttributes_HomePhoneNumber <String>
-Adm_ImageIconUrl <String>
-Baidu_ImageIconUrl <String>
-Fcm_ImageIconUrl <String>
-Adm_ImageUrl <String>
-Baidu_ImageUrl <String>
-Fcm_ImageUrl <String>
-Language <String>
-AgentAttributes_LastName <String>
-CustomerProfileAttributes_LastName <String>
-CustomerProfileAttributes_MailingAddress1 <String>
-CustomerProfileAttributes_MailingAddress2 <String>
-CustomerProfileAttributes_MailingAddress3 <String>
-CustomerProfileAttributes_MailingAddress4 <String>
-CustomerProfileAttributes_MailingCity <String>
-CustomerProfileAttributes_MailingCountry <String>
-CustomerProfileAttributes_MailingCounty <String>
-CustomerProfileAttributes_MailingPostalCode <String>
-CustomerProfileAttributes_MailingProvince <String>
-CustomerProfileAttributes_MailingState <String>
-Apns_MediaUrl <String>
-CustomerProfileAttributes_MiddleName <String>
-CustomerProfileAttributes_MobilePhoneNumber <String>
-SystemAttributes_Name <String>
-Name <String>
-CustomerProfileAttributes_PartyType <String>
-CustomerProfileAttributes_PhoneNumber <String>
-CustomerProfileAttributes_PostalCode <String>
-CustomerProfileAttributes_ProfileARN <String>
-CustomerProfileAttributes_ProfileId <String>
-CustomerProfileAttributes_Province <String>
-CustomerProfileAttributes_ShippingAddress1 <String>
-CustomerProfileAttributes_ShippingAddress2 <String>
-CustomerProfileAttributes_ShippingAddress3 <String>
-CustomerProfileAttributes_ShippingAddress4 <String>
-CustomerProfileAttributes_ShippingCity <String>
-CustomerProfileAttributes_ShippingCountry <String>
-CustomerProfileAttributes_ShippingCounty <String>
-CustomerProfileAttributes_ShippingPostalCode <String>
-CustomerProfileAttributes_ShippingProvince <String>
-CustomerProfileAttributes_ShippingState <String>
-Adm_SmallImageIconUrl <String>
-Baidu_SmallImageIconUrl <String>
-Fcm_SmallImageIconUrl <String>
-Adm_Sound <String>
-Apns_Sound <String>
-Baidu_Sound <String>
-Fcm_Sound <String>
-CustomerProfileAttributes_State <String>
-Email_Subject <String>
-Tag <Hashtable>
-WhatsApp_TemplateId <String>
-Adm_Title <String>
-Apns_Title <String>
-Baidu_Title <String>
-Fcm_Title <String>
-Adm_Url <String>
-Apns_Url <String>
-Baidu_Url <String>
-Fcm_Url <String>
-GroupingConfiguration_Value <String[]>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQConnectConfig>

Description

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

Parameters

-Adm_Action <PushMessageAction>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:
  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Adm_Action
-Adm_ImageIconUrl <String>
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Adm_ImageIconUrl
-Adm_ImageUrl <String>
The URL of an image to display in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Adm_ImageUrl
-Adm_SmallImageIconUrl <String>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Adm_SmallImageIconUrl
-Adm_Sound <String>
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Adm_Sound
-Adm_Title <String>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Adm_Title
-Adm_Url <String>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Adm_Url
-AgentAttributes_FirstName <String>
The agent’s first name as entered in their Amazon Connect user account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_AgentAttributes_FirstName
-AgentAttributes_LastName <String>
The agent’s last name as entered in their Amazon Connect user account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_AgentAttributes_LastName
-Apns_Action <PushMessageAction>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:
  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the iOS platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Apns_Action
-Apns_MediaUrl <String>
The URL of an image or video to display in push notifications that are based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Apns_MediaUrl
-Apns_Sound <String>
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Apns_Sound
-Apns_Title <String>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Apns_Title
-Apns_Url <String>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Apns_Url
-Baidu_Action <PushMessageAction>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:
  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Baidu_Action
-Baidu_ImageIconUrl <String>
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Baidu_ImageIconUrl
-Baidu_ImageUrl <String>
The URL of an image to display in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Baidu_ImageUrl
-Baidu_SmallImageIconUrl <String>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Baidu_SmallImageIconUrl
-Baidu_Sound <String>
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Baidu_Sound
-Baidu_Title <String>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Baidu_Title
-Baidu_Url <String>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Baidu_Url
-ChannelSubtype <ChannelSubtype>
The channel subtype this message template applies to.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonQConnectConfig>
Amazon.PowerShell.Cmdlets.QC.AmazonQConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Email_Body_PlainText_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Adm_Body_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Adm_RawContent_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Apns_Body_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Apns_RawContent_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Baidu_Body_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Baidu_RawContent_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Fcm_Body_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Push_Fcm_RawContent_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content_Sms_Body_PlainText_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerEndpoint_Address <String>
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_SystemAttributes_CustomerEndpoint_Address
-CustomerProfileAttributes_AccountNumber <String>
A unique account number that you have given to the customer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_AccountNumber
-CustomerProfileAttributes_AdditionalInformation <String>
Any additional information relevant to the customer's profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_AdditionalInformation
-CustomerProfileAttributes_Address1 <String>
The first line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Address1
-CustomerProfileAttributes_Address2 <String>
The second line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Address2
-CustomerProfileAttributes_Address3 <String>
The third line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Address3
-CustomerProfileAttributes_Address4 <String>
The fourth line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Address4
-CustomerProfileAttributes_BillingAddress1 <String>
The first line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingAddress1
-CustomerProfileAttributes_BillingAddress2 <String>
The second line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingAddress2
-CustomerProfileAttributes_BillingAddress3 <String>
The third line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingAddress3
-CustomerProfileAttributes_BillingAddress4 <String>
The fourth line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingAddress4
-CustomerProfileAttributes_BillingCity <String>
The city of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingCity
-CustomerProfileAttributes_BillingCountry <String>
The country of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingCountry
-CustomerProfileAttributes_BillingCounty <String>
The county of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingCounty
-CustomerProfileAttributes_BillingPostalCode <String>
The postal code of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingPostalCode
-CustomerProfileAttributes_BillingProvince <String>
The province of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingProvince
-CustomerProfileAttributes_BillingState <String>
The state of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BillingState
-CustomerProfileAttributes_BirthDate <String>
The customer's birth date.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BirthDate
-CustomerProfileAttributes_BusinessEmailAddress <String>
The customer's business email address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BusinessEmailAddress
-CustomerProfileAttributes_BusinessName <String>
The name of the customer's business.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BusinessName
-CustomerProfileAttributes_BusinessPhoneNumber <String>
The customer's business phone number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_BusinessPhoneNumber
-CustomerProfileAttributes_City <String>
The city in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_City
-CustomerProfileAttributes_Country <String>
The country in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Country
-CustomerProfileAttributes_County <String>
The county in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_County
-CustomerProfileAttributes_Custom <Hashtable>
The custom attributes in customer profile attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Custom
-CustomerProfileAttributes_EmailAddress <String>
The customer's email address, which has not been specified as a personal or business address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_EmailAddress
-CustomerProfileAttributes_FirstName <String>
The customer's first name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_FirstName
-CustomerProfileAttributes_Gender <String>
The customer's gender.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Gender
-CustomerProfileAttributes_HomePhoneNumber <String>
The customer's mobile phone number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_HomePhoneNumber
-CustomerProfileAttributes_LastName <String>
The customer's last name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_LastName
-CustomerProfileAttributes_MailingAddress1 <String>
The first line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingAddress1
-CustomerProfileAttributes_MailingAddress2 <String>
The second line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingAddress2
-CustomerProfileAttributes_MailingAddress3 <String>
The third line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingAddress3
-CustomerProfileAttributes_MailingAddress4 <String>
The fourth line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingAddress4
-CustomerProfileAttributes_MailingCity <String>
The city of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingCity
-CustomerProfileAttributes_MailingCountry <String>
The country of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingCountry
-CustomerProfileAttributes_MailingCounty <String>
The county of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingCounty
-CustomerProfileAttributes_MailingPostalCode <String>
The postal code of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingPostalCode
-CustomerProfileAttributes_MailingProvince <String>
The province of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingProvince
-CustomerProfileAttributes_MailingState <String>
The state of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MailingState
-CustomerProfileAttributes_MiddleName <String>
The customer's middle name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MiddleName
-CustomerProfileAttributes_MobilePhoneNumber <String>
The customer's mobile phone number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_MobilePhoneNumber
-CustomerProfileAttributes_PartyType <String>
The customer's party type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_PartyType
-CustomerProfileAttributes_PhoneNumber <String>
The customer's phone number, which has not been specified as a mobile, home, or business number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_PhoneNumber
-CustomerProfileAttributes_PostalCode <String>
The postal code of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_PostalCode
-CustomerProfileAttributes_ProfileARN <String>
The ARN of a customer profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ProfileARN
-CustomerProfileAttributes_ProfileId <String>
The unique identifier of a customer profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ProfileId
-CustomerProfileAttributes_Province <String>
The province in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_Province
-CustomerProfileAttributes_ShippingAddress1 <String>
The first line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingAddress1
-CustomerProfileAttributes_ShippingAddress2 <String>
The second line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingAddress2
-CustomerProfileAttributes_ShippingAddress3 <String>
The third line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingAddress3
-CustomerProfileAttributes_ShippingAddress4 <String>
The fourth line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingAddress4
-CustomerProfileAttributes_ShippingCity <String>
The city of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingCity
-CustomerProfileAttributes_ShippingCountry <String>
The country of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingCountry
-CustomerProfileAttributes_ShippingCounty <String>
The county of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingCounty
-CustomerProfileAttributes_ShippingPostalCode <String>
The postal code of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingPostalCode
-CustomerProfileAttributes_ShippingProvince <String>
The province of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingProvince
-CustomerProfileAttributes_ShippingState <String>
The state of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_ShippingState
-CustomerProfileAttributes_State <String>
The state in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomerProfileAttributes_State
-DefaultAttributes_CustomAttribute <Hashtable>
The custom attributes that are used with the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_CustomAttributes
-Description <String>
The description of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Email_Header <EmailHeader[]>
The email headers to include in email messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Email_Headers
-Email_Subject <String>
The subject line, or title, to use in email messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Email_Subject
-Fcm_Action <PushMessageAction>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:
  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Fcm_Action
-Fcm_ImageIconUrl <String>
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Fcm_ImageIconUrl
-Fcm_ImageUrl <String>
The URL of an image to display in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Fcm_ImageUrl
-Fcm_SmallImageIconUrl <String>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Fcm_SmallImageIconUrl
-Fcm_Sound <String>
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Fcm_Sound
-Fcm_Title <String>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Fcm_Title
-Fcm_Url <String>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Push_Fcm_Url
-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)
-GroupingConfiguration_Criterion <String>
The criteria used for grouping Amazon Q in Connect users.The following is the list of supported criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGroupingConfiguration_Criteria
-GroupingConfiguration_Value <String[]>
The list of values that define different groups of Amazon Q in Connect users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGroupingConfiguration_Values
-Html_Content <String>
The content of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Email_Body_Html_Content
-KnowledgeBaseId <String>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Language <String>
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MessageTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateMessageTemplateResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateMessageTemplateResponse 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)
-SystemAttributes_Name <String>
The name of the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_SystemAttributes_Name
-SystemEndpoint_Address <String>
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultAttributes_SystemAttributes_SystemEndpoint_Address
-Tag <Hashtable>
The tags used to organize, track, or control access for this resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-WhatsApp_BusinessAccountId <String>
The ID of the End User Messaging WhatsApp Business Account to associate with this template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_WhatsApp_BusinessAccountId
-WhatsApp_Component <String[]>
The list of component mapping from WhatsApp template parameters to Message Template attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_WhatsApp_Components
-WhatsApp_Data <String>
The data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_WhatsApp_Data
-WhatsApp_TemplateId <String>
The WhatsApp template ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_WhatsApp_TemplateId

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.QConnect.Model.MessageTemplateData or Amazon.QConnect.Model.CreateMessageTemplateResponse
This cmdlet returns an Amazon.QConnect.Model.MessageTemplateData object. The service call response (type Amazon.QConnect.Model.CreateMessageTemplateResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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