/******************************************************************************* * 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 the dimensions that can be queried for each specified metric type on a specified /// DB instance. /// [Cmdlet("Get", "PIAvailableResourceDimensionList")] [OutputType("Amazon.PI.Model.MetricDimensionGroups")] [AWSCmdlet("Calls the AWS Performance Insights ListAvailableResourceDimensions API operation.", Operation = new[] {"ListAvailableResourceDimensions"}, SelectReturnType = typeof(Amazon.PI.Model.ListAvailableResourceDimensionsResponse))] [AWSCmdletOutput("Amazon.PI.Model.MetricDimensionGroups or Amazon.PI.Model.ListAvailableResourceDimensionsResponse", "This cmdlet returns a collection of Amazon.PI.Model.MetricDimensionGroups objects.", "The service call response (type Amazon.PI.Model.ListAvailableResourceDimensionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetPIAvailableResourceDimensionListCmdlet : AmazonPIClientCmdlet, IExecutor { #region Parameter Identifier /// /// /// An immutable identifier for a data source that is unique within an Amazon Web Services /// Region. Performance Insights gathers metrics from this data source. To use an Amazon /// RDS DB instance as a data source, specify its DbiResourceId value. For /// example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ. /// /// #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 Metric /// /// /// The types of metrics for which to retrieve dimensions. Valid values include db.load. /// /// #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("Metrics")] public System.String[] Metric { get; set; } #endregion #region Parameter ServiceType /// /// /// The Amazon Web Services service for which Performance Insights returns metrics. /// /// #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 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 'MetricDimensions'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PI.Model.ListAvailableResourceDimensionsResponse). /// Specifying the name of a property of type Amazon.PI.Model.ListAvailableResourceDimensionsResponse 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; } = "MetricDimensions"; #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.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.Metric != null) { context.Metric = new List(this.Metric); } #if MODULAR if (this.Metric == null && ParameterWasBound(nameof(this.Metric))) { WriteWarning("You are passing $null as a value for parameter Metric 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.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 // 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.ListAvailableResourceDimensionsRequest(); if (cmdletContext.Identifier != null) { request.Identifier = cmdletContext.Identifier; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.Metric != null) { request.Metrics = cmdletContext.Metric; } if (cmdletContext.NextToken != null) { request.NextToken = cmdletContext.NextToken; } if (cmdletContext.ServiceType != null) { request.ServiceType = cmdletContext.ServiceType; } 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.ListAvailableResourceDimensionsResponse CallAWSServiceOperation(IAmazonPI client, Amazon.PI.Model.ListAvailableResourceDimensionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Performance Insights", "ListAvailableResourceDimensions"); try { #if DESKTOP return client.ListAvailableResourceDimensions(request); #elif CORECLR return client.ListAvailableResourceDimensionsAsync(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 Identifier { get; set; } public System.Int32? MaxResult { get; set; } public List Metric { get; set; } public System.String NextToken { get; set; } public Amazon.PI.ServiceType ServiceType { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.MetricDimensions; } } }