Class: Aws::SageMaker::Types::BatchTransformInput

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::BatchTransformInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Input object for the batch transform job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_captured_destination_s3_uri ⇒ String

  The Amazon S3 location being used to capture the data.

• #dataset_format ⇒ Types::MonitoringDatasetFormat

  The dataset format for your batch transform job.

• #end_time_offset ⇒ String

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

• #exclude_features_attribute ⇒ String

  The attributes of the input data to exclude from the analysis.

• #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 batch transform 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

#data_captured_destination_s3_uri ⇒ String

The Amazon S3 location being used to capture the data.

Returns:

• (String)

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

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

#dataset_format ⇒ Types::MonitoringDatasetFormat

The dataset format for your batch transform job.

Returns:

• (Types::MonitoringDatasetFormat)

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

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

#end_time_offset ⇒ String

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html

Returns:

• (String)

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

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

#exclude_features_attribute ⇒ String

The attributes of the input data to exclude from the analysis.

Returns:

• (String)

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

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

#features_attribute ⇒ String

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

Returns:

• (String)

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

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

#inference_attribute ⇒ String

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

Returns:

• (String)

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

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

#local_path ⇒ String

Path to the filesystem where the batch transform data is available to the container.

Returns:

• (String)

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

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

#probability_attribute ⇒ String

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

Returns:

• (String)

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

class BatchTransformInput < Struct.new(
  :data_captured_destination_s3_uri,
  :dataset_format,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset,
  :exclude_features_attribute)
  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 'lib/aws-sdk-sagemaker/types.rb', line 3202

class BatchTransformInput < Struct.new(
  :data_captured_destination_s3_uri,
  :dataset_format,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset,
  :exclude_features_attribute)
  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 'lib/aws-sdk-sagemaker/types.rb', line 3202

class BatchTransformInput < Struct.new(
  :data_captured_destination_s3_uri,
  :dataset_format,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset,
  :exclude_features_attribute)
  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 'lib/aws-sdk-sagemaker/types.rb', line 3202

class BatchTransformInput < Struct.new(
  :data_captured_destination_s3_uri,
  :dataset_format,
  :local_path,
  :s3_input_mode,
  :s3_data_distribution_type,
  :features_attribute,
  :inference_attribute,
  :probability_attribute,
  :probability_threshold_attribute,
  :start_time_offset,
  :end_time_offset,
  :exclude_features_attribute)
  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].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html

Returns:

• (String)

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

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