/*******************************************************************************
* 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.TranscribeService;
using Amazon.TranscribeService.Model;
namespace Amazon.PowerShell.Cmdlets.TRS
{
///
/// Creates a new Call Analytics category.
///
///
///
/// All categories are automatically applied to your Call Analytics transcriptions. Note
/// that in order to apply categories to your transcriptions, you must create them before
/// submitting your transcription request, as categories cannot be applied retroactively.
///
/// When creating a new category, you can use the InputType
parameter to
/// label the category as a POST_CALL
or a REAL_TIME
category.
/// POST_CALL
categories can only be applied to post-call transcriptions
/// and REAL_TIME
categories can only be applied to real-time transcriptions.
/// If you do not include InputType
, your category is created as a POST_CALL
/// category by default.
///
/// Call Analytics categories are composed of rules. For each category, you must create
/// between 1 and 20 rules. Rules can include these parameters: , , , and .
///
/// To update an existing category, see .
///
/// To learn more about Call Analytics categories, see Creating
/// categories for post-call transcriptions and Creating
/// categories for real-time transcriptions.
///
///
[Cmdlet("New", "TRSCallAnalyticsCategory", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.TranscribeService.Model.CategoryProperties")]
[AWSCmdlet("Calls the Amazon Transcribe Service CreateCallAnalyticsCategory API operation.", Operation = new[] {"CreateCallAnalyticsCategory"}, SelectReturnType = typeof(Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryResponse))]
[AWSCmdletOutput("Amazon.TranscribeService.Model.CategoryProperties or Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryResponse",
"This cmdlet returns an Amazon.TranscribeService.Model.CategoryProperties object.",
"The service call response (type Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewTRSCallAnalyticsCategoryCmdlet : AmazonTranscribeServiceClientCmdlet, IExecutor
{
#region Parameter CategoryName
///
///
/// A unique name, chosen by you, for your Call Analytics category. It's helpful to use
/// a detailed naming system that will make sense to you in the future. For example, it's
/// better to use sentiment-positive-last30seconds
for a category over a
/// generic name like test-category
.Category 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 CategoryName { get; set; }
#endregion
#region Parameter InputType
///
///
/// Choose whether you want to create a real-time or a post-call category for your Call
/// Analytics transcription.Specifying POST_CALL
assigns your category to post-call transcriptions;
/// categories with this input type cannot be applied to streaming (real-time) transcriptions.Specifying REAL_TIME
assigns your category to streaming transcriptions;
/// categories with this input type cannot be applied to post-call transcriptions.If you do not include InputType
, your category is created as a post-call
/// category by default.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.TranscribeService.InputType")]
public Amazon.TranscribeService.InputType InputType { get; set; }
#endregion
#region Parameter Rule
///
///
/// Rules define a Call Analytics category. When creating a new category, you must create
/// between 1 and 20 rules for that category. For each rule, you specify a filter you
/// want applied to the attributes of a call. For example, you can choose a sentiment
/// filter that detects if a customer's sentiment was positive during the last 30 seconds
/// of the call.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("Rules")]
public Amazon.TranscribeService.Model.Rule[] Rule { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'CategoryProperties'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryResponse).
/// Specifying the name of a property of type Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryResponse 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; } = "CategoryProperties";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the CategoryName parameter.
/// The -PassThru parameter is deprecated, use -Select '^CategoryName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CategoryName' 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.CategoryName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-TRSCallAnalyticsCategory (CreateCallAnalyticsCategory)"))
{
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.CategoryName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CategoryName = this.CategoryName;
#if MODULAR
if (this.CategoryName == null && ParameterWasBound(nameof(this.CategoryName)))
{
WriteWarning("You are passing $null as a value for parameter CategoryName 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.InputType = this.InputType;
if (this.Rule != null)
{
context.Rule = new List(this.Rule);
}
#if MODULAR
if (this.Rule == null && ParameterWasBound(nameof(this.Rule)))
{
WriteWarning("You are passing $null as a value for parameter Rule 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.TranscribeService.Model.CreateCallAnalyticsCategoryRequest();
if (cmdletContext.CategoryName != null)
{
request.CategoryName = cmdletContext.CategoryName;
}
if (cmdletContext.InputType != null)
{
request.InputType = cmdletContext.InputType;
}
if (cmdletContext.Rule != null)
{
request.Rules = cmdletContext.Rule;
}
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.TranscribeService.Model.CreateCallAnalyticsCategoryResponse CallAWSServiceOperation(IAmazonTranscribeService client, Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Transcribe Service", "CreateCallAnalyticsCategory");
try
{
#if DESKTOP
return client.CreateCallAnalyticsCategory(request);
#elif CORECLR
return client.CreateCallAnalyticsCategoryAsync(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 CategoryName { get; set; }
public Amazon.TranscribeService.InputType InputType { get; set; }
public List Rule { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.CategoryProperties;
}
}
}