/******************************************************************************* * 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.GuardDuty; using Amazon.GuardDuty.Model; namespace Amazon.PowerShell.Cmdlets.GD { /// /// Returns a list of malware scans. Each member account can view the malware scans for /// their own accounts. An administrator can view the malware scans for all the member /// accounts. /// /// /// /// There might be regional differences because some data sources might not be available /// in all the Amazon Web Services Regions where GuardDuty is presently supported. For /// more information, see Regions /// and endpoints. ///

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", "GDMalwareScan")] [OutputType("Amazon.GuardDuty.Model.Scan")] [AWSCmdlet("Calls the Amazon GuardDuty DescribeMalwareScans API operation.", Operation = new[] {"DescribeMalwareScans"}, SelectReturnType = typeof(Amazon.GuardDuty.Model.DescribeMalwareScansResponse))] [AWSCmdletOutput("Amazon.GuardDuty.Model.Scan or Amazon.GuardDuty.Model.DescribeMalwareScansResponse", "This cmdlet returns a collection of Amazon.GuardDuty.Model.Scan objects.", "The service call response (type Amazon.GuardDuty.Model.DescribeMalwareScansResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetGDMalwareScanCmdlet : AmazonGuardDutyClientCmdlet, IExecutor { #region Parameter DetectorId /// /// /// The unique ID of the detector that the request is associated with. /// /// #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 DetectorId { get; set; } #endregion #region Parameter FilterCriteria_FilterCriterion /// /// /// Represents a condition that when matched will be added to the response of the operation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public Amazon.GuardDuty.Model.FilterCriterion[] FilterCriteria_FilterCriterion { get; set; } #endregion #region Parameter SortCriterion /// /// /// Represents the criteria used for sorting scan entries. The attributeName is required and it must be scanStartTime. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SortCriteria")] public Amazon.GuardDuty.Model.SortCriteria SortCriterion { get; set; } #endregion #region Parameter MaxResult /// /// /// You can use this parameter to indicate the maximum number of items that you want in /// the response. The default value is 50. The maximum value is 50. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? 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 list action. For 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 'Scans'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GuardDuty.Model.DescribeMalwareScansResponse). /// Specifying the name of a property of type Amazon.GuardDuty.Model.DescribeMalwareScansResponse 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; } = "Scans"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the DetectorId parameter. /// The -PassThru parameter is deprecated, use -Select '^DetectorId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DetectorId' 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.DetectorId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DetectorId = this.DetectorId; #if MODULAR if (this.DetectorId == null && ParameterWasBound(nameof(this.DetectorId))) { WriteWarning("You are passing $null as a value for parameter DetectorId 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 if (this.FilterCriteria_FilterCriterion != null) { context.FilterCriteria_FilterCriterion = new List(this.FilterCriteria_FilterCriterion); } context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.SortCriterion = this.SortCriterion; // 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.GuardDuty.Model.DescribeMalwareScansRequest(); if (cmdletContext.DetectorId != null) { request.DetectorId = cmdletContext.DetectorId; } // populate FilterCriteria var requestFilterCriteriaIsNull = true; request.FilterCriteria = new Amazon.GuardDuty.Model.FilterCriteria(); List requestFilterCriteria_filterCriteria_FilterCriterion = null; if (cmdletContext.FilterCriteria_FilterCriterion != null) { requestFilterCriteria_filterCriteria_FilterCriterion = cmdletContext.FilterCriteria_FilterCriterion; } if (requestFilterCriteria_filterCriteria_FilterCriterion != null) { request.FilterCriteria.FilterCriterion = requestFilterCriteria_filterCriteria_FilterCriterion; requestFilterCriteriaIsNull = false; } // determine if request.FilterCriteria should be set to null if (requestFilterCriteriaIsNull) { request.FilterCriteria = null; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.SortCriterion != null) { request.SortCriteria = cmdletContext.SortCriterion; } // 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.GuardDuty.Model.DescribeMalwareScansResponse CallAWSServiceOperation(IAmazonGuardDuty client, Amazon.GuardDuty.Model.DescribeMalwareScansRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GuardDuty", "DescribeMalwareScans"); try { #if DESKTOP return client.DescribeMalwareScans(request); #elif CORECLR return client.DescribeMalwareScansAsync(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 DetectorId { get; set; } public List FilterCriteria_FilterCriterion { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public Amazon.GuardDuty.Model.SortCriteria SortCriterion { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Scans; } } }