/******************************************************************************* * 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.Pipes; using Amazon.Pipes.Model; namespace Amazon.PowerShell.Cmdlets.PIPES { /// /// Get the pipes associated with this account. For more information about pipes, see /// Amazon /// EventBridge Pipes in the Amazon EventBridge User Guide.

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", "PIPESPipeList")] [OutputType("Amazon.Pipes.Model.Pipe")] [AWSCmdlet("Calls the Amazon EventBridge Pipes ListPipes API operation.", Operation = new[] {"ListPipes"}, SelectReturnType = typeof(Amazon.Pipes.Model.ListPipesResponse))] [AWSCmdletOutput("Amazon.Pipes.Model.Pipe or Amazon.Pipes.Model.ListPipesResponse", "This cmdlet returns a collection of Amazon.Pipes.Model.Pipe objects.", "The service call response (type Amazon.Pipes.Model.ListPipesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetPIPESPipeListCmdlet : AmazonPipesClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter CurrentState /// /// /// The state the pipe is in. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Pipes.PipeState")] public Amazon.Pipes.PipeState CurrentState { get; set; } #endregion #region Parameter DesiredState /// /// /// The state the pipe should be in. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Pipes.RequestedPipeState")] public Amazon.Pipes.RequestedPipeState DesiredState { get; set; } #endregion #region Parameter NamePrefix /// /// /// A value that will return a subset of the pipes associated with this account. For example, /// "NamePrefix": "ABC" will return all endpoints with "ABC" in the name. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String NamePrefix { get; set; } #endregion #region Parameter SourcePrefix /// /// /// The prefix matching the pipe source. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SourcePrefix { get; set; } #endregion #region Parameter TargetPrefix /// /// /// The prefix matching the pipe target. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TargetPrefix { get; set; } #endregion #region Parameter Limit /// /// /// The maximum number of pipes to include in the response. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Limit { get; set; } #endregion #region Parameter NextToken /// /// /// If nextToken is returned, there are more results available. The value /// of nextToken is a unique pagination token for each page. Make the call /// again using the returned token to retrieve the next page. Keep all other arguments /// unchanged. Each pagination token expires after 24 hours. Using an expired pagination /// token will return an HTTP 400 InvalidToken error. /// /// ///
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 'Pipes'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pipes.Model.ListPipesResponse). /// Specifying the name of a property of type Amazon.Pipes.Model.ListPipesResponse 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; } = "Pipes"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the NamePrefix parameter. /// The -PassThru parameter is deprecated, use -Select '^NamePrefix' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^NamePrefix' 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.NamePrefix; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CurrentState = this.CurrentState; context.DesiredState = this.DesiredState; context.Limit = this.Limit; context.NamePrefix = this.NamePrefix; context.NextToken = this.NextToken; context.SourcePrefix = this.SourcePrefix; context.TargetPrefix = this.TargetPrefix; // 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.Pipes.Model.ListPipesRequest(); if (cmdletContext.CurrentState != null) { request.CurrentState = cmdletContext.CurrentState; } if (cmdletContext.DesiredState != null) { request.DesiredState = cmdletContext.DesiredState; } if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.Value; } if (cmdletContext.NamePrefix != null) { request.NamePrefix = cmdletContext.NamePrefix; } if (cmdletContext.SourcePrefix != null) { request.SourcePrefix = cmdletContext.SourcePrefix; } if (cmdletContext.TargetPrefix != null) { request.TargetPrefix = cmdletContext.TargetPrefix; } // 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.Pipes.Model.ListPipesResponse CallAWSServiceOperation(IAmazonPipes client, Amazon.Pipes.Model.ListPipesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EventBridge Pipes", "ListPipes"); try { #if DESKTOP return client.ListPipes(request); #elif CORECLR return client.ListPipesAsync(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 Amazon.Pipes.PipeState CurrentState { get; set; } public Amazon.Pipes.RequestedPipeState DesiredState { get; set; } public System.Int32? Limit { get; set; } public System.String NamePrefix { get; set; } public System.String NextToken { get; set; } public System.String SourcePrefix { get; set; } public System.String TargetPrefix { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Pipes; } } }