/*******************************************************************************
* 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
{
/// <summary>
/// Returns the list of all inference experiments.<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", "SMInferenceExperimentList")]
[OutputType("Amazon.SageMaker.Model.InferenceExperimentSummary")]
[AWSCmdlet("Calls the Amazon SageMaker Service ListInferenceExperiments API operation.", Operation = new[] {"ListInferenceExperiments"}, SelectReturnType = typeof(Amazon.SageMaker.Model.ListInferenceExperimentsResponse))]
[AWSCmdletOutput("Amazon.SageMaker.Model.InferenceExperimentSummary or Amazon.SageMaker.Model.ListInferenceExperimentsResponse",
"This cmdlet returns a collection of Amazon.SageMaker.Model.InferenceExperimentSummary objects.",
"The service call response (type Amazon.SageMaker.Model.ListInferenceExperimentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetSMInferenceExperimentListCmdlet : AmazonSageMakerClientCmdlet, IExecutor
{
#region Parameter CreationTimeAfter
/// <summary>
/// <para>
/// <para>Selects inference experiments which were created after this timestamp.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? CreationTimeAfter { get; set; }
#endregion
#region Parameter CreationTimeBefore
/// <summary>
/// <para>
/// <para>Selects inference experiments which were created before this timestamp.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? CreationTimeBefore { get; set; }
#endregion
#region Parameter LastModifiedTimeAfter
/// <summary>
/// <para>
/// <para>Selects inference experiments which were last modified after this timestamp.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? LastModifiedTimeAfter { get; set; }
#endregion
#region Parameter LastModifiedTimeBefore
/// <summary>
/// <para>
/// <para>Selects inference experiments which were last modified before this timestamp.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? LastModifiedTimeBefore { get; set; }
#endregion
#region Parameter NameContain
/// <summary>
/// <para>
/// <para>Selects inference experiments whose names contain this name.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NameContains")]
public System.String NameContain { get; set; }
#endregion
#region Parameter SortBy
/// <summary>
/// <para>
/// <para>The column by which to sort the listed inference experiments.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.SortInferenceExperimentsBy")]
public Amazon.SageMaker.SortInferenceExperimentsBy SortBy { get; set; }
#endregion
#region Parameter SortOrder
/// <summary>
/// <para>
/// <para>The direction of sorting (ascending or descending).</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.SortOrder")]
public Amazon.SageMaker.SortOrder SortOrder { get; set; }
#endregion
#region Parameter StatusEqual
/// <summary>
/// <para>
/// <para> Selects inference experiments which are in this status. For the possible statuses,
/// see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html">DescribeInferenceExperiment</a>.
/// </para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("StatusEquals")]
[AWSConstantClassSource("Amazon.SageMaker.InferenceExperimentStatus")]
public Amazon.SageMaker.InferenceExperimentStatus StatusEqual { get; set; }
#endregion
#region Parameter Type
/// <summary>
/// <para>
/// <para> Selects inference experiments of this type. For the possible types of inference experiments,
/// see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html">CreateInferenceExperiment</a>.
/// </para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.InferenceExperimentType")]
public Amazon.SageMaker.InferenceExperimentType Type { get; set; }
#endregion
#region Parameter MaxResult
/// <summary>
/// <para>
/// <para>The maximum number of results to select.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
/// <summary>
/// <para>
/// <para> The response from the last list when returning a list large enough to need tokening.
/// </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 'InferenceExperiments'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListInferenceExperimentsResponse).
/// Specifying the name of a property of type Amazon.SageMaker.Model.ListInferenceExperimentsResponse 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; } = "InferenceExperiments";
#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.SageMaker.Model.ListInferenceExperimentsResponse, GetSMInferenceExperimentListCmdlet>(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.CreationTimeAfter = this.CreationTimeAfter;
context.CreationTimeBefore = this.CreationTimeBefore;
context.LastModifiedTimeAfter = this.LastModifiedTimeAfter;
context.LastModifiedTimeBefore = this.LastModifiedTimeBefore;
context.MaxResult = this.MaxResult;
context.NameContain = this.NameContain;
context.NextToken = this.NextToken;
context.SortBy = this.SortBy;
context.SortOrder = this.SortOrder;
context.StatusEqual = this.StatusEqual;
context.Type = this.Type;
// 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.SageMaker.Model.ListInferenceExperimentsRequest();
if (cmdletContext.CreationTimeAfter != null)
{
request.CreationTimeAfter = cmdletContext.CreationTimeAfter.Value;
}
if (cmdletContext.CreationTimeBefore != null)
{
request.CreationTimeBefore = cmdletContext.CreationTimeBefore.Value;
}
if (cmdletContext.LastModifiedTimeAfter != null)
{
request.LastModifiedTimeAfter = cmdletContext.LastModifiedTimeAfter.Value;
}
if (cmdletContext.LastModifiedTimeBefore != null)
{
request.LastModifiedTimeBefore = cmdletContext.LastModifiedTimeBefore.Value;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NameContain != null)
{
request.NameContains = cmdletContext.NameContain;
}
if (cmdletContext.SortBy != null)
{
request.SortBy = cmdletContext.SortBy;
}
if (cmdletContext.SortOrder != null)
{
request.SortOrder = cmdletContext.SortOrder;
}
if (cmdletContext.StatusEqual != null)
{
request.StatusEquals = cmdletContext.StatusEqual;
}
if (cmdletContext.Type != null)
{
request.Type = cmdletContext.Type;
}
// 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.SageMaker.Model.ListInferenceExperimentsResponse CallAWSServiceOperation(IAmazonSageMaker client, Amazon.SageMaker.Model.ListInferenceExperimentsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon SageMaker Service", "ListInferenceExperiments");
try
{
#if DESKTOP
return client.ListInferenceExperiments(request);
#elif CORECLR
return client.ListInferenceExperimentsAsync(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? CreationTimeAfter { get; set; }
public System.DateTime? CreationTimeBefore { get; set; }
public System.DateTime? LastModifiedTimeAfter { get; set; }
public System.DateTime? LastModifiedTimeBefore { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NameContain { get; set; }
public System.String NextToken { get; set; }
public Amazon.SageMaker.SortInferenceExperimentsBy SortBy { get; set; }
public Amazon.SageMaker.SortOrder SortOrder { get; set; }
public Amazon.SageMaker.InferenceExperimentStatus StatusEqual { get; set; }
public Amazon.SageMaker.InferenceExperimentType Type { get; set; }
public System.Func<Amazon.SageMaker.Model.ListInferenceExperimentsResponse, GetSMInferenceExperimentListCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.InferenceExperiments;
}
}
}