/******************************************************************************* * 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.ConfigService; using Amazon.ConfigService.Model; namespace Amazon.PowerShell.Cmdlets.CFG { /// /// Returns the number of compliant and noncompliant rules for one or more accounts and /// regions in an aggregator. /// /// /// The results can return an empty result page, but if you have a nextToken, the results /// are displayed on the next page. ///

In the AWS.Tools.ConfigService module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Get", "CFGAggregateConfigRuleComplianceSummary")] [OutputType("Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse")] [AWSCmdlet("Calls the AWS Config GetAggregateConfigRuleComplianceSummary API operation.", Operation = new[] {"GetAggregateConfigRuleComplianceSummary"}, SelectReturnType = typeof(Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse))] [AWSCmdletOutput("Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse", "This cmdlet returns an Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetCFGAggregateConfigRuleComplianceSummaryCmdlet : AmazonConfigServiceClientCmdlet, IExecutor { #region Parameter Filters_AccountId /// /// /// The 12-digit account ID of the source account. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Filters_AccountId { get; set; } #endregion #region Parameter Filters_AwsRegion /// /// /// The source region where the data is aggregated. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Filters_AwsRegion { get; set; } #endregion #region Parameter ConfigurationAggregatorName /// /// /// The name of the configuration aggregator. /// /// #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 ConfigurationAggregatorName { get; set; } #endregion #region Parameter GroupByKey /// /// /// Groups the result based on ACCOUNT_ID or AWS_REGION. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ConfigService.ConfigRuleComplianceSummaryGroupKey")] public Amazon.ConfigService.ConfigRuleComplianceSummaryGroupKey GroupByKey { get; set; } #endregion #region Parameter Limit /// /// /// The maximum number of evaluation results returned on each page. The default is 1000. /// You cannot specify a number greater than 1000. If you specify 0, Config uses the default. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Limit { get; set; } #endregion #region Parameter NextToken /// /// /// The nextToken string returned on a previous page that you use to get /// the next page of results in a paginated response. /// /// ///
Note: In the AWS.Tools.ConfigService module, this parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. ///
///
[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.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse). /// Specifying the name of a property of type Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse 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 #region Parameter NoAutoIteration #if MODULAR /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { get; set; } #endif #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.ConfigurationAggregatorName = this.ConfigurationAggregatorName; #if MODULAR if (this.ConfigurationAggregatorName == null && ParameterWasBound(nameof(this.ConfigurationAggregatorName))) { WriteWarning("You are passing $null as a value for parameter ConfigurationAggregatorName 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.Filters_AccountId = this.Filters_AccountId; context.Filters_AwsRegion = this.Filters_AwsRegion; context.GroupByKey = this.GroupByKey; context.Limit = this.Limit; context.NextToken = this.NextToken; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members #if MODULAR public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryRequest(); if (cmdletContext.ConfigurationAggregatorName != null) { request.ConfigurationAggregatorName = cmdletContext.ConfigurationAggregatorName; } // populate Filters var requestFiltersIsNull = true; request.Filters = new Amazon.ConfigService.Model.ConfigRuleComplianceSummaryFilters(); System.String requestFilters_filters_AccountId = null; if (cmdletContext.Filters_AccountId != null) { requestFilters_filters_AccountId = cmdletContext.Filters_AccountId; } if (requestFilters_filters_AccountId != null) { request.Filters.AccountId = requestFilters_filters_AccountId; requestFiltersIsNull = false; } System.String requestFilters_filters_AwsRegion = null; if (cmdletContext.Filters_AwsRegion != null) { requestFilters_filters_AwsRegion = cmdletContext.Filters_AwsRegion; } if (requestFilters_filters_AwsRegion != null) { request.Filters.AwsRegion = requestFilters_filters_AwsRegion; requestFiltersIsNull = false; } // determine if request.Filters should be set to null if (requestFiltersIsNull) { request.Filters = null; } if (cmdletContext.GroupByKey != null) { request.GroupByKey = cmdletContext.GroupByKey; } if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.Value; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.NextToken; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.NextToken; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #else public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryRequest(); if (cmdletContext.ConfigurationAggregatorName != null) { request.ConfigurationAggregatorName = cmdletContext.ConfigurationAggregatorName; } // populate Filters var requestFiltersIsNull = true; request.Filters = new Amazon.ConfigService.Model.ConfigRuleComplianceSummaryFilters(); System.String requestFilters_filters_AccountId = null; if (cmdletContext.Filters_AccountId != null) { requestFilters_filters_AccountId = cmdletContext.Filters_AccountId; } if (requestFilters_filters_AccountId != null) { request.Filters.AccountId = requestFilters_filters_AccountId; requestFiltersIsNull = false; } System.String requestFilters_filters_AwsRegion = null; if (cmdletContext.Filters_AwsRegion != null) { requestFilters_filters_AwsRegion = cmdletContext.Filters_AwsRegion; } if (requestFilters_filters_AwsRegion != null) { request.Filters.AwsRegion = requestFilters_filters_AwsRegion; requestFiltersIsNull = false; } // determine if request.Filters should be set to null if (requestFiltersIsNull) { request.Filters = null; } if (cmdletContext.GroupByKey != null) { request.GroupByKey = cmdletContext.GroupByKey; } if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.Value; } if (cmdletContext.NextToken != null) { request.NextToken = cmdletContext.NextToken; } 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; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse CallAWSServiceOperation(IAmazonConfigService client, Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Config", "GetAggregateConfigRuleComplianceSummary"); try { #if DESKTOP return client.GetAggregateConfigRuleComplianceSummary(request); #elif CORECLR return client.GetAggregateConfigRuleComplianceSummaryAsync(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 ConfigurationAggregatorName { get; set; } public System.String Filters_AccountId { get; set; } public System.String Filters_AwsRegion { get; set; } public Amazon.ConfigService.ConfigRuleComplianceSummaryGroupKey GroupByKey { get; set; } public System.Int32? Limit { get; set; } public System.String NextToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }