pub struct InvokeEndpointAsync { /* private fields */ }
Expand description
Fluent builder constructing a request to InvokeEndpointAsync
.
After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.
Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before the you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it.
Amazon SageMaker strips all POST
headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.
Calls to InvokeEndpointAsync
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.
Implementations
sourceimpl InvokeEndpointAsync
impl InvokeEndpointAsync
sourcepub async fn send(
self
) -> Result<InvokeEndpointAsyncOutput, SdkError<InvokeEndpointAsyncError>>
pub async fn send(
self
) -> Result<InvokeEndpointAsyncOutput, SdkError<InvokeEndpointAsyncError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn endpoint_name(self, input: impl Into<String>) -> Self
pub fn endpoint_name(self, input: impl Into<String>) -> Self
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint
API.
sourcepub fn set_endpoint_name(self, input: Option<String>) -> Self
pub fn set_endpoint_name(self, input: Option<String>) -> Self
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint
API.
sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
The MIME type of the input data in the request body.
sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
The MIME type of the input data in the request body.
sourcepub fn accept(self, input: impl Into<String>) -> Self
pub fn accept(self, input: impl Into<String>) -> Self
The desired MIME type of the inference in the response.
sourcepub fn set_accept(self, input: Option<String>) -> Self
pub fn set_accept(self, input: Option<String>) -> Self
The desired MIME type of the inference in the response.
sourcepub fn custom_attributes(self, input: impl Into<String>) -> Self
pub fn custom_attributes(self, input: impl Into<String>) -> Self
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 set_custom_attributes(self, input: Option<String>) -> Self
pub fn set_custom_attributes(self, input: Option<String>) -> Self
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 inference_id(self, input: impl Into<String>) -> Self
pub fn inference_id(self, input: impl Into<String>) -> Self
The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.
sourcepub fn set_inference_id(self, input: Option<String>) -> Self
pub fn set_inference_id(self, input: Option<String>) -> Self
The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.
sourcepub fn input_location(self, input: impl Into<String>) -> Self
pub fn input_location(self, input: impl Into<String>) -> Self
The Amazon S3 URI where the inference request payload is stored.
sourcepub fn set_input_location(self, input: Option<String>) -> Self
pub fn set_input_location(self, input: Option<String>) -> Self
The Amazon S3 URI where the inference request payload is stored.
sourcepub fn request_ttl_seconds(self, input: i32) -> Self
pub fn request_ttl_seconds(self, input: i32) -> Self
Maximum age in seconds a request can be in the queue before it is marked as expired.
sourcepub fn set_request_ttl_seconds(self, input: Option<i32>) -> Self
pub fn set_request_ttl_seconds(self, input: Option<i32>) -> Self
Maximum age in seconds a request can be in the queue before it is marked as expired.
Trait Implementations
sourceimpl Clone for InvokeEndpointAsync
impl Clone for InvokeEndpointAsync
sourcefn clone(&self) -> InvokeEndpointAsync
fn clone(&self) -> InvokeEndpointAsync
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
Auto Trait Implementations
impl !RefUnwindSafe for InvokeEndpointAsync
impl Send for InvokeEndpointAsync
impl Sync for InvokeEndpointAsync
impl Unpin for InvokeEndpointAsync
impl !UnwindSafe for InvokeEndpointAsync
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