/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.Pinpoint;
using Amazon.Pinpoint.Model;
namespace Amazon.PowerShell.Cmdlets.PIN
{
///
/// Updates an existing message template for messages that are sent through the email
/// channel.
///
[Cmdlet("Update", "PINEmailTemplate", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Pinpoint.Model.MessageBody")]
[AWSCmdlet("Calls the Amazon Pinpoint UpdateEmailTemplate API operation.", Operation = new[] {"UpdateEmailTemplate"}, SelectReturnType = typeof(Amazon.Pinpoint.Model.UpdateEmailTemplateResponse))]
[AWSCmdletOutput("Amazon.Pinpoint.Model.MessageBody or Amazon.Pinpoint.Model.UpdateEmailTemplateResponse",
"This cmdlet returns an Amazon.Pinpoint.Model.MessageBody object.",
"The service call response (type Amazon.Pinpoint.Model.UpdateEmailTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdatePINEmailTemplateCmdlet : AmazonPinpointClientCmdlet, IExecutor
{
#region Parameter CreateNewVersion
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? CreateNewVersion { get; set; }
#endregion
#region Parameter EmailTemplateRequest_DefaultSubstitution
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("EmailTemplateRequest_DefaultSubstitutions")]
public System.String EmailTemplateRequest_DefaultSubstitution { get; set; }
#endregion
#region Parameter EmailTemplateRequest_HtmlPart
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EmailTemplateRequest_HtmlPart { get; set; }
#endregion
#region Parameter EmailTemplateRequest_RecommenderId
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EmailTemplateRequest_RecommenderId { get; set; }
#endregion
#region Parameter EmailTemplateRequest_Subject
///
///
/// The subject line, or title, to use in email messages that are based on the message
/// template.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EmailTemplateRequest_Subject { get; set; }
#endregion
#region Parameter EmailTemplateRequest_Tag
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("EmailTemplateRequest_Tags")]
public System.Collections.Hashtable EmailTemplateRequest_Tag { get; set; }
#endregion
#region Parameter EmailTemplateRequest_TemplateDescription
///
///
/// A custom description of the message template.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EmailTemplateRequest_TemplateDescription { get; set; }
#endregion
#region Parameter TemplateName
///
///
/// 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.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String TemplateName { get; set; }
#endregion
#region Parameter EmailTemplateRequest_TextPart
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EmailTemplateRequest_TextPart { get; set; }
#endregion
#region Parameter Version
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Version { get; set; }
#endregion
#region Parameter Select
///
/// 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.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "MessageBody";
#endregion
#region Parameter PassThru
///
/// 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.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TemplateName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.TemplateName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-PINEmailTemplate (UpdateEmailTemplate)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.TemplateName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CreateNewVersion = this.CreateNewVersion;
context.EmailTemplateRequest_DefaultSubstitution = this.EmailTemplateRequest_DefaultSubstitution;
context.EmailTemplateRequest_HtmlPart = this.EmailTemplateRequest_HtmlPart;
context.EmailTemplateRequest_RecommenderId = this.EmailTemplateRequest_RecommenderId;
context.EmailTemplateRequest_Subject = this.EmailTemplateRequest_Subject;
if (this.EmailTemplateRequest_Tag != null)
{
context.EmailTemplateRequest_Tag = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.EmailTemplateRequest_Tag.Keys)
{
context.EmailTemplateRequest_Tag.Add((String)hashKey, (String)(this.EmailTemplateRequest_Tag[hashKey]));
}
}
context.EmailTemplateRequest_TemplateDescription = this.EmailTemplateRequest_TemplateDescription;
context.EmailTemplateRequest_TextPart = this.EmailTemplateRequest_TextPart;
context.TemplateName = this.TemplateName;
#if MODULAR
if (this.TemplateName == null && ParameterWasBound(nameof(this.TemplateName)))
{
WriteWarning("You are passing $null as a value for parameter TemplateName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.Version = this.Version;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.Pinpoint.Model.UpdateEmailTemplateRequest();
if (cmdletContext.CreateNewVersion != null)
{
request.CreateNewVersion = cmdletContext.CreateNewVersion.Value;
}
// populate EmailTemplateRequest
var requestEmailTemplateRequestIsNull = true;
request.EmailTemplateRequest = new Amazon.Pinpoint.Model.EmailTemplateRequest();
System.String requestEmailTemplateRequest_emailTemplateRequest_DefaultSubstitution = null;
if (cmdletContext.EmailTemplateRequest_DefaultSubstitution != null)
{
requestEmailTemplateRequest_emailTemplateRequest_DefaultSubstitution = cmdletContext.EmailTemplateRequest_DefaultSubstitution;
}
if (requestEmailTemplateRequest_emailTemplateRequest_DefaultSubstitution != null)
{
request.EmailTemplateRequest.DefaultSubstitutions = requestEmailTemplateRequest_emailTemplateRequest_DefaultSubstitution;
requestEmailTemplateRequestIsNull = false;
}
System.String requestEmailTemplateRequest_emailTemplateRequest_HtmlPart = null;
if (cmdletContext.EmailTemplateRequest_HtmlPart != null)
{
requestEmailTemplateRequest_emailTemplateRequest_HtmlPart = cmdletContext.EmailTemplateRequest_HtmlPart;
}
if (requestEmailTemplateRequest_emailTemplateRequest_HtmlPart != null)
{
request.EmailTemplateRequest.HtmlPart = requestEmailTemplateRequest_emailTemplateRequest_HtmlPart;
requestEmailTemplateRequestIsNull = false;
}
System.String requestEmailTemplateRequest_emailTemplateRequest_RecommenderId = null;
if (cmdletContext.EmailTemplateRequest_RecommenderId != null)
{
requestEmailTemplateRequest_emailTemplateRequest_RecommenderId = cmdletContext.EmailTemplateRequest_RecommenderId;
}
if (requestEmailTemplateRequest_emailTemplateRequest_RecommenderId != null)
{
request.EmailTemplateRequest.RecommenderId = requestEmailTemplateRequest_emailTemplateRequest_RecommenderId;
requestEmailTemplateRequestIsNull = false;
}
System.String requestEmailTemplateRequest_emailTemplateRequest_Subject = null;
if (cmdletContext.EmailTemplateRequest_Subject != null)
{
requestEmailTemplateRequest_emailTemplateRequest_Subject = cmdletContext.EmailTemplateRequest_Subject;
}
if (requestEmailTemplateRequest_emailTemplateRequest_Subject != null)
{
request.EmailTemplateRequest.Subject = requestEmailTemplateRequest_emailTemplateRequest_Subject;
requestEmailTemplateRequestIsNull = false;
}
Dictionary requestEmailTemplateRequest_emailTemplateRequest_Tag = null;
if (cmdletContext.EmailTemplateRequest_Tag != null)
{
requestEmailTemplateRequest_emailTemplateRequest_Tag = cmdletContext.EmailTemplateRequest_Tag;
}
if (requestEmailTemplateRequest_emailTemplateRequest_Tag != null)
{
request.EmailTemplateRequest.Tags = requestEmailTemplateRequest_emailTemplateRequest_Tag;
requestEmailTemplateRequestIsNull = false;
}
System.String requestEmailTemplateRequest_emailTemplateRequest_TemplateDescription = null;
if (cmdletContext.EmailTemplateRequest_TemplateDescription != null)
{
requestEmailTemplateRequest_emailTemplateRequest_TemplateDescription = cmdletContext.EmailTemplateRequest_TemplateDescription;
}
if (requestEmailTemplateRequest_emailTemplateRequest_TemplateDescription != null)
{
request.EmailTemplateRequest.TemplateDescription = requestEmailTemplateRequest_emailTemplateRequest_TemplateDescription;
requestEmailTemplateRequestIsNull = false;
}
System.String requestEmailTemplateRequest_emailTemplateRequest_TextPart = null;
if (cmdletContext.EmailTemplateRequest_TextPart != null)
{
requestEmailTemplateRequest_emailTemplateRequest_TextPart = cmdletContext.EmailTemplateRequest_TextPart;
}
if (requestEmailTemplateRequest_emailTemplateRequest_TextPart != null)
{
request.EmailTemplateRequest.TextPart = requestEmailTemplateRequest_emailTemplateRequest_TextPart;
requestEmailTemplateRequestIsNull = false;
}
// determine if request.EmailTemplateRequest should be set to null
if (requestEmailTemplateRequestIsNull)
{
request.EmailTemplateRequest = null;
}
if (cmdletContext.TemplateName != null)
{
request.TemplateName = cmdletContext.TemplateName;
}
if (cmdletContext.Version != null)
{
request.Version = cmdletContext.Version;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Pinpoint.Model.UpdateEmailTemplateResponse CallAWSServiceOperation(IAmazonPinpoint client, Amazon.Pinpoint.Model.UpdateEmailTemplateRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Pinpoint", "UpdateEmailTemplate");
try
{
#if DESKTOP
return client.UpdateEmailTemplate(request);
#elif CORECLR
return client.UpdateEmailTemplateAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.Boolean? CreateNewVersion { get; set; }
public System.String EmailTemplateRequest_DefaultSubstitution { get; set; }
public System.String EmailTemplateRequest_HtmlPart { get; set; }
public System.String EmailTemplateRequest_RecommenderId { get; set; }
public System.String EmailTemplateRequest_Subject { get; set; }
public Dictionary EmailTemplateRequest_Tag { get; set; }
public System.String EmailTemplateRequest_TemplateDescription { get; set; }
public System.String EmailTemplateRequest_TextPart { get; set; }
public System.String TemplateName { get; set; }
public System.String Version { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.MessageBody;
}
}
}