/******************************************************************************* * 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 { /// /// Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side /// metric, or custom metric) by the given thing during the specified time period. /// [Cmdlet("Get", "IOTMetricValueList")] [OutputType("Amazon.IoT.Model.MetricDatum")] [AWSCmdlet("Calls the AWS IoT ListMetricValues API operation.", Operation = new[] {"ListMetricValues"}, SelectReturnType = typeof(Amazon.IoT.Model.ListMetricValuesResponse))] [AWSCmdletOutput("Amazon.IoT.Model.MetricDatum or Amazon.IoT.Model.ListMetricValuesResponse", "This cmdlet returns a collection of Amazon.IoT.Model.MetricDatum objects.", "The service call response (type Amazon.IoT.Model.ListMetricValuesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetIOTMetricValueListCmdlet : AmazonIoTClientCmdlet, IExecutor { #region Parameter DimensionName /// /// /// The dimension name. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DimensionName { get; set; } #endregion #region Parameter DimensionValueOperator /// /// /// The dimension value operator. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.IoT.DimensionValueOperator")] public Amazon.IoT.DimensionValueOperator DimensionValueOperator { get; set; } #endregion #region Parameter EndTime /// /// /// The end of the time period for which metric values are returned. /// /// #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? EndTime { get; set; } #endregion #region Parameter MetricName /// /// /// The name of the security profile metric for which values are returned. /// /// #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 StartTime /// /// /// The start of the time period for which metric values are returned. /// /// #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? StartTime { get; set; } #endregion #region Parameter ThingName /// /// /// The name of the thing for which security profile metric values are returned. /// /// #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 ThingName { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of results to return at one time. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// The token for the next set of results. /// /// [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 'MetricDatumList'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.ListMetricValuesResponse). /// Specifying the name of a property of type Amazon.IoT.Model.ListMetricValuesResponse 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; } = "MetricDatumList"; #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); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.DimensionName = this.DimensionName; context.DimensionValueOperator = this.DimensionValueOperator; context.EndTime = this.EndTime; #if MODULAR if (this.EndTime == null && ParameterWasBound(nameof(this.EndTime))) { WriteWarning("You are passing $null as a value for parameter EndTime 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.MaxResult = this.MaxResult; 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.NextToken = this.NextToken; context.StartTime = this.StartTime; #if MODULAR if (this.StartTime == null && ParameterWasBound(nameof(this.StartTime))) { WriteWarning("You are passing $null as a value for parameter StartTime 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.ThingName = this.ThingName; #if MODULAR if (this.ThingName == null && ParameterWasBound(nameof(this.ThingName))) { WriteWarning("You are passing $null as a value for parameter ThingName 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.IoT.Model.ListMetricValuesRequest(); if (cmdletContext.DimensionName != null) { request.DimensionName = cmdletContext.DimensionName; } if (cmdletContext.DimensionValueOperator != null) { request.DimensionValueOperator = cmdletContext.DimensionValueOperator; } if (cmdletContext.EndTime != null) { request.EndTime = cmdletContext.EndTime.Value; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.MetricName != null) { request.MetricName = cmdletContext.MetricName; } if (cmdletContext.NextToken != null) { request.NextToken = cmdletContext.NextToken; } if (cmdletContext.StartTime != null) { request.StartTime = cmdletContext.StartTime.Value; } if (cmdletContext.ThingName != null) { request.ThingName = cmdletContext.ThingName; } 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.ListMetricValuesResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.ListMetricValuesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "ListMetricValues"); try { #if DESKTOP return client.ListMetricValues(request); #elif CORECLR return client.ListMetricValuesAsync(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 DimensionName { get; set; } public Amazon.IoT.DimensionValueOperator DimensionValueOperator { get; set; } public System.DateTime? EndTime { get; set; } public System.Int32? MaxResult { get; set; } public System.String MetricName { get; set; } public System.String NextToken { get; set; } public System.DateTime? StartTime { get; set; } public System.String ThingName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.MetricDatumList; } } }