/******************************************************************************* * 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 { /// /// Creates a new message template for messages using the in-app message channel. /// [Cmdlet("New", "PINInAppTemplate", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Pinpoint.Model.TemplateCreateMessageBody")] [AWSCmdlet("Calls the Amazon Pinpoint CreateInAppTemplate API operation.", Operation = new[] {"CreateInAppTemplate"}, SelectReturnType = typeof(Amazon.Pinpoint.Model.CreateInAppTemplateResponse))] [AWSCmdletOutput("Amazon.Pinpoint.Model.TemplateCreateMessageBody or Amazon.Pinpoint.Model.CreateInAppTemplateResponse", "This cmdlet returns an Amazon.Pinpoint.Model.TemplateCreateMessageBody object.", "The service call response (type Amazon.Pinpoint.Model.CreateInAppTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewPINInAppTemplateCmdlet : AmazonPinpointClientCmdlet, IExecutor { #region Parameter InAppTemplateRequest_Content /// /// /// The content of the message, can include up to 5 modals. Each modal must contain a /// message, a header, and background color. ImageUrl and buttons are optional. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public Amazon.Pinpoint.Model.InAppMessageContent[] InAppTemplateRequest_Content { get; set; } #endregion #region Parameter InAppTemplateRequest_CustomConfig /// /// /// Custom config to be sent to client. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Collections.Hashtable InAppTemplateRequest_CustomConfig { get; set; } #endregion #region Parameter InAppTemplateRequest_Layout /// /// /// The layout of the message. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Pinpoint.Layout")] public Amazon.Pinpoint.Layout InAppTemplateRequest_Layout { get; set; } #endregion #region Parameter InAppTemplateRequest_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("InAppTemplateRequest_Tags")] public System.Collections.Hashtable InAppTemplateRequest_Tag { get; set; } #endregion #region Parameter InAppTemplateRequest_TemplateDescription /// /// /// The description of the template. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String InAppTemplateRequest_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 Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'TemplateCreateMessageBody'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateInAppTemplateResponse). /// Specifying the name of a property of type Amazon.Pinpoint.Model.CreateInAppTemplateResponse 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; } = "TemplateCreateMessageBody"; #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, "New-PINInAppTemplate (CreateInAppTemplate)")) { 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 if (this.InAppTemplateRequest_Content != null) { context.InAppTemplateRequest_Content = new List(this.InAppTemplateRequest_Content); } if (this.InAppTemplateRequest_CustomConfig != null) { context.InAppTemplateRequest_CustomConfig = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.InAppTemplateRequest_CustomConfig.Keys) { context.InAppTemplateRequest_CustomConfig.Add((String)hashKey, (String)(this.InAppTemplateRequest_CustomConfig[hashKey])); } } context.InAppTemplateRequest_Layout = this.InAppTemplateRequest_Layout; if (this.InAppTemplateRequest_Tag != null) { context.InAppTemplateRequest_Tag = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.InAppTemplateRequest_Tag.Keys) { context.InAppTemplateRequest_Tag.Add((String)hashKey, (String)(this.InAppTemplateRequest_Tag[hashKey])); } } context.InAppTemplateRequest_TemplateDescription = this.InAppTemplateRequest_TemplateDescription; 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 // 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.CreateInAppTemplateRequest(); // populate InAppTemplateRequest var requestInAppTemplateRequestIsNull = true; request.InAppTemplateRequest = new Amazon.Pinpoint.Model.InAppTemplateRequest(); List requestInAppTemplateRequest_inAppTemplateRequest_Content = null; if (cmdletContext.InAppTemplateRequest_Content != null) { requestInAppTemplateRequest_inAppTemplateRequest_Content = cmdletContext.InAppTemplateRequest_Content; } if (requestInAppTemplateRequest_inAppTemplateRequest_Content != null) { request.InAppTemplateRequest.Content = requestInAppTemplateRequest_inAppTemplateRequest_Content; requestInAppTemplateRequestIsNull = false; } Dictionary requestInAppTemplateRequest_inAppTemplateRequest_CustomConfig = null; if (cmdletContext.InAppTemplateRequest_CustomConfig != null) { requestInAppTemplateRequest_inAppTemplateRequest_CustomConfig = cmdletContext.InAppTemplateRequest_CustomConfig; } if (requestInAppTemplateRequest_inAppTemplateRequest_CustomConfig != null) { request.InAppTemplateRequest.CustomConfig = requestInAppTemplateRequest_inAppTemplateRequest_CustomConfig; requestInAppTemplateRequestIsNull = false; } Amazon.Pinpoint.Layout requestInAppTemplateRequest_inAppTemplateRequest_Layout = null; if (cmdletContext.InAppTemplateRequest_Layout != null) { requestInAppTemplateRequest_inAppTemplateRequest_Layout = cmdletContext.InAppTemplateRequest_Layout; } if (requestInAppTemplateRequest_inAppTemplateRequest_Layout != null) { request.InAppTemplateRequest.Layout = requestInAppTemplateRequest_inAppTemplateRequest_Layout; requestInAppTemplateRequestIsNull = false; } Dictionary requestInAppTemplateRequest_inAppTemplateRequest_Tag = null; if (cmdletContext.InAppTemplateRequest_Tag != null) { requestInAppTemplateRequest_inAppTemplateRequest_Tag = cmdletContext.InAppTemplateRequest_Tag; } if (requestInAppTemplateRequest_inAppTemplateRequest_Tag != null) { request.InAppTemplateRequest.Tags = requestInAppTemplateRequest_inAppTemplateRequest_Tag; requestInAppTemplateRequestIsNull = false; } System.String requestInAppTemplateRequest_inAppTemplateRequest_TemplateDescription = null; if (cmdletContext.InAppTemplateRequest_TemplateDescription != null) { requestInAppTemplateRequest_inAppTemplateRequest_TemplateDescription = cmdletContext.InAppTemplateRequest_TemplateDescription; } if (requestInAppTemplateRequest_inAppTemplateRequest_TemplateDescription != null) { request.InAppTemplateRequest.TemplateDescription = requestInAppTemplateRequest_inAppTemplateRequest_TemplateDescription; requestInAppTemplateRequestIsNull = false; } // determine if request.InAppTemplateRequest should be set to null if (requestInAppTemplateRequestIsNull) { request.InAppTemplateRequest = null; } if (cmdletContext.TemplateName != null) { request.TemplateName = cmdletContext.TemplateName; } 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.CreateInAppTemplateResponse CallAWSServiceOperation(IAmazonPinpoint client, Amazon.Pinpoint.Model.CreateInAppTemplateRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Pinpoint", "CreateInAppTemplate"); try { #if DESKTOP return client.CreateInAppTemplate(request); #elif CORECLR return client.CreateInAppTemplateAsync(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 List InAppTemplateRequest_Content { get; set; } public Dictionary InAppTemplateRequest_CustomConfig { get; set; } public Amazon.Pinpoint.Layout InAppTemplateRequest_Layout { get; set; } public Dictionary InAppTemplateRequest_Tag { get; set; } public System.String InAppTemplateRequest_TemplateDescription { get; set; } public System.String TemplateName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.TemplateCreateMessageBody; } } }