/*******************************************************************************
* 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.Connect;
using Amazon.Connect.Model;
namespace Amazon.PowerShell.Cmdlets.CONN
{
///
/// Submits a contact evaluation in the specified Amazon Connect instance. Answers included
/// in the request are merged with existing answers for the given evaluation. If no answers
/// or notes are passed, the evaluation is submitted with the existing answers and notes.
/// You can delete an answer or note by passing an empty object ({}
) to the
/// question identifier.
///
///
///
/// If a contact evaluation is already in submitted state, this operation will trigger
/// a resubmission.
///
///
[Cmdlet("Submit", "CONNContactEvaluation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Connect.Model.SubmitContactEvaluationResponse")]
[AWSCmdlet("Calls the Amazon Connect Service SubmitContactEvaluation API operation.", Operation = new[] {"SubmitContactEvaluation"}, SelectReturnType = typeof(Amazon.Connect.Model.SubmitContactEvaluationResponse))]
[AWSCmdletOutput("Amazon.Connect.Model.SubmitContactEvaluationResponse",
"This cmdlet returns an Amazon.Connect.Model.SubmitContactEvaluationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SubmitCONNContactEvaluationCmdlet : AmazonConnectClientCmdlet, IExecutor
{
#region Parameter Answer
///
///
/// A map of question identifiers to answer value.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Answers")]
public System.Collections.Hashtable Answer { get; set; }
#endregion
#region Parameter EvaluationId
///
///
/// A unique identifier for the contact evaluation.
///
///
#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 EvaluationId { get; set; }
#endregion
#region Parameter InstanceId
///
///
/// The identifier of the Amazon Connect instance. You can find
/// the instance ID in the Amazon Resource Name (ARN) of the instance.
///
///
#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 InstanceId { get; set; }
#endregion
#region Parameter Note
///
///
/// A map of question identifiers to note value.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Notes")]
public System.Collections.Hashtable Note { 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.Connect.Model.SubmitContactEvaluationResponse).
/// Specifying the name of a property of type Amazon.Connect.Model.SubmitContactEvaluationResponse 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 EvaluationId parameter.
/// The -PassThru parameter is deprecated, use -Select '^EvaluationId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^EvaluationId' 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.EvaluationId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Submit-CONNContactEvaluation (SubmitContactEvaluation)"))
{
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.EvaluationId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.Answer != null)
{
context.Answer = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Answer.Keys)
{
context.Answer.Add((String)hashKey, (EvaluationAnswerInput)(this.Answer[hashKey]));
}
}
context.EvaluationId = this.EvaluationId;
#if MODULAR
if (this.EvaluationId == null && ParameterWasBound(nameof(this.EvaluationId)))
{
WriteWarning("You are passing $null as a value for parameter EvaluationId 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.InstanceId = this.InstanceId;
#if MODULAR
if (this.InstanceId == null && ParameterWasBound(nameof(this.InstanceId)))
{
WriteWarning("You are passing $null as a value for parameter InstanceId 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.Note != null)
{
context.Note = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Note.Keys)
{
context.Note.Add((String)hashKey, (EvaluationNote)(this.Note[hashKey]));
}
}
// 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.Connect.Model.SubmitContactEvaluationRequest();
if (cmdletContext.Answer != null)
{
request.Answers = cmdletContext.Answer;
}
if (cmdletContext.EvaluationId != null)
{
request.EvaluationId = cmdletContext.EvaluationId;
}
if (cmdletContext.InstanceId != null)
{
request.InstanceId = cmdletContext.InstanceId;
}
if (cmdletContext.Note != null)
{
request.Notes = cmdletContext.Note;
}
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.Connect.Model.SubmitContactEvaluationResponse CallAWSServiceOperation(IAmazonConnect client, Amazon.Connect.Model.SubmitContactEvaluationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Connect Service", "SubmitContactEvaluation");
try
{
#if DESKTOP
return client.SubmitContactEvaluation(request);
#elif CORECLR
return client.SubmitContactEvaluationAsync(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 Dictionary Answer { get; set; }
public System.String EvaluationId { get; set; }
public System.String InstanceId { get; set; }
public Dictionary Note { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}