libZSservicesZSamazonka-sagemaker-runtimeZSamazonka-sagemaker-runtime
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMakerRuntime.Lens

Description

 
Synopsis

Operations

InvokeEndpointAsync

invokeEndpointAsync_accept :: Lens' InvokeEndpointAsync (Maybe Text) Source #

The desired MIME type of the inference in the response.

invokeEndpointAsync_customAttributes :: Lens' InvokeEndpointAsync (Maybe Text) Source #

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

invokeEndpointAsync_inferenceId :: Lens' InvokeEndpointAsync (Maybe Text) Source #

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

invokeEndpointAsync_requestTTLSeconds :: Lens' InvokeEndpointAsync (Maybe Natural) Source #

Maximum age in seconds a request can be in the queue before it is marked as expired.

invokeEndpointAsync_contentType :: Lens' InvokeEndpointAsync (Maybe Text) Source #

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

invokeEndpointAsync_endpointName :: Lens' InvokeEndpointAsync Text Source #

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

invokeEndpointAsync_inputLocation :: Lens' InvokeEndpointAsync Text Source #

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

invokeEndpointAsyncResponse_outputLocation :: Lens' InvokeEndpointAsyncResponse (Maybe Text) Source #

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

invokeEndpointAsyncResponse_inferenceId :: Lens' InvokeEndpointAsyncResponse (Maybe Text) Source #

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.

InvokeEndpoint

invokeEndpoint_accept :: Lens' InvokeEndpoint (Maybe Text) Source #

The desired MIME type of the inference in the response.

invokeEndpoint_targetModel :: Lens' InvokeEndpoint (Maybe Text) Source #

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

invokeEndpoint_customAttributes :: Lens' InvokeEndpoint (Maybe Text) Source #

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

invokeEndpoint_inferenceId :: Lens' InvokeEndpoint (Maybe Text) Source #

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.

invokeEndpoint_targetVariant :: Lens' InvokeEndpoint (Maybe Text) Source #

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

invokeEndpoint_contentType :: Lens' InvokeEndpoint (Maybe Text) Source #

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

invokeEndpoint_targetContainerHostname :: Lens' InvokeEndpoint (Maybe Text) Source #

If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.

invokeEndpoint_endpointName :: Lens' InvokeEndpoint Text Source #

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

invokeEndpoint_body :: Lens' InvokeEndpoint Text Source #

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.

invokeEndpointResponse_invokedProductionVariant :: Lens' InvokeEndpointResponse (Maybe Text) Source #

Identifies the production variant that was invoked.

invokeEndpointResponse_customAttributes :: Lens' InvokeEndpointResponse (Maybe Text) Source #

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

invokeEndpointResponse_contentType :: Lens' InvokeEndpointResponse (Maybe Text) Source #

The MIME type of the inference returned in the response body.

invokeEndpointResponse_body :: Lens' InvokeEndpointResponse Text Source #

Includes the inference provided by the model.

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

Types