/******************************************************************************* * 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.ConnectCases; using Amazon.ConnectCases.Model; namespace Amazon.PowerShell.Cmdlets.CCAS { /// /// Creates a template in the Cases domain. This template is used to define the case object /// model (that is, to define what data can be captured on cases) in a Cases domain. A /// template must have a unique name within a domain, and it must reference existing field /// IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within /// the same Template. A template can be either Active or Inactive, as indicated by its /// status. Inactive templates cannot be used to create cases. /// [Cmdlet("New", "CCASTemplate", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ConnectCases.Model.CreateTemplateResponse")] [AWSCmdlet("Calls the Amazon Connect Cases CreateTemplate API operation.", Operation = new[] {"CreateTemplate"}, SelectReturnType = typeof(Amazon.ConnectCases.Model.CreateTemplateResponse))] [AWSCmdletOutput("Amazon.ConnectCases.Model.CreateTemplateResponse", "This cmdlet returns an Amazon.ConnectCases.Model.CreateTemplateResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewCCASTemplateCmdlet : AmazonConnectCasesClientCmdlet, IExecutor { #region Parameter LayoutConfiguration_DefaultLayout /// /// /// Unique identifier of a layout. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String LayoutConfiguration_DefaultLayout { get; set; } #endregion #region Parameter Description /// /// /// A brief description of the template. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter DomainId /// /// /// The unique identifier of the Cases domain. /// /// #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 DomainId { get; set; } #endregion #region Parameter Name /// /// /// A name for the template. It must be unique per domain. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Name { get; set; } #endregion #region Parameter RequiredField /// /// /// A list of fields that must contain a value for a case to be successfully created with /// this template. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RequiredFields")] public Amazon.ConnectCases.Model.RequiredField[] RequiredField { get; set; } #endregion #region Parameter Status /// /// /// The status of the template. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ConnectCases.TemplateStatus")] public Amazon.ConnectCases.TemplateStatus Status { get; set; } #endregion #region Parameter Select /// /// 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.ConnectCases.Model.CreateTemplateResponse). /// Specifying the name of a property of type Amazon.ConnectCases.Model.CreateTemplateResponse 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; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the DomainId parameter. /// The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DomainId' 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.DomainId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-CCASTemplate (CreateTemplate)")) { 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.DomainId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Description = this.Description; context.DomainId = this.DomainId; #if MODULAR if (this.DomainId == null && ParameterWasBound(nameof(this.DomainId))) { WriteWarning("You are passing $null as a value for parameter DomainId 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.LayoutConfiguration_DefaultLayout = this.LayoutConfiguration_DefaultLayout; context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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 if (this.RequiredField != null) { context.RequiredField = new List(this.RequiredField); } context.Status = this.Status; // 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.ConnectCases.Model.CreateTemplateRequest(); if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.DomainId != null) { request.DomainId = cmdletContext.DomainId; } // populate LayoutConfiguration var requestLayoutConfigurationIsNull = true; request.LayoutConfiguration = new Amazon.ConnectCases.Model.LayoutConfiguration(); System.String requestLayoutConfiguration_layoutConfiguration_DefaultLayout = null; if (cmdletContext.LayoutConfiguration_DefaultLayout != null) { requestLayoutConfiguration_layoutConfiguration_DefaultLayout = cmdletContext.LayoutConfiguration_DefaultLayout; } if (requestLayoutConfiguration_layoutConfiguration_DefaultLayout != null) { request.LayoutConfiguration.DefaultLayout = requestLayoutConfiguration_layoutConfiguration_DefaultLayout; requestLayoutConfigurationIsNull = false; } // determine if request.LayoutConfiguration should be set to null if (requestLayoutConfigurationIsNull) { request.LayoutConfiguration = null; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.RequiredField != null) { request.RequiredFields = cmdletContext.RequiredField; } if (cmdletContext.Status != null) { request.Status = cmdletContext.Status; } 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.ConnectCases.Model.CreateTemplateResponse CallAWSServiceOperation(IAmazonConnectCases client, Amazon.ConnectCases.Model.CreateTemplateRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Connect Cases", "CreateTemplate"); try { #if DESKTOP return client.CreateTemplate(request); #elif CORECLR return client.CreateTemplateAsync(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.String Description { get; set; } public System.String DomainId { get; set; } public System.String LayoutConfiguration_DefaultLayout { get; set; } public System.String Name { get; set; } public List RequiredField { get; set; } public Amazon.ConnectCases.TemplateStatus Status { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }