/*******************************************************************************
* 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.SageMaker;
using Amazon.SageMaker.Model;
namespace Amazon.PowerShell.Cmdlets.SM
{
///
/// Lists the trial components in your account. You can sort the list by trial component
/// name or creation time. You can filter the list to show only components that were created
/// in a specific time range. You can also filter on one of the following:
///
/// ExperimentName
SourceArn
TrialName
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", "SMTrialComponentList")]
[OutputType("Amazon.SageMaker.Model.TrialComponentSummary")]
[AWSCmdlet("Calls the Amazon SageMaker Service ListTrialComponents API operation.", Operation = new[] {"ListTrialComponents"}, SelectReturnType = typeof(Amazon.SageMaker.Model.ListTrialComponentsResponse))]
[AWSCmdletOutput("Amazon.SageMaker.Model.TrialComponentSummary or Amazon.SageMaker.Model.ListTrialComponentsResponse",
"This cmdlet returns a collection of Amazon.SageMaker.Model.TrialComponentSummary objects.",
"The service call response (type Amazon.SageMaker.Model.ListTrialComponentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetSMTrialComponentListCmdlet : AmazonSageMakerClientCmdlet, IExecutor
{
#region Parameter CreatedAfter
///
///
/// A filter that returns only components created after the specified time.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? CreatedAfter { get; set; }
#endregion
#region Parameter CreatedBefore
///
///
/// A filter that returns only components created before the specified time.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? CreatedBefore { get; set; }
#endregion
#region Parameter ExperimentName
///
///
/// A filter that returns only components that are part of the specified experiment. If
/// you specify ExperimentName
, you can't filter by SourceArn
/// or TrialName
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ExperimentName { get; set; }
#endregion
#region Parameter SortBy
///
///
/// The property used to sort results. The default value is CreationTime
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.SortTrialComponentsBy")]
public Amazon.SageMaker.SortTrialComponentsBy SortBy { get; set; }
#endregion
#region Parameter SortOrder
///
///
/// The sort order. The default value is Descending
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.SortOrder")]
public Amazon.SageMaker.SortOrder SortOrder { get; set; }
#endregion
#region Parameter SourceArn
///
///
/// A filter that returns only components that have the specified source Amazon Resource
/// Name (ARN). If you specify SourceArn
, you can't filter by ExperimentName
/// or TrialName
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceArn { get; set; }
#endregion
#region Parameter TrialName
///
///
/// A filter that returns only components that are part of the specified trial. If you
/// specify TrialName
, you can't filter by ExperimentName
or
/// SourceArn
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TrialName { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of components to return in the response. The default value is 10.
///
///
///
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.
///
/// If a value for this parameter is not specified the cmdlet will use a default value of '100'.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxItems","MaxResults")]
public int? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// If the previous call to ListTrialComponents
didn't return the full set
/// of components, the call returns a token for getting the next set of components.
///
///
///
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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'TrialComponentSummaries'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListTrialComponentsResponse).
/// Specifying the name of a property of type Amazon.SageMaker.Model.ListTrialComponentsResponse 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; } = "TrialComponentSummaries";
#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 NextToken
/// 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.CreatedAfter = this.CreatedAfter;
context.CreatedBefore = this.CreatedBefore;
context.ExperimentName = this.ExperimentName;
context.MaxResult = this.MaxResult;
#if MODULAR
if (!ParameterWasBound(nameof(this.MaxResult)))
{
WriteVerbose("MaxResult parameter unset, using default value of '100'");
context.MaxResult = 100;
}
#endif
#if !MODULAR
if (ParameterWasBound(nameof(this.MaxResult)) && this.MaxResult.HasValue)
{
WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxResult 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 MaxResult" +
" to the service to specify how many items should be returned by each service call.");
}
#endif
context.NextToken = this.NextToken;
context.SortBy = this.SortBy;
context.SortOrder = this.SortOrder;
context.SourceArn = this.SourceArn;
context.TrialName = this.TrialName;
// 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.SageMaker.Model.ListTrialComponentsRequest();
if (cmdletContext.CreatedAfter != null)
{
request.CreatedAfter = cmdletContext.CreatedAfter.Value;
}
if (cmdletContext.CreatedBefore != null)
{
request.CreatedBefore = cmdletContext.CreatedBefore.Value;
}
if (cmdletContext.ExperimentName != null)
{
request.ExperimentName = cmdletContext.ExperimentName;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxResult.Value);
}
if (cmdletContext.SortBy != null)
{
request.SortBy = cmdletContext.SortBy;
}
if (cmdletContext.SortOrder != null)
{
request.SortOrder = cmdletContext.SortOrder;
}
if (cmdletContext.SourceArn != null)
{
request.SourceArn = cmdletContext.SourceArn;
}
if (cmdletContext.TrialName != null)
{
request.TrialName = cmdletContext.TrialName;
}
// 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.SageMaker.Model.ListTrialComponentsRequest();
if (cmdletContext.CreatedAfter != null)
{
request.CreatedAfter = cmdletContext.CreatedAfter.Value;
}
if (cmdletContext.CreatedBefore != null)
{
request.CreatedBefore = cmdletContext.CreatedBefore.Value;
}
if (cmdletContext.ExperimentName != null)
{
request.ExperimentName = cmdletContext.ExperimentName;
}
if (cmdletContext.SortBy != null)
{
request.SortBy = cmdletContext.SortBy;
}
if (cmdletContext.SortOrder != null)
{
request.SortOrder = cmdletContext.SortOrder;
}
if (cmdletContext.SourceArn != null)
{
request.SourceArn = cmdletContext.SourceArn;
}
if (cmdletContext.TrialName != null)
{
request.TrialName = cmdletContext.TrialName;
}
// 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.MaxResult.HasValue)
{
// The service has a maximum page size of 100. 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 100 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.MaxResult;
}
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(100, _emitLimit.Value);
request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToInt32(correctPageSize);
}
else if (!ParameterWasBound(nameof(this.MaxResult)))
{
request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToInt32(100);
}
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.TrialComponentSummaries.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.SageMaker.Model.ListTrialComponentsResponse CallAWSServiceOperation(IAmazonSageMaker client, Amazon.SageMaker.Model.ListTrialComponentsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon SageMaker Service", "ListTrialComponents");
try
{
#if DESKTOP
return client.ListTrialComponents(request);
#elif CORECLR
return client.ListTrialComponentsAsync(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.DateTime? CreatedAfter { get; set; }
public System.DateTime? CreatedBefore { get; set; }
public System.String ExperimentName { get; set; }
public int? MaxResult { get; set; }
public System.String NextToken { get; set; }
public Amazon.SageMaker.SortTrialComponentsBy SortBy { get; set; }
public Amazon.SageMaker.SortOrder SortOrder { get; set; }
public System.String SourceArn { get; set; }
public System.String TrialName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.TrialComponentSummaries;
}
}
}