Struct aws_sdk_sagemakerruntime::operation::invoke_endpoint_async::builders::InvokeEndpointAsyncFluentBuilder

pub struct InvokeEndpointAsyncFluentBuilder { /* private fields */ }

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

impl InvokeEndpointAsyncFluentBuilder

pub fn as_input(&self) -> &InvokeEndpointAsyncInputBuilder

Access the InvokeEndpointAsync as a reference.

pub async fn send( self ) -> Result<InvokeEndpointAsyncOutput, SdkError<InvokeEndpointAsyncError, HttpResponse>>

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.

pub fn customize( self ) -> CustomizableOperation<InvokeEndpointAsyncOutput, InvokeEndpointAsyncError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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.

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.

pub fn get_endpoint_name(&self) -> &Option<String>

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

pub fn content_type(self, input: impl Into<String>) -> Self

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

pub fn set_content_type(self, input: Option<String>) -> Self

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

pub fn get_content_type(&self) -> &Option<String>

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

pub fn accept(self, input: impl Into<String>) -> Self

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

pub fn set_accept(self, input: Option<String>) -> Self

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

pub fn get_accept(&self) -> &Option<String>

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

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.

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.

pub fn get_custom_attributes(&self) -> &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.

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.

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.

pub fn get_inference_id(&self) -> &Option<String>

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

pub fn input_location(self, input: impl Into<String>) -> Self

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

pub fn set_input_location(self, input: Option<String>) -> Self

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

pub fn get_input_location(&self) -> &Option<String>

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

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. The default is 6 hours, or 21,600 seconds.

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. The default is 6 hours, or 21,600 seconds.

pub fn get_request_ttl_seconds(&self) -> &Option<i32>

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

pub fn invocation_timeout_seconds(self, input: i32) -> Self

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

pub fn set_invocation_timeout_seconds(self, input: Option<i32>) -> Self

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

pub fn get_invocation_timeout_seconds(&self) -> &Option<i32>

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

Trait Implementations

impl Clone for InvokeEndpointAsyncFluentBuilder

fn clone(&self) -> InvokeEndpointAsyncFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeEndpointAsyncFluentBuilder

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

Formats the value using the given formatter.