Struct aws_sdk_sagemakerruntime::input::invoke_endpoint_async_input::Builder

pub struct Builder { /* private fields */ }

A builder for InvokeEndpointAsyncInput.

Implementations

impl Builder

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.

Examples found in repository

src/client.rs (line 400)

        pub fn endpoint_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.endpoint_name(input.into());
            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.

Examples found in repository

src/client.rs (line 408)

        pub fn set_endpoint_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_endpoint_name(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 413)

        pub fn content_type(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.content_type(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 418)

        pub fn set_content_type(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_content_type(input);
            self
        }

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

The desired MIME type of the inference in the response.

Examples found in repository

src/client.rs (line 423)

        pub fn accept(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.accept(input.into());
            self
        }

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

The desired MIME type of the inference in the response.

Examples found in repository

src/client.rs (line 428)

        pub fn set_accept(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_accept(input);
            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.

Examples found in repository

src/client.rs (line 435)

        pub fn custom_attributes(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.custom_attributes(input.into());
            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.

Examples found in repository

src/client.rs (line 445)

        pub fn set_custom_attributes(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_custom_attributes(input);
            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.

Examples found in repository

src/client.rs (line 450)

        pub fn inference_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.inference_id(input.into());
            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.

Examples found in repository

src/client.rs (line 455)

        pub fn set_inference_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_inference_id(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 460)

        pub fn input_location(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.input_location(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 468)

        pub fn set_input_location(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_input_location(input);
            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.

Examples found in repository

src/client.rs (line 473)

        pub fn request_ttl_seconds(mut self, input: i32) -> Self {
            self.inner = self.inner.request_ttl_seconds(input);
            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.

Examples found in repository

src/client.rs (line 478)

        pub fn set_request_ttl_seconds(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_request_ttl_seconds(input);
            self
        }

pub fn build(self) -> Result<InvokeEndpointAsyncInput, BuildError>

Consumes the builder and constructs a InvokeEndpointAsyncInput.

Examples found in repository

src/client.rs (line 367)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::InvokeEndpointAsync,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::InvokeEndpointAsyncError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::InvokeEndpointAsyncOutput,
            aws_smithy_http::result::SdkError<crate::error::InvokeEndpointAsyncError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Builder