Skip to main content

endpoint_with_response_streams

Creates, updates, deletes, gets or lists an endpoint_with_response_streams resource.

Overview​

Nameendpoint_with_response_streams
TypeResource
Idaws.sagemaker_runtime.endpoint_with_response_streams

Fields​

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
invoke_endpoint_with_response_streamexecendpoint_name, regionContent-Type, X-Amzn-SageMaker-Accept, X-Amzn-SageMaker-Custom-Attributes, X-Amzn-SageMaker-Target-Variant, X-Amzn-SageMaker-Target-Container-Hostname, X-Amzn-SageMaker-Inference-Id, X-Amzn-SageMaker-Inference-Component, X-Amzn-SageMaker-Session-Id, X-Amzn-SageMaker-Prefix-Aware-IdInvokes a model at the specified endpoint to return the inference response as a stream. The inference stream provides the response payload incrementally as a series of parts. Before you can get an inference stream, you must have access to a model that's deployed using Amazon SageMaker AI hosting services, and the container for that model must support inference streaming. For more information that can help you use this API, see the following sections in the Amazon SageMaker AI Developer Guide: For information about how to add streaming support to a model, see How Containers Serve Requests. For information about how to process the streaming response, see Invoke real-time endpoints. Before you can use this operation, your IAM permissions must allow the sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker AI actions for IAM policies, see Actions, resources, and condition keys for Amazon SageMaker AI in the IAM Service Authorization Reference. Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to InvokeEndpointWithResponseStream are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
endpoint_namestringThe name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
regionstringAWS region (default: us-east-1)
Content-TypestringThe MIME type of the input data in the request body.
X-Amzn-SageMaker-AcceptstringThe desired MIME type of the inference response from the model container.
X-Amzn-SageMaker-Custom-AttributesstringProvides 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.
X-Amzn-SageMaker-Inference-ComponentstringIf the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke for a streaming response.
X-Amzn-SageMaker-Inference-IdstringAn identifier that you assign to your request.
X-Amzn-SageMaker-Prefix-Aware-IdstringAn optional, stable identifier that serves as a routing hint for prefix-aware routing. The service routes requests with the same prefix and the same identifier to the same instance. If requests from different applications might have the same prompt prefix, set a different identifier for each application to differentiate their routing decisions. Applies only to endpoints configured with a RoutingStrategy of PREFIX_AWARE.
X-Amzn-SageMaker-Session-IdstringThe ID of a stateful session to handle your request. You can't create a stateful session by using the InvokeEndpointWithResponseStream action. Instead, you can create one by using the InvokeEndpoint action. In your request, you specify NEW_SESSION for the SessionId request parameter. The response to that request provides the session ID for the NewSessionId response parameter.
X-Amzn-SageMaker-Target-Container-HostnamestringIf the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.
X-Amzn-SageMaker-Target-VariantstringSpecify 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

Lifecycle Methods​

Invokes a model at the specified endpoint to return the inference response as a stream. The inference stream provides the response payload incrementally as a series of parts. Before you can get an inference stream, you must have access to a model that's deployed using Amazon SageMaker AI hosting services, and the container for that model must support inference streaming. For more information that can help you use this API, see the following sections in the Amazon SageMaker AI Developer Guide: For information about how to add streaming support to a model, see How Containers Serve Requests. For information about how to process the streaming response, see Invoke real-time endpoints. Before you can use this operation, your IAM permissions must allow the sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker AI actions for IAM policies, see Actions, resources, and condition keys for Amazon SageMaker AI in the IAM Service Authorization Reference. Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to InvokeEndpointWithResponseStream are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

EXEC aws.sagemaker_runtime.endpoint_with_response_streams.invoke_endpoint_with_response_stream
@endpoint_name='{{ endpoint_name }}' --required,
@region='{{ region }}' --required,
@Content-Type='{{ Content-Type }}',
@X-Amzn-SageMaker-Accept='{{ X-Amzn-SageMaker-Accept }}',
@X-Amzn-SageMaker-Custom-Attributes='{{ X-Amzn-SageMaker-Custom-Attributes }}',
@X-Amzn-SageMaker-Target-Variant='{{ X-Amzn-SageMaker-Target-Variant }}',
@X-Amzn-SageMaker-Target-Container-Hostname='{{ X-Amzn-SageMaker-Target-Container-Hostname }}',
@X-Amzn-SageMaker-Inference-Id='{{ X-Amzn-SageMaker-Inference-Id }}',
@X-Amzn-SageMaker-Inference-Component='{{ X-Amzn-SageMaker-Inference-Component }}',
@X-Amzn-SageMaker-Session-Id='{{ X-Amzn-SageMaker-Session-Id }}',
@X-Amzn-SageMaker-Prefix-Aware-Id='{{ X-Amzn-SageMaker-Prefix-Aware-Id }}'
@@json=
'{
"Body": "{{ Body }}"
}'
;