AWS.Tools.SageMakerRuntime

4.0.1.0

AWS.Tools.SageMakerRuntime.dll-Help.xml

                                <helpItems schema="maml">

  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <details>

      <name>Invoke-SMREndpoint</name>

      <description>

        <para>Calls the Amazon SageMaker Runtime InvokeEndpoint API operation.</para>

      </description>

      <verb>Invoke</verb>

      <noun>SMREndpoint</noun>

      <copyright>

        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>

      </copyright>

    </details>

    <description>

      <para>Initiates the asynchronous execution of the InvokeEndpoint operation. </para>

    </description>

    <syntax>

      <syntaxItem>

        <name>Invoke-SMREndpoint</name>

        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

          <name>EndpointName</name>

          <description>

            <para>The name of the endpoint that you specified when you created the endpoint using the <a href="http://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html">CreateEndpoint</a> API.  </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Accept</name>

          <description>

            <para>The desired MIME type of the inference in the response. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Body</name>

          <description>

            <para>Provides input data, in the format specified in the <code>ContentType</code> 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 <a href="http://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html">Common Data Formats—Inference</a>. 

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. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>ContentType</name>

          <description>

            <para>The MIME type of the input data in the request body. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>CustomAttribute</name>

          <description>

            <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>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Select</name>

          <description>

            <para>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. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>PassThru</name>

          <description>

            <para>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. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Force</name>

          <description>

            <para>This parameter overrides confirmation prompts to force  the cmdlet to continue its operation. This parameter should always be used with caution. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

      </syntaxItem>

    </syntax>

    <parameters>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Accept</name>

        <description>

          <para>The desired MIME type of the inference in the response. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Body</name>

        <description>

          <para>Provides input data, in the format specified in the <code>ContentType</code> 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 <a href="http://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html">Common Data Formats—Inference</a>. 

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. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue>

        <type>

          <name>System.Byte[]</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>ContentType</name>

        <description>

          <para>The MIME type of the input data in the request body. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>CustomAttribute</name>

        <description>

          <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>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

        <name>EndpointName</name>

        <description>

          <para>The name of the endpoint that you specified when you created the endpoint using the <a href="http://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html">CreateEndpoint</a> API.  </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Force</name>

        <description>

          <para>This parameter overrides confirmation prompts to force  the cmdlet to continue its operation. This parameter should always be used with caution. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        <type>

          <name>System.Management.Automation.SwitchParameter</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>PassThru</name>

        <description>

          <para>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. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        <type>

          <name>System.Management.Automation.SwitchParameter</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Select</name>

        <description>

          <para>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. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

    </parameters>

    <returnValues>

      <returnValue>

        <type>

          <name>Amazon.SageMakerRuntime.Model.InvokeEndpointResponse</name>

          <uri />

          <description />

        </type>

        <description>

          <para>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.</para>

        </description>

      </returnValue>

    </returnValues>

    <relatedLinks>

      <navigationLink>

        <linkText>Online version:</linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Invoke-SMREndpoint.html&amp;tocid=Invoke-SMREndpoint</uri>

      </navigationLink>

      <navigationLink>

        <linkText>Common credential and region parameters: </linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>

      </navigationLink>

      <navigationLink>

        <linkText>Developer Guide:</linkText>

        <uri>https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html</uri>

      </navigationLink>

      <navigationLink>

        <linkText>Service API Reference:</linkText>

        <uri>https://docs.aws.amazon.com/sagemaker/latest/dg/API_Operations_Amazon_SageMaker_Runtime.html</uri>

      </navigationLink>

    </relatedLinks>

  </command>

</helpItems>