/*******************************************************************************
* 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.LexModelsV2;
using Amazon.LexModelsV2.Model;
namespace Amazon.PowerShell.Cmdlets.LMBV2
{
///
/// Retrieves summary metrics for the intents in your bot. The following fields are required:
///
/// metrics
– A list of AnalyticsIntentMetric
/// objects. In each object, use the name
field to specify the metric to
/// calculate, the statistic
field to specify whether to calculate the Sum
,
/// Average
, or Max
number, and the order
field
/// to specify whether to sort the results in Ascending
or Descending
/// order.
/// startDateTime
and endDateTime
– Define a time range for
/// which you want to retrieve results.
///
/// Of the optional fields, you can organize the results in the following ways:
/// -
/// Use the
filters
field to filter the results, the groupBy
/// field to specify categories by which to group the results, and the binBy
/// field to specify time intervals by which to group the results.
/// -
/// Use the
maxResults
field to limit the number of results to return in
/// a single response and the nextToken
field to return the next batch of
/// results if the response does not return the full set of results.
///
/// Note that an order
field exists in both binBy
and metrics
.
/// You can specify only one order
in a given request.
///
///
[Cmdlet("Get", "LMBV2IntentMetricList")]
[OutputType("Amazon.LexModelsV2.Model.ListIntentMetricsResponse")]
[AWSCmdlet("Calls the Amazon Lex Model Building V2 ListIntentMetrics API operation.", Operation = new[] {"ListIntentMetrics"}, SelectReturnType = typeof(Amazon.LexModelsV2.Model.ListIntentMetricsResponse))]
[AWSCmdletOutput("Amazon.LexModelsV2.Model.ListIntentMetricsResponse",
"This cmdlet returns an Amazon.LexModelsV2.Model.ListIntentMetricsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetLMBV2IntentMetricListCmdlet : AmazonLexModelsV2ClientCmdlet, IExecutor
{
#region Parameter BinBy
///
///
/// A list of objects, each of which contains specifications for organizing the results
/// by time.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public Amazon.LexModelsV2.Model.AnalyticsBinBySpecification[] BinBy { get; set; }
#endregion
#region Parameter BotId
///
///
/// The identifier for the bot for which you want to retrieve intent metrics.
///
///
#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 BotId { get; set; }
#endregion
#region Parameter EndDateTime
///
///
/// The date and time that marks the end of the range of time for which you want to see
/// intent metrics.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? EndDateTime { get; set; }
#endregion
#region Parameter Filter
///
///
/// A list of objects, each of which describes a condition by which you want to filter
/// the results.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public Amazon.LexModelsV2.Model.AnalyticsIntentFilter[] Filter { get; set; }
#endregion
#region Parameter GroupBy
///
///
/// A list of objects, each of which specifies how to group the results. You can group
/// by the following criteria:IntentName
– The name of the intent.IntentEndState
– The final state of the intent. The possible end states
/// are detailed in Key
/// definitions in the user guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public Amazon.LexModelsV2.Model.AnalyticsIntentGroupBySpecification[] GroupBy { get; set; }
#endregion
#region Parameter Metric
///
///
/// A list of objects, each of which contains a metric you want to list, the statistic
/// for the metric you want to return, and the order by which to organize the results.
///
///
#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("Metrics")]
public Amazon.LexModelsV2.Model.AnalyticsIntentMetric[] Metric { get; set; }
#endregion
#region Parameter StartDateTime
///
///
/// The timestamp that marks the beginning of the range of time for which you want to
/// see intent metrics.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? StartDateTime { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of results to return in each page of results. If there are fewer
/// results than the maximum page size, only the actual number of results are returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// If the response from the ListIntentMetrics operation contains more results than specified
/// in the maxResults parameter, a token is returned in the response.Use the returned token in the nextToken parameter of a ListIntentMetrics request to
/// return the next page of results. For a complete set of results, call the ListIntentMetrics
/// operation until the nextToken returned in the response is null.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { 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.LexModelsV2.Model.ListIntentMetricsResponse).
/// Specifying the name of a property of type Amazon.LexModelsV2.Model.ListIntentMetricsResponse 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 BotId parameter.
/// The -PassThru parameter is deprecated, use -Select '^BotId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^BotId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
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.BotId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.BinBy != null)
{
context.BinBy = new List(this.BinBy);
}
context.BotId = this.BotId;
#if MODULAR
if (this.BotId == null && ParameterWasBound(nameof(this.BotId)))
{
WriteWarning("You are passing $null as a value for parameter BotId 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.EndDateTime = this.EndDateTime;
#if MODULAR
if (this.EndDateTime == null && ParameterWasBound(nameof(this.EndDateTime)))
{
WriteWarning("You are passing $null as a value for parameter EndDateTime 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.Filter != null)
{
context.Filter = new List(this.Filter);
}
if (this.GroupBy != null)
{
context.GroupBy = new List(this.GroupBy);
}
context.MaxResult = this.MaxResult;
if (this.Metric != null)
{
context.Metric = new List(this.Metric);
}
#if MODULAR
if (this.Metric == null && ParameterWasBound(nameof(this.Metric)))
{
WriteWarning("You are passing $null as a value for parameter Metric 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.NextToken = this.NextToken;
context.StartDateTime = this.StartDateTime;
#if MODULAR
if (this.StartDateTime == null && ParameterWasBound(nameof(this.StartDateTime)))
{
WriteWarning("You are passing $null as a value for parameter StartDateTime 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.LexModelsV2.Model.ListIntentMetricsRequest();
if (cmdletContext.BinBy != null)
{
request.BinBy = cmdletContext.BinBy;
}
if (cmdletContext.BotId != null)
{
request.BotId = cmdletContext.BotId;
}
if (cmdletContext.EndDateTime != null)
{
request.EndDateTime = cmdletContext.EndDateTime.Value;
}
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.GroupBy != null)
{
request.GroupBy = cmdletContext.GroupBy;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.Metric != null)
{
request.Metrics = cmdletContext.Metric;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
if (cmdletContext.StartDateTime != null)
{
request.StartDateTime = cmdletContext.StartDateTime.Value;
}
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.LexModelsV2.Model.ListIntentMetricsResponse CallAWSServiceOperation(IAmazonLexModelsV2 client, Amazon.LexModelsV2.Model.ListIntentMetricsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lex Model Building V2", "ListIntentMetrics");
try
{
#if DESKTOP
return client.ListIntentMetrics(request);
#elif CORECLR
return client.ListIntentMetricsAsync(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 BinBy { get; set; }
public System.String BotId { get; set; }
public System.DateTime? EndDateTime { get; set; }
public List Filter { get; set; }
public List GroupBy { get; set; }
public System.Int32? MaxResult { get; set; }
public List Metric { get; set; }
public System.String NextToken { get; set; }
public System.DateTime? StartDateTime { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}