/******************************************************************************* * 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 { /// /// Updates the data for a fleet metric. /// /// /// /// Requires permission to access the UpdateFleetMetric /// action. /// /// [Cmdlet("Update", "IOTFleetMetric", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS IoT UpdateFleetMetric API operation.", Operation = new[] {"UpdateFleetMetric"}, SelectReturnType = typeof(Amazon.IoT.Model.UpdateFleetMetricResponse))] [AWSCmdletOutput("None or Amazon.IoT.Model.UpdateFleetMetricResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.IoT.Model.UpdateFleetMetricResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateIOTFleetMetricCmdlet : AmazonIoTClientCmdlet, IExecutor { #region Parameter AggregationField /// /// /// The field to aggregate. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AggregationField { get; set; } #endregion #region Parameter Description /// /// /// The description of the fleet metric. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter ExpectedVersion /// /// /// The expected version of the fleet metric record in the registry. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int64? ExpectedVersion { get; set; } #endregion #region Parameter IndexName /// /// /// The name of the index to search. /// /// #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 IndexName { get; set; } #endregion #region Parameter MetricName /// /// /// The name of the fleet metric to update. /// /// #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 MetricName { get; set; } #endregion #region Parameter AggregationType_Name /// /// /// The name of the aggregation type. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.IoT.AggregationTypeName")] public Amazon.IoT.AggregationTypeName AggregationType_Name { get; set; } #endregion #region Parameter Period /// /// /// The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] /// and must be multiple of 60. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Period { get; set; } #endregion #region Parameter QueryString /// /// /// The search query string. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String QueryString { get; set; } #endregion #region Parameter QueryVersion /// /// /// The version of the query. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String QueryVersion { get; set; } #endregion #region Parameter Unit /// /// /// Used to support unit transformation such as milliseconds to seconds. The unit must /// be supported by CW /// metric. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.IoT.FleetMetricUnit")] public Amazon.IoT.FleetMetricUnit Unit { get; set; } #endregion #region Parameter AggregationType_Value /// /// /// A list of the values of aggregation types. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AggregationType_Values")] public System.String[] AggregationType_Value { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.UpdateFleetMetricResponse). /// 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 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.MetricName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-IOTFleetMetric (UpdateFleetMetric)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.AggregationField = this.AggregationField; context.AggregationType_Name = this.AggregationType_Name; if (this.AggregationType_Value != null) { context.AggregationType_Value = new List(this.AggregationType_Value); } context.Description = this.Description; context.ExpectedVersion = this.ExpectedVersion; context.IndexName = this.IndexName; #if MODULAR if (this.IndexName == null && ParameterWasBound(nameof(this.IndexName))) { WriteWarning("You are passing $null as a value for parameter IndexName 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.MetricName = this.MetricName; #if MODULAR if (this.MetricName == null && ParameterWasBound(nameof(this.MetricName))) { WriteWarning("You are passing $null as a value for parameter MetricName 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.Period = this.Period; context.QueryString = this.QueryString; context.QueryVersion = this.QueryVersion; context.Unit = this.Unit; // 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.UpdateFleetMetricRequest(); if (cmdletContext.AggregationField != null) { request.AggregationField = cmdletContext.AggregationField; } // populate AggregationType var requestAggregationTypeIsNull = true; request.AggregationType = new Amazon.IoT.Model.AggregationType(); Amazon.IoT.AggregationTypeName requestAggregationType_aggregationType_Name = null; if (cmdletContext.AggregationType_Name != null) { requestAggregationType_aggregationType_Name = cmdletContext.AggregationType_Name; } if (requestAggregationType_aggregationType_Name != null) { request.AggregationType.Name = requestAggregationType_aggregationType_Name; requestAggregationTypeIsNull = false; } List requestAggregationType_aggregationType_Value = null; if (cmdletContext.AggregationType_Value != null) { requestAggregationType_aggregationType_Value = cmdletContext.AggregationType_Value; } if (requestAggregationType_aggregationType_Value != null) { request.AggregationType.Values = requestAggregationType_aggregationType_Value; requestAggregationTypeIsNull = false; } // determine if request.AggregationType should be set to null if (requestAggregationTypeIsNull) { request.AggregationType = null; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.ExpectedVersion != null) { request.ExpectedVersion = cmdletContext.ExpectedVersion.Value; } if (cmdletContext.IndexName != null) { request.IndexName = cmdletContext.IndexName; } if (cmdletContext.MetricName != null) { request.MetricName = cmdletContext.MetricName; } if (cmdletContext.Period != null) { request.Period = cmdletContext.Period.Value; } if (cmdletContext.QueryString != null) { request.QueryString = cmdletContext.QueryString; } if (cmdletContext.QueryVersion != null) { request.QueryVersion = cmdletContext.QueryVersion; } if (cmdletContext.Unit != null) { request.Unit = cmdletContext.Unit; } 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.UpdateFleetMetricResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.UpdateFleetMetricRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "UpdateFleetMetric"); try { #if DESKTOP return client.UpdateFleetMetric(request); #elif CORECLR return client.UpdateFleetMetricAsync(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 Amazon.IoT.AggregationTypeName AggregationType_Name { get; set; } public List AggregationType_Value { get; set; } public System.String Description { get; set; } public System.Int64? ExpectedVersion { get; set; } public System.String IndexName { get; set; } public System.String MetricName { get; set; } public System.Int32? Period { get; set; } public System.String QueryString { get; set; } public System.String QueryVersion { get; set; } public Amazon.IoT.FleetMetricUnit Unit { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }