/******************************************************************************* * 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.Lightsail; using Amazon.Lightsail.Model; namespace Amazon.PowerShell.Cmdlets.LS { /// <summary> /// Returns the data points of a specific metric for an Amazon Lightsail content delivery /// network (CDN) distribution. /// /// /// <para> /// Metrics report the utilization of your resources, and the error counts generated by /// them. Monitor and collect metric data regularly to maintain the reliability, availability, /// and performance of your resources. /// </para> /// </summary> [Cmdlet("Get", "LSDistributionMetricData")] [OutputType("Amazon.Lightsail.Model.GetDistributionMetricDataResponse")] [AWSCmdlet("Calls the Amazon Lightsail GetDistributionMetricData API operation.", Operation = new[] {"GetDistributionMetricData"}, SelectReturnType = typeof(Amazon.Lightsail.Model.GetDistributionMetricDataResponse))] [AWSCmdletOutput("Amazon.Lightsail.Model.GetDistributionMetricDataResponse", "This cmdlet returns an Amazon.Lightsail.Model.GetDistributionMetricDataResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetLSDistributionMetricDataCmdlet : AmazonLightsailClientCmdlet, IExecutor { #region Parameter DistributionName /// <summary> /// <para> /// <para>The name of the distribution for which to get metric data.</para><para>Use the <code>GetDistributions</code> action to get a list of distribution names that /// you can specify.</para> /// </para> /// </summary> #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 DistributionName { get; set; } #endregion #region Parameter EndTime /// <summary> /// <para> /// <para>The end of the time interval for which to get metric data.</para><para>Constraints:</para><ul><li><para>Specified in Coordinated Universal Time (UTC).</para></li><li><para>Specified in the Unix time format.</para><para>For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify /// <code>1538427600</code> as the end time.</para></li></ul><para>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</para> /// </para> /// </summary> #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 /// <summary> /// <para> /// <para>The metric for which you want to return information.</para><para>Valid distribution metric names are listed below, along with the most useful <code>statistics</code> /// to include in your request, and the published <code>unit</code> value.</para><ul><li><para><b><code>Requests</code></b> - The total number of viewer requests received by /// your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</para><para><code>Unit</code>: The published unit is <code>None</code>.</para></li><li><para><b><code>BytesDownloaded</code></b> - The number of bytes downloaded by viewers /// for GET, HEAD, and OPTIONS requests.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</para><para><code>Unit</code>: The published unit is <code>None</code>.</para></li><li><para><b><code>BytesUploaded </code></b> - The number of bytes uploaded to your origin /// by your Lightsail distribution, using POST and PUT requests.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</para><para><code>Unit</code>: The published unit is <code>None</code>.</para></li><li><para><b><code>TotalErrorRate</code></b> - The percentage of all viewer requests for /// which the response's HTTP status code was 4xx or 5xx.</para><para><code>Statistics</code>: The most useful statistic is <code>Average</code>.</para><para><code>Unit</code>: The published unit is <code>Percent</code>.</para></li><li><para><b><code>4xxErrorRate</code></b> - The percentage of all viewer requests for which /// the response's HTTP status cod was 4xx. In these cases, the client or client viewer /// may have made an error. For example, a status code of 404 (Not Found) means that the /// client requested an object that could not be found.</para><para><code>Statistics</code>: The most useful statistic is <code>Average</code>.</para><para><code>Unit</code>: The published unit is <code>Percent</code>.</para></li><li><para><b><code>5xxErrorRate</code></b> - The percentage of all viewer requests for which /// the response's HTTP status code was 5xx. In these cases, the origin server did not /// satisfy the requests. For example, a status code of 503 (Service Unavailable) means /// that the origin server is currently unavailable.</para><para><code>Statistics</code>: The most useful statistic is <code>Average</code>.</para><para><code>Unit</code>: The published unit is <code>Percent</code>.</para></li></ul> /// </para> /// </summary> #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] [AWSConstantClassSource("Amazon.Lightsail.DistributionMetricName")] public Amazon.Lightsail.DistributionMetricName MetricName { get; set; } #endregion #region Parameter Period /// <summary> /// <para> /// <para>The granularity, in seconds, for the metric data points that will be returned.</para> /// </para> /// </summary> #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.Int32? Period { get; set; } #endregion #region Parameter StartTime /// <summary> /// <para> /// <para>The start of the time interval for which to get metric data.</para><para>Constraints:</para><ul><li><para>Specified in Coordinated Universal Time (UTC).</para></li><li><para>Specified in the Unix time format.</para><para>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify /// <code>1538424000</code> as the start time.</para></li></ul><para>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</para> /// </para> /// </summary> #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 Statistic /// <summary> /// <para> /// <para>The statistic for the metric.</para><para>The following statistics are available:</para><ul><li><para><code>Minimum</code> - The lowest value observed during the specified period. Use /// this value to determine low volumes of activity for your application.</para></li><li><para><code>Maximum</code> - The highest value observed during the specified period. Use /// this value to determine high volumes of activity for your application.</para></li><li><para><code>Sum</code> - All values submitted for the matching metric added together. You /// can use this statistic to determine the total volume of a metric.</para></li><li><para><code>Average</code> - The value of Sum / SampleCount during the specified period. /// By comparing this statistic with the Minimum and Maximum values, you can determine /// the full scope of a metric and how close the average use is to the Minimum and Maximum /// values. This comparison helps you to know when to increase or decrease your resources.</para></li><li><para><code>SampleCount</code> - The count, or number, of data points used for the statistical /// calculation.</para></li></ul> /// </para> /// </summary> #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("Statistics")] public System.String[] Statistic { get; set; } #endregion #region Parameter Unit /// <summary> /// <para> /// <para>The unit for the metric data request.</para><para>Valid units depend on the metric data being requested. For the valid units with each /// available metric, see the <code>metricName</code> parameter.</para> /// </para> /// </summary> #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] [AWSConstantClassSource("Amazon.Lightsail.MetricUnit")] public Amazon.Lightsail.MetricUnit Unit { get; set; } #endregion #region Parameter Select /// <summary> /// 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.Lightsail.Model.GetDistributionMetricDataResponse). /// Specifying the name of a property of type Amazon.Lightsail.Model.GetDistributionMetricDataResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the DistributionName parameter. /// The -PassThru parameter is deprecated, use -Select '^DistributionName' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DistributionName' 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<Amazon.Lightsail.Model.GetDistributionMetricDataResponse, GetLSDistributionMetricDataCmdlet>(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.DistributionName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DistributionName = this.DistributionName; #if MODULAR if (this.DistributionName == null && ParameterWasBound(nameof(this.DistributionName))) { WriteWarning("You are passing $null as a value for parameter DistributionName 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.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.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; #if MODULAR if (this.Period == null && ParameterWasBound(nameof(this.Period))) { WriteWarning("You are passing $null as a value for parameter Period 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.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 if (this.Statistic != null) { context.Statistic = new List<System.String>(this.Statistic); } #if MODULAR if (this.Statistic == null && ParameterWasBound(nameof(this.Statistic))) { WriteWarning("You are passing $null as a value for parameter Statistic 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.Unit = this.Unit; #if MODULAR if (this.Unit == null && ParameterWasBound(nameof(this.Unit))) { WriteWarning("You are passing $null as a value for parameter Unit 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.Lightsail.Model.GetDistributionMetricDataRequest(); if (cmdletContext.DistributionName != null) { request.DistributionName = cmdletContext.DistributionName; } if (cmdletContext.EndTime != null) { request.EndTime = cmdletContext.EndTime.Value; } if (cmdletContext.MetricName != null) { request.MetricName = cmdletContext.MetricName; } if (cmdletContext.Period != null) { request.Period = cmdletContext.Period.Value; } if (cmdletContext.StartTime != null) { request.StartTime = cmdletContext.StartTime.Value; } if (cmdletContext.Statistic != null) { request.Statistics = cmdletContext.Statistic; } 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.Lightsail.Model.GetDistributionMetricDataResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.GetDistributionMetricDataRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "GetDistributionMetricData"); try { #if DESKTOP return client.GetDistributionMetricData(request); #elif CORECLR return client.GetDistributionMetricDataAsync(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 DistributionName { get; set; } public System.DateTime? EndTime { get; set; } public Amazon.Lightsail.DistributionMetricName MetricName { get; set; } public System.Int32? Period { get; set; } public System.DateTime? StartTime { get; set; } public List<System.String> Statistic { get; set; } public Amazon.Lightsail.MetricUnit Unit { get; set; } public System.Func<Amazon.Lightsail.Model.GetDistributionMetricDataResponse, GetLSDistributionMetricDataCmdlet, object> Select { get; set; } = (response, cmdlet) => response; } } }