/******************************************************************************* * 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.ResilienceHub; using Amazon.ResilienceHub.Model; namespace Amazon.PowerShell.Cmdlets.RESH { /// /// Lists the assessments for an Resilience Hub application. You can use request parameters /// to refine the results for the response object.

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", "RESHAppAssessmentList")] [OutputType("Amazon.ResilienceHub.Model.AppAssessmentSummary")] [AWSCmdlet("Calls the AWS Resilience Hub ListAppAssessments API operation.", Operation = new[] {"ListAppAssessments"}, SelectReturnType = typeof(Amazon.ResilienceHub.Model.ListAppAssessmentsResponse))] [AWSCmdletOutput("Amazon.ResilienceHub.Model.AppAssessmentSummary or Amazon.ResilienceHub.Model.ListAppAssessmentsResponse", "This cmdlet returns a collection of Amazon.ResilienceHub.Model.AppAssessmentSummary objects.", "The service call response (type Amazon.ResilienceHub.Model.ListAppAssessmentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetRESHAppAssessmentListCmdlet : AmazonResilienceHubClientCmdlet, IExecutor { #region Parameter AppArn /// /// /// The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this /// ARN is: arn:partition:resiliencehub:region:account:app/app-id. /// For more information about ARNs, see /// Amazon Resource Names (ARNs) in the AWS General Reference guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AppArn { get; set; } #endregion #region Parameter AssessmentName /// /// /// The name for the assessment. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AssessmentName { get; set; } #endregion #region Parameter AssessmentStatus /// /// /// The current status of the assessment for the resiliency policy. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] AssessmentStatus { get; set; } #endregion #region Parameter ComplianceStatus /// /// /// The current status of compliance for the resiliency policy. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ResilienceHub.ComplianceStatus")] public Amazon.ResilienceHub.ComplianceStatus ComplianceStatus { get; set; } #endregion #region Parameter Invoker /// /// /// Specifies the entity that invoked a specific assessment, either a User /// or the System. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ResilienceHub.AssessmentInvoker")] public Amazon.ResilienceHub.AssessmentInvoker Invoker { get; set; } #endregion #region Parameter ReverseOrder /// /// /// The default is to sort by ascending startTime. To sort by descending startTime, /// set reverseOrder to true. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? ReverseOrder { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of results to include in the response. If more results exist than /// the specified MaxResults value, a token is included in the response so /// that the remaining results can be retrieved. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// Null, or the token from a previous call to get the next set of results. /// /// ///
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 'AssessmentSummaries'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResilienceHub.Model.ListAppAssessmentsResponse). /// Specifying the name of a property of type Amazon.ResilienceHub.Model.ListAppAssessmentsResponse 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; } = "AssessmentSummaries"; #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); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.AppArn = this.AppArn; context.AssessmentName = this.AssessmentName; if (this.AssessmentStatus != null) { context.AssessmentStatus = new List(this.AssessmentStatus); } context.ComplianceStatus = this.ComplianceStatus; context.Invoker = this.Invoker; context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.ReverseOrder = this.ReverseOrder; // 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; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.ResilienceHub.Model.ListAppAssessmentsRequest(); if (cmdletContext.AppArn != null) { request.AppArn = cmdletContext.AppArn; } if (cmdletContext.AssessmentName != null) { request.AssessmentName = cmdletContext.AssessmentName; } if (cmdletContext.AssessmentStatus != null) { request.AssessmentStatus = cmdletContext.AssessmentStatus; } if (cmdletContext.ComplianceStatus != null) { request.ComplianceStatus = cmdletContext.ComplianceStatus; } if (cmdletContext.Invoker != null) { request.Invoker = cmdletContext.Invoker; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.ReverseOrder != null) { request.ReverseOrder = cmdletContext.ReverseOrder.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.ResilienceHub.Model.ListAppAssessmentsResponse CallAWSServiceOperation(IAmazonResilienceHub client, Amazon.ResilienceHub.Model.ListAppAssessmentsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Resilience Hub", "ListAppAssessments"); try { #if DESKTOP return client.ListAppAssessments(request); #elif CORECLR return client.ListAppAssessmentsAsync(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 AppArn { get; set; } public System.String AssessmentName { get; set; } public List AssessmentStatus { get; set; } public Amazon.ResilienceHub.ComplianceStatus ComplianceStatus { get; set; } public Amazon.ResilienceHub.AssessmentInvoker Invoker { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public System.Boolean? ReverseOrder { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.AssessmentSummaries; } } }