com.amazonaws.services.sagemakerruntime.model

Class InvokeEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemakerruntime.model.InvokeEndpointRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InvokeEndpointRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
InvokeEndpointRequest()

Method Summary

Modifier and Type	Method and Description
InvokeEndpointRequest	clone()
boolean	equals(Object obj)
String	getAccept() The desired MIME type of the inference in the response.
ByteBuffer	getBody() Provides input data, in the format specified in the ContentType request header.
String	getContentType() The MIME type of the input data in the request body.
String	getCustomAttributes() Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.
String	getEndpointName() The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
String	getInferenceId() If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
String	getTargetContainerHostname() 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	getTargetModel() The model to request for inference when invoking a multi-model endpoint.
String	getTargetVariant() Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants.
int	hashCode()
void	setAccept(String accept) The desired MIME type of the inference in the response.
void	setBody(ByteBuffer body) Provides input data, in the format specified in the ContentType request header.
void	setContentType(String contentType) The MIME type of the input data in the request body.
void	setCustomAttributes(String customAttributes) Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.
void	setEndpointName(String endpointName) The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
void	setInferenceId(String inferenceId) If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
void	setTargetContainerHostname(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.
void	setTargetModel(String targetModel) The model to request for inference when invoking a multi-model endpoint.
void	setTargetVariant(String targetVariant) Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants.
String	toString() Returns a string representation of this object.
InvokeEndpointRequest	withAccept(String accept) The desired MIME type of the inference in the response.
InvokeEndpointRequest	withBody(ByteBuffer body) Provides input data, in the format specified in the ContentType request header.
InvokeEndpointRequest	withContentType(String contentType) The MIME type of the input data in the request body.
InvokeEndpointRequest	withCustomAttributes(String customAttributes) Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.
InvokeEndpointRequest	withEndpointName(String endpointName) The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
InvokeEndpointRequest	withInferenceId(String inferenceId) If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
InvokeEndpointRequest	withTargetContainerHostname(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.
InvokeEndpointRequest	withTargetModel(String targetModel) The model to request for inference when invoking a multi-model endpoint.
InvokeEndpointRequest	withTargetVariant(String targetVariant) Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvokeEndpointRequest

public InvokeEndpointRequest()

Method Detail

setEndpointName

public void setEndpointName(String endpointName)

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

Parameters:

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

getEndpointName

public String getEndpointName()

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.

withEndpointName

public InvokeEndpointRequest withEndpointName(String endpointName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setBody

public void setBody(ByteBuffer body)

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.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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

getBody

public ByteBuffer getBody()

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.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

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.

withBody

public InvokeEndpointRequest withBody(ByteBuffer body)

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.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setContentType

public void setContentType(String contentType)

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

Parameters:

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

getContentType

public String getContentType()

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

Returns:

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

withContentType

public InvokeEndpointRequest withContentType(String contentType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAccept

public void setAccept(String accept)

The desired MIME type of the inference in the response.

Parameters:

accept - The desired MIME type of the inference in the response.

getAccept

public String getAccept()

The desired MIME type of the inference in the response.

Returns:

The desired MIME type of the inference in the response.

withAccept

public InvokeEndpointRequest withAccept(String accept)

The desired MIME type of the inference in the response.

Parameters:

accept - The desired MIME type of the inference in the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCustomAttributes

public void setCustomAttributes(String customAttributes)

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

Parameters:

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

getCustomAttributes

public String getCustomAttributes()

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

Returns:

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

withCustomAttributes

public InvokeEndpointRequest withCustomAttributes(String customAttributes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTargetModel

public void setTargetModel(String targetModel)

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

Parameters:

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

getTargetModel

public String getTargetModel()

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.

withTargetModel

public InvokeEndpointRequest withTargetModel(String targetModel)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTargetVariant

public void setTargetVariant(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

Parameters:

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

getTargetVariant

public String getTargetVariant()

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

withTargetVariant

public InvokeEndpointRequest withTargetVariant(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTargetContainerHostname

public void setTargetContainerHostname(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.

Parameters:

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.

getTargetContainerHostname

public String getTargetContainerHostname()

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.

withTargetContainerHostname

public InvokeEndpointRequest withTargetContainerHostname(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setInferenceId

public void setInferenceId(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.

Parameters:

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.

getInferenceId

public String getInferenceId()

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.

withInferenceId

public InvokeEndpointRequest withInferenceId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public InvokeEndpointRequest clone()

Overrides:

clone in class AmazonWebServiceRequest