/*******************************************************************************
* 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.FSx;
using Amazon.FSx.Model;
namespace Amazon.PowerShell.Cmdlets.FSX
{
/// <summary>
/// Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data
/// repository associations, if one or more <code>AssociationIds</code> values are provided
/// in the request, or if filters are used in the request. Data repository associations
/// are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and newer
/// file systems, excluding <code>scratch_1</code> deployment type.
///
///
/// <para>
/// You can use filters to narrow the response to include just data repository associations
/// for specific file systems (use the <code>file-system-id</code> filter with the ID
/// of the file system) or caches (use the <code>file-cache-id</code> filter with the
/// ID of the cache), or data repository associations for a specific repository type (use
/// the <code>data-repository-type</code> filter with a value of <code>S3</code> or <code>NFS</code>).
/// If you don't use filters, the response returns all data repository associations owned
/// by your Amazon Web Services account in the Amazon Web Services Region of the endpoint
/// that you're calling.
/// </para><para>
/// When retrieving all data repository associations, you can paginate the response by
/// using the optional <code>MaxResults</code> parameter to limit the number of data repository
/// associations returned in a response. If more data repository associations remain,
/// a <code>NextToken</code> value is returned in the response. In this case, send a later
/// request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code>
/// from the last response.
/// </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", "FSXDataRepositoryAssociation")]
[OutputType("Amazon.FSx.Model.DataRepositoryAssociation")]
[AWSCmdlet("Calls the Amazon FSx DescribeDataRepositoryAssociations API operation.", Operation = new[] {"DescribeDataRepositoryAssociations"}, SelectReturnType = typeof(Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse))]
[AWSCmdletOutput("Amazon.FSx.Model.DataRepositoryAssociation or Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse",
"This cmdlet returns a collection of Amazon.FSx.Model.DataRepositoryAssociation objects.",
"The service call response (type Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetFSXDataRepositoryAssociationCmdlet : AmazonFSxClientCmdlet, IExecutor
{
#region Parameter AssociationId
/// <summary>
/// <para>
/// <para>IDs of the data repository associations whose descriptions you want to retrieve (String).</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("AssociationIds")]
public System.String[] AssociationId { get; set; }
#endregion
#region Parameter Filter
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public Amazon.FSx.Model.Filter[] Filter { get; set; }
#endregion
#region Parameter MaxResult
/// <summary>
/// <para>
/// <para>The maximum number of resources to return in the response. This value must be an integer
/// greater than zero.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </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 'Associations'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse).
/// Specifying the name of a property of type Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse 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; } = "Associations";
#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.FSx.Model.DescribeDataRepositoryAssociationsResponse, GetFSXDataRepositoryAssociationCmdlet>(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
if (this.AssociationId != null)
{
context.AssociationId = new List<System.String>(this.AssociationId);
}
if (this.Filter != null)
{
context.Filter = new List<Amazon.FSx.Model.Filter>(this.Filter);
}
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
// 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.FSx.Model.DescribeDataRepositoryAssociationsRequest();
if (cmdletContext.AssociationId != null)
{
request.AssociationIds = cmdletContext.AssociationId;
}
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
// 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.FSx.Model.DescribeDataRepositoryAssociationsResponse CallAWSServiceOperation(IAmazonFSx client, Amazon.FSx.Model.DescribeDataRepositoryAssociationsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon FSx", "DescribeDataRepositoryAssociations");
try
{
#if DESKTOP
return client.DescribeDataRepositoryAssociations(request);
#elif CORECLR
return client.DescribeDataRepositoryAssociationsAsync(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 List<System.String> AssociationId { get; set; }
public List<Amazon.FSx.Model.Filter> Filter { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Func<Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse, GetFSXDataRepositoryAssociationCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.Associations;
}
}
}