/******************************************************************************* * 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.ElasticFileSystem; using Amazon.ElasticFileSystem.Model; namespace Amazon.PowerShell.Cmdlets.EFS { /// /// Returns the descriptions of all the current mount targets, or a specific mount target, /// for a file system. When requesting all of the current mount targets, the order of /// mount targets returned in the response is unspecified. /// /// /// /// This operation requires permissions for the elasticfilesystem:DescribeMountTargets /// action, on either the file system ID that you specify in FileSystemId, /// or on the file system of the mount target that you specify in MountTargetId. ///

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", "EFSMountTarget")] [OutputType("Amazon.ElasticFileSystem.Model.MountTargetDescription")] [AWSCmdlet("Calls the Amazon Elastic File System DescribeMountTargets API operation.", Operation = new[] {"DescribeMountTargets"}, SelectReturnType = typeof(Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse))] [AWSCmdletOutput("Amazon.ElasticFileSystem.Model.MountTargetDescription or Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse", "This cmdlet returns a collection of Amazon.ElasticFileSystem.Model.MountTargetDescription objects.", "The service call response (type Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEFSMountTargetCmdlet : AmazonElasticFileSystemClientCmdlet, IExecutor { #region Parameter AccessPointId /// /// /// (Optional) The ID of the access point whose mount targets that you want to list. It /// must be included in your request if a FileSystemId or MountTargetId /// is not included in your request. Accepts either an access point ID or ARN as input. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AccessPointId { get; set; } #endregion #region Parameter FileSystemId /// /// /// (Optional) ID of the file system whose mount targets you want to list (String). It /// must be included in your request if an AccessPointId or MountTargetId /// is not included. Accepts either a file system ID or ARN as input. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String FileSystemId { get; set; } #endregion #region Parameter MountTargetId /// /// /// (Optional) ID of the mount target that you want to have described (String). It must /// be included in your request if FileSystemId is not included. Accepts /// either a mount target ID or ARN as input. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MountTargetId { get; set; } #endregion #region Parameter Marker /// /// /// (Optional) Opaque pagination token returned from a previous DescribeMountTargets /// operation (String). If present, it specifies to continue the list from where the previous /// returning call left off. /// /// ///
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 '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String Marker { get; set; } #endregion #region Parameter MaxItem /// /// /// (Optional) Maximum number of mount targets to return in the response. Currently, this /// number is automatically set to 10, and other values are ignored. The response is paginated /// at 100 per page if you have more than 100 mount targets. /// /// ///
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? MaxItem { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'MountTargets'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse). /// Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse 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; } = "MountTargets"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. /// The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FileSystemId' 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 Marker /// 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.FileSystemId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AccessPointId = this.AccessPointId; context.FileSystemId = this.FileSystemId; context.Marker = this.Marker; context.MaxItem = this.MaxItem; #if !MODULAR if (ParameterWasBound(nameof(this.MaxItem)) && this.MaxItem.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxItem 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 MaxItem" + " to the service to specify how many items should be returned by each service call."); } #endif context.MountTargetId = this.MountTargetId; // 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; #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.ElasticFileSystem.Model.DescribeMountTargetsRequest(); if (cmdletContext.AccessPointId != null) { request.AccessPointId = cmdletContext.AccessPointId; } if (cmdletContext.FileSystemId != null) { request.FileSystemId = cmdletContext.FileSystemId; } if (cmdletContext.MaxItem != null) { request.MaxItems = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxItem.Value); } if (cmdletContext.MountTargetId != null) { request.MountTargetId = cmdletContext.MountTargetId; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.Marker; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _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.NextMarker; } 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("^") || this.PassThru.IsPresent; // create request and set iteration invariants var request = new Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest(); if (cmdletContext.AccessPointId != null) { request.AccessPointId = cmdletContext.AccessPointId; } if (cmdletContext.FileSystemId != null) { request.FileSystemId = cmdletContext.FileSystemId; } if (cmdletContext.MountTargetId != null) { request.MountTargetId = cmdletContext.MountTargetId; } // Initialize loop variants and commence piping System.String _nextToken = null; int? _emitLimit = null; int _retrievedSoFar = 0; if (AutoIterationHelpers.HasValue(cmdletContext.Marker)) { _nextToken = cmdletContext.Marker; } if (cmdletContext.MaxItem.HasValue) { _emitLimit = cmdletContext.MaxItem; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; if (_emitLimit.HasValue) { request.MaxItems = AutoIterationHelpers.ConvertEmitLimitToInt32(_emitLimit.Value); } 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.MountTargets.Count; _nextToken = response.NextMarker; _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.ElasticFileSystem.Model.DescribeMountTargetsResponse CallAWSServiceOperation(IAmazonElasticFileSystem client, Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic File System", "DescribeMountTargets"); try { #if DESKTOP return client.DescribeMountTargets(request); #elif CORECLR return client.DescribeMountTargetsAsync(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 AccessPointId { get; set; } public System.String FileSystemId { get; set; } public System.String Marker { get; set; } public int? MaxItem { get; set; } public System.String MountTargetId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.MountTargets; } } }