AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Overview

Note:

When making an API call, you may pass InvokeEndpointAsyncInput data as a hash:

{
  endpoint_name: "EndpointName", # required
  content_type: "Header",
  accept: "Header",
  custom_attributes: "CustomAttributesHeader",
  inference_id: "InferenceId",
  input_location: "InputLocationHeader", # required
  request_ttl_seconds: 1,
}

Constant Summary collapse

SENSITIVE =
[:custom_attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#acceptString

The desired MIME type of the inference in the response.

Returns:

  • (String)


97
98
99
100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 97

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

#content_typeString

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

Returns:

  • (String)


97
98
99
100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 97

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

#custom_attributesString

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 AWS SDKs but not in the Amazon SageMaker Python SDK.

Returns:

  • (String)


97
98
99
100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 97

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

#endpoint_nameString

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

Returns:

  • (String)


97
98
99
100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 97

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

#inference_idString

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

Returns:

  • (String)


97
98
99
100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 97

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

#input_locationString

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

Returns:

  • (String)


97
98
99
100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 97

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

#request_ttl_secondsInteger

Maximum age in seconds a request can be in the queue before it is marked as expired.

Returns:

  • (Integer)


97
98
99
100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 97

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