Struct InvokeEndpointAsyncInputBuilder 

#[non_exhaustive]
pub struct InvokeEndpointAsyncInputBuilder { /* private fields */ }

A builder for InvokeEndpointAsyncInput.

Implementations

impl InvokeEndpointAsyncInputBuilder

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.

This field is required.

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 AI 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 AI 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 AI 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 AI 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 AI 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 AI Python SDK.

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

The identifier for the inference request. Amazon SageMaker AI 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 AI 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 AI 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 s3_output_path_extension(self, input: impl Into<String>) -> Self

The path extension that is appended to the Amazon S3 output path where the inference response payload is stored.

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

The path extension that is appended to the Amazon S3 output path where the inference response payload is stored.

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

The path extension that is appended to the Amazon S3 output path where the inference response payload is stored.

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

The filename for the inference response payload stored in Amazon S3. If not specified, Amazon SageMaker AI generates a filename based on the inference ID.

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

The filename for the inference response payload stored in Amazon S3. If not specified, Amazon SageMaker AI generates a filename based on the inference ID.

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

The filename for the inference response payload stored in Amazon S3. If not specified, Amazon SageMaker AI generates a filename based on the inference ID.

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.

pub fn body(self, input: Blob) -> Self

Provides inline input data for the inference request, in the format specified in the ContentType request header. Use this parameter to send the request payload directly in the API call instead of uploading it to Amazon S3 and referencing it with InputLocation. The inline payload can be up to 128,000 bytes.

Body and InputLocation are mutually exclusive. Provide exactly one of them.

For information about the format of the request body, see Common Data Formats-Inference.

pub fn set_body(self, input: Option<Blob>) -> Self

Provides inline input data for the inference request, in the format specified in the ContentType request header. Use this parameter to send the request payload directly in the API call instead of uploading it to Amazon S3 and referencing it with InputLocation. The inline payload can be up to 128,000 bytes.

Body and InputLocation are mutually exclusive. Provide exactly one of them.

For information about the format of the request body, see Common Data Formats-Inference.

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

Provides inline input data for the inference request, in the format specified in the ContentType request header. Use this parameter to send the request payload directly in the API call instead of uploading it to Amazon S3 and referencing it with InputLocation. The inline payload can be up to 128,000 bytes.

Body and InputLocation are mutually exclusive. Provide exactly one of them.

For information about the format of the request body, see Common Data Formats-Inference.

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

Consumes the builder and constructs a InvokeEndpointAsyncInput.

impl InvokeEndpointAsyncInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<InvokeEndpointAsyncOutput, SdkError<InvokeEndpointAsyncError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for InvokeEndpointAsyncInputBuilder

fn clone(&self) -> InvokeEndpointAsyncInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeEndpointAsyncInputBuilder

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

Formats the value using the given formatter.

impl Default for InvokeEndpointAsyncInputBuilder

fn default() -> InvokeEndpointAsyncInputBuilder

Returns the “default value” for a type.

impl PartialEq for InvokeEndpointAsyncInputBuilder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InvokeEndpointAsyncInputBuilder