Class: Aws::SageMaker::Types::EndpointInput

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::EndpointInput

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

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

{
  endpoint_name: "EndpointName", # required
  local_path: "ProcessingLocalPath", # required
  s3_input_mode: "Pipe", # accepts Pipe, File
  s3_data_distribution_type: "FullyReplicated", # accepts FullyReplicated, ShardedByS3Key
  features_attribute: "String",
  inference_attribute: "String",
  probability_attribute: "String",
  probability_threshold_attribute: 1.0,
  start_time_offset: "MonitoringTimeOffsetString",
  end_time_offset: "MonitoringTimeOffsetString",
}

Input object for the endpoint

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time_offset ⇒ String

  If specified, monitoring jobs substract this time from the end time.

• #endpoint_name ⇒ String

  An endpoint in customer's account which has enabled DataCaptureConfig enabled.

• #features_attribute ⇒ String

  The attributes of the input data that are the input features.

• #inference_attribute ⇒ String

  The attribute of the input data that represents the ground truth label.

• #local_path ⇒ String

  Path to the filesystem where the endpoint data is available to the container.

• #probability_attribute ⇒ String

  In a classification problem, the attribute that represents the class probability.

• #probability_threshold_attribute ⇒ Float

  The threshold for the class probability to be evaluated as a positive result.

• #s3_data_distribution_type ⇒ String

  Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.

• #s3_input_mode ⇒ String

  Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

• #start_time_offset ⇒ String

  If specified, monitoring jobs substract this time from the start time.

Instance Attribute Details

#end_time_offset ⇒ String

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_name ⇒ String

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#features_attribute ⇒ String

The attributes of the input data that are the input features.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#inference_attribute ⇒ String

The attribute of the input data that represents the ground truth label.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#local_path ⇒ String

Path to the filesystem where the endpoint data is available to the container.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#probability_attribute ⇒ String

In a classification problem, the attribute that represents the class probability.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#probability_threshold_attribute ⇒ Float

The threshold for the class probability to be evaluated as a positive result.

Returns:

• (Float)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#s3_data_distribution_type ⇒ String

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#s3_input_mode ⇒ String

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_offset ⇒ String

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 19597

class EndpointInput < Struct.new(
  :endpoint_name,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset)
  SENSITIVE = []
  include Aws::Structure
end