/******************************************************************************* * 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.IoT; using Amazon.IoT.Model; namespace Amazon.PowerShell.Cmdlets.IOT { /// /// Groups the aggregated values that match the query into percentile groupings. The default /// percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when /// you call GetPercentiles. This function returns a value for each percentile /// group specified (or the default percentile groupings). The percentile group "1" contains /// the aggregated field value that occurs in approximately one percent of the values /// that match the query. The percentile group "5" contains the aggregated field value /// that occurs in approximately five percent of the values that match the query, and /// so on. The result is an approximation, the more values that match the query, the more /// accurate the percentile values. /// /// /// /// Requires permission to access the GetPercentiles /// action. /// /// [Cmdlet("Get", "IOTPercentile")] [OutputType("Amazon.IoT.Model.PercentPair")] [AWSCmdlet("Calls the AWS IoT GetPercentiles API operation.", Operation = new[] {"GetPercentiles"}, SelectReturnType = typeof(Amazon.IoT.Model.GetPercentilesResponse))] [AWSCmdletOutput("Amazon.IoT.Model.PercentPair or Amazon.IoT.Model.GetPercentilesResponse", "This cmdlet returns a collection of Amazon.IoT.Model.PercentPair objects.", "The service call response (type Amazon.IoT.Model.GetPercentilesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetIOTPercentileCmdlet : AmazonIoTClientCmdlet, IExecutor { #region Parameter AggregationField /// /// /// The field to aggregate. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AggregationField { get; set; } #endregion #region Parameter IndexName /// /// /// The name of the index to search. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String IndexName { get; set; } #endregion #region Parameter Percent /// /// /// The percentile groups returned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Percents")] public System.Double[] Percent { get; set; } #endregion #region Parameter QueryString /// /// /// The search query string. /// /// #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 QueryString { get; set; } #endregion #region Parameter QueryVersion /// /// /// The query version. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String QueryVersion { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Percentiles'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.GetPercentilesResponse). /// Specifying the name of a property of type Amazon.IoT.Model.GetPercentilesResponse 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; } = "Percentiles"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the QueryString parameter. /// The -PassThru parameter is deprecated, use -Select '^QueryString' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^QueryString' 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.QueryString; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AggregationField = this.AggregationField; context.IndexName = this.IndexName; if (this.Percent != null) { context.Percent = new List(this.Percent); } context.QueryString = this.QueryString; #if MODULAR if (this.QueryString == null && ParameterWasBound(nameof(this.QueryString))) { WriteWarning("You are passing $null as a value for parameter QueryString 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.QueryVersion = this.QueryVersion; // 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.IoT.Model.GetPercentilesRequest(); if (cmdletContext.AggregationField != null) { request.AggregationField = cmdletContext.AggregationField; } if (cmdletContext.IndexName != null) { request.IndexName = cmdletContext.IndexName; } if (cmdletContext.Percent != null) { request.Percents = cmdletContext.Percent; } if (cmdletContext.QueryString != null) { request.QueryString = cmdletContext.QueryString; } if (cmdletContext.QueryVersion != null) { request.QueryVersion = cmdletContext.QueryVersion; } 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.IoT.Model.GetPercentilesResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.GetPercentilesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "GetPercentiles"); try { #if DESKTOP return client.GetPercentiles(request); #elif CORECLR return client.GetPercentilesAsync(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 AggregationField { get; set; } public System.String IndexName { get; set; } public List Percent { get; set; } public System.String QueryString { get; set; } public System.String QueryVersion { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Percentiles; } } }