java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sagemakerruntime.model.SageMakerRuntimeRequest
    - - software.amazon.awssdk.services.sagemakerruntime.model.InvokeEndpointRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<InvokeEndpointRequest.Builder,InvokeEndpointRequest>

@Generated("software.amazon.awssdk:codegen")
public final class InvokeEndpointRequest
extends SageMakerRuntimeRequest
implements ToCopyableBuilder<InvokeEndpointRequest.Builder,InvokeEndpointRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InvokeEndpointRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accept()`	The desired MIME type of the inference response from the model container.
`SdkBytes`	`body()`	Provides input data, in the format specified in the `ContentType` request header.
`static InvokeEndpointRequest.Builder`	`builder()`
`String`	`contentType()`	The MIME type of the input data in the request body.
`String`	`customAttributes()`	Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker AI endpoint.
`String`	`enableExplanations()`	An optional JMESPath expression used to override the `EnableExplanations` parameter of the `ClarifyExplainerConfig` API.
`String`	`endpointName()`	The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`inferenceComponentName()`	If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
`String`	`inferenceId()`	If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InvokeEndpointRequest.Builder>`	`serializableBuilderClass()`
`String`	`sessionId()`	Creates a stateful session or identifies an existing one.
`String`	`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.
`String`	`targetModel()`	The model to request for inference when invoking a multi-model endpoint.
`String`	`targetVariant()`	Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants.
`InvokeEndpointRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - endpointName
```
public final String endpointName()
```
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
    
    Returns:
    
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
  - body
```
public final SdkBytes body()
```
    Provides input data, in the format specified in the ContentType request header. Amazon SageMaker AI 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.
    
    Returns:
    
    Provides input data, in the format specified in the ContentType request header. Amazon SageMaker AI 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.
  - contentType
```
public final String contentType()
```
    The MIME type of the input data in the request body.
    
    Returns:
    
    The MIME type of the input data in the request body.
  - accept
```
public final String accept()
```
    The desired MIME type of the inference response from the model container.
    
    Returns:
    
    The desired MIME type of the inference response from the model container.
  - customAttributes
```
public final String customAttributes()
```
    Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker AI 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 AI Python SDK.
    
    Returns:
    
    Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker AI 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 AI Python SDK.
  - targetModel
```
public final String targetModel()
```
    The model to request for inference when invoking a multi-model endpoint.
    
    Returns:
    
    The model to request for inference when invoking a multi-model endpoint.
  - targetVariant
```
public final String 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
    
    Returns:
    
    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
  - targetContainerHostname
```
public final String 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.
    
    Returns:
    
    If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.
  - inferenceId
```
public final String 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.
    
    Returns:
    
    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.
  - enableExplanations
```
public final String enableExplanations()
```
    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.
    
    Returns:
    
    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.
  - inferenceComponentName
```
public final String inferenceComponentName()
```
    If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
    
    Returns:
    
    If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
  - sessionId
```
public final String sessionId()
```
    Creates a stateful session or identifies an existing one. You can do one of the following:
    
    Create a stateful session by specifying the value NEW_SESSION.
    
    Send your request to an existing stateful session by specifying the ID of that session.
    
    With a stateful session, you can send multiple requests to a stateful model. When you create a session with a stateful model, the model must create the session ID and set the expiration time. The model must also provide that information in the response to your request. You can get the ID and timestamp from the NewSessionId response parameter. For any subsequent request where you specify that session ID, SageMaker AI routes the request to the same instance that supports the session.
    Returns:
    
    Creates a stateful session or identifies an existing one. You can do one of the following:
    
    Create a stateful session by specifying the value NEW_SESSION.
    
    Send your request to an existing stateful session by specifying the ID of that session.
    
    With a stateful session, you can send multiple requests to a stateful model. When you create a session with a stateful model, the model must create the session ID and set the expiration time. The model must also provide that information in the response to your request. You can get the ID and timestamp from the NewSessionId response parameter. For any subsequent request where you specify that session ID, SageMaker AI routes the request to the same instance that supports the session.
  - toBuilder
```
public InvokeEndpointRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InvokeEndpointRequest.Builder,InvokeEndpointRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRuntimeRequest
  - builder
```
public static InvokeEndpointRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InvokeEndpointRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class InvokeEndpointRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

endpointName

body

contentType

accept

customAttributes

targetModel

targetVariant

targetContainerHostname

inferenceId

enableExplanations

inferenceComponentName

sessionId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField