/******************************************************************************* * 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.SageMakerRuntime; using Amazon.SageMakerRuntime.Model; namespace Amazon.PowerShell.Cmdlets.SMR { /// /// After you deploy a model into production using Amazon SageMaker hosting services, /// your client applications use this API to get inferences from the model hosted at the /// specified endpoint. /// /// /// /// For an overview of Amazon SageMaker, see How /// It Works. /// /// Amazon SageMaker strips all POST headers except those supported by the API. Amazon /// SageMaker might add additional headers. You should not rely on the behavior of headers /// outside those enumerated in the request syntax. /// /// Calls to InvokeEndpoint are authenticated by using Amazon Web Services /// Signature Version 4. For information, see Authenticating /// Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. /// /// A customer's model containers must respond to requests within 60 seconds. The model /// itself can have a maximum processing time of 60 seconds before responding to invocations. /// If your model is going to take 50-60 seconds of processing time, the SDK socket timeout /// should be set to be 70 seconds. /// /// Endpoints are scoped to an individual account, and are not public. The URL does not /// contain the account ID, but Amazon SageMaker determines the account ID from the authentication /// token that is supplied by the caller. /// /// [Cmdlet("Invoke", "SMREndpoint", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.SageMakerRuntime.Model.InvokeEndpointResponse")] [AWSCmdlet("Calls the Amazon SageMaker Runtime InvokeEndpoint API operation.", Operation = new[] {"InvokeEndpoint"}, SelectReturnType = typeof(Amazon.SageMakerRuntime.Model.InvokeEndpointResponse))] [AWSCmdletOutput("Amazon.SageMakerRuntime.Model.InvokeEndpointResponse", "This cmdlet returns an Amazon.SageMakerRuntime.Model.InvokeEndpointResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class InvokeSMREndpointCmdlet : AmazonSageMakerRuntimeClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter Accept /// /// /// The desired MIME type of the inference in the response. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Accept { get; set; } #endregion #region Parameter Body /// /// /// Provides input data, in the format specified in the ContentType request /// header. Amazon SageMaker passes all of the data in the body to the model. For information about the format of the request body, see Common /// Data Formats-Inference. /// /// The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service. /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Amazon.PowerShell.Common.MemoryStreamParameterConverter] public byte[] Body { get; set; } #endregion #region Parameter ContentType /// /// /// The MIME type of the input data in the request body. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ContentType { get; set; } #endregion #region Parameter CustomAttribute /// /// /// Provides additional information about a request for an inference submitted to a model /// hosted at an Amazon SageMaker endpoint. The information is an opaque value that is /// forwarded verbatim. You could use this value, for example, to provide an ID that you /// can use to track a request or to provide other metadata that a service endpoint was /// programmed to process. The value must consist of no more than 1024 visible US-ASCII /// characters as specified in Section /// 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible for setting or updating any custom attributes /// in the response. If your code does not set this value in the response, an empty value /// is returned. For example, if a custom attribute represents the trace ID, your model /// can prepend the custom attribute with Trace ID: in your post-processing /// function.This feature is currently supported in the Amazon Web Services SDKs but not in the /// Amazon SageMaker Python SDK. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CustomAttributes")] public System.String CustomAttribute { get; set; } #endregion #region Parameter EnableExplanation /// /// /// An optional JMESPath expression used to override the EnableExplanations /// parameter of the ClarifyExplainerConfig API. See the EnableExplanations /// section in the developer guide for more information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("EnableExplanations")] public System.String EnableExplanation { get; set; } #endregion #region Parameter EndpointName /// /// /// The name of the endpoint that you specified when you created the endpoint using the /// CreateEndpoint /// API. /// /// #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 EndpointName { get; set; } #endregion #region Parameter InferenceId /// /// /// If you provide a value, it is added to the captured data when you enable data capture /// on the endpoint. For information about data capture, see Capture /// Data. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String InferenceId { get; set; } #endregion #region Parameter TargetContainerHostname /// /// /// If the endpoint hosts multiple containers and is configured to use direct invocation, /// this parameter specifies the host name of the container to invoke. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TargetContainerHostname { get; set; } #endregion #region Parameter TargetModel /// /// /// The model to request for inference when invoking a multi-model endpoint. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TargetModel { get; set; } #endregion #region Parameter TargetVariant /// /// /// Specify the production variant to send the inference request to when invoking an endpoint /// that is running two or more variants. Note that this parameter overrides the default /// behavior for the endpoint, which is to distribute the invocation traffic based on /// the variant weights.For information about how to use variant targeting to perform a/b testing, see Test /// models in production /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TargetVariant { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMakerRuntime.Model.InvokeEndpointResponse). /// Specifying the name of a property of type Amazon.SageMakerRuntime.Model.InvokeEndpointResponse 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; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the EndpointName parameter. /// The -PassThru parameter is deprecated, use -Select '^EndpointName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^EndpointName' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.EndpointName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Invoke-SMREndpoint (InvokeEndpoint)")) { return; } 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.EndpointName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Accept = this.Accept; context.Body = this.Body; #if MODULAR if (this.Body == null && ParameterWasBound(nameof(this.Body))) { WriteWarning("You are passing $null as a value for parameter Body 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.ContentType = this.ContentType; context.CustomAttribute = this.CustomAttribute; context.EnableExplanation = this.EnableExplanation; context.EndpointName = this.EndpointName; #if MODULAR if (this.EndpointName == null && ParameterWasBound(nameof(this.EndpointName))) { WriteWarning("You are passing $null as a value for parameter EndpointName 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.InferenceId = this.InferenceId; context.TargetContainerHostname = this.TargetContainerHostname; context.TargetModel = this.TargetModel; context.TargetVariant = this.TargetVariant; // 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) { System.IO.MemoryStream _BodyStream = null; try { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.SageMakerRuntime.Model.InvokeEndpointRequest(); if (cmdletContext.Accept != null) { request.Accept = cmdletContext.Accept; } if (cmdletContext.Body != null) { _BodyStream = new System.IO.MemoryStream(cmdletContext.Body); request.Body = _BodyStream; } if (cmdletContext.ContentType != null) { request.ContentType = cmdletContext.ContentType; } if (cmdletContext.CustomAttribute != null) { request.CustomAttributes = cmdletContext.CustomAttribute; } if (cmdletContext.EnableExplanation != null) { request.EnableExplanations = cmdletContext.EnableExplanation; } if (cmdletContext.EndpointName != null) { request.EndpointName = cmdletContext.EndpointName; } if (cmdletContext.InferenceId != null) { request.InferenceId = cmdletContext.InferenceId; } if (cmdletContext.TargetContainerHostname != null) { request.TargetContainerHostname = cmdletContext.TargetContainerHostname; } if (cmdletContext.TargetModel != null) { request.TargetModel = cmdletContext.TargetModel; } if (cmdletContext.TargetVariant != null) { request.TargetVariant = cmdletContext.TargetVariant; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } finally { if( _BodyStream != null) { _BodyStream.Dispose(); } } } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.SageMakerRuntime.Model.InvokeEndpointResponse CallAWSServiceOperation(IAmazonSageMakerRuntime client, Amazon.SageMakerRuntime.Model.InvokeEndpointRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon SageMaker Runtime", "InvokeEndpoint"); try { #if DESKTOP return client.InvokeEndpoint(request); #elif CORECLR return client.InvokeEndpointAsync(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 Accept { get; set; } public byte[] Body { get; set; } public System.String ContentType { get; set; } public System.String CustomAttribute { get; set; } public System.String EnableExplanation { get; set; } public System.String EndpointName { get; set; } public System.String InferenceId { get; set; } public System.String TargetContainerHostname { get; set; } public System.String TargetModel { get; set; } public System.String TargetVariant { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }