AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMakerRuntime::Model::InvokeEndpointRequest Class Reference

#include <InvokeEndpointRequest.h>

+ Inheritance diagram for Aws::SageMakerRuntime::Model::InvokeEndpointRequest:

Public Member Functions

 InvokeEndpointRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetEndpointName () const
 
bool EndpointNameHasBeenSet () const
 
void SetEndpointName (const Aws::String &value)
 
void SetEndpointName (Aws::String &&value)
 
void SetEndpointName (const char *value)
 
InvokeEndpointRequestWithEndpointName (const Aws::String &value)
 
InvokeEndpointRequestWithEndpointName (Aws::String &&value)
 
InvokeEndpointRequestWithEndpointName (const char *value)
 
const Aws::StringGetAccept () const
 
bool AcceptHasBeenSet () const
 
void SetAccept (const Aws::String &value)
 
void SetAccept (Aws::String &&value)
 
void SetAccept (const char *value)
 
InvokeEndpointRequestWithAccept (const Aws::String &value)
 
InvokeEndpointRequestWithAccept (Aws::String &&value)
 
InvokeEndpointRequestWithAccept (const char *value)
 
const Aws::StringGetCustomAttributes () const
 
bool CustomAttributesHasBeenSet () const
 
void SetCustomAttributes (const Aws::String &value)
 
void SetCustomAttributes (Aws::String &&value)
 
void SetCustomAttributes (const char *value)
 
InvokeEndpointRequestWithCustomAttributes (const Aws::String &value)
 
InvokeEndpointRequestWithCustomAttributes (Aws::String &&value)
 
InvokeEndpointRequestWithCustomAttributes (const char *value)
 
const Aws::StringGetTargetModel () const
 
bool TargetModelHasBeenSet () const
 
void SetTargetModel (const Aws::String &value)
 
void SetTargetModel (Aws::String &&value)
 
void SetTargetModel (const char *value)
 
InvokeEndpointRequestWithTargetModel (const Aws::String &value)
 
InvokeEndpointRequestWithTargetModel (Aws::String &&value)
 
InvokeEndpointRequestWithTargetModel (const char *value)
 
const Aws::StringGetTargetVariant () const
 
bool TargetVariantHasBeenSet () const
 
void SetTargetVariant (const Aws::String &value)
 
void SetTargetVariant (Aws::String &&value)
 
void SetTargetVariant (const char *value)
 
InvokeEndpointRequestWithTargetVariant (const Aws::String &value)
 
InvokeEndpointRequestWithTargetVariant (Aws::String &&value)
 
InvokeEndpointRequestWithTargetVariant (const char *value)
 
const Aws::StringGetTargetContainerHostname () const
 
bool TargetContainerHostnameHasBeenSet () const
 
void SetTargetContainerHostname (const Aws::String &value)
 
void SetTargetContainerHostname (Aws::String &&value)
 
void SetTargetContainerHostname (const char *value)
 
InvokeEndpointRequestWithTargetContainerHostname (const Aws::String &value)
 
InvokeEndpointRequestWithTargetContainerHostname (Aws::String &&value)
 
InvokeEndpointRequestWithTargetContainerHostname (const char *value)
 
const Aws::StringGetInferenceId () const
 
bool InferenceIdHasBeenSet () const
 
void SetInferenceId (const Aws::String &value)
 
void SetInferenceId (Aws::String &&value)
 
void SetInferenceId (const char *value)
 
InvokeEndpointRequestWithInferenceId (const Aws::String &value)
 
InvokeEndpointRequestWithInferenceId (Aws::String &&value)
 
InvokeEndpointRequestWithInferenceId (const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file InvokeEndpointRequest.h.

Constructor & Destructor Documentation

◆ InvokeEndpointRequest()

Aws::SageMakerRuntime::Model::InvokeEndpointRequest::InvokeEndpointRequest ( )

Member Function Documentation

◆ AcceptHasBeenSet()

bool Aws::SageMakerRuntime::Model::InvokeEndpointRequest::AcceptHasBeenSet ( ) const
inline

The desired MIME type of the inference in the response.

Definition at line 109 of file InvokeEndpointRequest.h.

◆ CustomAttributesHasBeenSet()

bool Aws::SageMakerRuntime::Model::InvokeEndpointRequest::CustomAttributesHasBeenSet ( ) const
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 176 of file InvokeEndpointRequest.h.

◆ EndpointNameHasBeenSet()

bool Aws::SageMakerRuntime::Model::InvokeEndpointRequest::EndpointNameHasBeenSet ( ) const
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 50 of file InvokeEndpointRequest.h.

◆ GetAccept()

const Aws::String& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetAccept ( ) const
inline

The desired MIME type of the inference in the response.

Definition at line 104 of file InvokeEndpointRequest.h.

◆ GetCustomAttributes()

const Aws::String& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetCustomAttributes ( ) const
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 158 of file InvokeEndpointRequest.h.

◆ GetEndpointName()

const Aws::String& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetEndpointName ( ) const
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 42 of file InvokeEndpointRequest.h.

◆ GetInferenceId()

const Aws::String& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetInferenceId ( ) const
inline

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.

Definition at line 480 of file InvokeEndpointRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file InvokeEndpointRequest.h.

◆ GetTargetContainerHostname()

const Aws::String& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetTargetContainerHostname ( ) const
inline

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

Definition at line 422 of file InvokeEndpointRequest.h.

◆ GetTargetModel()

const Aws::String& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetTargetModel ( ) const
inline

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

Definition at line 290 of file InvokeEndpointRequest.h.

◆ GetTargetVariant()

const Aws::String& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::GetTargetVariant ( ) const
inline

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

Definition at line 337 of file InvokeEndpointRequest.h.

◆ InferenceIdHasBeenSet()

bool Aws::SageMakerRuntime::Model::InvokeEndpointRequest::InferenceIdHasBeenSet ( ) const
inline

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.

Definition at line 488 of file InvokeEndpointRequest.h.

◆ SetAccept() [1/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetAccept ( Aws::String &&  value)
inline

The desired MIME type of the inference in the response.

Definition at line 119 of file InvokeEndpointRequest.h.

◆ SetAccept() [2/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetAccept ( const Aws::String value)
inline

The desired MIME type of the inference in the response.

Definition at line 114 of file InvokeEndpointRequest.h.

◆ SetAccept() [3/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetAccept ( const char *  value)
inline

The desired MIME type of the inference in the response.

Definition at line 124 of file InvokeEndpointRequest.h.

◆ SetCustomAttributes() [1/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetCustomAttributes ( Aws::String &&  value)
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 212 of file InvokeEndpointRequest.h.

◆ SetCustomAttributes() [2/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetCustomAttributes ( const Aws::String value)
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 194 of file InvokeEndpointRequest.h.

◆ SetCustomAttributes() [3/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetCustomAttributes ( const char *  value)
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 230 of file InvokeEndpointRequest.h.

◆ SetEndpointName() [1/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetEndpointName ( Aws::String &&  value)
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 66 of file InvokeEndpointRequest.h.

◆ SetEndpointName() [2/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetEndpointName ( const Aws::String value)
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 58 of file InvokeEndpointRequest.h.

◆ SetEndpointName() [3/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetEndpointName ( const char *  value)
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 74 of file InvokeEndpointRequest.h.

◆ SetInferenceId() [1/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetInferenceId ( Aws::String &&  value)
inline

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.

Definition at line 504 of file InvokeEndpointRequest.h.

◆ SetInferenceId() [2/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetInferenceId ( const Aws::String value)
inline

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.

Definition at line 496 of file InvokeEndpointRequest.h.

◆ SetInferenceId() [3/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetInferenceId ( const char *  value)
inline

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.

Definition at line 512 of file InvokeEndpointRequest.h.

◆ SetTargetContainerHostname() [1/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetContainerHostname ( Aws::String &&  value)
inline

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

Definition at line 443 of file InvokeEndpointRequest.h.

◆ SetTargetContainerHostname() [2/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetContainerHostname ( const Aws::String value)
inline

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

Definition at line 436 of file InvokeEndpointRequest.h.

◆ SetTargetContainerHostname() [3/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetContainerHostname ( const char *  value)
inline

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

Definition at line 450 of file InvokeEndpointRequest.h.

◆ SetTargetModel() [1/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetModel ( Aws::String &&  value)
inline

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

Definition at line 305 of file InvokeEndpointRequest.h.

◆ SetTargetModel() [2/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetModel ( const Aws::String value)
inline

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

Definition at line 300 of file InvokeEndpointRequest.h.

◆ SetTargetModel() [3/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetModel ( const char *  value)
inline

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

Definition at line 310 of file InvokeEndpointRequest.h.

◆ SetTargetVariant() [1/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetVariant ( Aws::String &&  value)
inline

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

Definition at line 370 of file InvokeEndpointRequest.h.

◆ SetTargetVariant() [2/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetVariant ( const Aws::String value)
inline

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

Definition at line 359 of file InvokeEndpointRequest.h.

◆ SetTargetVariant() [3/3]

void Aws::SageMakerRuntime::Model::InvokeEndpointRequest::SetTargetVariant ( const char *  value)
inline

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

Definition at line 381 of file InvokeEndpointRequest.h.

◆ TargetContainerHostnameHasBeenSet()

bool Aws::SageMakerRuntime::Model::InvokeEndpointRequest::TargetContainerHostnameHasBeenSet ( ) const
inline

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

Definition at line 429 of file InvokeEndpointRequest.h.

◆ TargetModelHasBeenSet()

bool Aws::SageMakerRuntime::Model::InvokeEndpointRequest::TargetModelHasBeenSet ( ) const
inline

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

Definition at line 295 of file InvokeEndpointRequest.h.

◆ TargetVariantHasBeenSet()

bool Aws::SageMakerRuntime::Model::InvokeEndpointRequest::TargetVariantHasBeenSet ( ) const
inline

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

Definition at line 348 of file InvokeEndpointRequest.h.

◆ WithAccept() [1/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithAccept ( Aws::String &&  value)
inline

The desired MIME type of the inference in the response.

Definition at line 134 of file InvokeEndpointRequest.h.

◆ WithAccept() [2/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithAccept ( const Aws::String value)
inline

The desired MIME type of the inference in the response.

Definition at line 129 of file InvokeEndpointRequest.h.

◆ WithAccept() [3/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithAccept ( const char *  value)
inline

The desired MIME type of the inference in the response.

Definition at line 139 of file InvokeEndpointRequest.h.

◆ WithCustomAttributes() [1/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithCustomAttributes ( Aws::String &&  value)
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 266 of file InvokeEndpointRequest.h.

◆ WithCustomAttributes() [2/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithCustomAttributes ( const Aws::String value)
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 248 of file InvokeEndpointRequest.h.

◆ WithCustomAttributes() [3/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithCustomAttributes ( const char *  value)
inline

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 284 of file InvokeEndpointRequest.h.

◆ WithEndpointName() [1/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithEndpointName ( Aws::String &&  value)
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 90 of file InvokeEndpointRequest.h.

◆ WithEndpointName() [2/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithEndpointName ( const Aws::String value)
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 82 of file InvokeEndpointRequest.h.

◆ WithEndpointName() [3/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithEndpointName ( const char *  value)
inline

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Definition at line 98 of file InvokeEndpointRequest.h.

◆ WithInferenceId() [1/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithInferenceId ( Aws::String &&  value)
inline

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.

Definition at line 528 of file InvokeEndpointRequest.h.

◆ WithInferenceId() [2/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithInferenceId ( const Aws::String value)
inline

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.

Definition at line 520 of file InvokeEndpointRequest.h.

◆ WithInferenceId() [3/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithInferenceId ( const char *  value)
inline

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.

Definition at line 536 of file InvokeEndpointRequest.h.

◆ WithTargetContainerHostname() [1/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetContainerHostname ( Aws::String &&  value)
inline

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

Definition at line 464 of file InvokeEndpointRequest.h.

◆ WithTargetContainerHostname() [2/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetContainerHostname ( const Aws::String value)
inline

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

Definition at line 457 of file InvokeEndpointRequest.h.

◆ WithTargetContainerHostname() [3/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetContainerHostname ( const char *  value)
inline

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

Definition at line 471 of file InvokeEndpointRequest.h.

◆ WithTargetModel() [1/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetModel ( Aws::String &&  value)
inline

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

Definition at line 320 of file InvokeEndpointRequest.h.

◆ WithTargetModel() [2/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetModel ( const Aws::String value)
inline

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

Definition at line 315 of file InvokeEndpointRequest.h.

◆ WithTargetModel() [3/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetModel ( const char *  value)
inline

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

Definition at line 325 of file InvokeEndpointRequest.h.

◆ WithTargetVariant() [1/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetVariant ( Aws::String &&  value)
inline

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

Definition at line 403 of file InvokeEndpointRequest.h.

◆ WithTargetVariant() [2/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetVariant ( const Aws::String value)
inline

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

Definition at line 392 of file InvokeEndpointRequest.h.

◆ WithTargetVariant() [3/3]

InvokeEndpointRequest& Aws::SageMakerRuntime::Model::InvokeEndpointRequest::WithTargetVariant ( const char *  value)
inline

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

Definition at line 414 of file InvokeEndpointRequest.h.


The documentation for this class was generated from the following file: