/******************************************************************************* * 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.WorkSpaces; using Amazon.WorkSpaces.Model; namespace Amazon.PowerShell.Cmdlets.WKS { /// <summary> /// Describes the specified WorkSpaces. /// /// /// <para> /// You can filter the results by using the bundle identifier, directory identifier, or /// owner, but you can specify only one filter at a time. /// </para><br/><br/>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. /// </summary> [Cmdlet("Get", "WKSWorkspace")] [OutputType("Amazon.WorkSpaces.Model.Workspace")] [AWSCmdlet("Calls the Amazon WorkSpaces DescribeWorkspaces API operation.", Operation = new[] {"DescribeWorkspaces"}, SelectReturnType = typeof(Amazon.WorkSpaces.Model.DescribeWorkspacesResponse), LegacyAlias="Get-WKSWorkspaces")] [AWSCmdletOutput("Amazon.WorkSpaces.Model.Workspace or Amazon.WorkSpaces.Model.DescribeWorkspacesResponse", "This cmdlet returns a collection of Amazon.WorkSpaces.Model.Workspace objects.", "The service call response (type Amazon.WorkSpaces.Model.DescribeWorkspacesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetWKSWorkspaceCmdlet : AmazonWorkSpacesClientCmdlet, IExecutor { #region Parameter BundleId /// <summary> /// <para> /// <para>The identifier of the bundle. All WorkSpaces that are created from this bundle are /// retrieved. You cannot combine this parameter with any other filter.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String BundleId { get; set; } #endregion #region Parameter DirectoryId /// <summary> /// <para> /// <para>The identifier of the directory. In addition, you can optionally specify a specific /// directory user (see <code>UserName</code>). You cannot combine this parameter with /// any other filter.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DirectoryId { get; set; } #endregion #region Parameter UserName /// <summary> /// <para> /// <para>The name of the directory user. You must specify this parameter with <code>DirectoryId</code>.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String UserName { get; set; } #endregion #region Parameter WorkspaceId /// <summary> /// <para> /// <para>The identifiers of the WorkSpaces. You cannot combine this parameter with any other /// filter.</para><para>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns /// is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with /// this identifier, no information is returned.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("WorkspaceIds")] public System.String[] WorkspaceId { get; set; } #endregion #region Parameter Limit /// <summary> /// <para> /// <para>The maximum number of items to return.</para> /// </para> /// <para> /// <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. /// <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. /// <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxItems")] public int? Limit { get; set; } #endregion #region Parameter NextToken /// <summary> /// <para> /// <para>If you received a <code>NextToken</code> from a previous call that was paginated, /// provide this token to receive the next set of results.</para> /// </para> /// <para> /// <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. /// <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'Workspaces'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpaces.Model.DescribeWorkspacesResponse). /// Specifying the name of a property of type Amazon.WorkSpaces.Model.DescribeWorkspacesResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "Workspaces"; #endregion #region Parameter NoAutoIteration /// <summary> /// 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. /// </summary> [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<Amazon.WorkSpaces.Model.DescribeWorkspacesResponse, GetWKSWorkspaceCmdlet>(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.BundleId = this.BundleId; context.DirectoryId = this.DirectoryId; context.Limit = this.Limit; #if !MODULAR if (ParameterWasBound(nameof(this.Limit)) && this.Limit.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the Limit 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 Limit" + " to the service to specify how many items should be returned by each service call."); } #endif context.NextToken = this.NextToken; context.UserName = this.UserName; if (this.WorkspaceId != null) { context.WorkspaceId = new List<System.String>(this.WorkspaceId); } // 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.WorkSpaces.Model.DescribeWorkspacesRequest(); if (cmdletContext.BundleId != null) { request.BundleId = cmdletContext.BundleId; } if (cmdletContext.DirectoryId != null) { request.DirectoryId = cmdletContext.DirectoryId; } if (cmdletContext.Limit != null) { request.Limit = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.Limit.Value); } if (cmdletContext.UserName != null) { request.UserName = cmdletContext.UserName; } if (cmdletContext.WorkspaceId != null) { request.WorkspaceIds = cmdletContext.WorkspaceId; } // 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; } #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.WorkSpaces.Model.DescribeWorkspacesRequest(); if (cmdletContext.BundleId != null) { request.BundleId = cmdletContext.BundleId; } if (cmdletContext.DirectoryId != null) { request.DirectoryId = cmdletContext.DirectoryId; } if (cmdletContext.UserName != null) { request.UserName = cmdletContext.UserName; } if (cmdletContext.WorkspaceId != null) { request.WorkspaceIds = cmdletContext.WorkspaceId; } // Initialize loop variants and commence piping System.String _nextToken = null; int? _emitLimit = null; int _retrievedSoFar = 0; if (AutoIterationHelpers.HasValue(cmdletContext.NextToken)) { _nextToken = cmdletContext.NextToken; } if (cmdletContext.Limit.HasValue) { // The service has a maximum page size of 25. 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 25 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.Limit; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _nextToken; if (_emitLimit.HasValue) { int correctPageSize = Math.Min(25, _emitLimit.Value); request.Limit = 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.Workspaces.Count; _nextToken = response.NextToken; _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 >= 1)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.WorkSpaces.Model.DescribeWorkspacesResponse CallAWSServiceOperation(IAmazonWorkSpaces client, Amazon.WorkSpaces.Model.DescribeWorkspacesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces", "DescribeWorkspaces"); try { #if DESKTOP return client.DescribeWorkspaces(request); #elif CORECLR return client.DescribeWorkspacesAsync(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 BundleId { get; set; } public System.String DirectoryId { get; set; } public int? Limit { get; set; } public System.String NextToken { get; set; } public System.String UserName { get; set; } public List<System.String> WorkspaceId { get; set; } public System.Func<Amazon.WorkSpaces.Model.DescribeWorkspacesResponse, GetWKSWorkspaceCmdlet, object> Select { get; set; } = (response, cmdlet) => response.Workspaces; } } }