NAME

Paws::SageMakerRuntime::InvokeEndpoint - Arguments for method InvokeEndpoint on Paws::SageMakerRuntime

DESCRIPTION

This class represents the parameters used for calling the method InvokeEndpoint on the Amazon SageMaker Runtime service. Use the attributes of this class as arguments to method InvokeEndpoint.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InvokeEndpoint.

SYNOPSIS

    my $runtime.sagemaker = Paws->service('SageMakerRuntime');
    my $InvokeEndpointOutput = $runtime . sagemaker->InvokeEndpoint(
      Body                    => 'BlobBodyBlob',
      EndpointName            => 'MyEndpointName',
      Accept                  => 'MyHeader',                          # OPTIONAL
      ContentType             => 'MyHeader',                          # OPTIONAL
      CustomAttributes        => 'MyCustomAttributesHeader',          # OPTIONAL
      InferenceId             => 'MyInferenceId',                     # OPTIONAL
      TargetContainerHostname => 'MyTargetContainerHostnameHeader',   # OPTIONAL
      TargetModel             => 'MyTargetModelHeader',               # OPTIONAL
      TargetVariant           => 'MyTargetVariantHeader',             # OPTIONAL
    );
    # Results:
    my $Body             = $InvokeEndpointOutput->Body;
    my $ContentType      = $InvokeEndpointOutput->ContentType;
    my $CustomAttributes = $InvokeEndpointOutput->CustomAttributes;
    my $InvokedProductionVariant =
      $InvokeEndpointOutput->InvokedProductionVariant;
    # Returns a L<Paws::SageMakerRuntime::InvokeEndpointOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/runtime.sagemaker/InvokeEndpoint>

ATTRIBUTES

Accept => Str

The desired MIME type of the inference in the response.

REQUIRED Body => Str

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 (https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html).

ContentType => Str

The MIME type of the input data in the request body.

CustomAttributes => Str

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 (https://tools.ietf.org/html/rfc7230#section-3.2.6) 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 AWS SDKs but not in the Amazon SageMaker Python SDK.

REQUIRED EndpointName => Str

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html) API.

InferenceId => Str

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 (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html).

TargetContainerHostname => Str

If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.

TargetModel => Str

The model to request for inference when invoking a multi-model endpoint.

TargetVariant => Str

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 (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html)

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>