/******************************************************************************* * 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 your Resilience Hub applications. /// /// /// You can filter applications using only one filter at a time or without using any filter. /// If you try to filter applications using multiple filters, you will get the following /// error: /// An error occurred (ValidationException) when calling the ListApps operation: /// Only one filter is supported for this operation.

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", "RESHAppList")] [OutputType("Amazon.ResilienceHub.Model.AppSummary")] [AWSCmdlet("Calls the AWS Resilience Hub ListApps API operation.", Operation = new[] {"ListApps"}, SelectReturnType = typeof(Amazon.ResilienceHub.Model.ListAppsResponse))] [AWSCmdletOutput("Amazon.ResilienceHub.Model.AppSummary or Amazon.ResilienceHub.Model.ListAppsResponse", "This cmdlet returns a collection of Amazon.ResilienceHub.Model.AppSummary objects.", "The service call response (type Amazon.ResilienceHub.Model.ListAppsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetRESHAppListCmdlet : 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 Name /// /// /// The name for the one of the listed applications. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Name { 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 'AppSummaries'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResilienceHub.Model.ListAppsResponse). /// Specifying the name of a property of type Amazon.ResilienceHub.Model.ListAppsResponse 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; } = "AppSummaries"; #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.MaxResult = this.MaxResult; context.Name = this.Name; 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; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.ResilienceHub.Model.ListAppsRequest(); if (cmdletContext.AppArn != null) { request.AppArn = cmdletContext.AppArn; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } // 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.ListAppsResponse CallAWSServiceOperation(IAmazonResilienceHub client, Amazon.ResilienceHub.Model.ListAppsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Resilience Hub", "ListApps"); try { #if DESKTOP return client.ListApps(request); #elif CORECLR return client.ListAppsAsync(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.Int32? MaxResult { get; set; } public System.String Name { get; set; } public System.String NextToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.AppSummaries; } } }