/*******************************************************************************
* 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 agents of the assessment runs that are specified by the ARNs of the assessment
/// runs.
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", "INSAssessmentRunAgent")]
[OutputType("Amazon.Inspector.Model.AssessmentRunAgent")]
[AWSCmdlet("Calls the Amazon Inspector ListAssessmentRunAgents API operation.", Operation = new[] {"ListAssessmentRunAgents"}, SelectReturnType = typeof(Amazon.Inspector.Model.ListAssessmentRunAgentsResponse))]
[AWSCmdletOutput("Amazon.Inspector.Model.AssessmentRunAgent or Amazon.Inspector.Model.ListAssessmentRunAgentsResponse",
"This cmdlet returns a collection of Amazon.Inspector.Model.AssessmentRunAgent objects.",
"The service call response (type Amazon.Inspector.Model.ListAssessmentRunAgentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetINSAssessmentRunAgentCmdlet : AmazonInspectorClientCmdlet, IExecutor
{
#region Parameter Filter_AgentHealthCode
///
///
/// The detailed health state of the agent. Values can be set to IDLE, RUNNING,
/// SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filter_AgentHealthCodes")]
public System.String[] Filter_AgentHealthCode { get; set; }
#endregion
#region Parameter Filter_AgentHealth
///
///
/// The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filter_AgentHealths")]
public System.String[] Filter_AgentHealth { get; set; }
#endregion
#region Parameter AssessmentRunArn
///
///
/// The ARN that specifies the assessment run whose agents you want to list.
///
///
#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 AssessmentRunArn { 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 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 ListAssessmentRunAgents 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 'AssessmentRunAgents'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Inspector.Model.ListAssessmentRunAgentsResponse).
/// Specifying the name of a property of type Amazon.Inspector.Model.ListAssessmentRunAgentsResponse 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; } = "AssessmentRunAgents";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the AssessmentRunArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^AssessmentRunArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AssessmentRunArn' 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.AssessmentRunArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AssessmentRunArn = this.AssessmentRunArn;
#if MODULAR
if (this.AssessmentRunArn == null && ParameterWasBound(nameof(this.AssessmentRunArn)))
{
WriteWarning("You are passing $null as a value for parameter AssessmentRunArn 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.Filter_AgentHealthCode != null)
{
context.Filter_AgentHealthCode = new List(this.Filter_AgentHealthCode);
}
if (this.Filter_AgentHealth != null)
{
context.Filter_AgentHealth = new List(this.Filter_AgentHealth);
}
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.ListAssessmentRunAgentsRequest();
if (cmdletContext.AssessmentRunArn != null)
{
request.AssessmentRunArn = cmdletContext.AssessmentRunArn;
}
// populate Filter
var requestFilterIsNull = true;
request.Filter = new Amazon.Inspector.Model.AgentFilter();
List requestFilter_filter_AgentHealthCode = null;
if (cmdletContext.Filter_AgentHealthCode != null)
{
requestFilter_filter_AgentHealthCode = cmdletContext.Filter_AgentHealthCode;
}
if (requestFilter_filter_AgentHealthCode != null)
{
request.Filter.AgentHealthCodes = requestFilter_filter_AgentHealthCode;
requestFilterIsNull = false;
}
List requestFilter_filter_AgentHealth = null;
if (cmdletContext.Filter_AgentHealth != null)
{
requestFilter_filter_AgentHealth = cmdletContext.Filter_AgentHealth;
}
if (requestFilter_filter_AgentHealth != null)
{
request.Filter.AgentHealths = requestFilter_filter_AgentHealth;
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.ListAssessmentRunAgentsRequest();
if (cmdletContext.AssessmentRunArn != null)
{
request.AssessmentRunArn = cmdletContext.AssessmentRunArn;
}
// populate Filter
var requestFilterIsNull = true;
request.Filter = new Amazon.Inspector.Model.AgentFilter();
List requestFilter_filter_AgentHealthCode = null;
if (cmdletContext.Filter_AgentHealthCode != null)
{
requestFilter_filter_AgentHealthCode = cmdletContext.Filter_AgentHealthCode;
}
if (requestFilter_filter_AgentHealthCode != null)
{
request.Filter.AgentHealthCodes = requestFilter_filter_AgentHealthCode;
requestFilterIsNull = false;
}
List requestFilter_filter_AgentHealth = null;
if (cmdletContext.Filter_AgentHealth != null)
{
requestFilter_filter_AgentHealth = cmdletContext.Filter_AgentHealth;
}
if (requestFilter_filter_AgentHealth != null)
{
request.Filter.AgentHealths = requestFilter_filter_AgentHealth;
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.AssessmentRunAgents.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.ListAssessmentRunAgentsResponse CallAWSServiceOperation(IAmazonInspector client, Amazon.Inspector.Model.ListAssessmentRunAgentsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Inspector", "ListAssessmentRunAgents");
try
{
#if DESKTOP
return client.ListAssessmentRunAgents(request);
#elif CORECLR
return client.ListAssessmentRunAgentsAsync(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 AssessmentRunArn { get; set; }
public List Filter_AgentHealthCode { get; set; }
public List Filter_AgentHealth { get; set; }
public int? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.AssessmentRunAgents;
}
}
}