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 RenderMessageTemplate API operation.

Syntax

Invoke-QCMessageTemplate
-MessageTemplateId <String>
-CustomerProfileAttributes_AccountNumber <String>
-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>
-CustomerProfileAttributes_BusinessEmailAddress <String>
-CustomerProfileAttributes_BusinessName <String>
-CustomerProfileAttributes_BusinessPhoneNumber <String>
-CustomerProfileAttributes_City <String>
-CustomerProfileAttributes_Country <String>
-CustomerProfileAttributes_County <String>
-CustomerProfileAttributes_Custom <Hashtable>
-Attributes_CustomAttribute <Hashtable>
-CustomerProfileAttributes_EmailAddress <String>
-AgentAttributes_FirstName <String>
-CustomerProfileAttributes_FirstName <String>
-CustomerProfileAttributes_Gender <String>
-CustomerProfileAttributes_HomePhoneNumber <String>
-KnowledgeBaseId <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>
-CustomerProfileAttributes_MiddleName <String>
-CustomerProfileAttributes_MobilePhoneNumber <String>
-SystemAttributes_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>
-CustomerProfileAttributes_State <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQConnectConfig>

Description

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

Parameters

-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)
AliasesAttributes_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)
AliasesAttributes_AgentAttributes_LastName
-Attributes_CustomAttribute <Hashtable>
The custom attributes that are used with the message template. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomAttributes
-ClientConfig <AmazonQConnectConfig>
Amazon.PowerShell.Cmdlets.QC.AmazonQConnectClientCmdlet.ClientConfig
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)
AliasesAttributes_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)
AliasesAttributes_CustomerProfileAttributes_AccountNumber
-CustomerProfileAttributes_AdditionalInformation <String>
Any additional information relevant to the customer's profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_AdditionalInformation
-CustomerProfileAttributes_Address1 <String>
The first line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_Address1
-CustomerProfileAttributes_Address2 <String>
The second line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_Address2
-CustomerProfileAttributes_Address3 <String>
The third line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_Address3
-CustomerProfileAttributes_Address4 <String>
The fourth line of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_Address4
-CustomerProfileAttributes_BillingAddress1 <String>
The first line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingAddress1
-CustomerProfileAttributes_BillingAddress2 <String>
The second line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingAddress2
-CustomerProfileAttributes_BillingAddress3 <String>
The third line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingAddress3
-CustomerProfileAttributes_BillingAddress4 <String>
The fourth line of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingAddress4
-CustomerProfileAttributes_BillingCity <String>
The city of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingCity
-CustomerProfileAttributes_BillingCountry <String>
The country of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingCountry
-CustomerProfileAttributes_BillingCounty <String>
The county of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingCounty
-CustomerProfileAttributes_BillingPostalCode <String>
The postal code of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingPostalCode
-CustomerProfileAttributes_BillingProvince <String>
The province of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingProvince
-CustomerProfileAttributes_BillingState <String>
The state of a customer’s billing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BillingState
-CustomerProfileAttributes_BirthDate <String>
The customer's birth date.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BirthDate
-CustomerProfileAttributes_BusinessEmailAddress <String>
The customer's business email address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BusinessEmailAddress
-CustomerProfileAttributes_BusinessName <String>
The name of the customer's business.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BusinessName
-CustomerProfileAttributes_BusinessPhoneNumber <String>
The customer's business phone number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_BusinessPhoneNumber
-CustomerProfileAttributes_City <String>
The city in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_City
-CustomerProfileAttributes_Country <String>
The country in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_Country
-CustomerProfileAttributes_County <String>
The county in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_County
-CustomerProfileAttributes_Custom <Hashtable>
The custom attributes in customer profile attributes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_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)
AliasesAttributes_CustomerProfileAttributes_EmailAddress
-CustomerProfileAttributes_FirstName <String>
The customer's first name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_FirstName
-CustomerProfileAttributes_Gender <String>
The customer's gender.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_Gender
-CustomerProfileAttributes_HomePhoneNumber <String>
The customer's mobile phone number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_HomePhoneNumber
-CustomerProfileAttributes_LastName <String>
The customer's last name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_LastName
-CustomerProfileAttributes_MailingAddress1 <String>
The first line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingAddress1
-CustomerProfileAttributes_MailingAddress2 <String>
The second line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingAddress2
-CustomerProfileAttributes_MailingAddress3 <String>
The third line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingAddress3
-CustomerProfileAttributes_MailingAddress4 <String>
The fourth line of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingAddress4
-CustomerProfileAttributes_MailingCity <String>
The city of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingCity
-CustomerProfileAttributes_MailingCountry <String>
The country of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingCountry
-CustomerProfileAttributes_MailingCounty <String>
The county of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingCounty
-CustomerProfileAttributes_MailingPostalCode <String>
The postal code of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingPostalCode
-CustomerProfileAttributes_MailingProvince <String>
The province of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingProvince
-CustomerProfileAttributes_MailingState <String>
The state of a customer’s mailing address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MailingState
-CustomerProfileAttributes_MiddleName <String>
The customer's middle name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MiddleName
-CustomerProfileAttributes_MobilePhoneNumber <String>
The customer's mobile phone number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_MobilePhoneNumber
-CustomerProfileAttributes_PartyType <String>
The customer's party type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_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)
AliasesAttributes_CustomerProfileAttributes_PhoneNumber
-CustomerProfileAttributes_PostalCode <String>
The postal code of a customer address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_PostalCode
-CustomerProfileAttributes_ProfileARN <String>
The ARN of a customer profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ProfileARN
-CustomerProfileAttributes_ProfileId <String>
The unique identifier of a customer profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ProfileId
-CustomerProfileAttributes_Province <String>
The province in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_Province
-CustomerProfileAttributes_ShippingAddress1 <String>
The first line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingAddress1
-CustomerProfileAttributes_ShippingAddress2 <String>
The second line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingAddress2
-CustomerProfileAttributes_ShippingAddress3 <String>
The third line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingAddress3
-CustomerProfileAttributes_ShippingAddress4 <String>
The fourth line of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingAddress4
-CustomerProfileAttributes_ShippingCity <String>
The city of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingCity
-CustomerProfileAttributes_ShippingCountry <String>
The country of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingCountry
-CustomerProfileAttributes_ShippingCounty <String>
The county of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingCounty
-CustomerProfileAttributes_ShippingPostalCode <String>
The postal code of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingPostalCode
-CustomerProfileAttributes_ShippingProvince <String>
The province of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingProvince
-CustomerProfileAttributes_ShippingState <String>
The state of a customer’s shipping address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_ShippingState
-CustomerProfileAttributes_State <String>
The state in which a customer lives.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes_CustomerProfileAttributes_State
-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)
-KnowledgeBaseId <String>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MessageTemplateId <String>
The identifier of the message template. Can be either the ID or the ARN.
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.QConnect.Model.RenderMessageTemplateResponse). Specifying the name of a property of type Amazon.QConnect.Model.RenderMessageTemplateResponse 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)
AliasesAttributes_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)
AliasesAttributes_SystemAttributes_SystemEndpoint_Address

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.RenderMessageTemplateResponse
This cmdlet returns an Amazon.QConnect.Model.RenderMessageTemplateResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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