Amazon.PowerShell.Cmdlets.PIN.AmazonPinpointClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-EmailTemplateRequest_DefaultSubstitution <
String>
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EmailTemplateRequest_DefaultSubstitutions |
The list of
MessageHeaders for the email. You can have up to 15 Headers.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EmailTemplateRequest_Headers |
-EmailTemplateRequest_HtmlPart <
String>
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-EmailTemplateRequest_RecommenderId <
String>
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-EmailTemplateRequest_Subject <
String>
The subject line, or title, to use in email messages that are based on the message template.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
As of
22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either
Tags in the
API Reference for Amazon Pinpoint,
resourcegroupstaggingapi commands in the
AWS Command Line Interface Documentation or
resourcegroupstaggingapi in the
AWS SDK.(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EmailTemplateRequest_Tags |
-EmailTemplateRequest_TemplateDescription <
String>
A custom description of the message template.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-EmailTemplateRequest_TextPart <
String>
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
Changes the cmdlet behavior to return the value passed to the TemplateName parameter. The -PassThru parameter is deprecated, use -Select '^TemplateName' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateEmailTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateEmailTemplateResponse 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) |
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.If you don't specify a value for this parameter, Amazon Pinpoint does the following:
- For a get operation, retrieves information about the active version of the template.
- For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
- For a delete operation, deletes the template, including all versions of the template.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |