/******************************************************************************* * 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.ServiceCatalog; using Amazon.ServiceCatalog.Model; namespace Amazon.PowerShell.Cmdlets.SC { /// /// Gets information about the products to which the caller has access.

In the AWS.Tools.ServiceCatalog module, 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("Find", "SCProduct")] [OutputType("Amazon.ServiceCatalog.Model.SearchProductsResponse")] [AWSCmdlet("Calls the AWS Service Catalog SearchProducts API operation.", Operation = new[] {"SearchProducts"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.SearchProductsResponse))] [AWSCmdletOutput("Amazon.ServiceCatalog.Model.SearchProductsResponse", "This cmdlet returns an Amazon.ServiceCatalog.Model.SearchProductsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class FindSCProductCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor { #region Parameter AcceptLanguage /// /// /// The language code. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AcceptLanguage { get; set; } #endregion #region Parameter Filter /// /// /// The search filters. If no search filters are specified, the output includes all products /// to which the caller has access. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filters")] public System.Collections.Hashtable Filter { get; set; } #endregion #region Parameter SortBy /// /// /// The sort field. If no value is specified, the results are not sorted. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ServiceCatalog.ProductViewSortBy")] public Amazon.ServiceCatalog.ProductViewSortBy SortBy { get; set; } #endregion #region Parameter SortOrder /// /// /// The sort order. If no value is specified, the results are not sorted. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ServiceCatalog.SortOrder")] public Amazon.ServiceCatalog.SortOrder SortOrder { get; set; } #endregion #region Parameter PageSize /// /// /// The maximum number of items to return with this call. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? PageSize { get; set; } #endregion #region Parameter PageToken /// /// /// The page token for the next set of results. To retrieve the first set of results, /// use null. /// /// ///
Note: In the AWS.Tools.ServiceCatalog module, 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 '-PageToken $null' for the first call and '-PageToken $AWSHistory.LastServiceResponse.NextPageToken' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String PageToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceCatalog.Model.SearchProductsResponse). /// Specifying the name of a property of type Amazon.ServiceCatalog.Model.SearchProductsResponse 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; } = "*"; #endregion #region Parameter NoAutoIteration #if MODULAR /// /// 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 PageToken /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { get; set; } #endif #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.AcceptLanguage = this.AcceptLanguage; if (this.Filter != null) { context.Filter = new Dictionary>(StringComparer.Ordinal); foreach (var hashKey in this.Filter.Keys) { object hashValue = this.Filter[hashKey]; if (hashValue == null) { context.Filter.Add((String)hashKey, null); continue; } var enumerable = SafeEnumerable(hashValue); var valueSet = new List(); foreach (var s in enumerable) { valueSet.Add((System.String)s); } context.Filter.Add((String)hashKey, valueSet); } } context.PageSize = this.PageSize; context.PageToken = this.PageToken; context.SortBy = this.SortBy; context.SortOrder = this.SortOrder; // 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; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.ServiceCatalog.Model.SearchProductsRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } if (cmdletContext.Filter != null) { request.Filters = cmdletContext.Filter; } if (cmdletContext.PageSize != null) { request.PageSize = cmdletContext.PageSize.Value; } if (cmdletContext.SortBy != null) { request.SortBy = cmdletContext.SortBy; } if (cmdletContext.SortOrder != null) { request.SortOrder = cmdletContext.SortOrder; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.PageToken; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.PageToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.PageToken = _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.NextPageToken; } 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; // create request var request = new Amazon.ServiceCatalog.Model.SearchProductsRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } if (cmdletContext.Filter != null) { request.Filters = cmdletContext.Filter; } if (cmdletContext.PageSize != null) { request.PageSize = cmdletContext.PageSize.Value; } if (cmdletContext.PageToken != null) { request.PageToken = cmdletContext.PageToken; } if (cmdletContext.SortBy != null) { request.SortBy = cmdletContext.SortBy; } if (cmdletContext.SortOrder != null) { request.SortOrder = cmdletContext.SortOrder; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.ServiceCatalog.Model.SearchProductsResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.SearchProductsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "SearchProducts"); try { #if DESKTOP return client.SearchProducts(request); #elif CORECLR return client.SearchProductsAsync(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 AcceptLanguage { get; set; } public Dictionary> Filter { get; set; } public System.Int32? PageSize { get; set; } public System.String PageToken { get; set; } public Amazon.ServiceCatalog.ProductViewSortBy SortBy { get; set; } public Amazon.ServiceCatalog.SortOrder SortOrder { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }