Package software.amazon.awssdk.services.sagemakerruntime.model

Class InvokeEndpointAsyncRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InvokeEndpointAsyncRequest.Builder,InvokeEndpointAsyncRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvokeEndpointAsyncRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accept()	The desired MIME type of the inference response from the model container.
static InvokeEndpointAsyncRequest.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	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	inferenceId()	The identifier for the inference request.
String	inputLocation()	The Amazon S3 URI where the inference request payload is stored.
Integer	invocationTimeoutSeconds()	Maximum amount of time in seconds a request can be processed before it is marked as expired.
Integer	requestTTLSeconds()	Maximum age in seconds a request can be in the queue before it is marked as expired.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InvokeEndpointAsyncRequest.Builder>	serializableBuilderClass()
InvokeEndpointAsyncRequest.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.

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.

inferenceId

public final String inferenceId()

The identifier for the inference request. Amazon SageMaker AI will generate an identifier for you if none is specified.

Returns:

The identifier for the inference request. Amazon SageMaker AI will generate an identifier for you if none is specified.

inputLocation

public final String inputLocation()

The Amazon S3 URI where the inference request payload is stored.

Returns:

The Amazon S3 URI where the inference request payload is stored.

requestTTLSeconds

public final Integer requestTTLSeconds()

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

Returns:

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

invocationTimeoutSeconds

public final Integer invocationTimeoutSeconds()

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

Returns:

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

toBuilder

public InvokeEndpointAsyncRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvokeEndpointAsyncRequest.Builder,InvokeEndpointAsyncRequest>

Specified by:

toBuilder in class SageMakerRuntimeRequest

builder

public static InvokeEndpointAsyncRequest.Builder builder()

serializableBuilderClass

public static Class<? extends InvokeEndpointAsyncRequest.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