Serialized Form

Package com.amazonaws.services.sagemakerruntime.model

Class com.amazonaws.services.sagemakerruntime.model.AmazonSageMakerRuntimeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sagemakerruntime.model.InternalDependencyException extends AmazonSageMakerRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sagemakerruntime.model.InternalFailureException extends AmazonSageMakerRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sagemakerruntime.model.InvokeEndpointAsyncRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointName

String endpointName

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

contentType

String contentType

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

accept

String accept

The desired MIME type of the inference response from the model container.

customAttributes

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.

inferenceId

String inferenceId

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

inputLocation

String inputLocation

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

requestTTLSeconds

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.

invocationTimeoutSeconds

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.

Class com.amazonaws.services.sagemakerruntime.model.InvokeEndpointAsyncResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

inferenceId

String inferenceId

Identifier for an inference request. This will be the same as the InferenceId specified in the input. Amazon SageMaker will generate an identifier for you if you do not specify one.

outputLocation

String outputLocation

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

failureLocation

String failureLocation

The Amazon S3 URI where the inference failure response payload is stored.

Class com.amazonaws.services.sagemakerruntime.model.InvokeEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointName

String endpointName

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

body

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.

contentType

String contentType

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

accept

String accept

The desired MIME type of the inference response from the model container.

customAttributes

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.

targetModel

String targetModel

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

targetVariant

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

targetContainerHostname

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.

inferenceId

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.

enableExplanations

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.

inferenceComponentName

String inferenceComponentName

If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.

Class com.amazonaws.services.sagemakerruntime.model.InvokeEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

body

ByteBuffer body

Includes the inference provided by the model.

For information about the format of the response body, see Common Data Formats-Inference.

If the explainer is activated, the body includes the explanations provided by the model. For more information, see the Response section under Invoke the Endpoint in the Developer Guide.

contentType

String contentType

The MIME type of the inference returned from the model container.

invokedProductionVariant

String invokedProductionVariant

Identifies the production variant that was invoked.

customAttributes

String customAttributes

Provides additional information in the response about the inference returned by 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 return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. 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). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.

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.

Class com.amazonaws.services.sagemakerruntime.model.ModelErrorException extends AmazonSageMakerRuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

originalStatusCode

Integer originalStatusCode

Original status code.

originalMessage

String originalMessage

Original message.

logStreamArn

String logStreamArn

The Amazon Resource Name (ARN) of the log stream.

Class com.amazonaws.services.sagemakerruntime.model.ModelNotReadyException extends AmazonSageMakerRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sagemakerruntime.model.ServiceUnavailableException extends AmazonSageMakerRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sagemakerruntime.model.ValidationErrorException extends AmazonSageMakerRuntimeException implements Serializable

serialVersionUID:

1L