#[non_exhaustive]pub struct InvokeEndpointInput {
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_model: Option<String>,
pub target_variant: Option<String>,
pub target_container_hostname: Option<String>,
pub inference_id: Option<String>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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 in the response.
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_model: Option<String>
The model to request for inference when invoking a multi-model endpoint.
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>
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.
Implementations
sourceimpl InvokeEndpointInput
impl InvokeEndpointInput
sourcepub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<InvokeEndpoint, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<InvokeEndpoint, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<InvokeEndpoint
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture InvokeEndpointInput
sourceimpl InvokeEndpointInput
impl InvokeEndpointInput
sourcepub fn endpoint_name(&self) -> Option<&str>
pub fn endpoint_name(&self) -> Option<&str>
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
sourcepub fn body(&self) -> Option<&Blob>
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.
sourcepub fn content_type(&self) -> Option<&str>
pub fn content_type(&self) -> Option<&str>
The MIME type of the input data in the request body.
sourcepub fn custom_attributes(&self) -> Option<&str>
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.
sourcepub fn target_model(&self) -> Option<&str>
pub fn target_model(&self) -> Option<&str>
The model to request for inference when invoking a multi-model endpoint.
sourcepub fn target_variant(&self) -> Option<&str>
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
sourcepub fn target_container_hostname(&self) -> Option<&str>
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.
sourcepub fn inference_id(&self) -> Option<&str>
pub fn inference_id(&self) -> Option<&str>
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.
Trait Implementations
sourceimpl Clone for InvokeEndpointInput
impl Clone for InvokeEndpointInput
sourcefn clone(&self) -> InvokeEndpointInput
fn clone(&self) -> InvokeEndpointInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for InvokeEndpointInput
impl Debug for InvokeEndpointInput
sourceimpl PartialEq<InvokeEndpointInput> for InvokeEndpointInput
impl PartialEq<InvokeEndpointInput> for InvokeEndpointInput
sourcefn eq(&self, other: &InvokeEndpointInput) -> bool
fn eq(&self, other: &InvokeEndpointInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &InvokeEndpointInput) -> bool
fn ne(&self, other: &InvokeEndpointInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for InvokeEndpointInput
Auto Trait Implementations
impl RefUnwindSafe for InvokeEndpointInput
impl Send for InvokeEndpointInput
impl Sync for InvokeEndpointInput
impl Unpin for InvokeEndpointInput
impl UnwindSafe for InvokeEndpointInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more