API version 2017-05-13 of the Amazon SageMaker Runtime SDK configuration.

Your request caused an exception with an internal dependency. Contact customer support.

An internal failure occurred.

Model (owned by the customer in the container) returned 4xx or 5xx error code.

Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again.

The service is unavailable. Try your call again.

Inspect your request and try again.

See: newInvokeEndpoint smart constructor.

Create a value of InvokeEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accept:InvokeEndpoint', invokeEndpoint_accept - The desired MIME type of the inference in the response.

InvokeEndpoint, invokeEndpoint_contentType - The MIME type of the input data in the request body.

InvokeEndpoint, invokeEndpoint_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.

$sel:enableExplanations:InvokeEndpoint', invokeEndpoint_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.

$sel:inferenceId:InvokeEndpoint', invokeEndpoint_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.

$sel:targetContainerHostname:InvokeEndpoint', invokeEndpoint_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.

$sel:targetModel:InvokeEndpoint', invokeEndpoint_targetModel - The model to request for inference when invoking a multi-model endpoint.

$sel:targetVariant:InvokeEndpoint', invokeEndpoint_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

$sel:endpointName:InvokeEndpoint', invokeEndpoint_endpointName - The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

InvokeEndpoint, invokeEndpoint_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.

See: newInvokeEndpointResponse smart constructor.

Create a value of InvokeEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

InvokeEndpoint, invokeEndpointResponse_contentType - The MIME type of the inference returned in the response body.

InvokeEndpoint, invokeEndpointResponse_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.

$sel:invokedProductionVariant:InvokeEndpointResponse', invokeEndpointResponse_invokedProductionVariant - Identifies the production variant that was invoked.

$sel:httpStatus:InvokeEndpointResponse', invokeEndpointResponse_httpStatus - The response's http status code.

InvokeEndpoint, invokeEndpointResponse_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.

See: newInvokeEndpointAsync smart constructor.

Create a value of InvokeEndpointAsync with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accept:InvokeEndpointAsync', invokeEndpointAsync_accept - The desired MIME type of the inference in the response.

$sel:contentType:InvokeEndpointAsync', invokeEndpointAsync_contentType - The MIME type of the input data in the request body.

$sel:customAttributes:InvokeEndpointAsync', invokeEndpointAsync_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.

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

$sel:requestTTLSeconds:InvokeEndpointAsync', invokeEndpointAsync_requestTTLSeconds - Maximum age in seconds a request can be in the queue before it is marked as expired.

$sel:endpointName:InvokeEndpointAsync', invokeEndpointAsync_endpointName - The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

$sel:inputLocation:InvokeEndpointAsync', invokeEndpointAsync_inputLocation - The Amazon S3 URI where the inference request payload is stored.

See: newInvokeEndpointAsyncResponse smart constructor.

Create a value of InvokeEndpointAsyncResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

InvokeEndpointAsync, invokeEndpointAsyncResponse_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.

$sel:outputLocation:InvokeEndpointAsyncResponse', invokeEndpointAsyncResponse_outputLocation - The Amazon S3 URI where the inference response payload is stored.

$sel:httpStatus:InvokeEndpointAsyncResponse', invokeEndpointAsyncResponse_httpStatus - The response's http status code.