/******************************************************************************* * 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 { /// /// Lists the provisioned products that are available (not terminated). /// /// /// /// To use additional filtering, see SearchProvisionedProducts. ///

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", "SCProvisionedProduct")] [OutputType("Amazon.ServiceCatalog.Model.ProvisionedProductDetail")] [AWSCmdlet("Calls the AWS Service Catalog ScanProvisionedProducts API operation.", Operation = new[] {"ScanProvisionedProducts"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.ScanProvisionedProductsResponse))] [AWSCmdletOutput("Amazon.ServiceCatalog.Model.ProvisionedProductDetail or Amazon.ServiceCatalog.Model.ScanProvisionedProductsResponse", "This cmdlet returns a collection of Amazon.ServiceCatalog.Model.ProvisionedProductDetail objects.", "The service call response (type Amazon.ServiceCatalog.Model.ScanProvisionedProductsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetSCProvisionedProductCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor { #region Parameter AcceptLanguage /// /// /// The language code. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AcceptLanguage { get; set; } #endregion #region Parameter AccessLevelFilter_Key /// /// /// The access level. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ServiceCatalog.AccessLevelFilterKey")] public Amazon.ServiceCatalog.AccessLevelFilterKey AccessLevelFilter_Key { get; set; } #endregion #region Parameter AccessLevelFilter_Value /// /// /// The user to which the access level applies. The only supported value is Self. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AccessLevelFilter_Value { get; set; } #endregion #region Parameter PageSize /// /// /// The maximum number of items to return with this call. /// /// ///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. ///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. ///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxItems")] public int? 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: 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 'ProvisionedProducts'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceCatalog.Model.ScanProvisionedProductsResponse). /// Specifying the name of a property of type Amazon.ServiceCatalog.Model.ScanProvisionedProductsResponse 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; } = "ProvisionedProducts"; #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 PageToken /// 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.AcceptLanguage = this.AcceptLanguage; context.AccessLevelFilter_Key = this.AccessLevelFilter_Key; context.AccessLevelFilter_Value = this.AccessLevelFilter_Value; context.PageSize = this.PageSize; #if !MODULAR if (ParameterWasBound(nameof(this.PageSize)) && this.PageSize.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the PageSize parameter to limit the total number of items returned by the cmdlet." + " This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" + " retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing PageSize" + " to the service to specify how many items should be returned by each service call."); } #endif context.PageToken = this.PageToken; // 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.ScanProvisionedProductsRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } // populate AccessLevelFilter var requestAccessLevelFilterIsNull = true; request.AccessLevelFilter = new Amazon.ServiceCatalog.Model.AccessLevelFilter(); Amazon.ServiceCatalog.AccessLevelFilterKey requestAccessLevelFilter_accessLevelFilter_Key = null; if (cmdletContext.AccessLevelFilter_Key != null) { requestAccessLevelFilter_accessLevelFilter_Key = cmdletContext.AccessLevelFilter_Key; } if (requestAccessLevelFilter_accessLevelFilter_Key != null) { request.AccessLevelFilter.Key = requestAccessLevelFilter_accessLevelFilter_Key; requestAccessLevelFilterIsNull = false; } System.String requestAccessLevelFilter_accessLevelFilter_Value = null; if (cmdletContext.AccessLevelFilter_Value != null) { requestAccessLevelFilter_accessLevelFilter_Value = cmdletContext.AccessLevelFilter_Value; } if (requestAccessLevelFilter_accessLevelFilter_Value != null) { request.AccessLevelFilter.Value = requestAccessLevelFilter_accessLevelFilter_Value; requestAccessLevelFilterIsNull = false; } // determine if request.AccessLevelFilter should be set to null if (requestAccessLevelFilterIsNull) { request.AccessLevelFilter = null; } if (cmdletContext.PageSize != null) { request.PageSize = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.PageSize.Value); } // 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; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.ServiceCatalog.Model.ScanProvisionedProductsRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } // populate AccessLevelFilter var requestAccessLevelFilterIsNull = true; request.AccessLevelFilter = new Amazon.ServiceCatalog.Model.AccessLevelFilter(); Amazon.ServiceCatalog.AccessLevelFilterKey requestAccessLevelFilter_accessLevelFilter_Key = null; if (cmdletContext.AccessLevelFilter_Key != null) { requestAccessLevelFilter_accessLevelFilter_Key = cmdletContext.AccessLevelFilter_Key; } if (requestAccessLevelFilter_accessLevelFilter_Key != null) { request.AccessLevelFilter.Key = requestAccessLevelFilter_accessLevelFilter_Key; requestAccessLevelFilterIsNull = false; } System.String requestAccessLevelFilter_accessLevelFilter_Value = null; if (cmdletContext.AccessLevelFilter_Value != null) { requestAccessLevelFilter_accessLevelFilter_Value = cmdletContext.AccessLevelFilter_Value; } if (requestAccessLevelFilter_accessLevelFilter_Value != null) { request.AccessLevelFilter.Value = requestAccessLevelFilter_accessLevelFilter_Value; requestAccessLevelFilterIsNull = false; } // determine if request.AccessLevelFilter should be set to null if (requestAccessLevelFilterIsNull) { request.AccessLevelFilter = null; } // Initialize loop variants and commence piping System.String _nextToken = null; int? _emitLimit = null; int _retrievedSoFar = 0; if (AutoIterationHelpers.HasValue(cmdletContext.PageToken)) { _nextToken = cmdletContext.PageToken; } if (cmdletContext.PageSize.HasValue) { // The service has a maximum page size of 20. If the user has // asked for more items than page max, and there is no page size // configured, we rely on the service ignoring the set maximum // and giving us 20 items back. If a page size is set, that will // be used to configure the pagination. // We'll make further calls to satisfy the user's request. _emitLimit = cmdletContext.PageSize; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.PageToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.PageToken = _nextToken; if (_emitLimit.HasValue) { int correctPageSize = Math.Min(20, _emitLimit.Value); request.PageSize = AutoIterationHelpers.ConvertEmitLimitToInt32(correctPageSize); } 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 }; int _receivedThisCall = response.ProvisionedProducts.Count; _nextToken = response.NextPageToken; _retrievedSoFar += _receivedThisCall; if (_emitLimit.HasValue) { _emitLimit -= _receivedThisCall; } } catch (Exception e) { if (_retrievedSoFar == 0 || !_emitLimit.HasValue) { output = new CmdletOutput { ErrorResponse = e }; } else { break; } } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 0)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.ServiceCatalog.Model.ScanProvisionedProductsResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.ScanProvisionedProductsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "ScanProvisionedProducts"); try { #if DESKTOP return client.ScanProvisionedProducts(request); #elif CORECLR return client.ScanProvisionedProductsAsync(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 Amazon.ServiceCatalog.AccessLevelFilterKey AccessLevelFilter_Key { get; set; } public System.String AccessLevelFilter_Value { get; set; } public int? PageSize { get; set; } public System.String PageToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ProvisionedProducts; } } }