/*******************************************************************************
* 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
{
///
/// Returns a list of the subtasks for an Inference Recommender job.
///
///
///
/// The supported subtasks are benchmarks, which evaluate the performance of your model
/// on different instance types.
///
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", "SMInferenceRecommendationsJobStepList")]
[OutputType("Amazon.SageMaker.Model.InferenceRecommendationsJobStep")]
[AWSCmdlet("Calls the Amazon SageMaker Service ListInferenceRecommendationsJobSteps API operation.", Operation = new[] {"ListInferenceRecommendationsJobSteps"}, SelectReturnType = typeof(Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsResponse))]
[AWSCmdletOutput("Amazon.SageMaker.Model.InferenceRecommendationsJobStep or Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsResponse",
"This cmdlet returns a collection of Amazon.SageMaker.Model.InferenceRecommendationsJobStep objects.",
"The service call response (type Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetSMInferenceRecommendationsJobStepListCmdlet : AmazonSageMakerClientCmdlet, IExecutor
{
#region Parameter JobName
///
///
/// The name for the Inference Recommender job.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String JobName { get; set; }
#endregion
#region Parameter Status
///
///
/// A filter to return benchmarks of a specified status. If this field is left empty,
/// then all benchmarks are returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.RecommendationJobStatus")]
public Amazon.SageMaker.RecommendationJobStatus Status { get; set; }
#endregion
#region Parameter StepType
///
///
/// A filter to return details about the specified type of subtask.BENCHMARK
: Evaluate the performance of your model on different instance
/// types.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.RecommendationStepType")]
public Amazon.SageMaker.RecommendationStepType StepType { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of results to return.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// A token that you can specify to return more results from the list. Specify this field
/// if you have a token that was returned from a previous request.
///
///
///
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 'Steps'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsResponse).
/// Specifying the name of a property of type Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsResponse 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; } = "Steps";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the JobName parameter.
/// The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^JobName' 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 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);
#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.JobName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.JobName = this.JobName;
#if MODULAR
if (this.JobName == null && ParameterWasBound(nameof(this.JobName)))
{
WriteWarning("You are passing $null as a value for parameter JobName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.Status = this.Status;
context.StepType = this.StepType;
// 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;
#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.SageMaker.Model.ListInferenceRecommendationsJobStepsRequest();
if (cmdletContext.JobName != null)
{
request.JobName = cmdletContext.JobName;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.Status != null)
{
request.Status = cmdletContext.Status;
}
if (cmdletContext.StepType != null)
{
request.StepType = cmdletContext.StepType;
}
// 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.ListInferenceRecommendationsJobStepsResponse CallAWSServiceOperation(IAmazonSageMaker client, Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon SageMaker Service", "ListInferenceRecommendationsJobSteps");
try
{
#if DESKTOP
return client.ListInferenceRecommendationsJobSteps(request);
#elif CORECLR
return client.ListInferenceRecommendationsJobStepsAsync(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 JobName { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public Amazon.SageMaker.RecommendationJobStatus Status { get; set; }
public Amazon.SageMaker.RecommendationStepType StepType { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Steps;
}
}
}