/******************************************************************************* * 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.Inspector; using Amazon.Inspector.Model; namespace Amazon.PowerShell.Cmdlets.INS { /// /// Lists the assessment templates that correspond to the assessment targets that are /// specified by the ARNs of the assessment targets.

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", "INSAssessmentTemplateList")] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Inspector ListAssessmentTemplates API operation.", Operation = new[] {"ListAssessmentTemplates"}, SelectReturnType = typeof(Amazon.Inspector.Model.ListAssessmentTemplatesResponse))] [AWSCmdletOutput("System.String or Amazon.Inspector.Model.ListAssessmentTemplatesResponse", "This cmdlet returns a collection of System.String objects.", "The service call response (type Amazon.Inspector.Model.ListAssessmentTemplatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetINSAssessmentTemplateListCmdlet : AmazonInspectorClientCmdlet, IExecutor { #region Parameter AssessmentTargetArn /// /// /// A list of ARNs that specifies the assessment targets whose assessment templates you /// want to list. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] [Alias("AssessmentTargetArns")] public System.String[] AssessmentTargetArn { get; set; } #endregion #region Parameter DurationRange_MaxSecond /// /// /// The maximum value of the duration range. Must be less than or equal to 604800 seconds /// (1 week). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_DurationRange_MaxSeconds")] public System.Int32? DurationRange_MaxSecond { get; set; } #endregion #region Parameter DurationRange_MinSecond /// /// /// The minimum value of the duration range. Must be greater than zero. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_DurationRange_MinSeconds")] public System.Int32? DurationRange_MinSecond { get; set; } #endregion #region Parameter Filter_NamePattern /// /// /// For a record to match a filter, an explicit value or a string that contains a wildcard /// that is specified for this data type property must match the value of the assessmentTemplateName /// property of the AssessmentTemplate data type. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Filter_NamePattern { get; set; } #endregion #region Parameter Filter_RulesPackageArn /// /// /// For a record to match a filter, the values that are specified for this data type property /// must be contained in the list of values of the rulesPackageArns property of /// the AssessmentTemplate data type. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_RulesPackageArns")] public System.String[] Filter_RulesPackageArn { get; set; } #endregion #region Parameter MaxResult /// /// /// You can use this parameter to indicate the maximum number of items you want in the /// response. The default value is 10. The maximum value is 500. /// /// ///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. ///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. ///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxItems","MaxResults")] public int? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// You can use this parameter when paginating results. Set the value of this parameter /// to null on your first call to the ListAssessmentTemplates action. Subsequent /// calls to the action fill nextToken in the request with the value of NextToken /// from the previous response to continue listing data. /// /// ///
Note: 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 'AssessmentTemplateArns'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Inspector.Model.ListAssessmentTemplatesResponse). /// Specifying the name of a property of type Amazon.Inspector.Model.ListAssessmentTemplatesResponse 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; } = "AssessmentTemplateArns"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the AssessmentTargetArn parameter. /// The -PassThru parameter is deprecated, use -Select '^AssessmentTargetArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AssessmentTargetArn' 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 /// /// 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; } #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(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.AssessmentTargetArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.AssessmentTargetArn != null) { context.AssessmentTargetArn = new List(this.AssessmentTargetArn); } context.DurationRange_MaxSecond = this.DurationRange_MaxSecond; context.DurationRange_MinSecond = this.DurationRange_MinSecond; context.Filter_NamePattern = this.Filter_NamePattern; if (this.Filter_RulesPackageArn != null) { context.Filter_RulesPackageArn = new List(this.Filter_RulesPackageArn); } context.MaxResult = this.MaxResult; #if !MODULAR if (ParameterWasBound(nameof(this.MaxResult)) && this.MaxResult.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxResult parameter to limit the total number of items returned by the cmdlet." + " This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" + " retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing MaxResult" + " to the service to specify how many items should be returned by each service call."); } #endif 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; #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.Inspector.Model.ListAssessmentTemplatesRequest(); if (cmdletContext.AssessmentTargetArn != null) { request.AssessmentTargetArns = cmdletContext.AssessmentTargetArn; } // populate Filter var requestFilterIsNull = true; request.Filter = new Amazon.Inspector.Model.AssessmentTemplateFilter(); System.String requestFilter_filter_NamePattern = null; if (cmdletContext.Filter_NamePattern != null) { requestFilter_filter_NamePattern = cmdletContext.Filter_NamePattern; } if (requestFilter_filter_NamePattern != null) { request.Filter.NamePattern = requestFilter_filter_NamePattern; requestFilterIsNull = false; } List requestFilter_filter_RulesPackageArn = null; if (cmdletContext.Filter_RulesPackageArn != null) { requestFilter_filter_RulesPackageArn = cmdletContext.Filter_RulesPackageArn; } if (requestFilter_filter_RulesPackageArn != null) { request.Filter.RulesPackageArns = requestFilter_filter_RulesPackageArn; requestFilterIsNull = false; } Amazon.Inspector.Model.DurationRange requestFilter_filter_DurationRange = null; // populate DurationRange var requestFilter_filter_DurationRangeIsNull = true; requestFilter_filter_DurationRange = new Amazon.Inspector.Model.DurationRange(); System.Int32? requestFilter_filter_DurationRange_durationRange_MaxSecond = null; if (cmdletContext.DurationRange_MaxSecond != null) { requestFilter_filter_DurationRange_durationRange_MaxSecond = cmdletContext.DurationRange_MaxSecond.Value; } if (requestFilter_filter_DurationRange_durationRange_MaxSecond != null) { requestFilter_filter_DurationRange.MaxSeconds = requestFilter_filter_DurationRange_durationRange_MaxSecond.Value; requestFilter_filter_DurationRangeIsNull = false; } System.Int32? requestFilter_filter_DurationRange_durationRange_MinSecond = null; if (cmdletContext.DurationRange_MinSecond != null) { requestFilter_filter_DurationRange_durationRange_MinSecond = cmdletContext.DurationRange_MinSecond.Value; } if (requestFilter_filter_DurationRange_durationRange_MinSecond != null) { requestFilter_filter_DurationRange.MinSeconds = requestFilter_filter_DurationRange_durationRange_MinSecond.Value; requestFilter_filter_DurationRangeIsNull = false; } // determine if requestFilter_filter_DurationRange should be set to null if (requestFilter_filter_DurationRangeIsNull) { requestFilter_filter_DurationRange = null; } if (requestFilter_filter_DurationRange != null) { request.Filter.DurationRange = requestFilter_filter_DurationRange; requestFilterIsNull = false; } // determine if request.Filter should be set to null if (requestFilterIsNull) { request.Filter = null; } if (cmdletContext.MaxResult != null) { request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxResult.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; var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; // create request and set iteration invariants var request = new Amazon.Inspector.Model.ListAssessmentTemplatesRequest(); if (cmdletContext.AssessmentTargetArn != null) { request.AssessmentTargetArns = cmdletContext.AssessmentTargetArn; } // populate Filter var requestFilterIsNull = true; request.Filter = new Amazon.Inspector.Model.AssessmentTemplateFilter(); System.String requestFilter_filter_NamePattern = null; if (cmdletContext.Filter_NamePattern != null) { requestFilter_filter_NamePattern = cmdletContext.Filter_NamePattern; } if (requestFilter_filter_NamePattern != null) { request.Filter.NamePattern = requestFilter_filter_NamePattern; requestFilterIsNull = false; } List requestFilter_filter_RulesPackageArn = null; if (cmdletContext.Filter_RulesPackageArn != null) { requestFilter_filter_RulesPackageArn = cmdletContext.Filter_RulesPackageArn; } if (requestFilter_filter_RulesPackageArn != null) { request.Filter.RulesPackageArns = requestFilter_filter_RulesPackageArn; requestFilterIsNull = false; } Amazon.Inspector.Model.DurationRange requestFilter_filter_DurationRange = null; // populate DurationRange var requestFilter_filter_DurationRangeIsNull = true; requestFilter_filter_DurationRange = new Amazon.Inspector.Model.DurationRange(); System.Int32? requestFilter_filter_DurationRange_durationRange_MaxSecond = null; if (cmdletContext.DurationRange_MaxSecond != null) { requestFilter_filter_DurationRange_durationRange_MaxSecond = cmdletContext.DurationRange_MaxSecond.Value; } if (requestFilter_filter_DurationRange_durationRange_MaxSecond != null) { requestFilter_filter_DurationRange.MaxSeconds = requestFilter_filter_DurationRange_durationRange_MaxSecond.Value; requestFilter_filter_DurationRangeIsNull = false; } System.Int32? requestFilter_filter_DurationRange_durationRange_MinSecond = null; if (cmdletContext.DurationRange_MinSecond != null) { requestFilter_filter_DurationRange_durationRange_MinSecond = cmdletContext.DurationRange_MinSecond.Value; } if (requestFilter_filter_DurationRange_durationRange_MinSecond != null) { requestFilter_filter_DurationRange.MinSeconds = requestFilter_filter_DurationRange_durationRange_MinSecond.Value; requestFilter_filter_DurationRangeIsNull = false; } // determine if requestFilter_filter_DurationRange should be set to null if (requestFilter_filter_DurationRangeIsNull) { requestFilter_filter_DurationRange = null; } if (requestFilter_filter_DurationRange != null) { request.Filter.DurationRange = requestFilter_filter_DurationRange; requestFilterIsNull = false; } // determine if request.Filter should be set to null if (requestFilterIsNull) { request.Filter = null; } // Initialize loop variants and commence piping System.String _nextToken = null; int? _emitLimit = null; int _retrievedSoFar = 0; if (AutoIterationHelpers.HasValue(cmdletContext.NextToken)) { _nextToken = cmdletContext.NextToken; } if (cmdletContext.MaxResult.HasValue) { _emitLimit = cmdletContext.MaxResult; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _nextToken; if (_emitLimit.HasValue) { request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToInt32(_emitLimit.Value); } 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 }; int _receivedThisCall = response.AssessmentTemplateArns.Count; _nextToken = response.NextToken; _retrievedSoFar += _receivedThisCall; if (_emitLimit.HasValue) { _emitLimit -= _receivedThisCall; } } catch (Exception e) { if (_retrievedSoFar == 0 || !_emitLimit.HasValue) { output = new CmdletOutput { ErrorResponse = e }; } else { break; } } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.Inspector.Model.ListAssessmentTemplatesResponse CallAWSServiceOperation(IAmazonInspector client, Amazon.Inspector.Model.ListAssessmentTemplatesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Inspector", "ListAssessmentTemplates"); try { #if DESKTOP return client.ListAssessmentTemplates(request); #elif CORECLR return client.ListAssessmentTemplatesAsync(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 List AssessmentTargetArn { get; set; } public System.Int32? DurationRange_MaxSecond { get; set; } public System.Int32? DurationRange_MinSecond { get; set; } public System.String Filter_NamePattern { get; set; } public List Filter_RulesPackageArn { get; set; } public int? MaxResult { get; set; } public System.String NextToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.AssessmentTemplateArns; } } }