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

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 InvokeEndpointInput data as a hash:

{
  endpoint_name: "EndpointName", # required
  body: "data", # required
  content_type: "Header",
  accept: "Header",
  custom_attributes: "CustomAttributesHeader",
  target_model: "TargetModelHeader",
  target_variant: "TargetVariantHeader",
  target_container_hostname: "TargetContainerHostnameHeader",
  inference_id: "InferenceId",
}

Constant Summary collapse

SENSITIVE =
[:body, :custom_attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#acceptString

The desired MIME type of the inference in the response.

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#bodyString

Provides input data, in the format specified in the ContentType request header. Amazon SageMaker passes all of the data in the body to the model.

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

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#content_typeString

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

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :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)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :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)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#inference_idString

If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For information about data capture, see Capture Data.

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#target_container_hostnameString

If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#target_modelString

The model to request for inference when invoking a multi-model endpoint.

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#target_variantString

Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants. Note that this parameter overrides the default behavior for the endpoint, which is to distribute the invocation traffic based on the variant weights.

For information about how to use variant targeting to perform a/b testing, see Test models in production

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-sagemakerruntime/lib/aws-sdk-sagemakerruntime/types.rb', line 236

class InvokeEndpointInput < Struct.new(
  :endpoint_name,
  :body,
  :content_type,
  :accept,
  :custom_attributes,
  :target_model,
  :target_variant,
  :target_container_hostname,
  :inference_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end