Class: Aws::SageMakerRuntime::Types::InvokeEndpointAsyncInput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemakerruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:custom_attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#accept ⇒ String

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

Returns:

  • (String) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end

#content_type ⇒ String

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

Returns:

  • (String) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end

#custom_attributes ⇒ 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.

[1]: datatracker.ietf.org/doc/html/rfc7230#section-3.2.6

Returns:

  • (String) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end

#endpoint_name ⇒ String

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html

Returns:

  • (String) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end

#inference_id ⇒ String

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

Returns:

  • (String) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end

#input_location ⇒ String

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

Returns:

  • (String) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end

#invocation_timeout_seconds ⇒ Integer

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.

Returns:

  • (Integer) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end

#request_ttl_seconds ⇒ Integer

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.

Returns:

  • (Integer) 


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 119

class InvokeEndpointAsyncInput < Struct.new(
  :endpoint_name,
  :content_type,
  :accept,
  :custom_attributes,
  :inference_id,
  :input_location,
  :request_ttl_seconds,
  :invocation_timeout_seconds)
  SENSITIVE = [:custom_attributes]
  include Aws::Structure
end