/*******************************************************************************
* 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
{
/// <summary>
/// Returns a list of the conformance packs and their associated compliance status with
/// the count of compliant and noncompliant Config rules within each conformance pack.
/// Also returns the total rule count which includes compliant rules, noncompliant rules,
/// and rules that cannot be evaluated due to insufficient data.
///
/// <note><para>
/// The results can return an empty result page, but if you have a <code>nextToken</code>,
/// the results are displayed on the next page.
/// </para></note><br/><br/>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.
/// </summary>
[Cmdlet("Get", "CFGAggregateComplianceByConformancePack")]
[OutputType("Amazon.ConfigService.Model.AggregateComplianceByConformancePack")]
[AWSCmdlet("Calls the AWS Config DescribeAggregateComplianceByConformancePacks API operation.", Operation = new[] {"DescribeAggregateComplianceByConformancePacks"}, SelectReturnType = typeof(Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse))]
[AWSCmdletOutput("Amazon.ConfigService.Model.AggregateComplianceByConformancePack or Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse",
"This cmdlet returns a collection of Amazon.ConfigService.Model.AggregateComplianceByConformancePack objects.",
"The service call response (type Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetCFGAggregateComplianceByConformancePackCmdlet : AmazonConfigServiceClientCmdlet, IExecutor
{
#region Parameter Filters_AccountId
/// <summary>
/// <para>
/// <para>The 12-digit Amazon Web Services account ID of the source account.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Filters_AccountId { get; set; }
#endregion
#region Parameter Filters_AwsRegion
/// <summary>
/// <para>
/// <para>The source Amazon Web Services Region from where the data is aggregated.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Filters_AwsRegion { get; set; }
#endregion
#region Parameter Filters_ComplianceType
/// <summary>
/// <para>
/// <para>The compliance status of the conformance pack.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.ConfigService.ConformancePackComplianceType")]
public Amazon.ConfigService.ConformancePackComplianceType Filters_ComplianceType { get; set; }
#endregion
#region Parameter ConfigurationAggregatorName
/// <summary>
/// <para>
/// <para>The name of the configuration aggregator.</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 ConfigurationAggregatorName { get; set; }
#endregion
#region Parameter Filters_ConformancePackName
/// <summary>
/// <para>
/// <para>The name of the conformance pack.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Filters_ConformancePackName { get; set; }
#endregion
#region Parameter Limit
/// <summary>
/// <para>
/// <para>The maximum number of conformance packs compliance details returned on each page.
/// The default is maximum. If you specify 0, Config uses the default. </para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Limit { get; set; }
#endregion
#region Parameter NextToken
/// <summary>
/// <para>
/// <para>The <code>nextToken</code> string returned on a previous page that you use to get
/// the next page of results in a paginated response.</para>
/// </para>
/// <para>
/// <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
/// <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'AggregateComplianceByConformancePacks'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse).
/// Specifying the name of a property of type Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse 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; } = "AggregateComplianceByConformancePacks";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the ConfigurationAggregatorName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ConfigurationAggregatorName' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ConfigurationAggregatorName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter NoAutoIteration
/// <summary>
/// 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.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoAutoIteration { 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.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse, GetCFGAggregateComplianceByConformancePackCmdlet>(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.ConfigurationAggregatorName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
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.Filters_ComplianceType = this.Filters_ComplianceType;
context.Filters_ConformancePackName = this.Filters_ConformancePackName;
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
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// create request and set iteration invariants
var request = new Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksRequest();
if (cmdletContext.ConfigurationAggregatorName != null)
{
request.ConfigurationAggregatorName = cmdletContext.ConfigurationAggregatorName;
}
// populate Filters
var requestFiltersIsNull = true;
request.Filters = new Amazon.ConfigService.Model.AggregateConformancePackComplianceFilters();
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;
}
Amazon.ConfigService.ConformancePackComplianceType requestFilters_filters_ComplianceType = null;
if (cmdletContext.Filters_ComplianceType != null)
{
requestFilters_filters_ComplianceType = cmdletContext.Filters_ComplianceType;
}
if (requestFilters_filters_ComplianceType != null)
{
request.Filters.ComplianceType = requestFilters_filters_ComplianceType;
requestFiltersIsNull = false;
}
System.String requestFilters_filters_ConformancePackName = null;
if (cmdletContext.Filters_ConformancePackName != null)
{
requestFilters_filters_ConformancePackName = cmdletContext.Filters_ConformancePackName;
}
if (requestFilters_filters_ConformancePackName != null)
{
request.Filters.ConformancePackName = requestFilters_filters_ConformancePackName;
requestFiltersIsNull = false;
}
// determine if request.Filters should be set to null
if (requestFiltersIsNull)
{
request.Filters = null;
}
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;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse CallAWSServiceOperation(IAmazonConfigService client, Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Config", "DescribeAggregateComplianceByConformancePacks");
try
{
#if DESKTOP
return client.DescribeAggregateComplianceByConformancePacks(request);
#elif CORECLR
return client.DescribeAggregateComplianceByConformancePacksAsync(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.ConformancePackComplianceType Filters_ComplianceType { get; set; }
public System.String Filters_ConformancePackName { get; set; }
public System.Int32? Limit { get; set; }
public System.String NextToken { get; set; }
public System.Func<Amazon.ConfigService.Model.DescribeAggregateComplianceByConformancePacksResponse, GetCFGAggregateComplianceByConformancePackCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.AggregateComplianceByConformancePacks;
}
}
}