AWS SDK for C++  1.8.54
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)
 
- 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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 168 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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 154 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.

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

◆ 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 258 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.

Definition at line 302 of file InvokeEndpointRequest.h.

◆ SetAccept() [1/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() [2/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() [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 ( 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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 182 of file InvokeEndpointRequest.h.

◆ SetCustomAttributes() [2/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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 196 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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 210 of file InvokeEndpointRequest.h.

◆ SetEndpointName() [1/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() [2/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() [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.

◆ SetTargetModel() [1/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 268 of file InvokeEndpointRequest.h.

◆ SetTargetModel() [2/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 273 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 278 of file InvokeEndpointRequest.h.

◆ SetTargetVariant() [1/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.

Definition at line 318 of file InvokeEndpointRequest.h.

◆ SetTargetVariant() [2/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.

Definition at line 326 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.

Definition at line 334 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 263 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.

Definition at line 310 of file InvokeEndpointRequest.h.

◆ WithAccept() [1/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() [2/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() [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 ( 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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 224 of file InvokeEndpointRequest.h.

◆ WithCustomAttributes() [2/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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 238 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). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

Definition at line 252 of file InvokeEndpointRequest.h.

◆ WithEndpointName() [1/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() [2/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() [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.

◆ WithTargetModel() [1/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 283 of file InvokeEndpointRequest.h.

◆ WithTargetModel() [2/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 288 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 293 of file InvokeEndpointRequest.h.

◆ WithTargetVariant() [1/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.

Definition at line 342 of file InvokeEndpointRequest.h.

◆ WithTargetVariant() [2/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.

Definition at line 350 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.

Definition at line 358 of file InvokeEndpointRequest.h.


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