/******************************************************************************* * 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.PI; using Amazon.PI.Model; namespace Amazon.PowerShell.Cmdlets.PI { /// /// Retrieve Performance Insights metrics for a set of data sources over a time period. /// You can provide specific dimension groups and dimensions, and provide aggregation /// and filtering criteria for each group. /// /// /// Each response element returns a maximum of 500 bytes. For larger elements, such as /// SQL statements, only the first 500 bytes are returned. /// /// [Cmdlet("Get", "PIResourceMetric")] [OutputType("Amazon.PI.Model.GetResourceMetricsResponse")] [AWSCmdlet("Calls the AWS Performance Insights GetResourceMetrics API operation.", Operation = new[] {"GetResourceMetrics"}, SelectReturnType = typeof(Amazon.PI.Model.GetResourceMetricsResponse))] [AWSCmdletOutput("Amazon.PI.Model.GetResourceMetricsResponse", "This cmdlet returns an Amazon.PI.Model.GetResourceMetricsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetPIResourceMetricCmdlet : AmazonPIClientCmdlet, IExecutor { #region Parameter EndTime /// /// /// The date and time specifying the end of the requested time series query range. The /// value specified is exclusive. Thus, the command returns data points less than /// (but not equal to) EndTime.The value for EndTime must be later than the value for StartTime. /// /// #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 Identifier /// /// /// An immutable identifier for a data source that is unique for an Amazon Web Services /// Region. Performance Insights gathers metrics from this data source. In the console, /// the identifier is shown as ResourceID. When you call DescribeDBInstances, /// the identifier is returned as DbiResourceId.To use a DB instance as a data source, specify its DbiResourceId value. /// For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X. /// /// #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 Identifier { get; set; } #endregion #region Parameter MetricQuery /// /// /// An array of one or more queries to perform. Each query must specify a Performance /// Insights metric, and can optionally specify aggregation and filtering criteria. /// /// #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("MetricQueries")] public Amazon.PI.Model.MetricQuery[] MetricQuery { get; set; } #endregion #region Parameter PeriodAlignment /// /// /// The returned timestamp which is the start or end time of the time periods. The default /// value is END_TIME. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.PI.PeriodAlignment")] public Amazon.PI.PeriodAlignment PeriodAlignment { get; set; } #endregion #region Parameter PeriodInSecond /// /// /// The granularity, in seconds, of the data points returned from Performance Insights. /// A period can be as short as one second, or as long as one day (86400 seconds). Valid /// values are:If you don't specify PeriodInSeconds, then Performance Insights will /// choose a value for you, with a goal of returning roughly 100-200 data points in the /// response. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("PeriodInSeconds")] public System.Int32? PeriodInSecond { get; set; } #endregion #region Parameter ServiceType /// /// /// The Amazon Web Services service for which Performance Insights returns metrics. Valid /// values are as follows: /// /// #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.PI.ServiceType")] public Amazon.PI.ServiceType ServiceType { get; set; } #endregion #region Parameter StartTime /// /// /// The date and time specifying the beginning of the requested time series query range. /// You can't specify a StartTime that is earlier than 7 days ago. By default, /// Performance Insights has 7 days of retention, but you can extend this range up to /// 2 years. The value specified is inclusive. Thus, the command returns data points /// equal to or greater than StartTime.The value for StartTime must be earlier than the value for EndTime. /// /// #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 MaxResult /// /// /// The maximum number of items to return in the response. If more items exist than the /// specified MaxRecords value, a pagination token is included in the response /// so that the remaining results can be retrieved. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// An optional pagination token provided by a previous request. If this parameter is /// specified, the response includes only records beyond the token, up to the value specified /// by MaxRecords. /// /// [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.PI.Model.GetResourceMetricsResponse). /// Specifying the name of a property of type Amazon.PI.Model.GetResourceMetricsResponse 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 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.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.Identifier = this.Identifier; #if MODULAR if (this.Identifier == null && ParameterWasBound(nameof(this.Identifier))) { WriteWarning("You are passing $null as a value for parameter Identifier 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; if (this.MetricQuery != null) { context.MetricQuery = new List(this.MetricQuery); } #if MODULAR if (this.MetricQuery == null && ParameterWasBound(nameof(this.MetricQuery))) { WriteWarning("You are passing $null as a value for parameter MetricQuery 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.PeriodAlignment = this.PeriodAlignment; context.PeriodInSecond = this.PeriodInSecond; context.ServiceType = this.ServiceType; #if MODULAR if (this.ServiceType == null && ParameterWasBound(nameof(this.ServiceType))) { WriteWarning("You are passing $null as a value for parameter ServiceType 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 // 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.PI.Model.GetResourceMetricsRequest(); if (cmdletContext.EndTime != null) { request.EndTime = cmdletContext.EndTime.Value; } if (cmdletContext.Identifier != null) { request.Identifier = cmdletContext.Identifier; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.MetricQuery != null) { request.MetricQueries = cmdletContext.MetricQuery; } if (cmdletContext.NextToken != null) { request.NextToken = cmdletContext.NextToken; } if (cmdletContext.PeriodAlignment != null) { request.PeriodAlignment = cmdletContext.PeriodAlignment; } if (cmdletContext.PeriodInSecond != null) { request.PeriodInSeconds = cmdletContext.PeriodInSecond.Value; } if (cmdletContext.ServiceType != null) { request.ServiceType = cmdletContext.ServiceType; } if (cmdletContext.StartTime != null) { request.StartTime = cmdletContext.StartTime.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.PI.Model.GetResourceMetricsResponse CallAWSServiceOperation(IAmazonPI client, Amazon.PI.Model.GetResourceMetricsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Performance Insights", "GetResourceMetrics"); try { #if DESKTOP return client.GetResourceMetrics(request); #elif CORECLR return client.GetResourceMetricsAsync(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.DateTime? EndTime { get; set; } public System.String Identifier { get; set; } public System.Int32? MaxResult { get; set; } public List MetricQuery { get; set; } public System.String NextToken { get; set; } public Amazon.PI.PeriodAlignment PeriodAlignment { get; set; } public System.Int32? PeriodInSecond { get; set; } public Amazon.PI.ServiceType ServiceType { get; set; } public System.DateTime? StartTime { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }