Struct InvokeEndpointWithResponseStreamInput

#[non_exhaustive]
pub struct InvokeEndpointWithResponseStreamInput {
    pub endpoint_name: Option<String>,
    pub body: Option<Blob>,
    pub content_type: Option<String>,
    pub accept: Option<String>,
    pub custom_attributes: Option<String>,
    pub target_variant: Option<String>,
    pub target_container_hostname: Option<String>,
    pub inference_id: Option<String>,
    pub inference_component_name: Option<String>,
    pub session_id: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

endpoint_name: Option<String>

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

body: Option<Blob>

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.

content_type: Option<String>

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

accept: Option<String>

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

custom_attributes: Option<String>

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.

target_variant: Option<String>

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

target_container_hostname: Option<String>

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

inference_id: Option<String>

An identifier that you assign to your request.

inference_component_name: Option<String>

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

session_id: Option<String>

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

Implementations

impl InvokeEndpointWithResponseStreamInput

pub fn endpoint_name(&self) -> Option<&str>

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

pub fn body(&self) -> Option<&Blob>

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.

pub fn content_type(&self) -> Option<&str>

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

pub fn accept(&self) -> Option<&str>

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

pub fn custom_attributes(&self) -> Option<&str>

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.

pub fn target_variant(&self) -> Option<&str>

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

pub fn target_container_hostname(&self) -> Option<&str>

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

pub fn inference_id(&self) -> Option<&str>

An identifier that you assign to your request.

pub fn inference_component_name(&self) -> Option<&str>

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

pub fn session_id(&self) -> Option<&str>

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

impl InvokeEndpointWithResponseStreamInput

pub fn builder() -> InvokeEndpointWithResponseStreamInputBuilder

Creates a new builder-style object to manufacture InvokeEndpointWithResponseStreamInput.

Trait Implementations

impl Clone for InvokeEndpointWithResponseStreamInput

fn clone(&self) -> InvokeEndpointWithResponseStreamInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InvokeEndpointWithResponseStreamInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for InvokeEndpointWithResponseStreamInput

fn eq(&self, other: &InvokeEndpointWithResponseStreamInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InvokeEndpointWithResponseStreamInput