/******************************************************************************* * 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.Imagebuilder; using Amazon.Imagebuilder.Model; namespace Amazon.PowerShell.Cmdlets.EC2IB { /// /// Returns the list of components that can be filtered by name, or by using the listed /// filters to streamline results. Newly created components can take up to /// two minutes to appear in the ListComponents API Results. /// /// /// The semantic version has four nodes: <major>.<minor>.<patch>/<build>. /// You can assign values for the first three, and can filter on all of them. /// Filtering: With semantic versioning, you have the flexibility to use wildcards /// (x) to specify the most recent versions or nodes when selecting the base image or /// components for your recipe. When you use a wildcard in any node, all nodes to the /// right of the first wildcard must also be wildcards. ///

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", "EC2IBComponentList")] [OutputType("Amazon.Imagebuilder.Model.ComponentVersion")] [AWSCmdlet("Calls the EC2 Image Builder ListComponents API operation.", Operation = new[] {"ListComponents"}, SelectReturnType = typeof(Amazon.Imagebuilder.Model.ListComponentsResponse))] [AWSCmdletOutput("Amazon.Imagebuilder.Model.ComponentVersion or Amazon.Imagebuilder.Model.ListComponentsResponse", "This cmdlet returns a collection of Amazon.Imagebuilder.Model.ComponentVersion objects.", "The service call response (type Amazon.Imagebuilder.Model.ListComponentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEC2IBComponentListCmdlet : AmazonImagebuilderClientCmdlet, IExecutor { #region Parameter ByName /// /// /// Returns the list of components for the specified name. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? ByName { get; set; } #endregion #region Parameter Filter /// /// /// Use the following filters to streamline results: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filters")] public Amazon.Imagebuilder.Model.Filter[] Filter { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum items to return in a request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// A token to specify where to start paginating. This is the NextToken from a previously /// truncated response. /// /// ///
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 Owner /// /// /// Filters results based on the type of owner for the component. By default, this request /// returns a list of components that your account owns. To see results for other types /// of owners, you can specify components that Amazon manages, third party components, /// or components that other accounts have shared with you. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Imagebuilder.Ownership")] public Amazon.Imagebuilder.Ownership Owner { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ComponentVersionList'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ListComponentsResponse). /// Specifying the name of a property of type Amazon.Imagebuilder.Model.ListComponentsResponse 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; } = "ComponentVersionList"; #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.ByName = this.ByName; if (this.Filter != null) { context.Filter = new List(this.Filter); } context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.Owner = this.Owner; // 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.Imagebuilder.Model.ListComponentsRequest(); if (cmdletContext.ByName != null) { request.ByName = cmdletContext.ByName.Value; } if (cmdletContext.Filter != null) { request.Filters = cmdletContext.Filter; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.Owner != null) { request.Owner = cmdletContext.Owner; } // 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.Imagebuilder.Model.ListComponentsResponse CallAWSServiceOperation(IAmazonImagebuilder client, Amazon.Imagebuilder.Model.ListComponentsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "EC2 Image Builder", "ListComponents"); try { #if DESKTOP return client.ListComponents(request); #elif CORECLR return client.ListComponentsAsync(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.Boolean? ByName { get; set; } public List Filter { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public Amazon.Imagebuilder.Ownership Owner { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ComponentVersionList; } } }